Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'wifi_clean' into 'master'
[simgrid.git] / src / kernel / lmm / bmf.cpp
index 70cca13..24d6638 100644 (file)
@@ -4,7 +4,6 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/kernel/lmm/bmf.hpp"
-#include "xbt/config.hpp"
 
 #include <Eigen/LU>
 #include <iostream>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_bmf, kernel, "Kernel BMF solver");
 
-simgrid::config::Flag<int>
-    cfg_bmf_max_iteration("bmf/max-iterations",
-                          "Maximum number of steps to be performed while searching for a BMF allocation", 1000);
-
-simgrid::config::Flag<bool> cfg_bmf_selective_update{
-    "bmf/selective-update", "Update the constraint set propagating recursively to others constraints (off by default)",
-    false};
-
-simgrid::config::Flag<double> cfg_bmf_precision{"bmf/precision",
-                                                "Numerical precision used when computing resource sharing", 1E-12};
-
-namespace simgrid {
-namespace kernel {
-namespace lmm {
+namespace simgrid::kernel::lmm {
 
 AllocationGenerator::AllocationGenerator(Eigen::MatrixXd A) : A_(std::move(A)), alloc_(A_.cols(), 0)
 {
@@ -70,15 +56,13 @@ bool AllocationGenerator::next(std::vector<int>& next_alloc)
 /*****************************************************************************/
 
 BmfSolver::BmfSolver(Eigen::MatrixXd A, Eigen::MatrixXd maxA, Eigen::VectorXd C, std::vector<bool> shared,
-                     Eigen::VectorXd phi, Eigen::VectorXd weight)
+                     Eigen::VectorXd phi)
     : A_(std::move(A))
     , maxA_(std::move(maxA))
     , C_(std::move(C))
     , C_shared_(std::move(shared))
     , phi_(std::move(phi))
-    , weight_(std::move(weight))
     , gen_(A_)
-    , max_iteration_(cfg_bmf_max_iteration)
 
 {
   xbt_assert(max_iteration_ > 0,
@@ -86,11 +70,7 @@ BmfSolver::BmfSolver(Eigen::MatrixXd A, Eigen::MatrixXd maxA, Eigen::VectorXd C,
   xbt_assert(A_.cols() == maxA_.cols(), "Invalid number of cols in matrix A (%td) or maxA (%td)", A_.cols(),
              maxA_.cols());
   xbt_assert(A_.cols() == phi_.size(), "Invalid size of phi vector (%td)", phi_.size());
-  xbt_assert(A_.cols() == weight_.size(), "Invalid size of weight vector (%td)", weight_.size());
   xbt_assert(static_cast<long>(C_shared_.size()) == C_.size(), "Invalid size param shared (%zu)", C_shared_.size());
-
-  /* maxA_ must consider the weight for each player */
-  maxA_ = maxA_.array().rowwise() * weight_.transpose().array();
 }
 
 template <typename T> std::string BmfSolver::debug_eigen(const T& obj) const
@@ -111,8 +91,8 @@ template <typename C> std::string BmfSolver::debug_vector(const C& container) co
 std::string BmfSolver::debug_alloc(const allocation_map_t& alloc) const
 {
   std::stringstream debug;
-  for (const auto& e : alloc) {
-    debug << "{" + std::to_string(e.first) + ": [" + debug_vector(e.second) + "]}, ";
+  for (const auto& [resource, players] : alloc) {
+    debug << "{" + std::to_string(resource) + ": [" + debug_vector(players) + "]}, ";
   }
   return debug.str();
 }
@@ -141,9 +121,9 @@ double BmfSolver::get_maxmin_share(int resource, const std::vector<int>& bounded
 std::vector<int> BmfSolver::alloc_map_to_vector(const allocation_map_t& alloc) const
 {
   std::vector<int> alloc_by_player(A_.cols(), -1);
-  for (const auto& it : alloc) {
-    for (auto p : it.second) {
-      alloc_by_player[p] = it.first;
+  for (const auto& [resource, players] : alloc) {
+    for (auto p : players) {
+      alloc_by_player[p] = resource;
     }
   }
   return alloc_by_player;
@@ -152,9 +132,9 @@ std::vector<int> BmfSolver::alloc_map_to_vector(const allocation_map_t& alloc) c
 std::vector<int> BmfSolver::get_bounded_players(const allocation_map_t& alloc) const
 {
   std::vector<int> bounded_players;
-  for (const auto& e : alloc) {
-    if (e.first == NO_RESOURCE) {
-      bounded_players.insert(bounded_players.end(), e.second.begin(), e.second.end());
+  for (const auto& [resource, players] : alloc) {
+    if (resource == NO_RESOURCE) {
+      bounded_players.insert(bounded_players.end(), players.begin(), players.end());
     }
   }
   return bounded_players;
@@ -168,38 +148,37 @@ Eigen::VectorXd BmfSolver::equilibrium(const allocation_map_t& alloc) const
 
   int row = 0;
   auto bounded_players = get_bounded_players(alloc);
-  for (const auto& e : alloc) {
+  for (const auto& [resource, players] : alloc) {
     // add one row for the resource with A[r,]
-    int cur_resource = e.first;
     /* bounded players, nothing to do */
-    if (cur_resource == NO_RESOURCE)
+    if (resource == NO_RESOURCE)
       continue;
     /* not shared resource, each player can receive the full capacity of the resource */
-    if (not C_shared_[cur_resource]) {
-      for (int i : e.second) {
-        C_p[row]    = get_resource_capacity(cur_resource, bounded_players);
-        A_p(row, i) = A_(cur_resource, i);
+    if (not C_shared_[resource]) {
+      for (int i : players) {
+        C_p[row]    = get_resource_capacity(resource, bounded_players);
+        A_p(row, i) = A_(resource, i);
         row++;
       }
       continue;
     }
 
     /* shared resource: fairly share it between players */
-    A_p.row(row) = A_.row(cur_resource);
-    C_p[row]     = get_resource_capacity(cur_resource, bounded_players);
+    A_p.row(row) = A_.row(resource);
+    C_p[row]     = get_resource_capacity(resource, bounded_players);
     row++;
-    if (e.second.size() > 1) {
+    if (players.size() > 1) {
       // if 2 players have chosen the same resource
       // they must have a fair sharing of this resource, adjust A_p and C_p accordingly
-      auto it = e.second.begin();
+      auto it = players.begin();
       int i   = *it; // first player
       /* for each other player sharing this resource */
-      for (++it; it != e.second.end(); ++it) {
+      for (++it; it != players.end(); ++it) {
         /* player i and k on this resource j: so maxA_ji*rho_i - maxA_jk*rho_k = 0 */
         int k       = *it;
         C_p[row]    = 0;
-        A_p(row, i) = maxA_(cur_resource, i);
-        A_p(row, k) = -maxA_(cur_resource, k);
+        A_p(row, i) = maxA_(resource, i);
+        A_p(row, k) = -maxA_(resource, k);
         row++;
       }
     }
@@ -262,32 +241,29 @@ bool BmfSolver::get_alloc(const Eigen::VectorXd& fair_sharing, const allocation_
       if (A_(cnst_idx, player_idx) <= 0.0)
         continue;
 
-      /* Note: the weight_ may artificially increase the rate if < 0
+      /* Note: the max_ may artificially increase the rate if priority < 0
        * The equilibrium sets a rho which respects the C_ though */
-      double rate = fair_sharing[cnst_idx] / (weight_[player_idx] * A_(cnst_idx, player_idx));
-      if (min_rate == -1 || double_positive(min_rate - rate, cfg_bmf_precision)) {
+      if (double rate = fair_sharing[cnst_idx] / maxA_(cnst_idx, player_idx);
+          min_rate == -1 || double_positive(min_rate - rate, cfg_bmf_precision)) {
         selected_resource = cnst_idx;
         min_rate          = rate;
       }
-      double bound = initial ? -1 : phi_[player_idx];
-      /* Given that the weight_ may artificially increase the rate,
+      /* Given that the priority may artificially increase the rate,
        * we need to check that the bound given by user respects the resource capacity C_ */
-      if (bound > 0 && bound * A_(cnst_idx, player_idx) < C_[cnst_idx] &&
-          double_positive(min_rate - bound, cfg_bmf_precision)) {
+      if (double bound = initial ? -1 : phi_[player_idx]; bound > 0 &&
+                                                          bound * A_(cnst_idx, player_idx) < C_[cnst_idx] &&
+                                                          double_positive(min_rate - bound, cfg_bmf_precision)) {
         selected_resource = NO_RESOURCE;
         min_rate          = bound;
       }
     }
     alloc[selected_resource].insert(player_idx);
   }
-  bool is_stable = (alloc == last_alloc);
-  if (is_stable)
+  if (alloc == last_alloc) // considered stable
     return true;
 
-  std::vector<int> alloc_by_player      = alloc_map_to_vector(alloc);
-  auto ret = allocations_.insert(alloc_by_player);
-  /* oops, allocation already tried, let's pertube it a bit */
-  if (not ret.second) {
+  if (auto alloc_by_player = alloc_map_to_vector(alloc); not allocations_.insert(alloc_by_player).second) {
+    /* oops, allocation already tried, let's pertube it a bit */
     XBT_DEBUG("Allocation already tried: %s", debug_alloc(alloc).c_str());
     return disturb_allocation(alloc, alloc_by_player);
   }
@@ -376,7 +352,6 @@ Eigen::VectorXd BmfSolver::solve()
   XBT_DEBUG("maxA:\n%s", debug_eigen(maxA_).c_str());
   XBT_DEBUG("C:\n%s", debug_eigen(C_).c_str());
   XBT_DEBUG("phi:\n%s", debug_eigen(phi_).c_str());
-  XBT_DEBUG("weight:\n%s", debug_eigen(weight_).c_str());
 
   /* no flows to share, just returns */
   if (A_.cols() == 0)
@@ -412,14 +387,13 @@ Eigen::VectorXd BmfSolver::solve()
     fprintf(stderr, "Unable to find a BMF allocation for your system.\n"
                     "You may try to increase the maximum number of iterations performed by BMF solver "
                     "(\"--cfg=bmf/max-iterations\").\n"
-                    "Additionally, you could decrease numerical precision (\"--cfg=bmf/precision\").\n");
+                    "Additionally, you could adjust numerical precision (\"--cfg=bmf/precision\").\n");
     fprintf(stderr, "Internal states (after %d iterations):\n", it);
     fprintf(stderr, "A:\n%s\n", debug_eigen(A_).c_str());
     fprintf(stderr, "maxA:\n%s\n", debug_eigen(maxA_).c_str());
     fprintf(stderr, "C:\n%s\n", debug_eigen(C_).c_str());
     fprintf(stderr, "C_shared:\n%s\n", debug_vector(C_shared_).c_str());
     fprintf(stderr, "phi:\n%s\n", debug_eigen(phi_).c_str());
-    fprintf(stderr, "weight:\n%s\n", debug_eigen(weight_).c_str());
     fprintf(stderr, "rho:\n%s\n", debug_eigen(rho).c_str());
     xbt_abort();
   }
@@ -431,14 +405,13 @@ Eigen::VectorXd BmfSolver::solve()
 /*****************************************************************************/
 
 void BmfSystem::get_flows_data(Eigen::Index number_cnsts, Eigen::MatrixXd& A, Eigen::MatrixXd& maxA,
-                               Eigen::VectorXd& phi, Eigen::VectorXd& weight)
+                               Eigen::VectorXd& phi)
 {
   A.resize(number_cnsts, variable_set.size());
   A.setZero();
   maxA.resize(number_cnsts, variable_set.size());
   maxA.setZero();
   phi.resize(variable_set.size());
-  weight.resize(variable_set.size());
 
   int var_idx = 0;
   for (Variable& var : variable_set) {
@@ -447,10 +420,9 @@ void BmfSystem::get_flows_data(Eigen::Index number_cnsts, Eigen::MatrixXd& A, Ei
     bool active = false;
     bool linked = false; // variable is linked to some constraint (specially for selective_update)
     for (const Element& elem : var.cnsts_) {
-      const boost::intrusive::list_member_hook<>& cnst_hook = selective_update_active
-                                                                  ? elem.constraint->modified_constraint_set_hook_
-                                                                  : elem.constraint->active_constraint_set_hook_;
-      if (not cnst_hook.is_linked())
+      if (const auto& cnst_hook = selective_update_active ? elem.constraint->modified_constraint_set_hook_
+                                                          : elem.constraint->active_constraint_set_hook_;
+          not cnst_hook.is_linked())
         continue;
       /* active and linked variable, lets check its consumption */
       linked             = true;
@@ -459,7 +431,7 @@ void BmfSystem::get_flows_data(Eigen::Index number_cnsts, Eigen::MatrixXd& A, Ei
         int cnst_idx = cnst2idx_[elem.constraint];
         A(cnst_idx, var_idx) += consumption;
         // a variable with double penalty must receive half share, so it max weight is greater
-        maxA(cnst_idx, var_idx) = std::max(maxA(cnst_idx, var_idx), elem.max_consumption_weight);
+        maxA(cnst_idx, var_idx) = std::max(maxA(cnst_idx, var_idx), elem.max_consumption_weight * var.sharing_penalty_);
         active                  = true;
       }
     }
@@ -468,7 +440,6 @@ void BmfSystem::get_flows_data(Eigen::Index number_cnsts, Eigen::MatrixXd& A, Ei
       continue;
     if (active) {
       phi[var_idx]      = var.get_bound();
-      weight[var_idx]   = var.sharing_penalty_;
       idx2Var_[var_idx] = &var;
       var_idx++;
     } else {
@@ -479,7 +450,6 @@ void BmfSystem::get_flows_data(Eigen::Index number_cnsts, Eigen::MatrixXd& A, Ei
   A.conservativeResize(Eigen::NoChange_t::NoChange, var_idx);
   maxA.conservativeResize(Eigen::NoChange_t::NoChange, var_idx);
   phi.conservativeResize(var_idx);
-  weight.conservativeResize(var_idx);
 }
 
 template <class CnstList>
@@ -511,20 +481,17 @@ void BmfSystem::do_solve()
 
 template <class CnstList> void BmfSystem::bmf_solve(const CnstList& cnst_list)
 {
-  /* initialize players' weight and constraint matrices */
   idx2Var_.clear();
   cnst2idx_.clear();
   Eigen::MatrixXd A;
   Eigen::MatrixXd maxA;
   Eigen::VectorXd C;
   Eigen::VectorXd bounds;
-  Eigen::VectorXd weight;
   std::vector<bool> shared;
   get_constraint_data(cnst_list, C, shared);
-  get_flows_data(C.size(), A, maxA, bounds, weight);
+  get_flows_data(C.size(), A, maxA, bounds);
 
-  auto solver =
-      BmfSolver(std::move(A), std::move(maxA), std::move(C), std::move(shared), std::move(bounds), std::move(weight));
+  auto solver = BmfSolver(std::move(A), std::move(maxA), std::move(C), std::move(shared), std::move(bounds));
   auto rho    = solver.solve();
 
   if (rho.size() == 0)
@@ -536,6 +503,4 @@ template <class CnstList> void BmfSystem::bmf_solve(const CnstList& cnst_list)
   }
 }
 
-} // namespace lmm
-} // namespace kernel
-} // namespace simgrid
+} // namespace simgrid::kernel::lmm