-//using namespace generic;
+/* 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 "src/internal_config.h"
+#include "src/surf/surf_private.hpp"
+
+#include <cmath>
+#include <set>
#include <string>
+#include <unordered_map>
#include <vector>
-#include <iostream>
-#include <memory>
-#include <boost/function.hpp>
-#include "surf/trace_mgr.h"
-#include "xbt/lib.h"
-#include "surf/surf_routing.h"
-#include "simgrid/platf_interface.h"
-#include "surf/surf.h"
-#include "surf/surf_private.h"
-
-extern tmgr_history_t history;
-#define NO_MAX_DURATION -1.0
-
-using namespace std;
-
-/** \ingroup SURF_simulation
- * \brief Return the current time
- *
- * Return the current time in millisecond.
- */
/*********
* Utils *
*********/
/* user-visible parameters */
-extern double sg_tcp_gamma;
-extern double sg_sender_gap;
-extern double sg_latency_factor;
-extern double sg_bandwidth_factor;
-extern double sg_weight_S_parameter;
-extern int sg_network_crosstraffic;
-#ifdef HAVE_GTNETS
-extern double sg_gtnets_jitter;
-extern int sg_gtnets_jitter_seed;
-#endif
-extern xbt_dynar_t surf_path;
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-XBT_PUBLIC(double) surf_get_clock(void);
-#ifdef __cplusplus
+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 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;
}
-#endif
-
-extern double sg_sender_gap;
-XBT_PUBLIC(int) SURF_CPU_LEVEL; //Surf cpu level
-
-int __surf_is_absolute_file_path(const char *file_path);
-
-/***********
- * Classes *
- ***********/
-//class Model;
-typedef Model* ModelPtr;
-
-//class Resource;
-typedef Resource* ResourcePtr;
-typedef boost::function<void (ResourcePtr r)> ResourceCallback;
-
-//class Action;
-typedef Action* ActionPtr;
-typedef boost::function<void (ActionPtr a)> ActionCallback;
-
-//class ActionLmm;
-typedef ActionLmm* ActionLmmPtr;
-
-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_host_avail;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
+static inline int double_positive(double value, double precision)
+{
+ return (value > precision);
+}
-/*********
- * Model *
- *********/
-XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
-
-class Model {
-public:
- Model(string name);
- virtual ~Model();
-
- //ResourcePtr createResource(string name);
- ActionPtr createAction(double _cost, bool _failed);
- virtual double shareResources(double now);
- virtual double shareResourcesLazy(double now);
- virtual double shareResourcesFull(double now);
- double shareResourcesMaxMin(xbt_swag_t running_actions,
- lmm_system_t sys,
- void (*solve) (lmm_system_t));
- virtual void updateActionsState(double now, double delta);
- virtual void updateActionsStateLazy(double now, double delta);
- virtual void updateActionsStateFull(double now, double delta);
-
- string getName() {return m_name;};
-
- void addTurnedOnCallback(ResourceCallback rc);
- void notifyResourceTurnedOn(ResourcePtr r);
-
- void addTurnedOffCallback(ResourceCallback rc);
- void notifyResourceTurnedOff(ResourcePtr r);
-
- void addActionCancelCallback(ActionCallback ac);
- void notifyActionCancel(ActionPtr a);
- void addActionResumeCallback(ActionCallback ac);
- void notifyActionResume(ActionPtr a);
- void addActionSuspendCallback(ActionCallback ac);
- void notifyActionSuspend(ActionPtr a);
-
- lmm_system_t p_maxminSystem;
- e_UM_t p_updateMechanism;
- xbt_swag_t p_modifiedSet;
- xbt_heap_t p_actionHeap;
- int m_selectiveUpdate;
+static inline int double_equals(double value1, double value2, double precision)
+{
+ return (fabs(value1 - value2) < precision);
+}
- xbt_swag_t p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
- xbt_swag_t p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
- xbt_swag_t p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
- xbt_swag_t p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
- string m_name;
+/** @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 void surf_cpu_model_init_Cas01();
-protected:
- std::vector<ActionPtr> m_failedActions, m_runningActions;
+/** @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()
+ */
+#if !HAVE_SMPI
+XBT_ATTRIB_NORETURN
+#endif
+XBT_PUBLIC void surf_network_model_init_SMPI();
-private:
- ResourceCallback m_resOnCB, m_resOffCB;
- ActionCallback m_actCancelCB, m_actSuspendCB, m_actResumeCB;
-};
+/** @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()
+ */
+#if !HAVE_SMPI
+XBT_ATTRIB_NORETURN
+#endif
+XBT_PUBLIC void surf_network_model_init_IB();
-/************
- * Resource *
- ************/
+/** @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 void surf_network_model_init_LegrandVelho();
-/**
- * Resource which have a metric handled by a maxmin system
+/** @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()
*/
-typedef struct {
- double scale;
- double peak;
- tmgr_trace_event_t event;
-} s_surf_metric_t;
+XBT_PUBLIC void surf_network_model_init_Constant();
-class Resource {
-public:
- Resource();
- Resource(ModelPtr model, const char *name, xbt_dict_t properties);
- virtual ~Resource() {
- xbt_free((void*)m_name);
- xbt_dict_free(&m_properties);
- };
+/** @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();
- virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
+/** @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();
- //private
- virtual bool isUsed()=0;
- //FIXME:updateActionState();
- //FIXME:updateResourceState();
- //FIXME:finilize();
+/** @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();
- bool isOn();
- void turnOn();
- void turnOff();
- void setName(string name);
- const char *getName();
- virtual xbt_dict_t getProperties();
+/** @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();
- ModelPtr getModel() {return p_model;};
- virtual e_surf_resource_state_t getState();
- virtual void setState(e_surf_resource_state_t state);
- void printModel() { std::cout << p_model->getName() << "<<plop"<<std::endl;};
- void *p_resource;
- const char *m_name;
- xbt_dict_t m_properties;
- ModelPtr p_model;
- e_surf_resource_state_t p_stateCurrent;
+/** @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();
-protected:
+/** @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();
-private:
- bool m_running;
+/** @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;
};
-class ResourceLmm: virtual public Resource {
-public:
- ResourceLmm() : p_constraint(NULL) {
- p_power.event = NULL;
- };
- ResourceLmm(lmm_system_t system,
- double constraint_value,
- tmgr_history_t history,
- e_surf_resource_state_t state_init,
- tmgr_trace_t state_trace,
- double metric_peak,
- tmgr_trace_t metric_trace);
- ~ResourceLmm() {
- };
- lmm_constraint_t p_constraint;
- tmgr_trace_event_t p_stateEvent;
- s_surf_metric_t p_power;
-};
+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 *
**********/
-class Action {
-public:
- Action();
- Action(ModelPtr model, double cost, bool failed);
- virtual ~Action();
-
- s_xbt_swag_hookup_t p_stateHookup;
-
- e_surf_action_state_t getState(); /**< get the state*/
- virtual void setState(e_surf_action_state_t state); /**< Change state*/
- double getStartTime(); /**< Return the start time of an action */
- double getFinishTime(); /**< Return the finish time of an action */
- void setData(void* data);
-
- void ref();
- virtual int unref(); /**< Specify that we don't use that action anymore. Returns true if the action was destroyed and false if someone still has references on it. */
- virtual void cancel(); /**< Cancel a running action */
- virtual void recycle(); /**< Recycle an action */
-
- virtual void suspend()=0; /**< Suspend an action */
- virtual void resume()=0; /**< Resume a suspended action */
- virtual bool isSuspended()=0; /**< Return whether an action is suspended */
- virtual void setMaxDuration(double duration)=0; /**< Set the max duration of an action*/
- virtual void setPriority(double priority)=0; /**< Set the priority of an action */
-#ifdef HAVE_TRACING
- void setCategory(const char *category); /**< Set the category of an action */
-#endif
- virtual double getRemains(); /**< Get the remains of an action */
-#ifdef HAVE_LATENCY_BOUND_TRACKING
- int getLatencyLimited(); /**< Return 1 if action is limited by latency, 0 otherwise */
-#endif
-
- xbt_swag_t p_stateSet;
-
- double m_priority; /**< priority (1.0 by default) */
- double m_bound; /**< the capping of the CPU use */
- bool m_failed;
- double m_start; /**< start time */
- double m_finish; /**< finish time : this is modified during the run and fluctuates until the task is completed */
- double m_remains; /**< How much of that cost remains to be done in the currently running task */
- #ifdef HAVE_LATENCY_BOUND_TRACKING
- int m_latencyLimited; /**< Set to 1 if is limited by latency, 0 otherwise */
- #endif
- double m_maxDuration; /*< max_duration (may fluctuate until the task is completed) */
- char *p_category; /**< tracing category for categorized resource utilization monitoring */
- int m_cost;
- void *p_data; /**< for your convenience */
-protected:
- ModelPtr p_model;
- int m_refcount;
-#ifdef HAVE_TRACING
-#endif
-
-private:
- int resourceUsed(void *resource_id);
- /* Share the resources to the actions and return in how much time
- the next action may terminate */
- double shareResources(double now);
- /* Update the actions' state */
- void updateActionsState(double now, double delta);
- void updateResourceState(void *id, tmgr_trace_event_t event_type,
- double value, double time);
-
- xbt_swag_t p_modifiedSet;
- xbt_heap_t p_actionHeap;
- int m_selectiveUpdate;
-};
-
-//FIXME:REMOVE
-void surf_action_lmm_update_index_heap(void *action, int i);
-
-class ActionLmm: virtual public Action {
-public:
- ActionLmm() : m_suspended(false) {
- p_actionListHookup.prev = 0;
- p_actionListHookup.next = 0;
- m_lastUpdate = 0;
- m_lastValue = 0;
- };
- ActionLmm(ModelPtr /*model*/, double /*cost*/, bool /*failed*/) : m_suspended(false) {
- p_actionListHookup.prev = 0;
- p_actionListHookup.next = 0;
- m_lastUpdate = 0;
- m_lastValue = 0;
- };
-
- virtual void updateRemainingLazy(double now);
- void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
- void heapRemove(xbt_heap_t heap);
- double getRemains(); /**< Get the remains of an action */
- void updateIndexHeap(int i);
-
- virtual int unref();
- void cancel();
- void suspend();
- void resume();
- bool isSuspended();
- void setMaxDuration(double duration);
- void setPriority(double priority);
- void gapRemove();
-
- lmm_variable_t p_variable;
- s_xbt_swag_hookup_t p_actionListHookup;
- int m_indexHeap;
- double m_lastUpdate;
- double m_lastValue;
- enum heap_action_type m_hat;
- int m_suspended;
-};
-
#endif /* SURF_MODEL_H_ */
