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>
18 #define NO_MAX_DURATION -1.0
24 /* user-visible parameters */
25 extern XBT_PRIVATE double sg_tcp_gamma;
26 extern XBT_PRIVATE double sg_sender_gap;
27 extern XBT_PRIVATE double sg_latency_factor;
28 extern XBT_PRIVATE double sg_bandwidth_factor;
29 extern XBT_PRIVATE double sg_weight_S_parameter;
30 extern XBT_PRIVATE int sg_network_crosstraffic;
31 extern XBT_PRIVATE std::vector<std::string> surf_path;
34 XBT_PUBLIC(double) surf_get_clock();
36 /** \ingroup SURF_simulation
37 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
39 XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
42 extern XBT_PRIVATE double sg_sender_gap;
47 extern XBT_PRIVATE simgrid::xbt::signal<void()> surfExitCallbacks;
51 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
57 enum heap_action_type{
67 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
68 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
74 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
76 /** \ingroup SURF_models
77 * \brief List of initialized models
79 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
84 /** @ingroup SURF_interface
85 * @brief SURF action interface class
86 * @details An action is an event generated by a resource (e.g.: a communication for the network)
88 XBT_PUBLIC_CLASS Action {
90 boost::intrusive::list_member_hook<> action_hook;
91 boost::intrusive::list_member_hook<> action_lmm_hook;
92 typedef boost::intrusive::member_hook<
93 Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
94 typedef boost::intrusive::list<Action, ActionOptions> ActionList;
97 ready = 0, /**< Ready */
98 running, /**< Running */
99 failed, /**< Task Failure */
100 done, /**< Completed */
101 to_free, /**< Action to free in next cleanup */
102 not_in_the_system /**< Not in the system anymore. Why did you ask ? */
106 * @brief Action constructor
108 * @param model The Model associated to this Action
109 * @param cost The cost of the Action
110 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
112 Action(simgrid::surf::Model *model, double cost, bool failed);
115 * @brief Action constructor
117 * @param model The Model associated to this Action
118 * @param cost The cost of the Action
119 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
120 * @param var The lmm variable associated to this Action if it is part of a LMM component
122 Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
124 /** @brief Destructor */
127 /** @brief Mark that the action is now finished */
130 /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
131 Action::State getState(); /**< get the state*/
132 /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
133 virtual void setState(Action::State state);
135 /** @brief Get the bound of the current Action */
137 /** @brief Set the bound of the current Action */
138 void setBound(double bound);
140 /** @brief Get the start time of the current action */
141 double getStartTime();
142 /** @brief Get the finish time of the current action */
143 double getFinishTime();
145 /** @brief Get the user data associated to the current action */
146 void *getData() {return data_;}
147 /** @brief Set the user data associated to the current action */
148 void setData(void* data);
150 /** @brief Get the cost of the current action */
151 double getCost() {return cost_;}
152 /** @brief Set the cost of the current action */
153 void setCost(double cost) {cost_ = cost;}
155 /** @brief Update the maximum duration of the current action
156 * @param delta Amount to remove from the MaxDuration */
157 void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
159 /** @brief Update the remaining time of the current action
160 * @param delta Amount to remove from the remaining time */
161 void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
163 /** @brief Set the remaining time of the current action */
164 void setRemains(double value) {remains_ = value;}
165 /** @brief Get the remaining time of the current action after updating the resource */
166 virtual double getRemains();
167 /** @brief Get the remaining time of the current action without updating the resource */
168 double getRemainsNoUpdate();
170 /** @brief Set the finish time of the current action */
171 void setFinishTime(double value) {finishTime_ = value;}
173 /**@brief Add a reference to the current action (refcounting) */
175 /** @brief Unref that action (and destroy it if refcount reaches 0)
176 * @return true if the action was destroyed and false if someone still has references on it
180 /** @brief Cancel the current Action if running */
181 virtual void cancel();
183 /** @brief Suspend the current Action */
184 virtual void suspend();
186 /** @brief Resume the current Action */
187 virtual void resume();
189 /** @brief Returns true if the current action is running */
190 virtual bool isSuspended();
192 /** @brief Get the maximum duration of the current action */
193 double getMaxDuration() {return maxDuration_;}
194 /** @brief Set the maximum duration of the current Action */
195 virtual void setMaxDuration(double duration);
197 /** @brief Get the tracing category associated to the current action */
198 char *getCategory() {return category_;}
199 /** @brief Set the tracing category of the current Action */
200 void setCategory(const char *category);
202 /** @brief Get the priority of the current Action */
203 double getPriority() {return priority_;};
204 /** @brief Set the priority of the current Action */
205 virtual void setPriority(double priority);
207 /** @brief Get the state set in which the action is */
208 ActionList* getStateSet() {return stateSet_;};
210 s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
212 simgrid::surf::Model* getModel() { return model_; }
215 ActionList* stateSet_;
216 double priority_ = 1.0; /**< priority (1.0 by default) */
218 double remains_; /**< How much of that cost remains to be done in the currently running task */
219 double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
220 double finishTime_ = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
223 double start_; /**< start time */
224 char *category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
227 simgrid::surf::Model *model_;
228 void *data_ = nullptr; /**< for your convenience */
232 virtual void updateRemainingLazy(double now);
233 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
234 void heapRemove(xbt_heap_t heap);
235 void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
236 void updateIndexHeap(int i);
237 lmm_variable_t getVariable() {return variable_;}
238 double getLastUpdate() {return lastUpdate_;}
239 void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
240 enum heap_action_type getHat() {return hat_;}
241 bool is_linked() {return action_lmm_hook.is_linked();}
245 lmm_variable_t variable_ = nullptr;
246 double lastValue_ = 0;
247 double lastUpdate_ = 0;
250 enum heap_action_type hat_ = NOTSET;
253 typedef Action::ActionList ActionList;
255 typedef boost::intrusive::member_hook<
256 Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
257 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
258 typedef ActionLmmList* ActionLmmListPtr;
264 /** @ingroup SURF_interface
265 * @brief SURF model interface class
266 * @details A model is an object which handle the interactions between its Resources and its Actions
268 XBT_PUBLIC_CLASS Model {
273 /** @brief Get the set of [actions](@ref Action) in *ready* state */
274 virtual ActionList* getReadyActionSet() {return readyActionSet_;}
276 /** @brief Get the set of [actions](@ref Action) in *running* state */
277 virtual ActionList* getRunningActionSet() {return runningActionSet_;}
279 /** @brief Get the set of [actions](@ref Action) in *failed* state */
280 virtual ActionList* getFailedActionSet() {return failedActionSet_;}
282 /** @brief Get the set of [actions](@ref Action) in *done* state */
283 virtual ActionList* getDoneActionSet() {return doneActionSet_;}
285 /** @brief Get the set of modified [actions](@ref Action) */
286 virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
288 /** @brief Get the maxmin system of the current Model */
289 lmm_system_t getMaxminSystem() {return maxminSystem_;}
292 * @brief Get the update mechanism of the current Model
295 e_UM_t getUpdateMechanism() {return updateMechanism_;}
297 /** @brief Get Action heap */
298 xbt_heap_t getActionHeap() {return actionHeap_;}
301 * @brief Share the resources between the actions
303 * @param now The current time of the simulation
304 * @return The delta of time till the next action will finish
306 virtual double nextOccuringEvent(double now);
307 virtual double nextOccuringEventLazy(double now);
308 virtual double nextOccuringEventFull(double now);
311 * @brief Update action to the current time
313 * @param now The current time of the simulation
314 * @param delta The delta of time since the last update
316 virtual void updateActionsState(double now, double delta);
317 virtual void updateActionsStateLazy(double now, double delta);
318 virtual void updateActionsStateFull(double now, double delta);
320 /** @brief Returns whether this model have an idempotent shareResource()
322 * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
323 * so we need to call it only when the next timestamp of other sources is computed.
325 virtual bool nextOccuringEventIsIdempotent() { return true;}
328 ActionLmmListPtr modifiedSet_;
329 lmm_system_t maxminSystem_ = nullptr;
330 e_UM_t updateMechanism_ = UM_UNDEFINED;
331 bool selectiveUpdate_;
332 xbt_heap_t actionHeap_;
335 ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
336 ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
337 ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
338 ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
348 /** @ingroup SURF_interface
349 * @brief Resource which have a metric handled by a maxmin system
352 double peak; /**< The peak of the metric, ie its max value */
353 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
354 tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
360 /** @ingroup SURF_interface
361 * @brief SURF resource interface class
362 * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
364 XBT_PUBLIC_CLASS Resource {
367 * @brief Constructor of LMM Resources
369 * @param model Model associated to this Resource
370 * @param name The name of the Resource
371 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
373 Resource(Model *model, const char *name, lmm_constraint_t constraint);
377 /** @brief Get the Model of the current Resource */
378 Model* model() const;
380 /** @brief Get the name of the current Resource */
381 const char* cname() const;
383 bool operator==(const Resource &other) const;
386 * @brief Apply an event of external load event to that resource
388 * @param event What happened
389 * @param value [TODO]
391 virtual void apply_event(tmgr_trace_event_t event, double value) = 0;
393 /** @brief Check if the current Resource is used (if it currently serves an action) */
394 virtual bool isUsed()=0;
396 /** @brief Check if the current Resource is active */
397 virtual bool isOn() const;
398 /** @brief Check if the current Resource is shut down */
399 virtual bool isOff() const;
400 /** @brief Turn on the current Resource */
401 virtual void turnOn();
402 /** @brief Turn off the current Resource */
403 virtual void turnOff();
411 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
412 lmm_constraint_t constraint() const;
415 const lmm_constraint_t constraint_ = nullptr;
423 struct hash<simgrid::surf::Resource>
425 std::size_t operator()(const simgrid::surf::Resource& r) const
427 return (std::size_t) xbt_str_hash(r.cname());
432 #endif /* SURF_MODEL_H_ */