Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
lmm: rename some fields for clarity
[simgrid.git] / src / kernel / lmm / maxmin.hpp
index c67f8c4..fa5332d 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -7,13 +7,9 @@
 #define SURF_MAXMIN_HPP
 
 #include "simgrid/kernel/resource/Action.hpp"
-#include "src/internal_config.h"
-#include "src/surf/surf_interface.hpp"
-#include "surf/surf.hpp"
+#include "simgrid/s4u/Link.hpp"
 #include "xbt/asserts.h"
 #include "xbt/mallocator.h"
-#include "xbt/misc.h"
-#include "xbt/utility.hpp"
 
 #include <boost/intrusive/list.hpp>
 #include <cmath>
@@ -135,20 +131,6 @@ namespace lmm {
 
 /** @{ @ingroup SURF_lmm */
 
-/** Default functions associated to the chosen protocol. When using the lagrangian approach. */
-
-XBT_PUBLIC double func_reno_f(const Variable& var, double x);
-XBT_PUBLIC double func_reno_fp(const Variable& var, double x);
-XBT_PUBLIC double func_reno_fpi(const Variable& var, double x);
-
-XBT_PUBLIC double func_reno2_f(const Variable& var, double x);
-XBT_PUBLIC double func_reno2_fp(const Variable& var, double x);
-XBT_PUBLIC double func_reno2_fpi(const Variable& var, double x);
-
-XBT_PUBLIC double func_vegas_f(const Variable& var, double x);
-XBT_PUBLIC double func_vegas_fp(const Variable& var, double x);
-XBT_PUBLIC double func_vegas_fpi(const Variable& var, double x);
-
 /**
  * @brief LMM element
  * Elements can be seen as glue between constraint objects and variable objects.
@@ -179,7 +161,8 @@ public:
   double consumption_weight;
 };
 
-struct ConstraintLight {
+class ConstraintLight {
+public:
   double remaining_over_usage;
   Constraint* cnst;
 };
@@ -199,13 +182,13 @@ public:
   Constraint(void* id_value, double bound_value);
 
   /** @brief Unshare a constraint. */
-  void unshare() { sharing_policy = 0; }
+  void unshare() { sharing_policy_ = s4u::Link::SharingPolicy::FATPIPE; }
 
   /**
    * @brief Check if a constraint is shared (shared by default)
    * @return 1 if shared, 0 otherwise
    */
-  int get_sharing_policy() const { return sharing_policy; }
+  s4u::Link::SharingPolicy get_sharing_policy() const { return sharing_policy_; }
 
   /**
    * @brief Get the usage of the constraint after the last lmm solve
@@ -220,23 +203,23 @@ public:
    */
   void set_concurrency_limit(int limit)
   {
-    xbt_assert(limit < 0 || concurrency_maximum <= limit,
+    xbt_assert(limit < 0 || concurrency_maximum_ <= limit,
                "New concurrency limit should be larger than observed concurrency maximum. Maybe you want to call"
                " concurrency_maximum_reset() to reset the maximum?");
-    concurrency_limit = limit;
+    concurrency_limit_ = limit;
   }
 
   /**
    * @brief Gets the concurrency limit for this constraint
    * @return The concurrency limit used by this constraint
    */
-  int get_concurrency_limit() const { return concurrency_limit; }
+  int get_concurrency_limit() const { return concurrency_limit_; }
 
   /**
    * @brief Reset the concurrency maximum for a given variable (we will update the maximum to reflect constraint
    * evolution).
    */
-  void reset_concurrency_maximum() { concurrency_maximum = 0; }
+  void reset_concurrency_maximum() { concurrency_maximum_ = 0; }
 
   /**
    * @brief Get the concurrency maximum for a given variable (which reflects constraint evolution).
@@ -244,14 +227,14 @@ public:
    */
   int get_concurrency_maximum() const
   {
-    xbt_assert(concurrency_limit < 0 || concurrency_maximum <= concurrency_limit,
+    xbt_assert(concurrency_limit_ < 0 || concurrency_maximum_ <= concurrency_limit_,
                "Very bad: maximum observed concurrency is higher than limit. This is a bug of SURF, please report it.");
-    return concurrency_maximum;
+    return concurrency_maximum_;
   }
 
   int get_concurrency_slack() const
   {
-    return concurrency_limit < 0 ? std::numeric_limits<int>::max() : concurrency_limit - concurrency_current;
+    return concurrency_limit_ < 0 ? std::numeric_limits<int>::max() : concurrency_limit_ - concurrency_current_;
   }
 
   /**
@@ -260,7 +243,7 @@ public:
    * @param elem A element of constraint of the constraint or NULL
    * @return A variable associated to a constraint
    */
-  Variable* get_variable(const_lmm_element_t * elem) const;
+  Variable* get_variable(const Element** elem) const;
 
   /**
    * @brief Get a var associated to a constraint
@@ -270,47 +253,47 @@ public:
    * @param numelem parameter representing the number of elements to go
    * @return A variable associated to a constraint
    */
-  Variable* get_variable_safe(const_lmm_element_t * elem, const_lmm_element_t * nextelem, int* numelem) const;
+  Variable* get_variable_safe(const Element** elem, const Element** nextelem, int* numelem) const;
 
   /**
    * @brief Get the data associated to a constraint
    * @return The data associated to the constraint
    */
-  void* get_id() const { return id; }
+  void* get_id() const { return id_; }
 
   /* hookup to system */
-  boost::intrusive::list_member_hook<> constraint_set_hook;
-  boost::intrusive::list_member_hook<> active_constraint_set_hook;
-  boost::intrusive::list_member_hook<> modified_constraint_set_hook;
-  boost::intrusive::list_member_hook<> saturated_constraint_set_hook;
+  boost::intrusive::list_member_hook<> constraint_set_hook_;
+  boost::intrusive::list_member_hook<> active_constraint_set_hook_;
+  boost::intrusive::list_member_hook<> modified_constraint_set_hook_;
+  boost::intrusive::list_member_hook<> saturated_constraint_set_hook_;
   boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
                                                                 &Element::enabled_element_set_hook>>
-      enabled_element_set;
+      enabled_element_set_;
   boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
                                                                 &Element::disabled_element_set_hook>>
-      disabled_element_set;
+      disabled_element_set_;
   boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
                                                                 &Element::active_element_set_hook>>
-      active_element_set;
-  double remaining;
-  double usage;
-  double bound;
+      active_element_set_;
+  double remaining_;
+  double usage_;
+  double bound_;
   // TODO MARTIN Check maximum value across resources at the end of simulation and give a warning is more than e.g. 500
-  int concurrency_current; /* The current concurrency */
-  int concurrency_maximum; /* The maximum number of (enabled and disabled) variables associated to the constraint at any
-                            * given time (essentially for tracing)*/
+  int concurrency_current_; /* The current concurrency */
+  int concurrency_maximum_; /* The maximum number of (enabled and disabled) variables associated to the constraint at
+                             * any given time (essentially for tracing)*/
 
-  int sharing_policy; /* see @e_surf_link_sharing_policy_t (0: FATPIPE, 1: SHARED, 2: SPLITDUPLEX) */
-  int id_int;
-  double lambda;
-  double new_lambda;
-  lmm_constraint_light_t cnst_light;
+  s4u::Link::SharingPolicy sharing_policy_;
+  int rank_; // Only used in debug messages to identify the constraint
+  double lambda_;
+  double new_lambda_;
+  ConstraintLight* cnst_light_;
 
 private:
-  static int Global_debug_id;
-  int concurrency_limit; /* The maximum number of variables that may be enabled at any time (stage variables if
-                          * necessary) */
-  void* id;
+  static int next_rank_;  // To give a separate rank_ to each contraint
+  int concurrency_limit_; /* The maximum number of variables that may be enabled at any time (stage variables if
+                           * necessary) */
+  void* id_;
 };
 
 /**
@@ -321,58 +304,61 @@ private:
  */
 class XBT_PUBLIC Variable {
 public:
-  void initialize(simgrid::kernel::resource::Action * id_value, double sharing_weight_value, double bound_value,
+  void initialize(resource::Action* id_value, double sharing_weight_value, double bound_value,
                   int number_of_constraints, unsigned visited_value);
 
   /**
    * @brief Get the value of the variable after the last lmm solve
    * @return The value of the variable
    */
-  double get_value() const { return value; }
+  double get_value() const { return value_; }
 
   /**
    * @brief Get the maximum value of the variable (-1.0 if no maximum value)
    * @return The bound of the variable
    */
-  double get_bound() const { return bound; }
+  double get_bound() const { return bound_; }
 
   /**
    * @brief Set the concurrent share of the variable
    * @param value The new concurrency share
    */
-  void set_concurrency_share(short int value) { concurrency_share = value; }
+  void set_concurrency_share(short int value) { concurrency_share_ = value; }
 
   /**
    * @brief Get the numth constraint associated to the variable
    * @param num The rank of constraint we want to get
    * @return The numth constraint
    */
-  Constraint* get_constraint(unsigned num) const { return num < cnsts.size() ? cnsts[num].constraint : nullptr; }
+  Constraint* get_constraint(unsigned num) const { return num < cnsts_.size() ? cnsts_[num].constraint : nullptr; }
 
   /**
    * @brief Get the weigth of the numth constraint associated to the variable
    * @param num The rank of constraint we want to get
    * @return The numth constraint
    */
-  double get_constraint_weight(unsigned num) const { return num < cnsts.size() ? cnsts[num].consumption_weight : 0.0; }
+  double get_constraint_weight(unsigned num) const
+  {
+    return num < cnsts_.size() ? cnsts_[num].consumption_weight : 0.0;
+  }
 
   /**
    * @brief Get the number of constraint associated to a variable
    * @return The number of constraint associated to the variable
    */
-  int get_number_of_constraint() const { return cnsts.size(); }
+  size_t get_number_of_constraint() const { return cnsts_.size(); }
 
   /**
    * @brief Get the data associated to a variable
    * @return The data associated to the variable
    */
-  simgrid::kernel::resource::Action* get_id() const { return id; }
+  resource::Action* get_id() const { return id_; }
 
   /**
    * @brief Get the weight of a variable
    * @return The weight of the variable
    */
-  double get_weight() const { return sharing_weight; }
+  double get_weight() const { return sharing_weight_; }
 
   /** @brief Measure the minimum concurrency slack across all constraints where the given var is involved */
   int get_min_concurrency_slack() const;
@@ -380,45 +366,45 @@ public:
   /** @brief Check if a variable can be enabled
    * Make sure to set staged_weight before, if your intent is only to check concurrency
    */
-  int can_enable() const { return staged_weight > 0 && get_min_concurrency_slack() >= concurrency_share; }
+  int can_enable() const { return staged_weight_ > 0 && get_min_concurrency_slack() >= concurrency_share_; }
 
   /* hookup to system */
-  boost::intrusive::list_member_hook<> variable_set_hook;
-  boost::intrusive::list_member_hook<> saturated_variable_set_hook;
+  boost::intrusive::list_member_hook<> variable_set_hook_;
+  boost::intrusive::list_member_hook<> saturated_variable_set_hook_;
 
-  std::vector<Element> cnsts;
+  std::vector<Element> cnsts_;
 
   // sharing_weight: variable's impact on the resource during the sharing
   //   if == 0, the variable is not considered by LMM
   //   on CPU, actions with N threads have a sharing of N
   //   on network, the actions with higher latency have a lesser sharing_weight
-  double sharing_weight;
-
-  double staged_weight; /* If non-zero, variable is staged for addition as soon as maxconcurrency constraints will be
-                         * met */
-  double bound;
-  double value;
-  short int concurrency_share; /* The maximum number of elements that variable will add to a constraint */
-  simgrid::kernel::resource::Action* id;
-  int id_int;
-  unsigned visited; /* used by System::update_modified_set() */
+  double sharing_weight_;
+
+  double staged_weight_; /* If non-zero, variable is staged for addition as soon as maxconcurrency constraints will be
+                            met */
+  double bound_;
+  double value_;
+  short int concurrency_share_; /* The maximum number of elements that variable will add to a constraint */
+  resource::Action* id_;
+  int rank_;         // Only used in debug messages to identify the variable
+  unsigned visited_; /* used by System::update_modified_set() */
   /* \begin{For Lagrange only} */
-  double mu;
-  double new_mu;
+  double mu_;
+  double new_mu_;
   /* \end{For Lagrange only} */
 
 private:
-  static int Global_debug_id;
+  static int next_rank_; // To give a separate rank_ to each variable
 };
 
 inline void Element::make_active()
 {
-  constraint->active_element_set.push_front(*this);
+  constraint->active_element_set_.push_front(*this);
 }
 inline void Element::make_inactive()
 {
   if (active_element_set_hook.is_linked())
-    simgrid::xbt::intrusive_erase(constraint->active_element_set, *this);
+    simgrid::xbt::intrusive_erase(constraint->active_element_set_, *this);
 }
 
 /**
@@ -448,8 +434,7 @@ public:
    * @param bound The maximum value of the variable (-1.0 if no maximum value)
    * @param number_of_constraints The maximum number of constraint to associate to the variable
    */
-  Variable* variable_new(simgrid::kernel::resource::Action * id, double weight_value, double bound,
-                         int number_of_constraints);
+  Variable* variable_new(resource::Action* id, double weight_value, double bound, size_t number_of_constraints);
 
   /**
    * @brief Free a variable
@@ -499,7 +484,7 @@ public:
    * @param cnst A constraint
    * @return [description]
    */
-  int constraint_used(Constraint * cnst) { return cnst->active_constraint_set_hook.is_linked(); }
+  int constraint_used(Constraint* cnst) { return cnst->active_constraint_set_hook_.is_linked(); }
 
   /** @brief Print the lmm system */
   void print() const;
@@ -535,21 +520,21 @@ private:
   void insert_constraint(Constraint * cnst) { constraint_set.push_back(*cnst); }
   void remove_variable(Variable * var)
   {
-    if (var->variable_set_hook.is_linked())
+    if (var->variable_set_hook_.is_linked())
       simgrid::xbt::intrusive_erase(variable_set, *var);
-    if (var->saturated_variable_set_hook.is_linked())
+    if (var->saturated_variable_set_hook_.is_linked())
       simgrid::xbt::intrusive_erase(saturated_variable_set, *var);
   }
   void make_constraint_active(Constraint * cnst)
   {
-    if (not cnst->active_constraint_set_hook.is_linked())
+    if (not cnst->active_constraint_set_hook_.is_linked())
       active_constraint_set.push_back(*cnst);
   }
   void make_constraint_inactive(Constraint * cnst)
   {
-    if (cnst->active_constraint_set_hook.is_linked())
+    if (cnst->active_constraint_set_hook_.is_linked())
       simgrid::xbt::intrusive_erase(active_constraint_set, *cnst);
-    if (cnst->modified_constraint_set_hook.is_linked())
+    if (cnst->modified_constraint_set_hook_.is_linked())
       simgrid::xbt::intrusive_erase(modified_constraint_set, *cnst);
   }
 
@@ -577,33 +562,32 @@ private:
 public:
   bool modified_ = false;
   boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
-                                                                 &Variable::variable_set_hook>>
+                                                                 &Variable::variable_set_hook_>>
       variable_set;
   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
-                                                                   &Constraint::active_constraint_set_hook>>
+                                                                   &Constraint::active_constraint_set_hook_>>
       active_constraint_set;
   boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
-                                                                 &Variable::saturated_variable_set_hook>>
+                                                                 &Variable::saturated_variable_set_hook_>>
       saturated_variable_set;
   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
-                                                                   &Constraint::saturated_constraint_set_hook>>
+                                                                   &Constraint::saturated_constraint_set_hook_>>
       saturated_constraint_set;
 
-  simgrid::kernel::resource::Action::ModifiedSet* modified_set_ = nullptr;
+  resource::Action::ModifiedSet* modified_set_ = nullptr;
 
 private:
   bool selective_update_active; /* flag to update partially the system only selecting changed portions */
   unsigned visited_counter_ = 1; /* used by System::update_modified_set() and System::remove_all_modified_set() to
                                   * cleverly (un-)flag the constraints (more details in these functions) */
   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
-                                                                   &Constraint::constraint_set_hook>>
+                                                                   &Constraint::constraint_set_hook_>>
       constraint_set;
   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
-                                                                   &Constraint::modified_constraint_set_hook>>
+                                                                   &Constraint::modified_constraint_set_hook_>>
       modified_constraint_set;
   xbt_mallocator_t variable_mallocator_ =
       xbt_mallocator_new(65536, System::variable_mallocator_new_f, System::variable_mallocator_free_f, nullptr);
-  ;
 };
 
 class XBT_PUBLIC FairBottleneck : public System {
@@ -615,41 +599,8 @@ private:
   void bottleneck_solve();
 };
 
-class XBT_PUBLIC Lagrange : public System {
-public:
-  explicit Lagrange(bool selective_update) : System(selective_update) {}
-  void solve() final { lagrange_solve(); }
-
-  static void set_default_protocol_function(double (*func_f)(const Variable& var, double x),
-                                            double (*func_fp)(const Variable& var, double x),
-                                            double (*func_fpi)(const Variable& var, double x));
-
-private:
-  void lagrange_solve();
-
-  bool check_feasible(bool warn);
-  double dual_objective();
-
-  static double (*func_f)(const Variable& var, double x);   /* (f)    */
-  static double (*func_fp)(const Variable& var, double x);  /* (f')    */
-  static double (*func_fpi)(const Variable& var, double x); /* (f')^{-1}    */
-
-  /*
-   * Local prototypes to implement the Lagrangian optimization with optimal step, also called dichotomy.
-   */
-  // computes the value of the dichotomy using a initial values, init, with a specific variable or constraint
-  static double dichotomy(double init, double diff(double, const Constraint&), const Constraint& cnst,
-                          double min_error);
-  // computes the value of the differential of constraint cnst applied to lambda
-  static double partial_diff_lambda(double lambda, const Constraint& cnst);
-
-  static double new_value(const Variable& var);
-  static double new_mu(const Variable& var);
-};
-
 XBT_PUBLIC System* make_new_maxmin_system(bool selective_update);
 XBT_PUBLIC System* make_new_fair_bottleneck_system(bool selective_update);
-XBT_PUBLIC System* make_new_lagrange_system(bool selective_update);
 
 /** @} */
 }