-XBT_PUBLIC_DATA(std::vector<surf_model_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:
- 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 ? */
- };
-
-private:
- /**
- * @brief Common initializations for the constructors
- */
- void initialize(simgrid::surf::Model *model, double cost, bool failed,
- lmm_variable_t var = nullptr);
-
-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 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();
- /** @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 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 cost_;}
- /** @brief Set the cost of the current action */
- 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(&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(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
-
- /** @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();
-
- /** @brief Set the finish time of the current action */
- void setFinishTime(double value) {finishTime_ = 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 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_ = {nullptr,nullptr};
-
- 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:
- double start_; /**< start time */
- char *category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
-
- double cost_;
- simgrid::surf::Model *model_;
- void *data_ = nullptr; /**< 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 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;
-};
-
-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_CLASS Model {
-public:
- Model();
- virtual ~Model();
-
- /** @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 nextOccuringEvent(double now);
- virtual double nextOccuringEventLazy(double now);
- virtual double nextOccuringEventFull(double now);
-
- /**
- * @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 nextOccuringEventIsIdempotent() { return true;}
-
-protected:
- ActionLmmListPtr modifiedSet_;
- lmm_system_t maxminSystem_ = nullptr;
- e_UM_t updateMechanism_ = UM_UNDEFINED;
- bool selectiveUpdate_;
- xbt_heap_t actionHeap_;
-
-private:
- 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 *
- ************/
-
-/** @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;
-
-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:
- /**
- * @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;
-
- /** @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 *name_;
- Model *model_;
- bool isOn_ = true;
-
-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());
- }
- };
-}