-//using namespace generic;
+/* 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 <xbt.h>
#include <string>
#include <vector>
-#include <iostream>
#include <memory>
-#include <boost/function.hpp>
-#include "surf/trace_mgr.h"
+#include <utility>
+
+#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 "surf/surf_private.h"
+#include "src/surf/surf_private.h"
+#include "src/internal_config.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;
+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;
-XBT_PUBLIC(int) SURF_CPU_LEVEL; //Surf cpu level
+extern XBT_PRIVATE double sg_sender_gap;
+
+namespace simgrid {
+namespace surf {
-int __surf_is_absolute_file_path(const char *file_path);
+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 *
***********/
-//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,
*********/
/* 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 *
+ **********/
-/*********
- * Model *
- *********/
-XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
+XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
-class Model {
+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:
- Model(string name);
- virtual ~Model();
+ 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;
+
+ 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 ? */
+ };
- //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);
+private:
+ /**
+ * @brief Common initializations for the constructors
+ */
+ void initialize(simgrid::surf::Model *model, double cost, bool failed,
+ lmm_variable_t var = NULL);
- string getName() {return m_name;};
+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();
- void addTurnedOnCallback(ResourceCallback rc);
- void notifyResourceTurnedOn(ResourcePtr r);
+ /** @brief Mark that the action is now finished */
+ void finish();
- void addTurnedOffCallback(ResourceCallback rc);
- void notifyResourceTurnedOff(ResourcePtr r);
+ /** @brief Get the [state](\ref e_surf_action_state_t) of the current Action */
+ Action::State getState(); /**< get the state*/
+ /** @brief Set the [state](\ref e_surf_action_state_t) of the current Action */
+ virtual void setState(Action::State state);
- void addActionCancelCallback(ActionCallback ac);
- void notifyActionCancel(ActionPtr a);
- void addActionResumeCallback(ActionCallback ac);
- void notifyActionResume(ActionPtr a);
- void addActionSuspendCallback(ActionCallback ac);
- void notifyActionSuspend(ActionPtr a);
+ /** @brief Get the bound of the current Action */
+ double getBound();
+ /** @brief Set the bound of the current Action */
+ void setBound(double bound);
- lmm_system_t p_maxminSystem;
- e_UM_t p_updateMechanism;
- xbt_swag_t p_modifiedSet;
- xbt_heap_t p_actionHeap;
- int m_selectiveUpdate;
+ /** @brief Get the start time of the current action */
+ double getStartTime();
+ /** @brief Get the finish time of the current action */
+ double getFinishTime();
- 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;
+ /** @brief Get the user data associated to the current action */
+ void *getData() {return data_;}
+ /** @brief Set the user data associated to the current action */
+ void setData(void* data);
-protected:
- std::vector<ActionPtr> m_failedActions, m_runningActions;
+ /** @brief Get the cost of the current action */
+ double getCost() {return cost_;}
+ /** @brief Set the cost of the current action */
+ void setCost(double cost) {cost_ = cost;}
-private:
- ResourceCallback m_resOnCB, m_resOffCB;
- ActionCallback m_actCancelCB, m_actSuspendCB, m_actResumeCB;
-};
+ /** @brief Update the maximum duration of the current action
+ * @param delta Amount to remove from the MaxDuration */
+ void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
-/************
- * Resource *
- ************/
+ /** @brief Update the remaining time of the current action
+ * @param delta Amount to remove from the remaining time */
+ void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
-/**
- * Resource which have a metric handled by a maxmin system
- */
-typedef struct {
- double scale;
- double peak;
- tmgr_trace_event_t event;
-} s_surf_metric_t;
+ /** @brief Set the remaining time of the current action */
+ 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();
-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);
- };
+ /** @brief Set the finish time of the current action */
+ void setFinishTime(double value) {finishTime_ = value;}
- virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
+ /**@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();
- //private
- virtual bool isUsed()=0;
- //FIXME:updateActionState();
- //FIXME:updateResourceState();
- //FIXME:finilize();
-
- bool isOn();
- void turnOn();
- void turnOff();
- void setName(string name);
- const char *getName();
- virtual xbt_dict_t getProperties();
-
- 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;
+ /** @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 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 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 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 stateSet_;};
+
+ s_xbt_swag_hookup_t stateHookup_ = {NULL,NULL};
+
+ simgrid::surf::Model *getModel() {return model_;}
protected:
+ 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:
- bool m_running;
-};
+ double start_; /**< start time */
+ char *category_ = NULL; /**< tracing category for categorized resource utilization monitoring */
+
+ double cost_;
+ simgrid::surf::Model *model_;
+ void *data_ = NULL; /**< for your convenience */
-class ResourceLmm: virtual public Resource {
+ /* LMM */
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;
+ 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 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 variable_ = nullptr;
+ double lastValue_ = 0;
+ double lastUpdate_ = 0;
+ int suspended_ = 0;
+ int indexHeap_;
+ enum heap_action_type hat_ = NOTSET;
};
-/**********
- * Action *
- **********/
+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;
-class Action {
+/*********
+ * 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:
- Action();
- Action(ModelPtr model, double cost, bool failed);
- virtual ~Action();
-
- s_xbt_swag_hookup_t p_stateHookup;
+ Model();
+ virtual ~Model();
- 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);
+ /** @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 *running* state */
+ virtual ActionList* getRunningActionSet() {return 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 *done* state */
+ virtual ActionList* getDoneActionSet() {return doneActionSet_;}
+
+ /** @brief Get the set of modified [actions](@ref Action) */
+ virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
+
+ /** @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
+ */
+ e_UM_t getUpdateMechanism() {return updateMechanism_;}
+
+ /** @brief Get Action heap */
+ xbt_heap_t getActionHeap() {return 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;
- 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
+ ActionLmmListPtr modifiedSet_;
+ lmm_system_t maxminSystem_ = nullptr;
+ e_UM_t updateMechanism_ = UM_UNDEFINED;
+ int selectiveUpdate_;
+ xbt_heap_t actionHeap_;
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;
+ 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 */
};
-//FIXME:REMOVE
-void surf_action_lmm_update_index_heap(void *action, int i);
+}
+}
+
+/************
+ * 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_iterator_t event; /**< The associated trace event associated to the metric */
+} s_surf_metric_t;
-class ActionLmm: virtual public Action {
+namespace simgrid {
+namespace surf {
+
+/** @ingroup SURF_interface
+ * @brief SURF resource interface class
+ * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
+ */
+XBT_PUBLIC_CLASS Resource {
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;
- };
+ /**
+ * @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);
+
+ virtual ~Resource();
+
+ /** @brief Get the Model of the current Resource */
+ Model *getModel() const;
+
+ /** @brief Get the name of the current Resource */
+ const char *getName() const;
+
+ bool operator==(const Resource &other) const;
+
+ /**
+ * @brief Apply an event of external load event to that resource
+ *
+ * @param event What happened
+ * @param value [TODO]
+ */
+ virtual void apply_event(tmgr_trace_iterator_t event, double value)=0;
+
+ /** @brief Check if the current Resource is used (if it currently serves an action) */
+ virtual bool isUsed()=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);
+ /** @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();
- virtual int unref();
- void cancel();
- void suspend();
- void resume();
- bool isSuspended();
- void setMaxDuration(double duration);
- void setPriority(double priority);
- void gapRemove();
+private:
+ const char *name_;
+ Model *model_;
+ bool isOn_ = true;
- 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;
+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_ */
