src/kernel/lmm/System.cpp

   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 #include "src/kernel/lmm/fair_bottleneck.hpp"
   7 #include "src/kernel/lmm/maxmin.hpp"
   8 #if SIMGRID_HAVE_EIGEN3
   9 #include "src/kernel/lmm/bmf.hpp"
  10 #endif
  11 #include <boost/core/demangle.hpp>
  12 #include <typeinfo>
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_lmm, kernel, "Kernel Linear Max-Min solver");
  15
  16 double sg_maxmin_precision = 1E-5; /* Change this with --cfg=maxmin/precision:VALUE */
  17 double sg_surf_precision   = 1E-9; /* Change this with --cfg=surf/precision:VALUE */
  18 int sg_concurrency_limit   = -1;      /* Change this with --cfg=maxmin/concurrency-limit:VALUE */
  19
  20 namespace simgrid::kernel::lmm {
  21
  22 int Variable::next_rank_   = 1;
  23 int Constraint::next_rank_ = 1;
  24
  25 Element::Element(Constraint* constraint, Variable* variable, double cweight)
  26     : constraint(constraint), variable(variable), consumption_weight(cweight), max_consumption_weight(cweight)
  27 {
  28 }
  29
  30 int Element::get_concurrency() const
  31 {
  32   // just to try having the computation of the concurrency
  33   if(constraint->get_sharing_policy() == Constraint::SharingPolicy::WIFI) {
  34     return 1;
  35   }
  36
  37   // Ignore element with weight less than one (e.g. cross-traffic)
  38   return (consumption_weight >= 1) ? 1 : 0;
  39   // There are other alternatives, but they will change the behavior of the model..
  40   // So do not use it unless you want to make a new model.
  41   // If you do, remember to change the variables concurrency share to reflect it.
  42   // Potential examples are:
  43   // return (elem->weight>0)?1:0;//Include element as soon  as weight is non-zero
  44   // return (int)ceil(elem->weight);//Include element as the rounded-up integer value of the element weight
  45 }
  46
  47 void Element::decrease_concurrency()
  48 {
  49   xbt_assert(constraint->concurrency_current_ >= get_concurrency());
  50   constraint->concurrency_current_ -= get_concurrency();
  51 }
  52
  53 void Element::increase_concurrency(bool check_limit)
  54 {
  55   constraint->concurrency_current_ += get_concurrency();
  56
  57   if (constraint->concurrency_current_ > constraint->concurrency_maximum_)
  58     constraint->concurrency_maximum_ = constraint->concurrency_current_;
  59
  60   xbt_assert(not check_limit || constraint->get_concurrency_limit() < 0 ||
  61                  constraint->concurrency_current_ <= constraint->get_concurrency_limit(),
  62              "Concurrency limit overflow!");
  63 }
  64
  65 System* System::build(const std::string& solver_name, bool selective_update)
  66 {
  67   System* system = nullptr;
  68   if (solver_name == "bmf") {
  69 #if SIMGRID_HAVE_EIGEN3
  70     system = new BmfSystem(selective_update);
  71 #endif
  72   } else if (solver_name == "fairbottleneck") {
  73     system = new FairBottleneck(selective_update);
  74   } else {
  75     system = new MaxMin(selective_update);
  76   }
  77   return system;
  78 }
  79
  80 void System::validate_solver(const std::string& solver_name)
  81 {
  82   static const std::vector<std::string> opts{"bmf", "maxmin", "fairbottleneck"};
  83   if (solver_name == "bmf") {
  84 #if !SIMGRID_HAVE_EIGEN3
  85     xbt_die("Cannot use the BMF solver without installing Eigen3.");
  86 #endif
  87   }
  88   if (std::find(opts.begin(), opts.end(), solver_name) == std::end(opts)) {
  89     xbt_die("Invalid system solver, it should be one of: \"maxmin\", \"fairbottleneck\" or \"bmf\"");
  90   }
  91 }
  92
  93 void System::check_concurrency() const
  94 {
  95   // These checks are very expensive, so do them only if we want to debug SURF LMM
  96   if (not XBT_LOG_ISENABLED(ker_lmm, xbt_log_priority_debug))
  97     return;
  98
  99   for (Constraint const& cnst : constraint_set) {
 100     int concurrency       = 0;
 101     for (Element const& elem : cnst.enabled_element_set_) {
 102       xbt_assert(elem.variable->sharing_penalty_ > 0);
 103       concurrency += elem.get_concurrency();
 104     }
 105
 106     for (Element const& elem : cnst.disabled_element_set_) {
 107       // We should have staged variables only if concurrency is reached in some constraint
 108       xbt_assert(cnst.get_concurrency_limit() < 0 || elem.variable->staged_sharing_penalty_ == 0 ||
 109                      elem.variable->get_min_concurrency_slack() == 0,
 110                  "should not have staged variable!");
 111     }
 112
 113     xbt_assert(cnst.get_concurrency_limit() < 0 || cnst.get_concurrency_limit() >= concurrency,
 114                "concurrency check failed!");
 115     xbt_assert(cnst.concurrency_current_ == concurrency, "concurrency_current is out-of-date!");
 116   }
 117
 118   // Check that for each variable, all corresponding elements are in the same state (i.e. same element sets)
 119   for (Variable const& var : variable_set) {
 120     if (var.cnsts_.empty())
 121       continue;
 122
 123     const Element& elem    = var.cnsts_[0];
 124     bool belong_to_enabled  = elem.enabled_element_set_hook.is_linked();
 125     bool belong_to_disabled = elem.disabled_element_set_hook.is_linked();
 126     bool belong_to_active   = elem.active_element_set_hook.is_linked();
 127
 128     for (Element const& elem2 : var.cnsts_) {
 129       xbt_assert(belong_to_enabled == elem2.enabled_element_set_hook.is_linked(),
 130                  "Variable inconsistency (1): enabled_element_set");
 131       xbt_assert(belong_to_disabled == elem2.disabled_element_set_hook.is_linked(),
 132                  "Variable inconsistency (2): disabled_element_set");
 133       xbt_assert(belong_to_active == elem2.active_element_set_hook.is_linked(),
 134                  "Variable inconsistency (3): active_element_set");
 135     }
 136   }
 137 }
 138
 139 void System::var_free(Variable* var)
 140 {
 141   XBT_IN("(sys=%p, var=%p)", this, var);
 142   modified_ = true;
 143
 144   // TODOLATER Can do better than that by leaving only the variable in only one enabled_element_set, call
 145   // update_modified_set, and then remove it..
 146   update_modified_cnst_set_from_variable(var);
 147
 148   for (Element& elem : var->cnsts_) {
 149     if (var->sharing_penalty_ > 0)
 150       elem.decrease_concurrency();
 151     if (elem.enabled_element_set_hook.is_linked())
 152       simgrid::xbt::intrusive_erase(elem.constraint->enabled_element_set_, elem);
 153     if (elem.disabled_element_set_hook.is_linked())
 154       simgrid::xbt::intrusive_erase(elem.constraint->disabled_element_set_, elem);
 155     if (elem.active_element_set_hook.is_linked())
 156       simgrid::xbt::intrusive_erase(elem.constraint->active_element_set_, elem);
 157     if (elem.constraint->enabled_element_set_.empty() && elem.constraint->disabled_element_set_.empty())
 158       make_constraint_inactive(elem.constraint);
 159     else
 160       on_disabled_var(elem.constraint);
 161   }
 162
 163   var->cnsts_.clear();
 164
 165   check_concurrency();
 166
 167   xbt_mallocator_release(variable_mallocator_, var);
 168   XBT_OUT();
 169 }
 170
 171 System::System(bool selective_update) : selective_update_active(selective_update)
 172 {
 173   XBT_DEBUG("Setting selective_update_active flag to %d", selective_update_active);
 174
 175   if (selective_update)
 176     modified_set_ = std::make_unique<kernel::resource::Action::ModifiedSet>();
 177 }
 178
 179 System::~System()
 180 {
 181   while (Variable* var = extract_variable()) {
 182     const char* name = var->id_ ? typeid(*var->id_).name() : "(unidentified)";
 183     boost::core::scoped_demangled_name demangled(name);
 184     XBT_WARN("Probable bug: a %s variable (#%d) not removed before the LMM system destruction.",
 185              demangled.get() ? demangled.get() : name, var->rank_);
 186     var_free(var);
 187   }
 188   while (Constraint* cnst = extract_constraint())
 189     cnst_free(cnst);
 190
 191   xbt_mallocator_free(variable_mallocator_);
 192 }
 193
 194 void System::cnst_free(Constraint* cnst)
 195 {
 196   make_constraint_inactive(cnst);
 197   delete cnst;
 198 }
 199
 200 Constraint::Constraint(resource::Resource* id_value, double bound_value) : bound_(bound_value), id_(id_value)
 201 {
 202   rank_ = next_rank_++;
 203 }
 204
 205 Constraint* System::constraint_new(resource::Resource* id, double bound_value)
 206 {
 207   auto* cnst = new Constraint(id, bound_value);
 208   insert_constraint(cnst);
 209   return cnst;
 210 }
 211
 212 void* System::variable_mallocator_new_f()
 213 {
 214   return new Variable;
 215 }
 216
 217 void System::variable_mallocator_free_f(void* var)
 218 {
 219   delete static_cast<Variable*>(var);
 220 }
 221
 222 Variable* System::variable_new(resource::Action* id, double sharing_penalty, double bound, size_t number_of_constraints)
 223 {
 224   XBT_IN("(sys=%p, id=%p, penalty=%f, bound=%f, num_cons =%zu)", this, id, sharing_penalty, bound,
 225          number_of_constraints);
 226
 227   auto* var = static_cast<Variable*>(xbt_mallocator_get(variable_mallocator_));
 228   var->initialize(id, sharing_penalty, bound, number_of_constraints, visited_counter_ - 1);
 229   if (sharing_penalty > 0)
 230     variable_set.push_front(*var);
 231   else
 232     variable_set.push_back(*var);
 233
 234   XBT_OUT(" returns %p", var);
 235   return var;
 236 }
 237
 238 void System::variable_free(Variable* var)
 239 {
 240   remove_variable(var);
 241   var_free(var);
 242 }
 243
 244 void System::variable_free_all()
 245 {
 246   while (Variable* var = extract_variable())
 247     variable_free(var);
 248 }
 249
 250 Element& System::expand_create_elem(Constraint* cnst, Variable* var, double consumption_weight)
 251 {
 252   xbt_assert(var->cnsts_.size() < var->cnsts_.capacity(), "Too much constraints");
 253
 254   var->cnsts_.emplace_back(cnst, var, consumption_weight);
 255   Element& elem = var->cnsts_.back();
 256
 257   if (var->sharing_penalty_ != 0.0) {
 258     elem.constraint->enabled_element_set_.push_front(elem);
 259   } else
 260     elem.constraint->disabled_element_set_.push_back(elem);
 261
 262   if (elem.consumption_weight > 0 || var->sharing_penalty_ > 0) {
 263     make_constraint_active(cnst);
 264   }
 265   return elem;
 266 }
 267
 268 Element& System::expand_add_to_elem(Element& elem, const Constraint* cnst, double consumption_weight) const
 269 {
 270   elem.max_consumption_weight = std::max(elem.max_consumption_weight, consumption_weight);
 271   if (cnst->sharing_policy_ != Constraint::SharingPolicy::FATPIPE)
 272     elem.consumption_weight += consumption_weight;
 273   else
 274     elem.consumption_weight = std::max(elem.consumption_weight, consumption_weight);
 275   return elem;
 276 }
 277
 278 void System::expand(Constraint* cnst, Variable* var, double consumption_weight)
 279 {
 280   modified_ = true;
 281
 282   auto elem_it =
 283       std::find_if(begin(var->cnsts_), end(var->cnsts_), [&cnst](Element const& x) { return x.constraint == cnst; });
 284   if (elem_it != end(var->cnsts_) && var->sharing_penalty_ != 0.0) {
 285     /* before changing it, decreases concurrency on constraint, it'll be added back later */
 286     elem_it->decrease_concurrency();
 287   }
 288   Element& elem = elem_it != end(var->cnsts_) ? expand_add_to_elem(*elem_it, cnst, consumption_weight)
 289                                               : expand_create_elem(cnst, var, consumption_weight);
 290
 291   // Check if we need to disable the variable
 292   if (var->sharing_penalty_ != 0) {
 293     /* increase concurrency in constraint that this element uses.
 294      * as we don't check if constraint has reached its limit before increasing,
 295      * we can't check the correct state at increase_concurrency, anyway
 296      * it'll check if the slack is smaller than 0 just below */
 297     elem.increase_concurrency(false);
 298     if (cnst->get_concurrency_slack() < 0) {
 299       double penalty = var->sharing_penalty_;
 300       disable_var(var);
 301       for (Element const& elem2 : var->cnsts_)
 302         on_disabled_var(elem2.constraint);
 303       var->staged_sharing_penalty_ = penalty;
 304       xbt_assert(not var->sharing_penalty_);
 305     }
 306   }
 307
 308   /* update modified constraint set accordingly */
 309   if (elem.consumption_weight > 0 || var->sharing_penalty_ > 0)
 310     update_modified_cnst_set(cnst);
 311
 312   check_concurrency();
 313 }
 314
 315 Variable* Constraint::get_variable(const Element** elem) const
 316 {
 317   if (*elem == nullptr) {
 318     // That is the first call, pick the first element among enabled_element_set (or disabled_element_set if
 319     // enabled_element_set is empty)
 320     if (not enabled_element_set_.empty())
 321       *elem = &enabled_element_set_.front();
 322     else if (not disabled_element_set_.empty())
 323       *elem = &disabled_element_set_.front();
 324   } else {
 325     // elem is not null, so we carry on
 326     if ((*elem)->enabled_element_set_hook.is_linked()) {
 327       // Look at enabled_element_set, and jump to disabled_element_set when finished
 328       auto iter = std::next(enabled_element_set_.iterator_to(**elem));
 329       if (iter != std::end(enabled_element_set_))
 330         *elem = &*iter;
 331       else if (not disabled_element_set_.empty())
 332         *elem = &disabled_element_set_.front();
 333       else
 334         *elem = nullptr;
 335     } else {
 336       auto iter = std::next(disabled_element_set_.iterator_to(**elem));
 337       *elem     = iter != std::end(disabled_element_set_) ? &*iter : nullptr;
 338     }
 339   }
 340   if (*elem)
 341     return (*elem)->variable;
 342   else
 343     return nullptr;
 344 }
 345
 346 // if we modify the list between calls, normal version may loop forever
 347 // this safe version ensures that we browse the list elements only once
 348 Variable* Constraint::get_variable_safe(const Element** elem, const Element** nextelem, size_t* numelem) const
 349 {
 350   if (*elem == nullptr) {
 351     *numelem = enabled_element_set_.size() + disabled_element_set_.size() - 1;
 352     if (not enabled_element_set_.empty())
 353       *elem = &enabled_element_set_.front();
 354     else if (not disabled_element_set_.empty())
 355       *elem = &disabled_element_set_.front();
 356   } else {
 357     *elem = *nextelem;
 358     if (*numelem > 0) {
 359       (*numelem)--;
 360     } else
 361       return nullptr;
 362   }
 363   if (*elem) {
 364     // elem is not null, so we carry on
 365     if ((*elem)->enabled_element_set_hook.is_linked()) {
 366       // Look at enabled_element_set, and jump to disabled_element_set when finished
 367       auto iter = std::next(enabled_element_set_.iterator_to(**elem));
 368       if (iter != std::end(enabled_element_set_))
 369         *nextelem = &*iter;
 370       else if (not disabled_element_set_.empty())
 371         *nextelem = &disabled_element_set_.front();
 372       else
 373         *nextelem = nullptr;
 374     } else {
 375       auto iter = std::next(disabled_element_set_.iterator_to(**elem));
 376       *nextelem = iter != std::end(disabled_element_set_) ? &*iter : nullptr;
 377     }
 378     return (*elem)->variable;
 379   } else
 380     return nullptr;
 381 }
 382
 383 template <class ElemList>
 384 static void format_element_list(const ElemList& elem_list, Constraint::SharingPolicy sharing_policy, double& sum,
 385                                 std::string& buf)
 386 {
 387   for (Element const& elem : elem_list) {
 388     buf += std::to_string(elem.consumption_weight) + ".'" + std::to_string(elem.variable->rank_) + "'(" +
 389            std::to_string(elem.variable->value_) + ")" +
 390            (sharing_policy != Constraint::SharingPolicy::FATPIPE ? " + " : " , ");
 391     if (sharing_policy != Constraint::SharingPolicy::FATPIPE)
 392       sum += elem.consumption_weight * elem.variable->value_;
 393     else
 394       sum = std::max(sum, elem.consumption_weight * elem.variable->value_);
 395   }
 396 }
 397
 398 void System::print() const
 399 {
 400   std::string buf = "MAX-MIN ( ";
 401
 402   /* Printing Objective */
 403   for (Variable const& var : variable_set)
 404     buf += "'" + std::to_string(var.rank_) + "'(" + std::to_string(var.sharing_penalty_) + ") ";
 405   buf += ")";
 406   XBT_DEBUG("%20s", buf.c_str());
 407   buf.clear();
 408
 409   XBT_DEBUG("Constraints");
 410   /* Printing Constraints */
 411   for (Constraint const& cnst : active_constraint_set) {
 412     double sum            = 0.0;
 413     // Show  the enabled variables
 414     buf += "\t";
 415     buf += cnst.sharing_policy_ != Constraint::SharingPolicy::FATPIPE ? "(" : "max(";
 416     format_element_list(cnst.enabled_element_set_, cnst.sharing_policy_, sum, buf);
 417     // TODO: Adding disabled elements only for test compatibility, but do we really want them to be printed?
 418     format_element_list(cnst.disabled_element_set_, cnst.sharing_policy_, sum, buf);
 419
 420     buf += "0) <= " + std::to_string(cnst.bound_) + " ('" + std::to_string(cnst.rank_) + "')";
 421
 422     if (cnst.sharing_policy_ == Constraint::SharingPolicy::FATPIPE) {
 423       buf += " [MAX-Constraint]";
 424     }
 425     XBT_DEBUG("%s", buf.c_str());
 426     buf.clear();
 427     xbt_assert(not double_positive(sum - cnst.bound_, cnst.bound_ * sg_maxmin_precision),
 428                "Incorrect value (%f is not smaller than %f): %g", sum, cnst.bound_, sum - cnst.bound_);
 429   }
 430
 431   XBT_DEBUG("Variables");
 432   /* Printing Result */
 433   for (Variable const& var : variable_set) {
 434     if (var.bound_ > 0) {
 435       XBT_DEBUG("'%d'(%f) : %f (<=%f)", var.rank_, var.sharing_penalty_, var.value_, var.bound_);
 436       xbt_assert(not double_positive(var.value_ - var.bound_, var.bound_ * sg_maxmin_precision),
 437                  "Incorrect value (%f is not smaller than %f", var.value_, var.bound_);
 438     } else {
 439       XBT_DEBUG("'%d'(%f) : %f", var.rank_, var.sharing_penalty_, var.value_);
 440     }
 441   }
 442 }
 443
 444 resource::Action::ModifiedSet* System::get_modified_action_set() const
 445 {
 446   return modified_set_.get();
 447 }
 448
 449 void System::solve()
 450 {
 451   if (not modified_)
 452     return;
 453
 454   do_solve();
 455
 456   modified_ = false;
 457   if (selective_update_active) {
 458     /* update list of modified variables */
 459     for (const Constraint& cnst : modified_constraint_set) {
 460       for (const Element& elem : cnst.enabled_element_set_) {
 461         if (elem.consumption_weight > 0) {
 462           resource::Action* action = elem.variable->id_;
 463           if (not action->is_within_modified_set())
 464             modified_set_->push_back(*action);
 465         }
 466       }
 467     }
 468     /* clear list of modified constraint */
 469     remove_all_modified_cnst_set();
 470   }
 471
 472   if (XBT_LOG_ISENABLED(ker_lmm, xbt_log_priority_debug)) {
 473     print();
 474   }
 475
 476   check_concurrency();
 477 }
 478
 479 /** @brief Attribute the value bound to var->bound.
 480  *
 481  *  @param var the Variable*
 482  *  @param bound the new bound to associate with var
 483  *
 484  *  Makes var->bound equal to bound. Whenever this function is called a change is  signed in the system. To
 485  *  avoid false system changing detection it is a good idea to test (bound != 0) before calling it.
 486  */
 487 void System::update_variable_bound(Variable* var, double bound)
 488 {
 489   modified_  = true;
 490   var->bound_ = bound;
 491
 492   if (not var->cnsts_.empty()) {
 493     for (Element const& elem : var->cnsts_) {
 494       update_modified_cnst_set(elem.constraint);
 495     }
 496   }
 497 }
 498
 499 void Variable::initialize(resource::Action* id_value, double sharing_penalty, double bound_value,
 500                           size_t number_of_constraints, unsigned visited_value)
 501 {
 502   id_     = id_value;
 503   rank_   = next_rank_++;
 504   cnsts_.reserve(number_of_constraints);
 505   sharing_penalty_   = sharing_penalty;
 506   staged_sharing_penalty_ = 0.0;
 507   bound_             = bound_value;
 508   value_             = 0.0;
 509   visited_           = visited_value;
 510   mu_                = 0.0;
 511
 512   xbt_assert(not variable_set_hook_.is_linked());
 513   xbt_assert(not saturated_variable_set_hook_.is_linked());
 514 }
 515
 516 int Variable::get_min_concurrency_slack() const
 517 {
 518   int minslack = std::numeric_limits<int>::max();
 519   for (Element const& elem : cnsts_) {
 520     int slack = elem.constraint->get_concurrency_slack();
 521     if (slack < minslack) {
 522       // This is only an optimization, to avoid looking at more constraints when slack is already zero
 523       if (slack == 0)
 524         return 0;
 525       minslack = slack;
 526     }
 527   }
 528   return minslack;
 529 }
 530
 531 // Small remark: In this implementation of System::enable_var() and System::disable_var(), we will meet multiple times
 532 // with var when running System::update_modified_cnst_set().
 533 // A priori not a big performance issue, but we might do better by calling System::update_modified_cnst_set() within the
 534 // for loops (after doing the first for enabling==1, and before doing the last for disabling==1)
 535 void System::enable_var(Variable* var)
 536 {
 537   xbt_assert(not XBT_LOG_ISENABLED(ker_lmm, xbt_log_priority_debug) || var->can_enable());
 538
 539   var->sharing_penalty_        = var->staged_sharing_penalty_;
 540   var->staged_sharing_penalty_ = 0;
 541
 542   // Enabling the variable, move var to list head. Subtlety is: here, we need to call update_modified_cnst_set AFTER
 543   // moving at least one element of var.
 544
 545   simgrid::xbt::intrusive_erase(variable_set, *var);
 546   variable_set.push_front(*var);
 547   for (Element& elem : var->cnsts_) {
 548     simgrid::xbt::intrusive_erase(elem.constraint->disabled_element_set_, elem);
 549     elem.constraint->enabled_element_set_.push_front(elem);
 550     elem.increase_concurrency();
 551   }
 552   update_modified_cnst_set_from_variable(var);
 553
 554   // When used within on_disabled_var, we would get an assertion fail, because transiently there can be variables
 555   // that are staged and could be activated.
 556   // Anyway, caller functions all call check_concurrency() in the end.
 557 }
 558
 559 void System::disable_var(Variable* var)
 560 {
 561   xbt_assert(not var->staged_sharing_penalty_, "Staged penalty should have been cleared");
 562   // Disabling the variable, move to var to list tail. Subtlety is: here, we need to call update_modified_cnst_set
 563   // BEFORE moving the last element of var.
 564   simgrid::xbt::intrusive_erase(variable_set, *var);
 565   variable_set.push_back(*var);
 566   update_modified_cnst_set_from_variable(var);
 567   for (Element& elem : var->cnsts_) {
 568     simgrid::xbt::intrusive_erase(elem.constraint->enabled_element_set_, elem);
 569     elem.constraint->disabled_element_set_.push_back(elem);
 570     if (elem.active_element_set_hook.is_linked())
 571       simgrid::xbt::intrusive_erase(elem.constraint->active_element_set_, elem);
 572     elem.decrease_concurrency();
 573   }
 574
 575   var->sharing_penalty_ = 0.0;
 576   var->staged_sharing_penalty_ = 0.0;
 577   var->value_          = 0.0;
 578   check_concurrency();
 579 }
 580
 581 /* /brief Find variables that can be enabled and enable them.
 582  *
 583  * Assuming that the variable has already been removed from non-zero penalties
 584  * Can we find a staged variable to add?
 585  * If yes, check that none of the constraints that this variable is involved in is at the limit of its concurrency
 586  * And then add it to enabled variables
 587  */
 588 void System::on_disabled_var(Constraint* cnstr)
 589 {
 590   if (cnstr->get_concurrency_limit() < 0)
 591     return;
 592
 593   size_t numelem = cnstr->disabled_element_set_.size();
 594   if (numelem == 0)
 595     return;
 596
 597   Element* elem = &cnstr->disabled_element_set_.front();
 598
 599   // Cannot use foreach loop, because System::enable_var() will modify disabled_element_set.. within the loop
 600   while (numelem-- && elem) {
 601     Element* nextelem;
 602     if (elem->disabled_element_set_hook.is_linked()) {
 603       auto iter = std::next(cnstr->disabled_element_set_.iterator_to(*elem));
 604       nextelem  = iter != std::end(cnstr->disabled_element_set_) ? &*iter : nullptr;
 605     } else {
 606       nextelem = nullptr;
 607     }
 608
 609     if (elem->variable->staged_sharing_penalty_ > 0 && elem->variable->can_enable()) {
 610       // Found a staged variable
 611       // TODOLATER: Add random timing function to model reservation protocol fuzziness? Then how to make sure that
 612       // staged variables will eventually be called?
 613       enable_var(elem->variable);
 614     }
 615
 616     xbt_assert(cnstr->concurrency_current_ <= cnstr->get_concurrency_limit(), "Concurrency overflow!");
 617     if (cnstr->concurrency_current_ == cnstr->get_concurrency_limit())
 618       break;
 619
 620     elem = nextelem;
 621   }
 622
 623   // We could get an assertion fail, because transiently there can be variables that are staged and could be activated.
 624   // And we need to go through all constraints of the disabled var before getting back a coherent state.
 625   // Anyway, caller functions all call check_concurrency() in the end.
 626 }
 627
 628 /** @brief update the penalty of a variable (disable it by passing 0 as a penalty) */
 629 void System::update_variable_penalty(Variable* var, double penalty)
 630 {
 631   xbt_assert(penalty >= 0, "Variable penalty should not be negative!");
 632   if (penalty == var->sharing_penalty_)
 633     return;
 634
 635   bool enabling_var  = (penalty > 0 && var->sharing_penalty_ <= 0);
 636   bool disabling_var = (penalty <= 0 && var->sharing_penalty_ > 0);
 637
 638   XBT_IN("(sys=%p, var=%p, var->sharing_penalty = %f, penalty=%f)", this, var, var->sharing_penalty_, penalty);
 639
 640   modified_ = true;
 641
 642   // Are we enabling this variable?
 643   if (enabling_var) {
 644     var->staged_sharing_penalty_ = penalty;
 645     int minslack       = var->get_min_concurrency_slack();
 646     if (minslack == 0) {
 647       XBT_DEBUG("Staging var (instead of enabling) because min concurrency slack is 0");
 648       return;
 649     }
 650     XBT_DEBUG("Enabling var with min concurrency slack %i", minslack);
 651     enable_var(var);
 652   } else if (disabling_var) {
 653     disable_var(var);
 654   } else {
 655     var->sharing_penalty_ = penalty;
 656     update_modified_cnst_set_from_variable(var);
 657   }
 658
 659   check_concurrency();
 660
 661   XBT_OUT();
 662 }
 663
 664 void System::update_constraint_bound(Constraint* cnst, double bound)
 665 {
 666   modified_ = true;
 667   update_modified_cnst_set(cnst);
 668   cnst->bound_ = bound;
 669 }
 670
 671 /** @brief Update the constraint set propagating recursively to other constraints so the system should not be entirely
 672  *  computed.
 673  *
 674  *  @param cnst the Constraint* affected by the change
 675  *
 676  *  A recursive algorithm to optimize the system recalculation selecting only constraints that have changed. Each
 677  *  constraint change is propagated to the list of constraints for each variable.
 678  */
 679 void System::update_modified_cnst_set_rec(const Constraint* cnst)
 680 {
 681   for (Element const& elem : cnst->enabled_element_set_) {
 682     Variable* var = elem.variable;
 683     for (Element const& elem2 : var->cnsts_) {
 684       if (var->visited_ == visited_counter_)
 685         break;
 686       if (elem2.constraint != cnst && not elem2.constraint->modified_constraint_set_hook_.is_linked()) {
 687         modified_constraint_set.push_back(*elem2.constraint);
 688         update_modified_cnst_set_rec(elem2.constraint);
 689       }
 690     }
 691     // var will be ignored in later visits as long as sys->visited_counter does not move
 692     var->visited_ = visited_counter_;
 693   }
 694 }
 695
 696 void System::update_modified_cnst_set_from_variable(const Variable* var)
 697 {
 698   /* nothing to update in these cases:
 699    * - selective update not active, all variables are active
 700    * - variable doesn't use any constraint
 701    * - variable is disabled (sharing penalty <= 0): we iterate only through the enabled_variables in
 702    * update_modified_cnst_set_rec */
 703   if (not selective_update_active || var->cnsts_.empty() || var->sharing_penalty_ <= 0)
 704     return;
 705
 706   /* Normally, if the conditions above are true, specially variable is enabled, we can call
 707    * modified_set over the first contraint only, since the recursion in update_modified_cnst_set_rec
 708    * will iterate over the other constraints of this variable */
 709   update_modified_cnst_set(var->cnsts_[0].constraint);
 710 }
 711
 712 void System::update_modified_cnst_set(Constraint* cnst)
 713 {
 714   /* nothing to do if selective update isn't active */
 715   if (selective_update_active && not cnst->modified_constraint_set_hook_.is_linked()) {
 716     modified_constraint_set.push_back(*cnst);
 717     update_modified_cnst_set_rec(cnst);
 718   }
 719 }
 720
 721 void System::remove_all_modified_cnst_set()
 722 {
 723   // We cleverly un-flag all variables just by incrementing visited_counter
 724   // In effect, the var->visited value will no more be equal to visited counter
 725   // To be clean, when visited counter has wrapped around, we force these var->visited values so that variables that
 726   // were in the modified a long long time ago are not wrongly skipped here, which would lead to very nasty bugs
 727   // (i.e. not readily reproducible, and requiring a lot of run time before happening).
 728   if (++visited_counter_ == 1) {
 729     /* the counter wrapped around, reset each variable->visited */
 730     for (Variable& var : variable_set)
 731       var.visited_ = 0;
 732   }
 733   modified_constraint_set.clear();
 734 }
 735
 736 /**
 737  * Returns resource load (in flop per second, or byte per second, or similar)
 738  *
 739  * If the resource is shared (the default case), the load is sum of resource usage made by
 740  * every variables located on this resource.
 741  *
 742  * If the resource is not shared (ie in FATPIPE mode), then the load is the max (not the sum)
 743  * of all resource usages located on this resource.
 744  */
 745 double Constraint::get_usage() const
 746 {
 747   double result              = 0.0;
 748   if (sharing_policy_ != SharingPolicy::FATPIPE) {
 749     for (Element const& elem : enabled_element_set_)
 750       if (elem.consumption_weight > 0)
 751         result += elem.consumption_weight * elem.variable->value_;
 752   } else {
 753     for (Element const& elem : enabled_element_set_)
 754       if (elem.consumption_weight > 0)
 755         result = std::max(result, elem.consumption_weight * elem.variable->value_);
 756   }
 757   return result;
 758 }
 759
 760 void Constraint::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
 761 {
 762   xbt_assert(policy == SharingPolicy::NONLINEAR || policy == SharingPolicy::WIFI || not cb,
 763              "Invalid sharing policy for constraint. Callback should be used with NONLINEAR sharing policy");
 764   sharing_policy_    = policy;
 765   dyn_constraint_cb_ = cb;
 766 }
 767
 768 } // namespace simgrid::kernel::lmm