src/kernel/lmm/bmf.cpp

   1 /* Copyright (c) 2007-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 #include "src/kernel/lmm/bmf.hpp"
   7 #include "xbt/config.hpp"
   8
   9 #include <Eigen/LU>
  10 #include <iostream>
  11 #include <numeric>
  12 #include <sstream>
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_bmf, kernel, "Kernel BMF solver");
  15
  16 simgrid::config::Flag<int>
  17     cfg_bmf_max_iteration("bmf/max-iterations",
  18                           "Maximum number of steps to be performed while searching for a BMF allocation", 1000);
  19
  20 simgrid::config::Flag<double> cfg_bmf_precision{"bmf/precision",
  21                                                 "Numerical precision used when computing resource sharing", 1E-12};
  22
  23 namespace simgrid {
  24 namespace kernel {
  25 namespace lmm {
  26
  27 AllocationGenerator::AllocationGenerator(Eigen::MatrixXd A) : A_(std::move(A)), alloc_(A_.cols(), 0)
  28 {
  29   // got a first valid allocation
  30   for (size_t p = 0; p < alloc_.size(); p++) {
  31     for (int r = 0; r < A_.rows(); r++) {
  32       if (A_(r, p) > 0) {
  33         alloc_[p] = r;
  34         break;
  35       }
  36     }
  37   }
  38 }
  39
  40 bool AllocationGenerator::next(std::vector<int>& next_alloc)
  41 {
  42   if (first_) {
  43     next_alloc = alloc_;
  44     first_     = false;
  45     return true;
  46   }
  47
  48   auto n_resources = A_.rows();
  49   size_t idx      = 0;
  50   while (idx < alloc_.size()) {
  51     alloc_[idx] = (alloc_[idx] + 1) % n_resources;
  52     if (alloc_[idx] == 0) {
  53       idx++;
  54       continue;
  55     } else {
  56       idx = 0;
  57     }
  58     if (A_(alloc_[idx], idx) > 0) {
  59       next_alloc = alloc_;
  60       return true;
  61     }
  62   }
  63   return false;
  64 }
  65
  66 /*****************************************************************************/
  67
  68 BmfSolver::BmfSolver(Eigen::MatrixXd A, Eigen::MatrixXd maxA, Eigen::VectorXd C, std::vector<bool> shared,
  69                      Eigen::VectorXd phi)
  70     : A_(std::move(A))
  71     , maxA_(std::move(maxA))
  72     , C_(std::move(C))
  73     , C_shared_(std::move(shared))
  74     , phi_(std::move(phi))
  75     , gen_(A_)
  76     , max_iteration_(cfg_bmf_max_iteration)
  77
  78 {
  79   xbt_assert(max_iteration_ > 0,
  80              "Invalid number of iterations for BMF solver. Please check your \"bmf/max-iterations\" configuration.");
  81   xbt_assert(A_.cols() == maxA_.cols(), "Invalid number of cols in matrix A (%td) or maxA (%td)", A_.cols(),
  82              maxA_.cols());
  83   xbt_assert(A_.cols() == phi_.size(), "Invalid size of phi vector (%td)", phi_.size());
  84   xbt_assert(static_cast<long>(C_shared_.size()) == C_.size(), "Invalid size param shared (%zu)", C_shared_.size());
  85 }
  86
  87 template <typename T> std::string BmfSolver::debug_eigen(const T& obj) const
  88 {
  89   std::stringstream debug;
  90   debug << obj;
  91   return debug.str();
  92 }
  93
  94 template <typename C> std::string BmfSolver::debug_vector(const C& container) const
  95 {
  96   std::stringstream debug;
  97   std::copy(container.begin(), container.end(),
  98             std::ostream_iterator<typename std::remove_reference<decltype(container)>::type::value_type>(debug, " "));
  99   return debug.str();
 100 }
 101
 102 std::string BmfSolver::debug_alloc(const allocation_map_t& alloc) const
 103 {
 104   std::stringstream debug;
 105   for (const auto& [resource, players] : alloc) {
 106     debug << "{" + std::to_string(resource) + ": [" + debug_vector(players) + "]}, ";
 107   }
 108   return debug.str();
 109 }
 110
 111 double BmfSolver::get_resource_capacity(int resource, const std::vector<int>& bounded_players) const
 112 {
 113   double capacity = C_[resource];
 114   if (not C_shared_[resource])
 115     return capacity;
 116
 117   for (int p : bounded_players) {
 118     capacity -= A_(resource, p) * phi_[p];
 119   }
 120   return std::max(0.0, capacity);
 121 }
 122
 123 double BmfSolver::get_maxmin_share(int resource, const std::vector<int>& bounded_players) const
 124 {
 125   auto n_players  = (A_.row(resource).array() > 0).count() - bounded_players.size();
 126   double capacity = get_resource_capacity(resource, bounded_players);
 127   if (n_players > 0)
 128     capacity /= n_players;
 129   return capacity;
 130 }
 131
 132 std::vector<int> BmfSolver::alloc_map_to_vector(const allocation_map_t& alloc) const
 133 {
 134   std::vector<int> alloc_by_player(A_.cols(), -1);
 135   for (const auto& [resource, players] : alloc) {
 136     for (auto p : players) {
 137       alloc_by_player[p] = resource;
 138     }
 139   }
 140   return alloc_by_player;
 141 }
 142
 143 std::vector<int> BmfSolver::get_bounded_players(const allocation_map_t& alloc) const
 144 {
 145   std::vector<int> bounded_players;
 146   for (const auto& [resource, players] : alloc) {
 147     if (resource == NO_RESOURCE) {
 148       bounded_players.insert(bounded_players.end(), players.begin(), players.end());
 149     }
 150   }
 151   return bounded_players;
 152 }
 153
 154 Eigen::VectorXd BmfSolver::equilibrium(const allocation_map_t& alloc) const
 155 {
 156   auto n_players      = A_.cols();
 157   Eigen::MatrixXd A_p = Eigen::MatrixXd::Zero(n_players, n_players); // square matrix with number of players
 158   Eigen::VectorXd C_p = Eigen::VectorXd::Zero(n_players);
 159
 160   int row = 0;
 161   auto bounded_players = get_bounded_players(alloc);
 162   for (const auto& [resource, players] : alloc) {
 163     // add one row for the resource with A[r,]
 164     /* bounded players, nothing to do */
 165     if (resource == NO_RESOURCE)
 166       continue;
 167     /* not shared resource, each player can receive the full capacity of the resource */
 168     if (not C_shared_[resource]) {
 169       for (int i : players) {
 170         C_p[row]    = get_resource_capacity(resource, bounded_players);
 171         A_p(row, i) = A_(resource, i);
 172         row++;
 173       }
 174       continue;
 175     }
 176
 177     /* shared resource: fairly share it between players */
 178     A_p.row(row) = A_.row(resource);
 179     C_p[row]     = get_resource_capacity(resource, bounded_players);
 180     row++;
 181     if (players.size() > 1) {
 182       // if 2 players have chosen the same resource
 183       // they must have a fair sharing of this resource, adjust A_p and C_p accordingly
 184       auto it = players.begin();
 185       int i   = *it; // first player
 186       /* for each other player sharing this resource */
 187       for (++it; it != players.end(); ++it) {
 188         /* player i and k on this resource j: so maxA_ji*rho_i - maxA_jk*rho_k = 0 */
 189         int k       = *it;
 190         C_p[row]    = 0;
 191         A_p(row, i) = maxA_(resource, i);
 192         A_p(row, k) = -maxA_(resource, k);
 193         row++;
 194       }
 195     }
 196   }
 197   /* clear players which are externally bounded */
 198   for (int p : bounded_players) {
 199     A_p.col(p).setZero();
 200   }
 201
 202   XBT_DEBUG("A':\n%s", debug_eigen(A_p).c_str());
 203
 204   XBT_DEBUG("C':\n%s", debug_eigen(C_p).c_str());
 205   /* PartialPivLU is much faster than FullPivLU but requires that the matrix is invertible
 206    * FullPivLU however assures that it finds come solution even if the matrix is singular
 207    * Ideally we would like to be optimist and try Partial and in case of error, go back
 208    * to FullPivLU.
 209    * However, this with isNaN doesn't work if compiler uses -Ofastmath. In our case,
 210    * the icc compiler raises an error when compiling the code (comparison with NaN always evaluates to false in fast
 211    * floating point modes).
 212    * Eigen::VectorXd rho = Eigen::PartialPivLU<Eigen::MatrixXd>(A_p).solve(C_p);
 213    * if (rho.array().isNaN().any()) {
 214    *   XBT_DEBUG("rho with nan values, falling back to FullPivLU, rho:\n%s", debug_eigen(rho).c_str());
 215    *   rho = Eigen::FullPivLU<Eigen::MatrixXd>(A_p).solve(C_p);
 216    * }
 217    */
 218
 219   Eigen::VectorXd rho = Eigen::FullPivLU<Eigen::MatrixXd>(A_p).solve(C_p);
 220   for (int p : bounded_players) {
 221     rho[p] = phi_[p];
 222   }
 223   return rho;
 224 }
 225
 226 bool BmfSolver::disturb_allocation(allocation_map_t& alloc, std::vector<int>& alloc_by_player)
 227 {
 228   while (gen_.next(alloc_by_player)) {
 229     if (allocations_.find(alloc_by_player) == allocations_.end()) {
 230       allocations_.clear();
 231       allocations_.insert(alloc_by_player);
 232       alloc.clear();
 233       for (size_t p = 0; p < alloc_by_player.size(); p++) {
 234         alloc[alloc_by_player[p]].insert(p);
 235       }
 236       return false;
 237     }
 238   }
 239   return true;
 240 }
 241
 242 bool BmfSolver::get_alloc(const Eigen::VectorXd& fair_sharing, const allocation_map_t& last_alloc,
 243                           allocation_map_t& alloc, bool initial)
 244 {
 245   alloc.clear();
 246   for (int player_idx = 0; player_idx < A_.cols(); player_idx++) {
 247     int selected_resource = NO_RESOURCE;
 248
 249     /* the player's maximal rate is the minimum among all resources */
 250     double min_rate = -1;
 251     for (int cnst_idx = 0; cnst_idx < A_.rows(); cnst_idx++) {
 252       if (A_(cnst_idx, player_idx) <= 0.0)
 253         continue;
 254
 255       /* Note: the max_ may artificially increase the rate if priority < 0
 256        * The equilibrium sets a rho which respects the C_ though */
 257       double rate = fair_sharing[cnst_idx] / maxA_(cnst_idx, player_idx);
 258       if (min_rate == -1 || double_positive(min_rate - rate, cfg_bmf_precision)) {
 259         selected_resource = cnst_idx;
 260         min_rate          = rate;
 261       }
 262       double bound = initial ? -1 : phi_[player_idx];
 263       /* Given that the priority may artificially increase the rate,
 264        * we need to check that the bound given by user respects the resource capacity C_ */
 265       if (bound > 0 && bound * A_(cnst_idx, player_idx) < C_[cnst_idx] &&
 266           double_positive(min_rate - bound, cfg_bmf_precision)) {
 267         selected_resource = NO_RESOURCE;
 268         min_rate          = bound;
 269       }
 270     }
 271     alloc[selected_resource].insert(player_idx);
 272   }
 273   bool is_stable = (alloc == last_alloc);
 274   if (is_stable)
 275     return true;
 276
 277   std::vector<int> alloc_by_player      = alloc_map_to_vector(alloc);
 278   bool inserted                         = allocations_.insert(alloc_by_player).second;
 279   /* oops, allocation already tried, let's pertube it a bit */
 280   if (not inserted) {
 281     XBT_DEBUG("Allocation already tried: %s", debug_alloc(alloc).c_str());
 282     return disturb_allocation(alloc, alloc_by_player);
 283   }
 284   return false;
 285 }
 286
 287 void BmfSolver::set_fair_sharing(const allocation_map_t& alloc, const Eigen::VectorXd& rho,
 288                                  Eigen::VectorXd& fair_sharing) const
 289 {
 290   std::vector<int> bounded_players = get_bounded_players(alloc);
 291
 292   for (int r = 0; r < fair_sharing.size(); r++) {
 293     auto it = alloc.find(r);
 294     if (it != alloc.end()) { // resource selected by some player, fair share depends on rho
 295       double min_share = std::numeric_limits<double>::max();
 296       for (int p : it->second) {
 297         double share = A_(r, p) * rho[p];
 298         min_share    = std::min(min_share, share);
 299       }
 300       fair_sharing[r] = min_share;
 301     } else { // nobody selects this resource, fair_sharing depends on resource saturation
 302       // resource r is saturated (A[r,*] * rho > C), divide it among players
 303       double consumption_r = A_.row(r) * rho;
 304       double_update(&consumption_r, C_[r], cfg_bmf_precision);
 305       if (consumption_r > 0.0) {
 306         fair_sharing[r] = get_maxmin_share(r, bounded_players);
 307       } else {
 308         fair_sharing[r] = C_[r];
 309       }
 310     }
 311   }
 312 }
 313
 314 bool BmfSolver::is_bmf(const Eigen::VectorXd& rho) const
 315 {
 316   bool bmf = true;
 317
 318   // 1) the capacity of all resources is respected
 319   Eigen::VectorXd shared(C_shared_.size());
 320   for (int j = 0; j < shared.size(); j++)
 321     shared[j] = C_shared_[j] ? 1.0 : 0.0;
 322
 323   Eigen::VectorXd remaining = (A_ * rho) - C_;
 324   remaining                 = remaining.array() * shared.array(); // ignore non shared resources
 325   bmf                       = bmf && (not std::any_of(remaining.data(), remaining.data() + remaining.size(),
 326                                 [](double v) { return double_positive(v, sg_maxmin_precision); }));
 327
 328   // 3) every player receives maximum share in at least 1 saturated resource
 329   // due to subflows, compare with the maximum consumption and not the A matrix
 330   Eigen::MatrixXd usage =
 331       maxA_.array().rowwise() * rho.transpose().array(); // usage_ji: indicates the usage of player i on resource j
 332
 333   XBT_DEBUG("Usage_ji considering max consumption:\n%s", debug_eigen(usage).c_str());
 334   auto max_share = usage.rowwise().maxCoeff(); // max share for each resource j
 335
 336   // matrix_ji: boolean indicating player p has the maximum share at resource j
 337   Eigen::MatrixXi player_max_share =
 338       ((usage.array().colwise() - max_share.array()).abs() <= sg_maxmin_precision).cast<int>();
 339   // but only saturated resources must be considered
 340   Eigen::VectorXi saturated = (remaining.array().abs() <= sg_maxmin_precision).cast<int>();
 341   XBT_DEBUG("Saturated_j resources:\n%s", debug_eigen(saturated).c_str());
 342   player_max_share.array().colwise() *= saturated.array();
 343
 344   // just check if it has received at least it's bound
 345   for (int p = 0; p < rho.size(); p++) {
 346     if (double_equals(rho[p], phi_[p], sg_maxmin_precision)) {
 347       player_max_share(0, p) = 1; // it doesn't really matter, just to say that it's a bmf
 348       saturated[0]           = 1;
 349     }
 350   }
 351
 352   // 2) at least 1 resource is saturated
 353   bmf = bmf && (saturated.array() == 1).any();
 354
 355   XBT_DEBUG("Player_ji usage of saturated resources:\n%s", debug_eigen(player_max_share).c_str());
 356   // for all columns(players) it has to be the max at least in 1
 357   bmf = bmf && (player_max_share.colwise().sum().array() >= 1).all();
 358   return bmf;
 359 }
 360
 361 Eigen::VectorXd BmfSolver::solve()
 362 {
 363   XBT_DEBUG("Starting BMF solver");
 364
 365   XBT_DEBUG("A:\n%s", debug_eigen(A_).c_str());
 366   XBT_DEBUG("maxA:\n%s", debug_eigen(maxA_).c_str());
 367   XBT_DEBUG("C:\n%s", debug_eigen(C_).c_str());
 368   XBT_DEBUG("phi:\n%s", debug_eigen(phi_).c_str());
 369
 370   /* no flows to share, just returns */
 371   if (A_.cols() == 0)
 372     return {};
 373
 374   int it            = 0;
 375   auto fair_sharing = C_;
 376
 377   /* BMF allocation for each player (current and last one) stop when are equal */
 378   allocation_map_t last_alloc;
 379   allocation_map_t cur_alloc;
 380   Eigen::VectorXd rho;
 381
 382   while (it < max_iteration_ && not get_alloc(fair_sharing, last_alloc, cur_alloc, it == 0)) {
 383     last_alloc = cur_alloc;
 384     XBT_DEBUG("BMF: iteration %d", it);
 385     XBT_DEBUG("B (current allocation): %s", debug_alloc(cur_alloc).c_str());
 386
 387     // solve inv(A)*rho = C
 388     rho = equilibrium(cur_alloc);
 389     XBT_DEBUG("rho:\n%s", debug_eigen(rho).c_str());
 390
 391     // get fair sharing for each resource
 392     set_fair_sharing(cur_alloc, rho, fair_sharing);
 393     XBT_DEBUG("Fair sharing vector (per resource):\n%s", debug_eigen(fair_sharing).c_str());
 394
 395     // get new allocation for players
 396     it++;
 397   }
 398
 399   /* Not mandatory but a safe check to assure we have a proper solution */
 400   if (not is_bmf(rho)) {
 401     fprintf(stderr, "Unable to find a BMF allocation for your system.\n"
 402                     "You may try to increase the maximum number of iterations performed by BMF solver "
 403                     "(\"--cfg=bmf/max-iterations\").\n"
 404                     "Additionally, you could adjust numerical precision (\"--cfg=bmf/precision\").\n");
 405     fprintf(stderr, "Internal states (after %d iterations):\n", it);
 406     fprintf(stderr, "A:\n%s\n", debug_eigen(A_).c_str());
 407     fprintf(stderr, "maxA:\n%s\n", debug_eigen(maxA_).c_str());
 408     fprintf(stderr, "C:\n%s\n", debug_eigen(C_).c_str());
 409     fprintf(stderr, "C_shared:\n%s\n", debug_vector(C_shared_).c_str());
 410     fprintf(stderr, "phi:\n%s\n", debug_eigen(phi_).c_str());
 411     fprintf(stderr, "rho:\n%s\n", debug_eigen(rho).c_str());
 412     xbt_abort();
 413   }
 414
 415   XBT_DEBUG("BMF done after %d iterations", it);
 416   return rho;
 417 }
 418
 419 /*****************************************************************************/
 420
 421 void BmfSystem::get_flows_data(Eigen::Index number_cnsts, Eigen::MatrixXd& A, Eigen::MatrixXd& maxA,
 422                                Eigen::VectorXd& phi)
 423 {
 424   A.resize(number_cnsts, variable_set.size());
 425   A.setZero();
 426   maxA.resize(number_cnsts, variable_set.size());
 427   maxA.setZero();
 428   phi.resize(variable_set.size());
 429
 430   int var_idx = 0;
 431   for (Variable& var : variable_set) {
 432     if (var.sharing_penalty_ <= 0)
 433       continue;
 434     bool active = false;
 435     bool linked = false; // variable is linked to some constraint (specially for selective_update)
 436     for (const Element& elem : var.cnsts_) {
 437       const boost::intrusive::list_member_hook<>& cnst_hook = selective_update_active
 438                                                                   ? elem.constraint->modified_constraint_set_hook_
 439                                                                   : elem.constraint->active_constraint_set_hook_;
 440       if (not cnst_hook.is_linked())
 441         continue;
 442       /* active and linked variable, lets check its consumption */
 443       linked             = true;
 444       double consumption = elem.consumption_weight;
 445       if (consumption > 0) {
 446         int cnst_idx = cnst2idx_[elem.constraint];
 447         A(cnst_idx, var_idx) += consumption;
 448         // a variable with double penalty must receive half share, so it max weight is greater
 449         maxA(cnst_idx, var_idx) = std::max(maxA(cnst_idx, var_idx), elem.max_consumption_weight * var.sharing_penalty_);
 450         active                  = true;
 451       }
 452     }
 453     /* skip variables not linked to any modified or active constraint */
 454     if (not linked)
 455       continue;
 456     if (active) {
 457       phi[var_idx]      = var.get_bound();
 458       idx2Var_[var_idx] = &var;
 459       var_idx++;
 460     } else {
 461       var.value_ = 1; // assign something by default for tasks with 0 consumption
 462     }
 463   }
 464   // resize matrix to active variables only
 465   A.conservativeResize(Eigen::NoChange_t::NoChange, var_idx);
 466   maxA.conservativeResize(Eigen::NoChange_t::NoChange, var_idx);
 467   phi.conservativeResize(var_idx);
 468 }
 469
 470 template <class CnstList>
 471 void BmfSystem::get_constraint_data(const CnstList& cnst_list, Eigen::VectorXd& C, std::vector<bool>& shared)
 472 {
 473   C.resize(cnst_list.size());
 474   shared.resize(cnst_list.size());
 475   cnst2idx_.clear();
 476   int cnst_idx = 0;
 477   for (const Constraint& cnst : cnst_list) {
 478     C(cnst_idx)      = cnst.bound_;
 479     if (cnst.get_sharing_policy() == Constraint::SharingPolicy::NONLINEAR && cnst.dyn_constraint_cb_) {
 480       C(cnst_idx) = cnst.dyn_constraint_cb_(cnst.bound_, cnst.concurrency_current_);
 481     }
 482     cnst2idx_[&cnst] = cnst_idx;
 483     // FATPIPE links aren't really shared
 484     shared[cnst_idx] = (cnst.sharing_policy_ != Constraint::SharingPolicy::FATPIPE);
 485     cnst_idx++;
 486   }
 487 }
 488
 489 void BmfSystem::do_solve()
 490 {
 491   if (selective_update_active)
 492     bmf_solve(modified_constraint_set);
 493   else
 494     bmf_solve(active_constraint_set);
 495 }
 496
 497 template <class CnstList> void BmfSystem::bmf_solve(const CnstList& cnst_list)
 498 {
 499   idx2Var_.clear();
 500   cnst2idx_.clear();
 501   Eigen::MatrixXd A;
 502   Eigen::MatrixXd maxA;
 503   Eigen::VectorXd C;
 504   Eigen::VectorXd bounds;
 505   std::vector<bool> shared;
 506   get_constraint_data(cnst_list, C, shared);
 507   get_flows_data(C.size(), A, maxA, bounds);
 508
 509   auto solver = BmfSolver(std::move(A), std::move(maxA), std::move(C), std::move(shared), std::move(bounds));
 510   auto rho    = solver.solve();
 511
 512   if (rho.size() == 0)
 513     return;
 514
 515   /* setting rhos */
 516   for (int i = 0; i < rho.size(); i++) {
 517     idx2Var_[i]->value_ = rho[i];
 518   }
 519 }
 520
 521 } // namespace lmm
 522 } // namespace kernel
 523 } // namespace simgrid