src/kernel/lmm/bmf.hpp

   1 /* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SURF_BMF_HPP
   7 #define SURF_BMF_HPP
   8
   9 #include "src/kernel/lmm/maxmin.hpp"
  10 #include <Eigen/Dense>
  11 #include <unordered_set>
  12
  13 namespace simgrid {
  14 namespace kernel {
  15 namespace lmm {
  16
  17 /** @brief Generate all combinations of valid allocation */
  18 class XBT_PUBLIC AllocationGenerator {
  19 public:
  20   explicit AllocationGenerator(Eigen::MatrixXd A);
  21
  22   /**
  23    * @brief Get next valid allocation
  24    *
  25    * @param next_alloc Allocation (OUTPUT)
  26    * @return true if there's an allocation not tested yet, false otherwise
  27    */
  28   bool next(std::vector<int>& next_alloc);
  29
  30 private:
  31   Eigen::MatrixXd A_;
  32   std::vector<int> alloc_;
  33   bool first_ = true;
  34 };
  35
  36 /**
  37  * @beginrst
  38  *
  39  * Despite the simplicity of BMF fairness definition, it's quite hard to
  40  * find a BMF allocation in the general case.
  41  *
  42  * This solver implements one possible algorithm to find a BMF, as proposed
  43  * at: https://hal.archives-ouvertes.fr/hal-01552739.
  44  *
  45  * The idea of this algorithm is that each player/flow "selects" a resource to
  46  * saturate. Then, we calculate the rate each flow would have with this allocation.
  47  * If the allocation is a valid BMF and no one needs to move, it's over. Otherwise,
  48  * each player selects a new resource to saturate based on the minimim rate possible
  49  * between all resources.
  50  *
  51  * The steps:
  52  * 1) Given an initial allocation B_i
  53  * 2) Build a matrix A'_ji and C'_ji which assures that the player receives the most
  54  * share at selected resources
  55  * 3) Solve: A'_ji * rho_i = C'_j
  56  * 4) Calculate the minimum fair rate for each resource j: f_j. The f_j represents
  57  * the maximum each flow can receive at the resource j.
  58  * 5) Builds a new vector B'_i = arg min(f_j/A_ji).
  59  * 6) Stop if B == B' (nobody needs to move), go to step 2 otherwise
  60  *
  61  * Despite the overall good performance of this algorithm, which converges in a few
  62  * iterations, we don't have any assurance about its convergence. In the worst case,
  63  * it may be needed to test all possible combination of allocations (which is exponential).
  64  *
  65  * @endrst
  66  */
  67 class XBT_PUBLIC BmfSolver {
  68 public:
  69   /**
  70    * @brief Instantiate the BMF solver
  71    *
  72    * @param A A_ji: consumption of player i on resource j
  73    * @param maxA maxA_ji: consumption of larger player i on resource j
  74    * @param C Resource capacity
  75    * @param shared Is resource shared between player or each player receives the full capacity (FATPIPE links)
  76    * @param phi Bound for each player
  77    */
  78   BmfSolver(Eigen::MatrixXd A, Eigen::MatrixXd maxA, Eigen::VectorXd C, std::vector<bool> shared, Eigen::VectorXd phi);
  79   /** @brief Solve equation system to find a fair-sharing of resources */
  80   Eigen::VectorXd solve();
  81
  82 private:
  83   using allocation_map_t = std::unordered_map<int, std::unordered_set<int>>;
  84   /**
  85    * @brief Get actual resource capacity considering bounded players
  86    *
  87    * Calculates the resource capacity considering that some players on it may be bounded by user,
  88    * i.e. an explicit limit in speed was configured
  89    *
  90    * @param resource Internal index of resource in C_ vector
  91    * @param bounded_players List of players that are externally bounded
  92    * @return Actual resource capacity
  93    */
  94   double get_resource_capacity(int resource, const std::vector<int>& bounded_players) const;
  95   /**
  96    * @brief Auxiliary method to get list of bounded player from allocation
  97    *
  98    * @param alloc Current allocation
  99    * @return list of bounded players
 100    */
 101   std::vector<int> get_bounded_players(const allocation_map_t& alloc) const;
 102
 103   /**
 104    * @brief Given an allocation calculates the speed/rho for each player
 105    *
 106    * Do the magic!!
 107    * Builds 2 auxiliares matrices A' and C' and solves the system: rho_i = inv(A'_ji) * C'_j
 108    *
 109    * All resources in A' and C' are saturated, i.e., sum(A'_j * rho_i) = C'_j.
 110    *
 111    * The matrix A' is built as follows:
 112    * - For each resource j in alloc: copy row A_j to A'
 113    * - If 2 players (i, k) share a same resource, assure fairness by adding a row in A' such as:
 114    *   -  A_ji*rho_i - Ajk*rho_j = 0
 115    *
 116    * @param alloc for each resource, players that chose to saturate it
 117    * @return Vector rho with "players' speed"
 118    */
 119   Eigen::VectorXd equilibrium(const allocation_map_t& alloc) const;
 120
 121   /**
 122    * @brief Given a fair_sharing vector, gets the allocation
 123    *
 124    * The allocation for player i is given by: min(bound, f_j/A_ji).
 125    * The minimum between all fair-sharing and the external bound (if any)
 126    *
 127    * The algorithm dictates a random initial allocation. For simplicity, we opt to use the same
 128    * logic with the fair_sharing vector.
 129    *
 130    * @param fair_sharing Fair sharing vector
 131    * @param initial Is this the initial allocation?
 132    * @return allocation vector
 133    */
 134   bool get_alloc(const Eigen::VectorXd& fair_sharing, const allocation_map_t& last_alloc, allocation_map_t& alloc,
 135                  bool initial);
 136
 137   bool disturb_allocation(allocation_map_t& alloc, std::vector<int>& alloc_by_player);
 138   /**
 139    * @brief Calculates the fair sharing for each resource
 140    *
 141    * Basically 3 options:
 142    * 1) resource in allocation: A_ji*rho_i since all players who selected this resource have the same share
 143    * 2) resource not selected by saturated (fully used): divide it by the number of players C_/n_players
 144    * 3) resource not selected and not-saturated: no limitation
 145    *
 146    * @param alloc Allocation map (resource-> players)
 147    * @param rho Speed for each player i
 148    * @param fair_sharing Output vector, fair sharing for each resource j
 149    */
 150   void set_fair_sharing(const allocation_map_t& alloc, const Eigen::VectorXd& rho, Eigen::VectorXd& fair_sharing) const;
 151
 152   /**
 153    * @brief Check if allocation is BMF
 154    *
 155    * To be a bmf allocation it must:
 156    * - respect the capacity of all resources
 157    * - saturate at least 1 resource
 158    * - every player receives maximum share in at least 1 saturated resource
 159    * @param rho Allocation
 160    * @return true if BMF false otherwise
 161    */
 162   bool is_bmf(const Eigen::VectorXd& rho) const;
 163   std::vector<int> alloc_map_to_vector(const allocation_map_t& alloc) const;
 164
 165   /**
 166    * @brief Set of debug functions to print the different objects
 167    */
 168   template <typename T> std::string debug_eigen(const T& obj) const;
 169   template <typename C> std::string debug_vector(const C& container) const;
 170   std::string debug_alloc(const allocation_map_t& alloc) const;
 171
 172   Eigen::MatrixXd A_;    //!< A_ji: resource usage matrix, each row j represents a resource and col i a flow/player
 173   Eigen::MatrixXd maxA_; //!< maxA_ji,  similar as A_, but containing the maximum consumption of player i (if player a
 174                          //!< single flow it's equal to A_)
 175   Eigen::VectorXd C_;    //!< C_j Capacity of each resource
 176   std::vector<bool> C_shared_; //!< shared_j Resource j is shared or not
 177   Eigen::VectorXd phi_;        //!< phi_i bound for each player
 178
 179   std::set<std::vector<int>> allocations_; //!< set of already tested allocations, since last identified loop
 180   AllocationGenerator gen_;
 181   std::vector<int> allocations_age_;
 182   static constexpr int NO_RESOURCE = -1;                    //!< flag to indicate player has selected no resource
 183   int max_iteration_;                                       //!< number maximum of iterations of BMF algorithm
 184 };
 185
 186 /**
 187  * @beginrst
 188  *
 189  * A BMF (bottleneck max fairness) solver to resolve inequation systems.
 190  *
 191  * Usually, SimGrid relies on a *max-min fairness* solver to share the resources.
 192  * Max-min is great when sharing homogenous resources, however it cannot be used with heterogeneous resources.
 193  *
 194  * BMF is a natural alternative to max-min, providing a fair-sharing of heterogeneous resources (CPU, network, disk).
 195  * It is specially relevant for the implementation of parallel tasks whose sharing involves different
 196  * kinds of resources.
 197  *
 198  * BMF assures that every flow receives the maximum share possible in at least 1 bottleneck (fully used) resource.
 199  *
 200  * The BMF is characterized by:
 201  * - A_ji: a matrix of requirement for flows/player. For each resource j, and flow i, A_ji represents the utilization
 202  * of resource j for 1 unit of the flow i.
 203  * - rho_i: the rate allocated for flow i (same among all resources)
 204  * - C_j: the capacity of each resource (can be bytes/s, flops/s, etc)
 205  *
 206  * Therefore, these conditions need to satisfied to an allocation be considered a BMF:
 207  * 1) All constraints are respected (flows cannot use more than the resource has available)
 208  *   - for all resource j and player i: A_ji * rho_i <= C_j
 209  * 2) At least 1 resource is fully used (bottleneck).
 210  *   - for some resource j: A_ji * rho_i = C_j
 211  * 3) Each flow (player) receives the maximum share in at least 1 bottleneck.
 212  *   - for all player i: exist a resource j: A_ji * rho_i >= A_jk * rho_k for all other player k
 213  *
 214  * Despite the prove of existence of a BMF allocation in the general case, it may not
 215  * be unique, which leads to possible different rate for the applications.
 216  *
 217  * More details about BMF can be found at: https://hal.inria.fr/hal-01243985/document
 218  *
 219  * @endrst
 220  */
 221 /**
 222  * @brief Bottleneck max-fair system
 223  */
 224 class XBT_PUBLIC BmfSystem : public System {
 225 public:
 226   using System::System;
 227   /** @brief Implements the solve method to calculate a BMF allocation */
 228   void solve() final;
 229
 230 private:
 231   using allocation_map_t = std::unordered_map<int, std::unordered_set<int>>;
 232   /**
 233    * @brief Solve equation system to find a fair-sharing of resources
 234    *
 235    * @param cnst_list Constraint list (modified for selective update or active)
 236    */
 237   template <class CnstList> void bmf_solve(const CnstList& cnst_list);
 238   /**
 239    * @brief Iterates over system and build the consumption matrix A_ji and maxA_ji
 240    *
 241    * Each row j represents a resource and each col i a player/flow
 242    *
 243    * Considers only active variables to build the matrix.
 244    *
 245    * @param number_cnsts Number of constraints in the system
 246    * @param A Consumption matrix (OUTPUT)
 247    * @param maxA Max subflow consumption matrix (OUTPUT)
 248    * @param phi Bounds for variables
 249    */
 250   void get_flows_data(Eigen::Index number_cnsts, Eigen::MatrixXd& A, Eigen::MatrixXd& maxA, Eigen::VectorXd& phi);
 251   /**
 252    * @brief Builds the vector C_ with resource's capacity
 253    *
 254    * @param cnst_list Constraint list (modified for selective update or active)
 255    * @param C Resource capacity vector
 256    * @param shared Resource is shared or not (fatpipe links)
 257    */
 258   template <class CnstList>
 259   void get_constraint_data(const CnstList& cnst_list, Eigen::VectorXd& C, std::vector<bool>& shared);
 260
 261   std::unordered_map<int, Variable*> idx2Var_; //!< Map player index (and position in matrices) to system's variable
 262   std::unordered_map<const Constraint*, int> cnst2idx_; //!< Conversely map constraint to index
 263   bool warned_nonlinear_ = false;
 264 };
 265
 266 } // namespace lmm
 267 } // namespace kernel
 268 } // namespace simgrid
 269
 270 #endif