X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d4b2fe80fbab6343e6dce68a12eb522a2e0559b8..d74e17e7c1af9fdf99700b1b21bae6b95ba5241a:/src/kernel/lmm/maxmin.hpp diff --git a/src/kernel/lmm/maxmin.hpp b/src/kernel/lmm/maxmin.hpp index 608d6f4ad3..4e88bba2b8 100644 --- a/src/kernel/lmm/maxmin.hpp +++ b/src/kernel/lmm/maxmin.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2017. 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. */ @@ -6,13 +6,11 @@ #ifndef SURF_MAXMIN_HPP #define SURF_MAXMIN_HPP -#include "src/internal_config.h" -#include "src/surf/surf_interface.hpp" -#include "surf/surf.hpp" +#include "simgrid/kernel/resource/Action.hpp" +#include "simgrid/s4u/Link.hpp" #include "xbt/asserts.h" #include "xbt/mallocator.h" -#include "xbt/misc.h" -#include "xbt/utility.hpp" + #include #include #include @@ -85,7 +83,7 @@ namespace lmm { * * max( var1.weight * var1.value * elem5.value , var3.weight * var3.value * elem6.value ) <= cons3.bound * - * This is usefull for the sharing of resources for various models. + * This is useful for the sharing of resources for various models. * For instance, for the network model, each link is associated to a constraint and each communication to a variable. * * Implementation details @@ -133,34 +131,6 @@ namespace lmm { /** @{ @ingroup SURF_lmm */ -/** - * @brief Solve the lmm system - * @param sys The lmm system to solve - */ -XBT_PUBLIC(void) lmm_solve(lmm_system_t sys); - -XBT_PUBLIC(void) lagrange_solve(lmm_system_t sys); -XBT_PUBLIC(void) bottleneck_solve(lmm_system_t sys); - -/** Default functions associated to the chosen protocol. When using the lagrangian approach. */ - -XBT_PUBLIC(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)); - -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. @@ -168,8 +138,7 @@ XBT_PUBLIC(double) func_vegas_fpi(const Variable& var, double x); * Then, it is used to list all variables involved in constraint through constraint's xxx_element_set lists, or * vice-versa list all constraints for a given variable. */ -XBT_PUBLIC_CLASS Element -{ +class XBT_PUBLIC Element { public: int get_concurrency() const; void decrease_concurrency(); @@ -183,8 +152,8 @@ public: boost::intrusive::list_member_hook<> disabled_element_set_hook; boost::intrusive::list_member_hook<> active_element_set_hook; - lmm_constraint_t constraint; - lmm_variable_t variable; + Constraint* constraint; + Variable* variable; // consumption_weight: impact of 1 byte or flop of your application onto the resource (in byte or flop) // - if CPU, then probably 1. @@ -192,9 +161,10 @@ public: double consumption_weight; }; -struct ConstraintLight { +class ConstraintLight { +public: double remaining_over_usage; - lmm_constraint_t cnst; + Constraint* cnst; }; /** @@ -206,66 +176,50 @@ struct ConstraintLight { * \li Active elements which variable's weight is non-zero (i.e. it is enabled) AND its element value is non-zero. * LMM_solve iterates over active elements during resolution, dynamically making them active or unactive. */ -XBT_PUBLIC_CLASS Constraint -{ +class XBT_PUBLIC Constraint { public: - Constraint() = default; - Constraint(void* id_value, double bound_value); + Constraint() = delete; + Constraint(resource::Resource* 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; } + /** @brief Check how a constraint is shared */ + s4u::Link::SharingPolicy get_sharing_policy() const { return sharing_policy_; } - /** - * @brief Get the usage of the constraint after the last lmm solve - * @return The usage of the constraint - */ + /** @brief Get the usage of the constraint after the last lmm solve */ double get_usage() const; int get_variable_amount() const; - /** - * @brief Sets the concurrency limit for this constraint - * @param concurrency_limit The concurrency limit to use for this constraint - */ + /** @brief Sets the concurrency limit for this constraint */ 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; } + /** @brief Gets the concurrency limit for this constraint */ + 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). - * @return the maximum concurrency of the constraint - */ + /** @brief Get the concurrency maximum for a given constraint (which reflects constraint evolution). */ 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::max() : concurrency_limit - concurrency_current; + return concurrency_limit_ < 0 ? std::numeric_limits::max() : concurrency_limit_ - concurrency_current_; } /** @@ -274,7 +228,7 @@ public: * @param elem A element of constraint of the constraint or NULL * @return A variable associated to a constraint */ - lmm_variable_t get_variable(const_lmm_element_t* elem) const; + Variable* get_variable(const Element** elem) const; /** * @brief Get a var associated to a constraint @@ -284,47 +238,47 @@ public: * @param numelem parameter representing the number of elements to go * @return A variable associated to a constraint */ - lmm_variable_t 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; } + resource::Resource* 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::enabled_element_set_hook>> - enabled_element_set; + enabled_element_set_; boost::intrusive::list, &Element::disabled_element_set_hook>> - disabled_element_set; + disabled_element_set_; boost::intrusive::list, &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: FULLDUPLEX) */ - 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) */ + resource::Resource* id_; }; /** @@ -333,117 +287,97 @@ private: * When something prevents us from enabling a variable, we "stage" the weight that we would have like to set, so that as * soon as possible we enable the variable with desired weight */ -XBT_PUBLIC_CLASS Variable -{ +class XBT_PUBLIC Variable { public: - void initialize(simgrid::surf::Action* id_value, double sharing_weight_value, double bound_value, - int number_of_constraints, unsigned visited_value); + void initialize(resource::Action* id_value, double sharing_penalty, 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; } + /** @brief Get the value of the variable after the last lmm solve */ + 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; } + /** @brief Get the maximum value of the variable (-1.0 if no specified maximum) */ + double get_bound() const { return bound_; } /** * @brief Set the concurrent share of the variable - * @param concurrency_share The new concurrency share + * @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 */ - lmm_constraint_t 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(); } + /** @brief Get the number of constraint associated to a variable */ + 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::surf::Action* get_id() const { return id; } + /** @brief Get the data associated to a variable */ + 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; } + /** @brief Get the penalty of a variable */ + double get_penalty() const { return sharing_penalty_; } /** @brief Measure the minimum concurrency slack across all constraints where the given var is involved */ int get_min_concurrency_slack() const; /** @brief Check if a variable can be enabled - * Make sure to set staged_weight before, if your intent is only to check concurrency + * Make sure to set staged_penalty 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_penalty_ > 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 cnsts; + std::vector cnsts_; - // sharing_weight: variable's impact on the resource during the sharing + // sharing_penalty: 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::surf::Action* id; - int id_int; - unsigned visited; /* used by System::update_modified_set() */ - /* \begin{For Lagrange only} */ - double mu; - double new_mu; - double (*func_f)(const Variable& var, double x); /* (f) */ - double (*func_fp)(const Variable& var, double x); /* (f') */ - double (*func_fpi)(const Variable& var, double x); /* (f')^{-1} */ - /* \end{For Lagrange only} */ + // on network, the actions with higher latency have a lesser sharing_penalty + double sharing_penalty_; + + double staged_penalty_; /* 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() */ + double mu_; 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); } /** * @brief LMM system */ -XBT_PUBLIC_CLASS System -{ +class XBT_PUBLIC System { public: /** * @brief Create a new Linear MaxMim system @@ -451,29 +385,33 @@ public: */ explicit System(bool selective_update); /** @brief Free an existing Linear MaxMin system */ - ~System(); + virtual ~System(); /** * @brief Create a new Linear MaxMin constraint * @param id Data associated to the constraint (e.g.: a network link) * @param bound_value The bound value of the constraint */ - lmm_constraint_t constraint_new(void* id, double bound_value); + Constraint* constraint_new(resource::Resource* id, double bound_value); /** * @brief Create a new Linear MaxMin variable * @param id Data associated to the variable (e.g.: a network communication) - * @param weight_value The weight of the variable (0.0 if not used) + * @param sharing_penalty The weight of the variable (0.0 if not used) * @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 + * @param number_of_constraints The maximum number of constraints to associate to the variable */ - lmm_variable_t variable_new(simgrid::surf::Action* id, double weight_value, double bound, int number_of_constraints); + Variable* variable_new(resource::Action* id, double sharing_penalty, double bound = -1.0, + size_t number_of_constraints = 1); /** * @brief Free a variable * @param var The variable to free */ - void variable_free(lmm_variable_t var); + void variable_free(Variable * var); + + /** @brief Free all variables */ + void variable_free_all(); /** * @brief Associate a variable to a constraint with a coefficient @@ -481,7 +419,7 @@ public: * @param var A variable * @param value The coefficient associated to the variable in the constraint */ - void expand(lmm_constraint_t cnst, lmm_variable_t var, double value); + void expand(Constraint * cnst, Variable * var, double value); /** * @brief Add value to the coefficient between a constraint and a variable or create one @@ -489,88 +427,74 @@ public: * @param var A variable * @param value The value to add to the coefficient associated to the variable in the constraint */ - void expand_add(lmm_constraint_t cnst, lmm_variable_t var, double value); + void expand_add(Constraint * cnst, Variable * var, double value); - /** - * @brief Update the bound of a variable - * @param var A constraint - * @param bound The new bound - */ - void update_variable_bound(lmm_variable_t var, double bound); + /** @brief Update the bound of a variable */ + void update_variable_bound(Variable * var, double bound); - /** - * @brief Update the weight of a variable - * @param var A variable - * @param weight The new weight of the variable - */ - void update_variable_weight(lmm_variable_t var, double weight); + /** @brief Update the sharing penalty of a variable */ + void update_variable_penalty(Variable* var, double penalty); - /** - * @brief Update a constraint bound - * @param cnst A constraint - * @param bound The new bound of the consrtaint - */ - void update_constraint_bound(lmm_constraint_t cnst, double bound); + /** @brief Update a constraint bound */ + void update_constraint_bound(Constraint * cnst, double bound); - /** - * @brief [brief description] - * @param cnst A constraint - * @return [description] - */ - int constraint_used(lmm_constraint_t 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; /** @brief Solve the lmm system */ - void solve(); + void lmm_solve(); + + /** @brief Solve the lmm system. May be specialized in subclasses. */ + virtual void solve() { lmm_solve(); } private: static void* variable_mallocator_new_f(); static void variable_mallocator_free_f(void* var); - void var_free(lmm_variable_t var); - void cnst_free(lmm_constraint_t cnst); - lmm_variable_t extract_variable() + void var_free(Variable * var); + void cnst_free(Constraint * cnst); + Variable* extract_variable() { if (variable_set.empty()) return nullptr; - lmm_variable_t res = &variable_set.front(); + Variable* res = &variable_set.front(); variable_set.pop_front(); return res; } - lmm_constraint_t extract_constraint() + Constraint* extract_constraint() { if (constraint_set.empty()) return nullptr; - lmm_constraint_t res = &constraint_set.front(); + Constraint* res = &constraint_set.front(); constraint_set.pop_front(); return res; } - void insert_constraint(lmm_constraint_t cnst) { constraint_set.push_back(*cnst); } - void remove_variable(lmm_variable_t var) + 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(lmm_constraint_t cnst) + 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(lmm_constraint_t 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); } - void enable_var(lmm_variable_t var); - void disable_var(lmm_variable_t var); - void on_disabled_var(lmm_constraint_t cnstr); + void enable_var(Variable * var); + void disable_var(Variable * var); + void on_disabled_var(Constraint * cnstr); /** * @brief Update the value of element linking the constraint and the variable @@ -578,51 +502,59 @@ private: * @param var A variable * @param value The new value */ - void update(lmm_constraint_t cnst, lmm_variable_t var, double value); + void update(Constraint * cnst, Variable * var, double value); - void update_modified_set(lmm_constraint_t cnst); - void update_modified_set_rec(lmm_constraint_t cnst); + void update_modified_set(Constraint * cnst); + void update_modified_set_rec(Constraint * cnst); /** @brief Remove all constraints of the modified_constraint_set. */ void remove_all_modified_set(); void check_concurrency() const; - template void solve(CnstList& cnst_list); + template void lmm_solve(CnstList& cnst_list); + public: - bool modified; + bool modified_ = false; boost::intrusive::list, - &Variable::variable_set_hook>> + &Variable::variable_set_hook_>> variable_set; boost::intrusive::list, - &Constraint::active_constraint_set_hook>> + &Constraint::active_constraint_set_hook_>> active_constraint_set; boost::intrusive::list, - &Variable::saturated_variable_set_hook>> + &Variable::saturated_variable_set_hook_>> saturated_variable_set; boost::intrusive::list, - &Constraint::saturated_constraint_set_hook>> + &Constraint::saturated_constraint_set_hook_>> saturated_constraint_set; - simgrid::surf::ActionLmmListPtr keep_track; - - void (*solve_fun)(lmm_system_t self); + resource::Action::ModifiedSet* modified_set_ = nullptr; private: bool selective_update_active; /* flag to update partially the system only selecting changed portions */ - unsigned visited_counter; /* used by System::update_modified_set() and System::remove_all_modified_set() to - * cleverly (un-)flag the constraints (more details in these functions) */ + 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::constraint_set_hook>> + &Constraint::constraint_set_hook_>> constraint_set; boost::intrusive::list, - &Constraint::modified_constraint_set_hook>> + &Constraint::modified_constraint_set_hook_>> modified_constraint_set; - xbt_mallocator_t variable_mallocator; + 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 { +public: + explicit FairBottleneck(bool selective_update) : System(selective_update) {} + void solve() final { bottleneck_solve(); } + +private: + void bottleneck_solve(); }; -extern XBT_PRIVATE double (*func_f_def)(const Variable&, double); -extern XBT_PRIVATE double (*func_fp_def)(const Variable&, double); -extern XBT_PRIVATE double (*func_fpi_def)(const Variable&, double); +XBT_PUBLIC System* make_new_maxmin_system(bool selective_update); +XBT_PUBLIC System* make_new_fair_bottleneck_system(bool selective_update); /** @} */ }