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