X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ff25d0379ffdbee9ddbd8f0d1ab6931de25b420a..1b4dc02411d79e4c367d331b85c1b295ec41edff:/src/kernel/lmm/maxmin.hpp diff --git a/src/kernel/lmm/maxmin.hpp b/src/kernel/lmm/maxmin.hpp index a691217232..1e3b0d3707 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,12 @@ #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/swag.h" + +#include #include #include #include @@ -84,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 @@ -132,33 +131,19 @@ 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) -lmm_set_default_protocol_function(double (*func_f)(lmm_variable_t var, double x), - double (*func_fp)(lmm_variable_t var, double x), - double (*func_fpi)(lmm_variable_t 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_reno_f(lmm_variable_t var, double x); -XBT_PUBLIC(double) func_reno_fp(lmm_variable_t var, double x); -XBT_PUBLIC(double) func_reno_fpi(lmm_variable_t 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_reno2_f(lmm_variable_t var, double x); -XBT_PUBLIC(double) func_reno2_fp(lmm_variable_t var, double x); -XBT_PUBLIC(double) func_reno2_fpi(lmm_variable_t var, double x); - -XBT_PUBLIC(double) func_vegas_f(lmm_variable_t var, double x); -XBT_PUBLIC(double) func_vegas_fp(lmm_variable_t var, double x); -XBT_PUBLIC(double) func_vegas_fpi(lmm_variable_t 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 @@ -167,8 +152,7 @@ XBT_PUBLIC(double) func_vegas_fpi(lmm_variable_t 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 s_lmm_element_t -{ +class XBT_PUBLIC Element { public: int get_concurrency() const; void decrease_concurrency(); @@ -178,12 +162,12 @@ public: void make_inactive(); /* hookup to constraint */ - s_xbt_swag_hookup_t enabled_element_set_hookup; - s_xbt_swag_hookup_t disabled_element_set_hookup; - s_xbt_swag_hookup_t active_element_set_hookup; + boost::intrusive::list_member_hook<> enabled_element_set_hook; + 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. @@ -191,9 +175,10 @@ public: double consumption_weight; }; -struct s_lmm_constraint_light_t { +class ConstraintLight { +public: double remaining_over_usage; - lmm_constraint_t cnst; + Constraint* cnst; }; /** @@ -205,20 +190,19 @@ struct s_lmm_constraint_light_t { * \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 s_lmm_constraint_t -{ +class XBT_PUBLIC Constraint { public: - s_lmm_constraint_t() = default; - s_lmm_constraint_t(void* id_value, double bound_value); + Constraint() = delete; + 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 @@ -229,7 +213,7 @@ public: /** * @brief Sets the concurrency limit for this constraint - * @param concurrency_limit The concurrency limit to use for this constraint + * @param limit The concurrency limit to use for this constraint */ void set_concurrency_limit(int limit) { @@ -273,7 +257,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 @@ -283,7 +267,7 @@ 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 @@ -292,13 +276,19 @@ public: void* get_id() const { return id; } /* hookup to system */ - s_xbt_swag_hookup_t constraint_set_hookup = {nullptr, nullptr}; - s_xbt_swag_hookup_t active_constraint_set_hookup = {nullptr, nullptr}; - s_xbt_swag_hookup_t modified_constraint_set_hookup = {nullptr, nullptr}; - s_xbt_swag_hookup_t saturated_constraint_set_hookup = {nullptr, nullptr}; - s_xbt_swag_t enabled_element_set; /* a list of lmm_element_t */ - s_xbt_swag_t disabled_element_set; /* a list of lmm_element_t */ - s_xbt_swag_t active_element_set; /* a list of lmm_element_t */ + 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; + boost::intrusive::list, + &Element::disabled_element_set_hook>> + disabled_element_set; + boost::intrusive::list, + &Element::active_element_set_hook>> + active_element_set; double remaining; double usage; double bound; @@ -307,11 +297,11 @@ public: 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) */ + s4u::Link::SharingPolicy sharing_policy; int id_int; double lambda; double new_lambda; - lmm_constraint_light_t cnst_light; + ConstraintLight* cnst_light; private: static int Global_debug_id; @@ -326,10 +316,9 @@ 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 s_lmm_variable_t -{ +class XBT_PUBLIC Variable { public: - void initialize(simgrid::surf::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); /** @@ -346,7 +335,7 @@ public: /** * @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; } @@ -355,7 +344,7 @@ public: * @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 @@ -368,13 +357,13 @@ public: * @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::surf::Action* get_id() const { return id; } + resource::Action* get_id() const { return id; } /** * @brief Get the weight of a variable @@ -391,10 +380,10 @@ public: int can_enable() const { return staged_weight > 0 && get_min_concurrency_slack() >= concurrency_share; } /* hookup to system */ - s_xbt_swag_hookup_t variable_set_hookup = {nullptr, nullptr}; - s_xbt_swag_hookup_t saturated_variable_set_hookup = {nullptr, nullptr}; + 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 // if == 0, the variable is not considered by LMM @@ -407,50 +396,47 @@ public: double bound; double value; short int concurrency_share; /* The maximum number of elements that variable will add to a constraint */ - simgrid::surf::Action* id; + resource::Action* id; int id_int; - unsigned visited; /* used by lmm_update_modified_set */ + unsigned visited; /* used by System::update_modified_set() */ /* \begin{For Lagrange only} */ double mu; double new_mu; - double (*func_f)(s_lmm_variable_t * var, double x); /* (f) */ - double (*func_fp)(s_lmm_variable_t * var, double x); /* (f') */ - double (*func_fpi)(s_lmm_variable_t * var, double x); /* (f')^{-1} */ /* \end{For Lagrange only} */ private: static int Global_debug_id; }; -inline void s_lmm_element_t::make_active() +inline void Element::make_active() { - xbt_swag_insert_at_head(this, &constraint->active_element_set); + constraint->active_element_set.push_front(*this); } -inline void s_lmm_element_t::make_inactive() +inline void Element::make_inactive() { - xbt_swag_remove(this, &constraint->active_element_set); + if (active_element_set_hook.is_linked()) + simgrid::xbt::intrusive_erase(constraint->active_element_set, *this); } /** * @brief LMM system */ -XBT_PUBLIC_CLASS s_lmm_system_t -{ +class XBT_PUBLIC System { public: /** * @brief Create a new Linear MaxMim system * @param selective_update whether we should do lazy updates */ - explicit s_lmm_system_t(bool selective_update); + explicit System(bool selective_update); /** @brief Free an existing Linear MaxMin system */ - ~s_lmm_system_t(); + 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(void* id, double bound_value); /** * @brief Create a new Linear MaxMin variable @@ -459,13 +445,13 @@ 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 */ - 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 weight_value, double bound, size_t number_of_constraints); /** * @brief Free a variable * @param var The variable to free */ - void variable_free(lmm_variable_t var); + void variable_free(Variable * var); /** * @brief Associate a variable to a constraint with a coefficient @@ -473,7 +459,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 @@ -481,66 +467,91 @@ 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); + 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); + void update_variable_weight(Variable * var, double weight); /** * @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); + 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 xbt_swag_belongs(cnst, &active_constraint_set); } + 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() { return static_cast(xbt_swag_extract(&variable_set)); } - lmm_constraint_t extract_constraint() { return static_cast(xbt_swag_extract(&constraint_set)); } - void insert_constraint(lmm_constraint_t cnst) { xbt_swag_insert(cnst, &constraint_set); } - void remove_variable(lmm_variable_t var) + void var_free(Variable * var); + void cnst_free(Constraint * cnst); + Variable* extract_variable() + { + if (variable_set.empty()) + return nullptr; + Variable* res = &variable_set.front(); + variable_set.pop_front(); + return res; + } + Constraint* extract_constraint() + { + if (constraint_set.empty()) + return nullptr; + Constraint* res = &constraint_set.front(); + constraint_set.pop_front(); + return res; + } + void insert_constraint(Constraint * cnst) { constraint_set.push_back(*cnst); } + void remove_variable(Variable * var) + { + if (var->variable_set_hook.is_linked()) + simgrid::xbt::intrusive_erase(variable_set, *var); + if (var->saturated_variable_set_hook.is_linked()) + simgrid::xbt::intrusive_erase(saturated_variable_set, *var); + } + void make_constraint_active(Constraint * cnst) { - xbt_swag_remove(var, &variable_set); - xbt_swag_remove(var, &saturated_variable_set); + if (not cnst->active_constraint_set_hook.is_linked()) + active_constraint_set.push_back(*cnst); } - void make_constraint_active(lmm_constraint_t cnst) { xbt_swag_insert(cnst, &active_constraint_set); } - void make_constraint_inactive(lmm_constraint_t cnst) + void make_constraint_inactive(Constraint * cnst) { - xbt_swag_remove(cnst, &active_constraint_set); - xbt_swag_remove(cnst, &modified_constraint_set); + if (cnst->active_constraint_set_hook.is_linked()) + simgrid::xbt::intrusive_erase(active_constraint_set, *cnst); + 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 @@ -548,38 +559,92 @@ 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 lmm_solve(CnstList& cnst_list); + public: - bool modified; - s_xbt_swag_t variable_set; /* a list of lmm_variable_t */ - s_xbt_swag_t active_constraint_set; /* a list of lmm_constraint_t */ - s_xbt_swag_t saturated_variable_set; /* a list of lmm_variable_t */ - s_xbt_swag_t saturated_constraint_set; /* a list of lmm_constraint_t */ + bool modified_ = false; + boost::intrusive::list, + &Variable::variable_set_hook>> + variable_set; + boost::intrusive::list, + &Constraint::active_constraint_set_hook>> + active_constraint_set; + boost::intrusive::list, + &Variable::saturated_variable_set_hook>> + saturated_variable_set; + boost::intrusive::list, + &Constraint::saturated_constraint_set_hook>> + saturated_constraint_set; + + resource::Action::ModifiedSet* modified_set_ = nullptr; - simgrid::surf::ActionLmmListPtr keep_track; +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::constraint_set_hook>> + constraint_set; + boost::intrusive::list, + &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); +}; - void (*solve_fun)(lmm_system_t self); +class XBT_PUBLIC FairBottleneck : public System { +public: + explicit FairBottleneck(bool selective_update) : System(selective_update) {} + void solve() final { bottleneck_solve(); } private: - bool selective_update_active; /* flag to update partially the system only selecting changed portions */ - unsigned visited_counter; /* used by lmm_update_modified_set and lmm_remove_modified_set to cleverly (un-)flag the - * constraints (more details in these functions) */ - s_xbt_swag_t constraint_set; /* a list of lmm_constraint_t */ - s_xbt_swag_t modified_constraint_set; /* a list of modified lmm_constraint_t */ - xbt_mallocator_t variable_mallocator; + 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); }; -extern XBT_PRIVATE double (*func_f_def)(lmm_variable_t, double); -extern XBT_PRIVATE double (*func_fp_def)(lmm_variable_t, double); -extern XBT_PRIVATE double (*func_fpi_def)(lmm_variable_t, double); +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); /** @} */ }