-/* 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. */
#ifndef SURF_MAXMIN_HPP
#define SURF_MAXMIN_HPP
-#include "src/internal_config.h"
-#include "src/kernel/resource/Action.hpp"
-#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 <boost/intrusive/list.hpp>
#include <cmath>
#include <limits>
/** @{ @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_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_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);
+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
* 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();
double consumption_weight;
};
-struct ConstraintLight {
+class ConstraintLight {
+public:
double remaining_over_usage;
Constraint* cnst;
};
* \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() = 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
* @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
* @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
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) */
+ 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;
* 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,
+ void initialize(resource::Action* id_value, double sharing_weight_value, double bound_value,
int number_of_constraints, unsigned visited_value);
/**
* @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
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 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} */
private:
/**
* @brief LMM system
*/
-XBT_PUBLIC_CLASS System
-{
+class XBT_PUBLIC System {
public:
/**
* @brief Create a new Linear MaxMim system
*/
explicit System(bool selective_update);
/** @brief Free an existing Linear MaxMin system */
- ~System();
+ virtual ~System();
/**
* @brief Create a new Linear MaxMin constraint
* @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::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
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();
void remove_all_modified_set();
void check_concurrency() const;
- template <class CnstList> void solve(CnstList& cnst_list);
+ template <class CnstList> void lmm_solve(CnstList& cnst_list);
+
public:
- bool modified;
+ bool modified_ = false;
boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
&Variable::variable_set_hook>>
variable_set;
&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, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_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>>
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();
+};
+
+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)(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);
+XBT_PUBLIC System* make_new_lagrange_system(bool selective_update);
/** @} */
}
