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"
13 #include "surf/surf_routing.h"
16 #include <boost/intrusive/list.hpp>
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;
35 XBT_PUBLIC(double) surf_get_clock(void);
37 /** \ingroup SURF_simulation
38 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
40 XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
43 extern XBT_PRIVATE double sg_sender_gap;
48 extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
53 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
55 static inline char* sg_storage_name(sg_storage_t storage) {
63 enum heap_action_type{
73 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
74 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
80 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
82 /** \ingroup SURF_models
83 * \brief List of initialized models
85 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
90 /** @ingroup SURF_interface
91 * @brief SURF action interface class
92 * @details An action is an event generated by a resource (e.g.: a communication for the network)
94 XBT_PUBLIC_CLASS Action {
96 boost::intrusive::list_member_hook<> action_hook;
97 boost::intrusive::list_member_hook<> action_lmm_hook;
98 typedef boost::intrusive::member_hook<
99 Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
100 typedef boost::intrusive::list<Action, ActionOptions> ActionList;
103 ready = 0, /**< Ready */
104 running, /**< Running */
105 failed, /**< Task Failure */
106 done, /**< Completed */
107 to_free, /**< Action to free in next cleanup */
108 not_in_the_system /**< Not in the system anymore. Why did you ask ? */
112 * @brief Action constructor
114 * @param model The Model associated to this Action
115 * @param cost The cost of the Action
116 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
118 Action(simgrid::surf::Model *model, double cost, bool failed);
121 * @brief Action constructor
123 * @param model The Model associated to this Action
124 * @param cost The cost of the Action
125 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
126 * @param var The lmm variable associated to this Action if it is part of a LMM component
128 Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
130 /** @brief Destructor */
133 /** @brief Mark that the action is now finished */
136 /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
137 Action::State getState(); /**< get the state*/
138 /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
139 virtual void setState(Action::State state);
141 /** @brief Get the bound of the current Action */
143 /** @brief Set the bound of the current Action */
144 void setBound(double bound);
146 /** @brief Get the start time of the current action */
147 double getStartTime();
148 /** @brief Get the finish time of the current action */
149 double getFinishTime();
151 /** @brief Get the user data associated to the current action */
152 void *getData() {return data_;}
153 /** @brief Set the user data associated to the current action */
154 void setData(void* data);
156 /** @brief Get the cost of the current action */
157 double getCost() {return cost_;}
158 /** @brief Set the cost of the current action */
159 void setCost(double cost) {cost_ = cost;}
161 /** @brief Update the maximum duration of the current action
162 * @param delta Amount to remove from the MaxDuration */
163 void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
165 /** @brief Update the remaining time of the current action
166 * @param delta Amount to remove from the remaining time */
167 void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
169 /** @brief Set the remaining time of the current action */
170 void setRemains(double value) {remains_ = value;}
171 /** @brief Get the remaining time of the current action after updating the resource */
172 virtual double getRemains();
173 /** @brief Get the remaining time of the current action without updating the resource */
174 double getRemainsNoUpdate();
176 /** @brief Set the finish time of the current action */
177 void setFinishTime(double value) {finishTime_ = value;}
179 /**@brief Add a reference to the current action (refcounting) */
181 /** @brief Unref that action (and destroy it if refcount reaches 0)
182 * @return true if the action was destroyed and false if someone still has references on it
186 /** @brief Cancel the current Action if running */
187 virtual void cancel();
189 /** @brief Suspend the current Action */
190 virtual void suspend();
192 /** @brief Resume the current Action */
193 virtual void resume();
195 /** @brief Returns true if the current action is running */
196 virtual bool isSuspended();
198 /** @brief Get the maximum duration of the current action */
199 double getMaxDuration() {return maxDuration_;}
200 /** @brief Set the maximum duration of the current Action */
201 virtual void setMaxDuration(double duration);
203 /** @brief Get the tracing category associated to the current action */
204 char *getCategory() {return category_;}
205 /** @brief Set the tracing category of the current Action */
206 void setCategory(const char *category);
208 /** @brief Get the priority of the current Action */
209 double getPriority() {return priority_;};
210 /** @brief Set the priority of the current Action */
211 virtual void setPriority(double priority);
213 /** @brief Get the state set in which the action is */
214 ActionList* getStateSet() {return stateSet_;};
216 s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
218 simgrid::surf::Model* getModel() { return model_; }
221 ActionList* stateSet_;
222 double priority_ = 1.0; /**< priority (1.0 by default) */
224 double remains_; /**< How much of that cost remains to be done in the currently running task */
225 double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
226 double finishTime_ = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
229 double start_; /**< start time */
230 char *category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
233 simgrid::surf::Model *model_;
234 void *data_ = nullptr; /**< for your convenience */
238 virtual void updateRemainingLazy(double now);
239 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
240 void heapRemove(xbt_heap_t heap);
241 void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
242 void updateIndexHeap(int i);
243 lmm_variable_t getVariable() {return variable_;}
244 double getLastUpdate() {return lastUpdate_;}
245 void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
246 enum heap_action_type getHat() {return hat_;}
247 bool is_linked() {return action_lmm_hook.is_linked();}
251 lmm_variable_t variable_ = nullptr;
252 double lastValue_ = 0;
253 double lastUpdate_ = 0;
256 enum heap_action_type hat_ = NOTSET;
259 typedef Action::ActionList ActionList;
261 typedef boost::intrusive::member_hook<
262 Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
263 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
264 typedef ActionLmmList* ActionLmmListPtr;
270 /** @ingroup SURF_interface
271 * @brief SURF model interface class
272 * @details A model is an object which handle the interactions between its Resources and its Actions
274 XBT_PUBLIC_CLASS Model {
279 /** @brief Get the set of [actions](@ref Action) in *ready* state */
280 virtual ActionList* getReadyActionSet() {return readyActionSet_;}
282 /** @brief Get the set of [actions](@ref Action) in *running* state */
283 virtual ActionList* getRunningActionSet() {return runningActionSet_;}
285 /** @brief Get the set of [actions](@ref Action) in *failed* state */
286 virtual ActionList* getFailedActionSet() {return failedActionSet_;}
288 /** @brief Get the set of [actions](@ref Action) in *done* state */
289 virtual ActionList* getDoneActionSet() {return doneActionSet_;}
291 /** @brief Get the set of modified [actions](@ref Action) */
292 virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
294 /** @brief Get the maxmin system of the current Model */
295 lmm_system_t getMaxminSystem() {return maxminSystem_;}
298 * @brief Get the update mechanism of the current Model
301 e_UM_t getUpdateMechanism() {return updateMechanism_;}
303 /** @brief Get Action heap */
304 xbt_heap_t getActionHeap() {return actionHeap_;}
307 * @brief Share the resources between the actions
309 * @param now The current time of the simulation
310 * @return The delta of time till the next action will finish
312 virtual double nextOccuringEvent(double now);
313 virtual double nextOccuringEventLazy(double now);
314 virtual double nextOccuringEventFull(double now);
317 * @brief Update action to the current time
319 * @param now The current time of the simulation
320 * @param delta The delta of time since the last update
322 virtual void updateActionsState(double now, double delta);
323 virtual void updateActionsStateLazy(double now, double delta);
324 virtual void updateActionsStateFull(double now, double delta);
326 /** @brief Returns whether this model have an idempotent shareResource()
328 * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
329 * so we need to call it only when the next timestamp of other sources is computed.
331 virtual bool nextOccuringEventIsIdempotent() { return true;}
334 ActionLmmListPtr modifiedSet_;
335 lmm_system_t maxminSystem_ = nullptr;
336 e_UM_t updateMechanism_ = UM_UNDEFINED;
337 bool selectiveUpdate_;
338 xbt_heap_t actionHeap_;
341 ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
342 ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
343 ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
344 ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
354 /** @ingroup SURF_interface
355 * @brief Resource which have a metric handled by a maxmin system
358 double peak; /**< The peak of the metric, ie its max value */
359 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
360 tmgr_trace_iterator_t event; /**< The associated trace event associated to the metric */
366 /** @ingroup SURF_interface
367 * @brief SURF resource interface class
368 * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
370 XBT_PUBLIC_CLASS Resource {
373 * @brief Constructor of LMM Resources
375 * @param model Model associated to this Resource
376 * @param name The name of the Resource
377 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
379 Resource(Model *model, const char *name, lmm_constraint_t constraint);
383 /** @brief Get the Model of the current Resource */
384 Model* model() const;
386 /** @brief Get the name of the current Resource */
387 const char* cname() const;
389 bool operator==(const Resource &other) const;
392 * @brief Apply an event of external load event to that resource
394 * @param event What happened
395 * @param value [TODO]
397 virtual void apply_event(tmgr_trace_iterator_t event, double value)=0;
399 /** @brief Check if the current Resource is used (if it currently serves an action) */
400 virtual bool isUsed()=0;
402 /** @brief Check if the current Resource is active */
403 virtual bool isOn() const;
404 /** @brief Check if the current Resource is shut down */
405 virtual bool isOff() const;
406 /** @brief Turn on the current Resource */
407 virtual void turnOn();
408 /** @brief Turn off the current Resource */
409 virtual void turnOff();
417 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
418 lmm_constraint_t constraint() const;
421 const lmm_constraint_t constraint_ = nullptr;
429 struct hash<simgrid::surf::Resource>
431 std::size_t operator()(const simgrid::surf::Resource& r) const
433 return (std::size_t) xbt_str_hash(r.cname());
438 #endif /* SURF_MODEL_H_ */