-/* Copyright (c) 2004-2016. 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_MODEL_H_
#define SURF_MODEL_H_
-#include <xbt.h>
-#include <string>
-#include <vector>
-#include <memory>
-#include <utility>
-
-#include <boost/function.hpp>
-#include <boost/intrusive/list.hpp>
-
-#include <xbt/signal.hpp>
-
-#include "xbt/lib.h"
-#include "surf/surf_routing.h"
-#include "simgrid/platf_interface.h"
-#include "surf/surf.h"
-#include "src/surf/surf_private.h"
#include "src/internal_config.h"
+#include "src/surf/surf_private.hpp"
-#define NO_MAX_DURATION -1.0
+#include <cmath>
+#include <set>
+#include <string>
+#include <unordered_map>
+#include <vector>
/*********
* Utils *
*********/
/* user-visible parameters */
-extern XBT_PRIVATE double sg_tcp_gamma;
-extern XBT_PRIVATE double sg_sender_gap;
+XBT_PUBLIC_DATA double sg_maxmin_precision;
+XBT_PUBLIC_DATA double sg_surf_precision;
+XBT_PUBLIC_DATA int sg_concurrency_limit;
+
extern XBT_PRIVATE double sg_latency_factor;
extern XBT_PRIVATE double sg_bandwidth_factor;
extern XBT_PRIVATE double sg_weight_S_parameter;
-extern XBT_PRIVATE int sg_network_crosstraffic;
-extern XBT_PRIVATE xbt_dynar_t surf_path;
-
-extern "C" {
-XBT_PUBLIC(double) surf_get_clock(void);
+extern XBT_PRIVATE std::vector<std::string> surf_path;
+extern XBT_PRIVATE std::unordered_map<std::string, simgrid::kernel::profile::Profile*> traces_set_list;
+extern XBT_PRIVATE std::set<std::string> watched_hosts;
+
+static inline void double_update(double* variable, double value, double precision)
+{
+ // printf("Updating %g -= %g +- %g\n",*variable,value,precision);
+ // xbt_assert(value==0 || value>precision);
+ // Check that precision is higher than the machine-dependent size of the mantissa. If not, brutal rounding may
+ // happen, and the precision mechanism is not active...
+ // xbt_assert(*variable< (2<<DBL_MANT_DIG)*precision && FLT_RADIX==2);
+ *variable -= value;
+ if (*variable < precision)
+ *variable = 0.0;
}
-extern XBT_PRIVATE double sg_sender_gap;
-
-namespace simgrid {
-namespace surf {
-
-extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
-
-}
+static inline int double_positive(double value, double precision)
+{
+ return (value > precision);
}
-int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
-
-/***********
- * Classes *
- ***********/
-
-enum heap_action_type{
- LATENCY = 100,
- MAX_DURATION,
- NORMAL,
- NOTSET
-};
-
-/*********
- * Trace *
- *********/
-/* For the trace and trace:connect tag (store their content till the end of the parsing) */
-XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_bw;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_lat;
-
-/**********
- * Action *
- **********/
-
-XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
-
-XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
-
-namespace simgrid {
-namespace surf {
+static inline int double_equals(double value1, double value2, double precision)
+{
+ return (fabs(value1 - value2) < precision);
+}
-/** @ingroup SURF_interface
- * @brief SURF action interface class
- * @details An action is an event generated by a resource (e.g.: a communication for the network)
+/** @ingroup SURF_models
+ * @brief Initializes the CPU model with the model Cas01
+ *
+ * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
+ * for lazy action update.
+ * You can change this behavior by setting the cpu/optim configuration variable to a different value.
+ *
+ * You shouldn't have to call it by yourself.
*/
-XBT_PUBLIC_CLASS Action {
-public:
- boost::intrusive::list_member_hook<> action_hook;
- boost::intrusive::list_member_hook<> action_lmm_hook;
- typedef boost::intrusive::member_hook<
- Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
- typedef boost::intrusive::list<Action, ActionOptions> ActionList;
-private:
- /**
- * @brief Common initializations for the constructors
- */
- void initialize(simgrid::surf::Model *model, double cost, bool failed,
- lmm_variable_t var = NULL);
-
-public:
- /**
- * @brief Action constructor
- *
- * @param model The Model associated to this Action
- * @param cost The cost of the Action
- * @param failed If the action is impossible (e.g.: execute something on a switched off host)
- */
- Action(simgrid::surf::Model *model, double cost, bool failed);
-
- /**
- * @brief Action constructor
- *
- * @param model The Model associated to this Action
- * @param cost The cost of the Action
- * @param failed If the action is impossible (e.g.: execute something on a switched off host)
- * @param var The lmm variable associated to this Action if it is part of a LMM component
- */
- Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
-
- /** @brief Destructor */
- virtual ~Action();
-
- /** @brief Mark that the action is now finished */
- void finish();
-
- /** @brief Get the [state](\ref e_surf_action_state_t) of the current Action */
- e_surf_action_state_t getState(); /**< get the state*/
- /** @brief Set the [state](\ref e_surf_action_state_t) of the current Action */
- virtual void setState(e_surf_action_state_t state);
-
- /** @brief Get the bound of the current Action */
- double getBound();
- /** @brief Set the bound of the current Action */
- void setBound(double bound);
-
- /** @brief Get the start time of the current action */
- double getStartTime();
- /** @brief Get the finish time of the current action */
- double getFinishTime();
-
- /** @brief Get the user data associated to the current action */
- void *getData() {return p_data;}
- /** @brief Set the user data associated to the current action */
- void setData(void* data);
-
- /** @brief Get the cost of the current action */
- double getCost() {return m_cost;}
- /** @brief Set the cost of the current action */
- void setCost(double cost) {m_cost = cost;}
-
- /** @brief Update the maximum duration of the current action
- * @param delta Amount to remove from the MaxDuration */
- void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
-
- /** @brief Update the remaining time of the current action
- * @param delta Amount to remove from the remaining time */
- void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
-
- /** @brief Set the remaining time of the current action */
- void setRemains(double value) {m_remains = value;}
- /** @brief Get the remaining time of the current action after updating the resource */
- virtual double getRemains();
- /** @brief Get the remaining time of the current action without updating the resource */
- double getRemainsNoUpdate();
-
- /** @brief Set the finish time of the current action */
- void setFinishTime(double value) {m_finish = value;}
-
- /**@brief Add a reference to the current action (refcounting) */
- void ref();
- /** @brief Unref that action (and destroy it if refcount reaches 0)
- * @return true if the action was destroyed and false if someone still has references on it
- */
- virtual int unref();
-
- /** @brief Cancel the current Action if running */
- virtual void cancel();
-
- /** @brief Suspend the current Action */
- virtual void suspend();
-
- /** @brief Resume the current Action */
- virtual void resume();
-
- /** @brief Returns true if the current action is running */
- virtual bool isSuspended();
-
- /** @brief Get the maximum duration of the current action */
- double getMaxDuration() {return m_maxDuration;}
- /** @brief Set the maximum duration of the current Action */
- virtual void setMaxDuration(double duration);
-
- /** @brief Get the tracing category associated to the current action */
- char *getCategory() {return p_category;}
- /** @brief Set the tracing category of the current Action */
- void setCategory(const char *category);
-
- /** @brief Get the priority of the current Action */
- double getPriority() {return m_priority;};
- /** @brief Set the priority of the current Action */
- virtual void setPriority(double priority);
-
- /** @brief Get the state set in which the action is */
- ActionList* getStateSet() {return p_stateSet;};
-
- s_xbt_swag_hookup_t p_stateHookup = {NULL,NULL};
-
- simgrid::surf::Model *getModel() {return p_model;}
-
-protected:
- ActionList* p_stateSet;
- double m_priority = 1.0; /**< priority (1.0 by default) */
- int m_refcount = 1;
- double m_remains; /**< How much of that cost remains to be done in the currently running task */
- double m_maxDuration = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
- double m_finish = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
-
-private:
- double m_start; /**< start time */
- char *p_category = NULL; /**< tracing category for categorized resource utilization monitoring */
-
- #ifdef HAVE_LATENCY_BOUND_TRACKING
- int m_latencyLimited; /**< Set to 1 if is limited by latency, 0 otherwise */
- #endif
- double m_cost;
- simgrid::surf::Model *p_model;
- void *p_data = NULL; /**< for your convenience */
-
- /* LMM */
-public:
- virtual void updateRemainingLazy(double now);
- void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
- void heapRemove(xbt_heap_t heap);
- void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
- void updateIndexHeap(int i);
- lmm_variable_t getVariable() {return p_variable;}
- double getLastUpdate() {return m_lastUpdate;}
- void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
- enum heap_action_type getHat() {return m_hat;}
- bool is_linked() {return action_lmm_hook.is_linked();}
- void gapRemove();
-
-protected:
- lmm_variable_t p_variable;
- double m_lastValue = 0;
- double m_lastUpdate = 0;
- int m_suspended = 0;
- int m_indexHeap;
- enum heap_action_type m_hat = NOTSET;
-};
-
-typedef Action::ActionList ActionList;
-
-typedef boost::intrusive::member_hook<
- Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
-typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
-typedef ActionLmmList* ActionLmmListPtr;
-
-/*********
- * Model *
- *********/
-
-/** @ingroup SURF_interface
- * @brief SURF model interface class
- * @details A model is an object which handle the interactions between its Resources and its Actions
+XBT_PUBLIC void surf_cpu_model_init_Cas01();
+
+/** @ingroup SURF_models
+ * @brief Same as network model 'LagrangeVelho', only with different correction factors.
+ *
+ * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
+ * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
+ * See comments in the code for more information.
+ *
+ * @see surf_host_model_init_SMPI()
*/
-XBT_PUBLIC_CLASS Model {
-public:
- Model();
- virtual ~Model();
-
- virtual void addTraces() =0;
-
- /** @brief Get the set of [actions](@ref Action) in *ready* state */
- virtual ActionList* getReadyActionSet() {return p_readyActionSet;}
-
- /** @brief Get the set of [actions](@ref Action) in *running* state */
- virtual ActionList* getRunningActionSet() {return p_runningActionSet;}
-
- /** @brief Get the set of [actions](@ref Action) in *failed* state */
- virtual ActionList* getFailedActionSet() {return p_failedActionSet;}
-
- /** @brief Get the set of [actions](@ref Action) in *done* state */
- virtual ActionList* getDoneActionSet() {return p_doneActionSet;}
-
- /** @brief Get the set of modified [actions](@ref Action) */
- virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
-
- /** @brief Get the maxmin system of the current Model */
- lmm_system_t getMaxminSystem() {return p_maxminSystem;}
-
- /**
- * @brief Get the update mechanism of the current Model
- * @see e_UM_t
- */
- e_UM_t getUpdateMechanism() {return p_updateMechanism;}
-
- /** @brief Get Action heap */
- xbt_heap_t getActionHeap() {return p_actionHeap;}
-
- /**
- * @brief Share the resources between the actions
- *
- * @param now The current time of the simulation
- * @return The delta of time till the next action will finish
- */
- virtual double next_occuring_event(double now);
- virtual double next_occuring_event_lazy(double now);
- virtual double next_occuring_event_full(double now);
- double shareResourcesMaxMin(ActionList* running_actions,
- lmm_system_t sys, void (*solve) (lmm_system_t));
-
- /**
- * @brief Update action to the current time
- *
- * @param now The current time of the simulation
- * @param delta The delta of time since the last update
- */
- virtual void updateActionsState(double now, double delta);
- virtual void updateActionsStateLazy(double now, double delta);
- virtual void updateActionsStateFull(double now, double delta);
-
- /** @brief Returns whether this model have an idempotent shareResource()
- *
- * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
- * so we need to call it only when the next timestamp of other sources is computed.
- */
- virtual bool next_occuring_event_isIdempotent()=0;
-
-protected:
- ActionLmmListPtr p_modifiedSet;
- lmm_system_t p_maxminSystem = nullptr;
- e_UM_t p_updateMechanism = UM_UNDEFINED;
- int m_selectiveUpdate;
- xbt_heap_t p_actionHeap;
-
-private:
- ActionList* p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
- ActionList* p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
- ActionList* p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
- ActionList* p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
-};
-
-}
-}
-
-/************
- * Resource *
- ************/
-
-/** @ingroup SURF_interface
- * @brief Resource which have a metric handled by a maxmin system
+#if !HAVE_SMPI
+XBT_ATTRIB_NORETURN
+#endif
+XBT_PUBLIC void surf_network_model_init_SMPI();
+
+/** @ingroup SURF_models
+ * @brief Same as network model 'LagrangeVelho', only with different correction factors.
+ *
+ * This model implements a variant of the contention model on Infiniband networks based on
+ * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
+ *
+ * @see surf_host_model_init_IB()
*/
-typedef struct {
- double peak; /**< The peak of the metric, ie its max value */
- double scale; /**< Current availability of the metric according to the traces, in [0,1] */
- tmgr_trace_iterator_t event; /**< The associated trace event associated to the metric */
-} s_surf_metric_t;
-
-namespace simgrid {
-namespace surf {
-
-/** @ingroup SURF_interface
- * @brief SURF resource interface class
- * @details A resource represent an element of a component (e.g.: a link for the network)
+#if !HAVE_SMPI
+XBT_ATTRIB_NORETURN
+#endif
+XBT_PUBLIC void surf_network_model_init_IB();
+
+/** @ingroup SURF_models
+ * @brief Initializes the platform with the network model 'LegrandVelho'
+ *
+ * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
+ * onelink and dogbone sharing scenarios. See comments in the code for more information.
+ *
+ * @see surf_host_model_init_LegrandVelho()
*/
-XBT_PUBLIC_CLASS Resource {
-public:
- /**
- * @brief Constructor of non-LMM Resources
- *
- * @param model Model associated to this Resource
- * @param name The name of the Resource
- */
- Resource(Model *model, const char *name);
-
- /**
- * @brief Constructor of LMM Resources
- *
- * @param model Model associated to this Resource
- * @param name The name of the Resource
- * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
- */
- Resource(Model *model, const char *name, lmm_constraint_t constraint);
-
- Resource(Model *model, const char *name, lmm_constraint_t constraint, int initiallyOn);
-
- /**
- * @brief Resource constructor
- *
- * @param model Model associated to this Resource
- * @param name The name of the Resource
- * @param initiallyOn the initial state of the Resource
- */
- Resource(Model *model, const char *name, int initiallyOn);
-
- virtual ~Resource();
-
- /** @brief Get the Model of the current Resource */
- Model *getModel();
-
- /** @brief Get the name of the current Resource */
- const char *getName();
-
- /**
- * @brief Update the state of the current Resource
- * @details [TODO]
- *
- * @param event_type [TODO]
- * @param value [TODO]
- */
- virtual void apply_event(tmgr_trace_iterator_t event_type, double value)=0;
+XBT_PUBLIC void surf_network_model_init_LegrandVelho();
+
+/** @ingroup SURF_models
+ * @brief Initializes the platform with the network model 'Constant'
+ *
+ * In this model, the communication time between two network cards is constant, hence no need for a routing table.
+ * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
+ * function is called in conjunction with surf_host_model_init_compound.
+ *
+ * @see surf_host_model_init_compound()
+ */
+XBT_PUBLIC void surf_network_model_init_Constant();
- /** @brief Check if the current Resource is used (if it currently serves an action) */
- virtual bool isUsed()=0;
+/** @ingroup SURF_models
+ * @brief Initializes the platform with the network model CM02
+ *
+ * You should call this function by yourself only if you plan using surf_host_model_init_compound.
+ * See comments in the code for more information.
+ */
+XBT_PUBLIC void surf_network_model_init_CM02();
+
+/** @ingroup SURF_models
+ * @brief Initializes the platform with the network model NS3
+ *
+ * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
+ * surf_host_model_init_compound
+ *
+ * @see surf_host_model_init_NS3()
+ */
+#if !SIMGRID_HAVE_NS3
+XBT_ATTRIB_NORETURN
+#endif
+XBT_PUBLIC void surf_network_model_init_NS3();
+
+/** @ingroup SURF_models
+ * @brief Initializes the platform with the current best network and cpu models at hand
+ *
+ * This platform model separates the host model and the network model.
+ * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
+ * traffic support) and the CPU model with the model Cas01.
+ * Such model is subject to modification with warning in the ChangeLog so monitor it!
+ */
+XBT_PUBLIC void surf_vm_model_init_HL13();
- /** @brief Check if the current Resource is active */
- virtual bool isOn();
- /** @brief Check if the current Resource is shut down */
- virtual bool isOff();
- /** @brief Turn on the current Resource */
- virtual void turnOn();
- /** @brief Turn off the current Resource */
- virtual void turnOff();
+/** @ingroup SURF_models
+ * @brief Initializes the platform with a compound host model
+ *
+ * This function should be called after a cpu_model and a network_model have been set up.
+ */
+XBT_PUBLIC void surf_host_model_init_compound();
+
+/** @ingroup SURF_models
+ * @brief Initializes the platform with the current best network and cpu models at hand
+ *
+ * This platform model separates the host model and the network model.
+ * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
+ * traffic support) and the CPU model with the model Cas01.
+ * Such model is subject to modification with warning in the ChangeLog so monitor it!
+ */
+XBT_PUBLIC void surf_host_model_init_current_default();
-private:
- const char *p_name;
- Model *p_model;
- bool m_isOn;
+/** @ingroup SURF_models
+ * @brief Initializes the platform with the model L07
+ *
+ * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
+ * equal share of the model to each action.
+ */
+XBT_PUBLIC void surf_host_model_init_ptask_L07();
-public: /* LMM */
- /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component */
- lmm_constraint_t getConstraint();
-protected:
- lmm_constraint_t p_constraint = nullptr;
+/** @ingroup SURF_models
+ * @brief The storage model
+ */
+XBT_PUBLIC void surf_storage_model_init_default();
+
+XBT_PUBLIC void surf_disk_model_init_default();
+
+/* --------------------
+ * Model Descriptions
+ * -------------------- */
+/** @brief Resource model description */
+struct surf_model_description_t {
+ const char* name;
+ const char* description;
+ void_f_void_t model_init_preparse;
};
-}
-}
+XBT_PUBLIC int find_model_description(const std::vector<surf_model_description_t>& table, const std::string& name);
+XBT_PUBLIC void model_help(const char* category, const std::vector<surf_model_description_t>& table);
+
+#define SIMGRID_REGISTER_PLUGIN(id, desc, init) \
+ static void XBT_ATTRIB_CONSTRUCTOR(800) _XBT_CONCAT3(simgrid_, id, _plugin_register)() \
+ { \
+ simgrid_add_plugin_description(_XBT_STRINGIFY(id), (desc), (init)); \
+ }
+
+XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun);
+
+/** @brief The list of all available plugins */
+XBT_PUBLIC_DATA std::vector<surf_model_description_t>* surf_plugin_description;
+/** @brief The list of all available optimization modes (both for cpu and networks).
+ * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:... */
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_optimization_mode_description;
+/** @brief The list of all cpu models (pick one with --cfg=cpu/model) */
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_cpu_model_description;
+/** @brief The list of all network models (pick one with --cfg=network/model) */
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_network_model_description;
+/** @brief The list of all disk models (pick one with --cfg=disk/model) */
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_disk_model_description;
+/** @brief The list of all storage models (pick one with --cfg=storage/model) */
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_storage_model_description;
+/** @brief The list of all host models (pick one with --cfg=host/model:) */
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_host_model_description;
+
+/**********
+ * Action *
+ **********/
#endif /* SURF_MODEL_H_ */
