X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f3e4803befab19389587dd1d9af5ecdeffec551e..5c979a2a19b47295bc467cfda3c6541f60b6fe13:/src/surf/surf_interface.hpp diff --git a/src/surf/surf_interface.hpp b/src/surf/surf_interface.hpp index e8aa31d182..c49574de4f 100644 --- a/src/surf/surf_interface.hpp +++ b/src/surf/surf_interface.hpp @@ -1,5 +1,4 @@ -/* Copyright (c) 2004-2014. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2016. 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. */ @@ -11,6 +10,8 @@ #include #include #include +#include + #include #include #include "surf/trace_mgr.h" @@ -18,65 +19,83 @@ #include "surf/surf_routing.h" #include "simgrid/platf_interface.h" #include "surf/surf.h" -#include "surf/surf_private.h" -#include "internal_config.h" +#include "src/surf/surf_private.h" +#include "src/internal_config.h" #ifdef LIBSIGC #include -#define surf_callback(arg1, ...) sigc::signal -#define surf_callback_connect(callback, fun_ptr) callback.connect(sigc::ptr_fun(fun_ptr)) -#define surf_callback_emit(callback, ...) callback.emit(__VA_ARGS__) +namespace simgrid { +namespace surf { + // Wraps sigc++ signals with the interface of boost::signals2: + template class signal; + template + class signal { + private: + sigc::signal sig_; + public: + template XBT_ALWAYS_INLINE + void connect(T&& slot) + { + sig_.connect(std::forward(slot)); + } + template XBT_ALWAYS_INLINE + void connect(Res(*slot)(Args...)) + { + sig_.connect(sigc::ptr_fun(slot)); + } + template + R operator()(Args&&... args) const + { + return sig_.emit(std::forward(args)...); + } + }; +} +} #else #include -#define surf_callback(arg1, ...) boost::signals2::signal -#define surf_callback_connect(callback, fun_ptr) callback.connect(fun_ptr) -#define surf_callback_emit(callback, ...) callback(__VA_ARGS__) +namespace simgrid { +namespace surf { + template + using signal = ::boost::signals2::signal; +} +} #endif -extern tmgr_history_t history; +extern XBT_PRIVATE tmgr_history_t history; #define NO_MAX_DURATION -1.0 -using namespace std; - /********* * 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; +extern XBT_PRIVATE double sg_tcp_gamma; +extern XBT_PRIVATE double sg_sender_gap; +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 double sg_sender_gap; +extern XBT_PRIVATE double sg_sender_gap; + +namespace simgrid { +namespace surf { + +extern XBT_PRIVATE simgrid::surf::signal surfExitCallbacks; -extern surf_callback(void, void) surfExitCallbacks; +} +} -int __surf_is_absolute_file_path(const char *file_path); +int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path); /*********** * Classes * ***********/ -typedef boost::intrusive::list ActionList; -typedef ActionList* ActionListPtr; -typedef boost::intrusive::list_base_hook<> actionHook; - -struct lmmTag; -typedef boost::intrusive::list > > > ActionLmmList; -typedef ActionLmmList* ActionLmmListPtr; -typedef boost::intrusive::list_base_hook > actionLmmHook; - enum heap_action_type{ LATENCY = 100, @@ -96,287 +115,33 @@ 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; -/********* - * Model * - *********/ -XBT_PUBLIC_DATA(xbt_dynar_t) model_list; - -/** @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_CLASS Model { -public: - /** @brief Constructor */ - Model(); - /** @brief Destructor */ - virtual ~Model(); - - virtual void addTraces() =0; - - /** - * @brief Get the set of [actions](@ref Action) in *ready* state - * - * @return The set of [actions](@ref Action) in *ready* state - */ - virtual ActionListPtr getReadyActionSet() {return p_readyActionSet;} - - /** - * @brief Get the set of [actions](@ref Action) in *running* state - * - * @return The set of [actions](@ref Action) in *running* state - */ - virtual ActionListPtr getRunningActionSet() {return p_runningActionSet;} - - /** - * @brief Get the set of [actions](@ref Action) in *failed* state - * - * @return The set of [actions](@ref Action) in *failed* state - */ - virtual ActionListPtr getFailedActionSet() {return p_failedActionSet;} - - /** - * @brief Get the set of [actions](@ref Action) in *done* state - * - * @return The set of [actions](@ref Action) in *done* state - */ - virtual ActionListPtr getDoneActionSet() {return p_doneActionSet;} - - /** - * @brief Get the set of modified [actions](@ref Action) - * - * @return The set of modified [actions](@ref Action) - */ - virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;} - - /** - * @brief Get the maxmin system of the current Model - * - * @return 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 - * - * @return [description] - */ - e_UM_t getUpdateMechanism() {return p_updateMechanism;} - - /** - * @brief Get Action heap - * @details [TODO] - * - * @return The Action heap - */ - xbt_heap_t getActionHeap() {return p_actionHeap;} - - /** - * @brief share the resources - * @details 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 shareResources(double now); - virtual double shareResourcesLazy(double now); - virtual double shareResourcesFull(double now); - double shareResourcesMaxMin(ActionListPtr running_actions, - lmm_system_t sys, - void (*solve) (lmm_system_t)); - - /** - * @brief Update state of actions - * @details 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 shareResourcesIsIdempotent()=0; - -protected: - ActionLmmListPtr p_modifiedSet; - lmm_system_t p_maxminSystem; - e_UM_t p_updateMechanism; - int m_selectiveUpdate; - xbt_heap_t p_actionHeap; - -private: - ActionListPtr p_readyActionSet; /**< Actions in state SURF_ACTION_READY */ - ActionListPtr p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */ - ActionListPtr p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */ - ActionListPtr p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */ -}; - -/************ - * Resource * - ************/ - -/** @ingroup SURF_interface - * @brief Resource which have a metric handled by a maxmin system - */ -typedef struct { - double scale; /**< The scale of the metric */ - double peak; /**< The peak of the metric */ - tmgr_trace_event_t event; /**< The associated trace event associated to the metric */ -} s_surf_metric_t; - -/** @ingroup SURF_interface - * @brief SURF resource interface class - * @details A resource represent an element of a component (e.g.: a link for the network) - */ -XBT_PUBLIC_CLASS Resource { -public: - /** - * @brief Resource constructor - */ - Resource(); - - /** - * @brief Resource constructor - * - * @param model Model associated to this Resource - * @param name The name of the Resource - * @param props Dictionary of properties associated to this Resource - */ - Resource(Model *model, const char *name, xbt_dict_t props); - - /** - * @brief Resource constructor - * - * @param model Model associated to this Resource - * @param name The name of the Resource - * @param props Dictionary of properties associated to this Resource - * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component - */ - Resource(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint); - /** - * @brief Resource constructor - * - * @param model Model associated to this Resource - * @param name The name of the Resource - * @param props Dictionary of properties associated to this Resource - * @param stateInit the initial state of the Resource - */ - Resource(Model *model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit); - - /** - * @brief Resource destructor - */ - virtual ~Resource(); - - /** - * @brief Get the Model of the current Resource - * - * @return The Model of the current Resource - */ - Model *getModel(); - - /** - * @brief Get the name of the current Resource - * - * @return The name of the current Resource - */ - const char *getName(); - - /** - * @brief Get the properties of the current Resource - * - * @return The properties of the current Resource - */ - virtual xbt_dict_t getProperties(); - - /** - * @brief Update the state of the current Resource - * @details [TODO] - * - * @param event_type [TODO] - * @param value [TODO] - * @param date [TODO] - */ - virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0; - - /** - * @brief Check if the current Resource is used - * @return true if the current Resource is used, false otherwise - */ - virtual bool isUsed()=0; - - /** - * @brief Check if the current Resource is active - * - * @return true if the current Resource is active, false otherwise - */ - bool isOn(); - - /** - * @brief Turn on the current Resource - */ - void turnOn(); - - /** - * @brief Turn off the current Resource - */ - void turnOff(); - - /** - * @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource - * - * @return The state of the currenrt Resource - */ - virtual e_surf_resource_state_t getState(); - - /** - * @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource - * - * @param state The new state of the current Resource - */ - virtual void setState(e_surf_resource_state_t state); - -private: - const char *p_name; - xbt_dict_t p_properties; - Model *p_model; - bool m_running; - e_surf_resource_state_t m_stateCurrent; - - /* LMM */ -public: - /** - * @brief Get the lmm constraint associated to this Resource if it is part of a LMM component - * - * @return The lmm constraint associated to this Resource - */ - lmm_constraint_t getConstraint(); -private: - lmm_constraint_t p_constraint; -}; - /********** * Action * **********/ -void surf_action_lmm_update_index_heap(void *action, int i); + +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 { /** @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) */ -XBT_PUBLIC_CLASS Action : public actionHook, public actionLmmHook { +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 ActionList; private: /** * @brief Common initializations for the constructors */ - void initialize(Model *model, double cost, bool failed, + void initialize(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var = NULL); public: @@ -387,7 +152,7 @@ public: * @param cost The cost of the Action * @param failed If the action is impossible (e.g.: execute something on a switched off host) */ - Action(Model *model, double cost, bool failed); + Action(simgrid::surf::Model *model, double cost, bool failed); /** * @brief Action constructor @@ -397,7 +162,7 @@ public: * @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(Model *model, double cost, bool failed, lmm_variable_t var); + Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var); /** @brief Destructor */ virtual ~Action(); @@ -482,36 +247,31 @@ public: /** @brief Set the priority of the current Action */ virtual void setPriority(double priority); - /** - * @brief Get the state set in which the action is - * - * @return The state set in which the action is - */ - ActionListPtr getStateSet() {return p_stateSet;}; + /** @brief Get the state set in which the action is */ + ActionList* getStateSet() {return p_stateSet;}; - s_xbt_swag_hookup_t p_stateHookup; + s_xbt_swag_hookup_t p_stateHookup = {NULL,NULL}; - Model *getModel() {return p_model;} + simgrid::surf::Model *getModel() {return p_model;} protected: - ActionListPtr p_stateSet; - double m_priority; /**< priority (1.0 by default) */ - int m_refcount; + 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; /*< max_duration (may fluctuate until the task is completed) */ - double m_finish; /**< finish time : this is modified during the run and fluctuates until the task is completed */ + 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: - bool m_failed; double m_start; /**< start time */ - char *p_category; /**< tracing category for categorized resource utilization monitoring */ + 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; - Model *p_model; - void *p_data; /**< for your convenience */ + simgrid::surf::Model *p_model; + void *p_data = NULL; /**< for your convenience */ /* LMM */ public: @@ -524,16 +284,207 @@ public: double getLastUpdate() {return m_lastUpdate;} void refreshLastUpdate() {m_lastUpdate = surf_get_clock();} enum heap_action_type getHat() {return m_hat;} - bool is_linked() {return actionLmmHook::is_linked();} + bool is_linked() {return action_lmm_hook.is_linked();} void gapRemove(); protected: lmm_variable_t p_variable; - double m_lastValue; - double m_lastUpdate; - int m_suspended; + double m_lastValue = 0; + double m_lastUpdate = 0; + int m_suspended = 0; int m_indexHeap; - enum heap_action_type m_hat; + 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 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_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 shareResources(double now); + virtual double shareResourcesLazy(double now); + virtual double shareResourcesFull(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 shareResourcesIsIdempotent()=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 + */ +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_event_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) + */ +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] + * @param date [TODO] + */ + virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0; + + /** @brief Check if the current Resource is used (if it currently serves an action) */ + virtual bool isUsed()=0; + + /** @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(); + +private: + const char *p_name; + Model *p_model; + bool m_isOn; + +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; +}; + +} +} + #endif /* SURF_MODEL_H_ */