-/* Copyright (c) 2004-2015. 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. */
#ifndef SURF_MODEL_H_
#define SURF_MODEL_H_
+#include <cstddef>
+
#include <xbt.h>
-#include <string>
-#include <vector>
#include <memory>
-#include <boost/function.hpp>
+#include <utility>
+
#include <boost/intrusive/list.hpp>
-#include "surf/trace_mgr.h"
+
+#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"
-#ifdef LIBSIGC
-#include <sigc++/sigc++.h>
-#define surf_callback(arg1, ...) sigc::signal<arg1,__VA_ARGS__>
-#define surf_callback_connect(callback, fun_ptr) callback.connect(sigc::ptr_fun(fun_ptr))
-#define surf_callback_emit(callback, ...) callback.emit(__VA_ARGS__)
-#else
-#include <boost/signals2.hpp>
-#define surf_callback(arg1, ...) boost::signals2::signal<arg1(__VA_ARGS__)>
-#define surf_callback_connect(callback, fun_ptr) callback.connect(fun_ptr)
-#define surf_callback_emit(callback, ...) callback(__VA_ARGS__)
-#endif
-
-#ifdef _MSC_VER
-#pragma warning( disable : 4251)
-// 4251: needs to have dll-interface to be used by clients of class
-#endif
-
-extern XBT_PRIVATE tmgr_history_t history;
#define NO_MAX_DURATION -1.0
-using namespace std;
-
/*********
* Utils *
*********/
extern XBT_PRIVATE double sg_sender_gap;
-extern XBT_PRIVATE surf_callback(void, void) surfExitCallbacks;
+namespace simgrid {
+namespace surf {
+
+extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
+
+}
+}
int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
+static inline char* sg_storage_name(sg_storage_t storage) {
+ return storage->key;
+}
+
/***********
* Classes *
***********/
*********/
/* 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;
/**********
* 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 {
+
/** @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)
typedef boost::intrusive::member_hook<
Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
typedef boost::intrusive::list<Action, ActionOptions> ActionList;
+
+ enum class State {
+ ready = 0, /**< Ready */
+ running, /**< Running */
+ failed, /**< Task Failure */
+ done, /**< Completed */
+ to_free, /**< Action to free in next cleanup */
+ not_in_the_system /**< Not in the system anymore. Why did you ask ? */
+ };
+
private:
/**
* @brief Common initializations for the constructors
*/
- void initialize(Model *model, double cost, bool failed,
- lmm_variable_t var = NULL);
+ void initialize(simgrid::surf::Model *model, double cost, bool failed,
+ lmm_variable_t var = nullptr);
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
* @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();
/** @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 [state](\ref simgrid::surf::Action::State) of the current Action */
+ Action::State getState(); /**< get the state*/
+ /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
+ virtual void setState(Action::State state);
/** @brief Get the bound of the current Action */
double getBound();
double getFinishTime();
/** @brief Get the user data associated to the current action */
- void *getData() {return p_data;}
+ void *getData() {return 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;}
+ double getCost() {return cost_;}
/** @brief Set the cost of the current action */
- void setCost(double cost) {m_cost = cost;}
+ void setCost(double cost) {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);}
+ void updateMaxDuration(double delta) {double_update(&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);}
+ void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
/** @brief Set the remaining time of the current action */
- void setRemains(double value) {m_remains = value;}
+ void setRemains(double value) {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;}
+ void setFinishTime(double value) {finishTime_ = value;}
/**@brief Add a reference to the current action (refcounting) */
void ref();
virtual bool isSuspended();
/** @brief Get the maximum duration of the current action */
- double getMaxDuration() {return m_maxDuration;}
+ double getMaxDuration() {return 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;}
+ char *getCategory() {return 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;};
+ double getPriority() {return 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;};
+ ActionList* getStateSet() {return stateSet_;};
- s_xbt_swag_hookup_t p_stateHookup;
+ s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
- Model *getModel() {return p_model;}
+ simgrid::surf::Model *getModel() {return model_;}
protected:
- ActionList* p_stateSet;
- double m_priority; /**< priority (1.0 by default) */
- int m_refcount;
- 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 */
+ ActionList* stateSet_;
+ double priority_ = 1.0; /**< priority (1.0 by default) */
+ int refcount_ = 1;
+ double remains_; /**< How much of that cost remains to be done in the currently running task */
+ double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
+ double finishTime_ = -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; /**< tracing category for categorized resource utilization monitoring */
+ double start_; /**< start time */
+ char *category_ = nullptr; /**< 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 */
+ double cost_;
+ simgrid::surf::Model *model_;
+ void *data_ = nullptr; /**< for your convenience */
/* LMM */
public:
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;}
+ lmm_variable_t getVariable() {return variable_;}
+ double getLastUpdate() {return lastUpdate_;}
+ void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
+ enum heap_action_type getHat() {return hat_;}
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;
- int m_indexHeap;
- enum heap_action_type m_hat;
+ lmm_variable_t variable_ = nullptr;
+ double lastValue_ = 0;
+ double lastUpdate_ = 0;
+ int suspended_ = 0;
+ int indexHeap_;
+ enum heap_action_type hat_ = NOTSET;
};
typedef Action::ActionList ActionList;
/*********
* Model *
*********/
-XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
/** @ingroup SURF_interface
* @brief SURF model interface class
*/
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 */
+ virtual ActionList* getReadyActionSet() {return readyActionSet_;}
- /**
- * @brief Get the set of [actions](@ref Action) in *ready* state
- *
- * @return 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 runningActionSet_;}
- /**
- * @brief Get the set of [actions](@ref Action) in *running* state
- *
- * @return 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 failedActionSet_;}
- /**
- * @brief Get the set of [actions](@ref Action) in *failed* state
- *
- * @return 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
- *
- * @return The set of [actions](@ref Action) in *done* state
- */
- virtual ActionList* getDoneActionSet() {return p_doneActionSet;}
+ /** @brief Get the set of [actions](@ref Action) in *done* state */
+ virtual ActionList* getDoneActionSet() {return 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 set of modified [actions](@ref Action) */
+ virtual ActionLmmListPtr getModifiedSet() {return 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 maxmin system of the current Model */
+ lmm_system_t getMaxminSystem() {return maxminSystem_;}
/**
* @brief Get the update mechanism of the current Model
* @see e_UM_t
- *
- * @return [description]
*/
- e_UM_t getUpdateMechanism() {return p_updateMechanism;}
+ e_UM_t getUpdateMechanism() {return updateMechanism_;}
- /**
- * @brief Get Action heap
- * @details [TODO]
- *
- * @return The Action heap
- */
- xbt_heap_t getActionHeap() {return p_actionHeap;}
+ /** @brief Get Action heap */
+ xbt_heap_t getActionHeap() {return actionHeap_;}
/**
- * @brief share the resources
- * @details Share the resources between the actions
+ * @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);
+ 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));
+ lmm_system_t sys, void (*solve) (lmm_system_t));
/**
- * @brief Update state of actions
- * @details Update action to the current time
+ * @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
* 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;
+ virtual bool next_occuring_event_isIdempotent()=0;
protected:
- ActionLmmListPtr p_modifiedSet;
- lmm_system_t p_maxminSystem;
- e_UM_t p_updateMechanism = UM_UNDEFINED;
- int m_selectiveUpdate;
- xbt_heap_t p_actionHeap;
+ ActionLmmListPtr modifiedSet_;
+ lmm_system_t maxminSystem_ = nullptr;
+ e_UM_t updateMechanism_ = UM_UNDEFINED;
+ int selectiveUpdate_;
+ xbt_heap_t 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 */
+ ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
+ ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
+ ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
+ ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
};
+}
+}
+
/************
* Resource *
************/
* @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 */
+ 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)
+ * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
*/
XBT_PUBLIC_CLASS Resource {
public:
/**
- * @brief Resource constructor
- */
- Resource();
-
- /**
- * @brief Resource constructor
+ * @brief Constructor of non-LMM Resources
*
* @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);
+ Resource(Model *model, const char *name);
/**
- * @brief Resource constructor
+ * @brief Constructor of LMM Resources
*
* @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);
+ Resource(Model *model, const char *name, lmm_constraint_t constraint);
- /**
- * @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 Model of the current Resource */
+ Model *getModel() const;
- /**
- * @brief Get the name of the current Resource
- *
- * @return The name of the current Resource
- */
- const char *getName();
+ /** @brief Get the name of the current Resource */
+ const char *getName() const;
- /**
- * @brief Get the properties of the current Resource
- *
- * @return The properties of the current Resource
- */
- virtual xbt_dict_t getProperties();
+ bool operator==(const Resource &other) const;
/**
- * @brief Update the state of the current Resource
- * @details [TODO]
+ * @brief Apply an event of external load event to that resource
*
- * @param event_type [TODO]
+ * @param event What happened
* @param value [TODO]
- * @param date [TODO]
*/
- virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
+ virtual void apply_event(tmgr_trace_iterator_t event, double value)=0;
- /**
- * @brief Check if the current Resource is used
- * @return true if the current Resource is used, false otherwise
- */
+ /** @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
- *
- * @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);
+ /** @brief Check if the current Resource is active */
+ virtual bool isOn() const;
+ /** @brief Check if the current Resource is shut down */
+ virtual bool isOff() const;
+ /** @brief Turn on the current Resource */
+ virtual void turnOn();
+ /** @brief Turn off the current Resource */
+ virtual void turnOff();
private:
- const char *p_name;
- xbt_dict_t p_properties;
- Model *p_model;
- bool m_running;
- e_surf_resource_state_t m_stateCurrent;
+ const char *name_;
+ Model *model_;
+ bool isOn_ = true;
- /* 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;
+public: /* LMM */
+ /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
+ lmm_constraint_t getConstraint() const;
+protected:
+ lmm_constraint_t constraint_ = nullptr;
};
+}
+}
+
+namespace std {
+ template <>
+ struct hash<simgrid::surf::Resource>
+ {
+ std::size_t operator()(const simgrid::surf::Resource& r) const
+ {
+ return (std::size_t) xbt_str_hash(r.getName());
+ }
+ };
+}
+
#endif /* SURF_MODEL_H_ */
