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);
59 enum heap_action_type{
69 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
70 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
76 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
78 /** \ingroup SURF_models
79 * \brief List of initialized models
81 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
86 /** @ingroup SURF_interface
87 * @brief SURF action interface class
88 * @details An action is an event generated by a resource (e.g.: a communication for the network)
90 XBT_PUBLIC_CLASS Action {
92 boost::intrusive::list_member_hook<> action_hook;
93 boost::intrusive::list_member_hook<> action_lmm_hook;
94 typedef boost::intrusive::member_hook<
95 Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
96 typedef boost::intrusive::list<Action, ActionOptions> ActionList;
99 ready = 0, /**< Ready */
100 running, /**< Running */
101 failed, /**< Task Failure */
102 done, /**< Completed */
103 to_free, /**< Action to free in next cleanup */
104 not_in_the_system /**< Not in the system anymore. Why did you ask ? */
108 * @brief Action constructor
110 * @param model The Model associated to this Action
111 * @param cost The cost of the Action
112 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
114 Action(simgrid::surf::Model *model, double cost, bool failed);
117 * @brief Action constructor
119 * @param model The Model associated to this Action
120 * @param cost The cost of the Action
121 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
122 * @param var The lmm variable associated to this Action if it is part of a LMM component
124 Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
126 /** @brief Destructor */
129 /** @brief Mark that the action is now finished */
132 /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
133 Action::State getState(); /**< get the state*/
134 /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
135 virtual void setState(Action::State state);
137 /** @brief Get the bound of the current Action */
139 /** @brief Set the bound of the current Action */
140 void setBound(double bound);
142 /** @brief Get the start time of the current action */
143 double getStartTime();
144 /** @brief Get the finish time of the current action */
145 double getFinishTime();
147 /** @brief Get the user data associated to the current action */
148 void *getData() {return data_;}
149 /** @brief Set the user data associated to the current action */
150 void setData(void* data);
152 /** @brief Get the cost of the current action */
153 double getCost() {return cost_;}
154 /** @brief Set the cost of the current action */
155 void setCost(double cost) {cost_ = cost;}
157 /** @brief Update the maximum duration of the current action
158 * @param delta Amount to remove from the MaxDuration */
159 void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
161 /** @brief Update the remaining time of the current action
162 * @param delta Amount to remove from the remaining time */
163 void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
165 /** @brief Set the remaining time of the current action */
166 void setRemains(double value) {remains_ = value;}
167 /** @brief Get the remaining time of the current action after updating the resource */
168 virtual double getRemains();
169 /** @brief Get the remaining time of the current action without updating the resource */
170 double getRemainsNoUpdate();
172 /** @brief Set the finish time of the current action */
173 void setFinishTime(double value) {finishTime_ = value;}
175 /**@brief Add a reference to the current action (refcounting) */
177 /** @brief Unref that action (and destroy it if refcount reaches 0)
178 * @return true if the action was destroyed and false if someone still has references on it
182 /** @brief Cancel the current Action if running */
183 virtual void cancel();
185 /** @brief Suspend the current Action */
186 virtual void suspend();
188 /** @brief Resume the current Action */
189 virtual void resume();
191 /** @brief Returns true if the current action is running */
192 virtual bool isSuspended();
194 /** @brief Get the maximum duration of the current action */
195 double getMaxDuration() {return maxDuration_;}
196 /** @brief Set the maximum duration of the current Action */
197 virtual void setMaxDuration(double duration);
199 /** @brief Get the tracing category associated to the current action */
200 char *getCategory() {return category_;}
201 /** @brief Set the tracing category of the current Action */
202 void setCategory(const char *category);
204 /** @brief Get the priority of the current Action */
205 double getPriority() {return priority_;};
206 /** @brief Set the priority of the current Action */
207 virtual void setPriority(double priority);
209 /** @brief Get the state set in which the action is */
210 ActionList* getStateSet() {return stateSet_;};
212 s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
214 simgrid::surf::Model* getModel() { return model_; }
217 ActionList* stateSet_;
218 double priority_ = 1.0; /**< priority (1.0 by default) */
220 double remains_; /**< How much of that cost remains to be done in the currently running task */
221 double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
222 double finishTime_ = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
225 double start_; /**< start time */
226 char *category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
229 simgrid::surf::Model *model_;
230 void *data_ = nullptr; /**< for your convenience */
234 virtual void updateRemainingLazy(double now);
235 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
236 void heapRemove(xbt_heap_t heap);
237 void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
238 void updateIndexHeap(int i);
239 lmm_variable_t getVariable() {return variable_;}
240 double getLastUpdate() {return lastUpdate_;}
241 void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
242 enum heap_action_type getHat() {return hat_;}
243 bool is_linked() {return action_lmm_hook.is_linked();}
247 lmm_variable_t variable_ = nullptr;
248 double lastValue_ = 0;
249 double lastUpdate_ = 0;
252 enum heap_action_type hat_ = NOTSET;
255 typedef Action::ActionList ActionList;
257 typedef boost::intrusive::member_hook<
258 Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
259 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
260 typedef ActionLmmList* ActionLmmListPtr;
266 /** @ingroup SURF_interface
267 * @brief SURF model interface class
268 * @details A model is an object which handle the interactions between its Resources and its Actions
270 XBT_PUBLIC_CLASS Model {
275 /** @brief Get the set of [actions](@ref Action) in *ready* state */
276 virtual ActionList* getReadyActionSet() {return readyActionSet_;}
278 /** @brief Get the set of [actions](@ref Action) in *running* state */
279 virtual ActionList* getRunningActionSet() {return runningActionSet_;}
281 /** @brief Get the set of [actions](@ref Action) in *failed* state */
282 virtual ActionList* getFailedActionSet() {return failedActionSet_;}
284 /** @brief Get the set of [actions](@ref Action) in *done* state */
285 virtual ActionList* getDoneActionSet() {return doneActionSet_;}
287 /** @brief Get the set of modified [actions](@ref Action) */
288 virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
290 /** @brief Get the maxmin system of the current Model */
291 lmm_system_t getMaxminSystem() {return maxminSystem_;}
294 * @brief Get the update mechanism of the current Model
297 e_UM_t getUpdateMechanism() {return updateMechanism_;}
299 /** @brief Get Action heap */
300 xbt_heap_t getActionHeap() {return actionHeap_;}
303 * @brief Share the resources between the actions
305 * @param now The current time of the simulation
306 * @return The delta of time till the next action will finish
308 virtual double nextOccuringEvent(double now);
309 virtual double nextOccuringEventLazy(double now);
310 virtual double nextOccuringEventFull(double now);
313 * @brief Update action to the current time
315 * @param now The current time of the simulation
316 * @param delta The delta of time since the last update
318 virtual void updateActionsState(double now, double delta);
319 virtual void updateActionsStateLazy(double now, double delta);
320 virtual void updateActionsStateFull(double now, double delta);
322 /** @brief Returns whether this model have an idempotent shareResource()
324 * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
325 * so we need to call it only when the next timestamp of other sources is computed.
327 virtual bool nextOccuringEventIsIdempotent() { return true;}
330 ActionLmmListPtr modifiedSet_;
331 lmm_system_t maxminSystem_ = nullptr;
332 e_UM_t updateMechanism_ = UM_UNDEFINED;
333 bool selectiveUpdate_;
334 xbt_heap_t actionHeap_;
337 ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
338 ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
339 ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
340 ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
350 /** @ingroup SURF_interface
351 * @brief Resource which have a metric handled by a maxmin system
354 double peak; /**< The peak of the metric, ie its max value */
355 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
356 tmgr_trace_iterator_t event; /**< The associated trace event associated to the metric */
362 /** @ingroup SURF_interface
363 * @brief SURF resource interface class
364 * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
366 XBT_PUBLIC_CLASS Resource {
369 * @brief Constructor of LMM Resources
371 * @param model Model associated to this Resource
372 * @param name The name of the Resource
373 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
375 Resource(Model *model, const char *name, lmm_constraint_t constraint);
379 /** @brief Get the Model of the current Resource */
380 Model* model() const;
382 /** @brief Get the name of the current Resource */
383 const char* cname() const;
385 bool operator==(const Resource &other) const;
388 * @brief Apply an event of external load event to that resource
390 * @param event What happened
391 * @param value [TODO]
393 virtual void apply_event(tmgr_trace_iterator_t event, double value)=0;
395 /** @brief Check if the current Resource is used (if it currently serves an action) */
396 virtual bool isUsed()=0;
398 /** @brief Check if the current Resource is active */
399 virtual bool isOn() const;
400 /** @brief Check if the current Resource is shut down */
401 virtual bool isOff() const;
402 /** @brief Turn on the current Resource */
403 virtual void turnOn();
404 /** @brief Turn off the current Resource */
405 virtual void turnOff();
413 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
414 lmm_constraint_t constraint() const;
417 const lmm_constraint_t constraint_ = nullptr;
425 struct hash<simgrid::surf::Resource>
427 std::size_t operator()(const simgrid::surf::Resource& r) const
429 return (std::size_t) xbt_str_hash(r.cname());
434 #endif /* SURF_MODEL_H_ */