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