1 /* Copyright (c) 2004-2016. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "xbt/signal.hpp"
11 #include "src/surf/surf_private.h"
12 #include "surf/surf.h"
15 #include <boost/intrusive/list.hpp>
17 #include <unordered_map>
19 #define NO_MAX_DURATION -1.0
25 /* user-visible parameters */
26 extern XBT_PRIVATE double sg_tcp_gamma;
27 extern XBT_PRIVATE double sg_sender_gap;
28 extern XBT_PRIVATE double sg_latency_factor;
29 extern XBT_PRIVATE double sg_bandwidth_factor;
30 extern XBT_PRIVATE double sg_weight_S_parameter;
31 extern XBT_PRIVATE int sg_network_crosstraffic;
32 extern XBT_PRIVATE std::vector<std::string> surf_path;
33 extern XBT_PRIVATE std::unordered_map<std::string, tmgr_trace_t> traces_set_list;
36 XBT_PUBLIC(double) surf_get_clock();
38 /** \ingroup SURF_simulation
39 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
41 XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
44 extern XBT_PRIVATE double sg_sender_gap;
49 extern XBT_PRIVATE simgrid::xbt::signal<void()> surfExitCallbacks;
53 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
59 enum heap_action_type{
70 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
72 /** \ingroup SURF_models
73 * \brief List of initialized models
75 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
80 /** @ingroup SURF_interface
81 * @brief SURF action interface class
82 * @details An action is an event generated by a resource (e.g.: a communication for the network)
84 XBT_PUBLIC_CLASS Action {
86 boost::intrusive::list_member_hook<> action_hook;
87 boost::intrusive::list_member_hook<> action_lmm_hook;
88 typedef boost::intrusive::member_hook<
89 Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
90 typedef boost::intrusive::list<Action, ActionOptions> ActionList;
93 ready = 0, /**< Ready */
94 running, /**< Running */
95 failed, /**< Task Failure */
96 done, /**< Completed */
97 to_free, /**< Action to free in next cleanup */
98 not_in_the_system /**< Not in the system anymore. Why did you ask ? */
102 * @brief Action constructor
104 * @param model The Model associated to this Action
105 * @param cost The cost of the Action
106 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
108 Action(simgrid::surf::Model *model, double cost, bool failed);
111 * @brief Action constructor
113 * @param model The Model associated to this Action
114 * @param cost The cost of the Action
115 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
116 * @param var The lmm variable associated to this Action if it is part of a LMM component
118 Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
120 /** @brief Destructor */
123 /** @brief Mark that the action is now finished */
126 /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
127 Action::State getState(); /**< get the state*/
128 /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
129 virtual void setState(Action::State state);
131 /** @brief Get the bound of the current Action */
133 /** @brief Set the bound of the current Action */
134 void setBound(double bound);
136 /** @brief Get the start time of the current action */
137 double getStartTime();
138 /** @brief Get the finish time of the current action */
139 double getFinishTime();
141 /** @brief Get the user data associated to the current action */
142 void *getData() {return data_;}
143 /** @brief Set the user data associated to the current action */
144 void setData(void* data);
146 /** @brief Get the cost of the current action */
147 double getCost() {return cost_;}
148 /** @brief Set the cost of the current action */
149 void setCost(double cost) {cost_ = cost;}
151 /** @brief Update the maximum duration of the current action
152 * @param delta Amount to remove from the MaxDuration */
153 void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
155 /** @brief Update the remaining time of the current action
156 * @param delta Amount to remove from the remaining time */
157 void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
159 /** @brief Set the remaining time of the current action */
160 void setRemains(double value) {remains_ = value;}
161 /** @brief Get the remaining time of the current action after updating the resource */
162 virtual double getRemains();
163 /** @brief Get the remaining time of the current action without updating the resource */
164 double getRemainsNoUpdate();
166 /** @brief Set the finish time of the current action */
167 void setFinishTime(double value) {finishTime_ = value;}
169 /**@brief Add a reference to the current action (refcounting) */
171 /** @brief Unref that action (and destroy it if refcount reaches 0)
172 * @return true if the action was destroyed and false if someone still has references on it
176 /** @brief Cancel the current Action if running */
177 virtual void cancel();
179 /** @brief Suspend the current Action */
180 virtual void suspend();
182 /** @brief Resume the current Action */
183 virtual void resume();
185 /** @brief Returns true if the current action is running */
186 virtual bool isSuspended();
188 /** @brief Get the maximum duration of the current action */
189 double getMaxDuration() {return maxDuration_;}
190 /** @brief Set the maximum duration of the current Action */
191 virtual void setMaxDuration(double duration);
193 /** @brief Get the tracing category associated to the current action */
194 char *getCategory() {return category_;}
195 /** @brief Set the tracing category of the current Action */
196 void setCategory(const char *category);
198 /** @brief Get the priority of the current Action */
199 double getPriority() { return sharingWeight_; };
200 /** @brief Set the priority of the current Action */
201 virtual void setSharingWeight(double priority);
203 /** @brief Get the state set in which the action is */
204 ActionList* getStateSet() {return stateSet_;};
206 s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
208 simgrid::surf::Model* getModel() { return model_; }
211 ActionList* stateSet_;
212 double sharingWeight_ = 1.0; /**< priority (1.0 by default) */
214 double remains_; /**< How much of that cost remains to be done in the currently running task */
215 double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
216 double finishTime_ = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
219 double start_; /**< start time */
220 char *category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
223 simgrid::surf::Model *model_;
224 void *data_ = nullptr; /**< for your convenience */
228 virtual void updateRemainingLazy(double now);
229 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
230 void heapRemove(xbt_heap_t heap);
231 void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
232 virtual void updateIndexHeap(int i);
233 lmm_variable_t getVariable() {return variable_;}
234 double getLastUpdate() {return lastUpdate_;}
235 void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
236 enum heap_action_type getHat() {return hat_;}
237 bool is_linked() {return action_lmm_hook.is_linked();}
240 lmm_variable_t variable_ = nullptr;
241 double lastValue_ = 0;
242 double lastUpdate_ = 0;
245 enum heap_action_type hat_ = NOTSET;
248 typedef Action::ActionList ActionList;
250 typedef boost::intrusive::member_hook<
251 Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
252 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
253 typedef ActionLmmList* ActionLmmListPtr;
259 /** @ingroup SURF_interface
260 * @brief SURF model interface class
261 * @details A model is an object which handle the interactions between its Resources and its Actions
263 XBT_PUBLIC_CLASS Model {
268 /** @brief Get the set of [actions](@ref Action) in *ready* state */
269 virtual ActionList* getReadyActionSet() {return readyActionSet_;}
271 /** @brief Get the set of [actions](@ref Action) in *running* state */
272 virtual ActionList* getRunningActionSet() {return runningActionSet_;}
274 /** @brief Get the set of [actions](@ref Action) in *failed* state */
275 virtual ActionList* getFailedActionSet() {return failedActionSet_;}
277 /** @brief Get the set of [actions](@ref Action) in *done* state */
278 virtual ActionList* getDoneActionSet() {return doneActionSet_;}
280 /** @brief Get the set of modified [actions](@ref Action) */
281 virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
283 /** @brief Get the maxmin system of the current Model */
284 lmm_system_t getMaxminSystem() {return maxminSystem_;}
287 * @brief Get the update mechanism of the current Model
290 e_UM_t getUpdateMechanism() {return updateMechanism_;}
292 /** @brief Get Action heap */
293 xbt_heap_t getActionHeap() {return actionHeap_;}
296 * @brief Share the resources between the actions
298 * @param now The current time of the simulation
299 * @return The delta of time till the next action will finish
301 virtual double nextOccuringEvent(double now);
302 virtual double nextOccuringEventLazy(double now);
303 virtual double nextOccuringEventFull(double now);
306 * @brief Update action to the current time
308 * @param now The current time of the simulation
309 * @param delta The delta of time since the last update
311 virtual void updateActionsState(double now, double delta);
312 virtual void updateActionsStateLazy(double now, double delta);
313 virtual void updateActionsStateFull(double now, double delta);
315 /** @brief Returns whether this model have an idempotent shareResource()
317 * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
318 * so we need to call it only when the next timestamp of other sources is computed.
320 virtual bool nextOccuringEventIsIdempotent() { return true;}
323 ActionLmmListPtr modifiedSet_;
324 lmm_system_t maxminSystem_ = nullptr;
325 e_UM_t updateMechanism_ = UM_UNDEFINED;
326 bool selectiveUpdate_;
327 xbt_heap_t actionHeap_;
330 ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
331 ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
332 ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
333 ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
343 /** @ingroup SURF_interface
344 * @brief Resource which have a metric handled by a maxmin system
347 double peak; /**< The peak of the metric, ie its max value */
348 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
349 tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
355 /** @ingroup SURF_interface
356 * @brief SURF resource interface class
357 * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
359 XBT_PUBLIC_CLASS Resource {
362 * @brief Constructor of LMM Resources
364 * @param model Model associated to this Resource
365 * @param name The name of the Resource
366 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
368 Resource(Model *model, const char *name, lmm_constraint_t constraint);
372 /** @brief Get the Model of the current Resource */
373 Model* model() const;
375 /** @brief Get the name of the current Resource */
376 const char* cname() const;
378 bool operator==(const Resource &other) const;
381 * @brief Apply an event of external load event to that resource
383 * @param event What happened
384 * @param value [TODO]
386 virtual void apply_event(tmgr_trace_event_t event, double value) = 0;
388 /** @brief Check if the current Resource is used (if it currently serves an action) */
389 virtual bool isUsed()=0;
391 /** @brief Check if the current Resource is active */
392 virtual bool isOn() const;
393 /** @brief Check if the current Resource is shut down */
394 virtual bool isOff() const;
395 /** @brief Turn on the current Resource */
396 virtual void turnOn();
397 /** @brief Turn off the current Resource */
398 virtual void turnOff();
406 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
407 lmm_constraint_t constraint() const;
410 const lmm_constraint_t constraint_ = nullptr;
418 struct hash<simgrid::surf::Resource>
420 std::size_t operator()(const simgrid::surf::Resource& r) const
422 return (std::size_t) xbt_str_hash(r.cname());
427 #endif /* SURF_MODEL_H_ */