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. */
15 #include <boost/intrusive/list.hpp>
17 #include <xbt/signal.hpp>
20 #include "surf/surf_routing.h"
21 #include "surf/surf.h"
22 #include "src/surf/surf_private.h"
23 #include "src/internal_config.h"
25 #define NO_MAX_DURATION -1.0
31 /* user-visible parameters */
32 extern XBT_PRIVATE double sg_tcp_gamma;
33 extern XBT_PRIVATE double sg_sender_gap;
34 extern XBT_PRIVATE double sg_latency_factor;
35 extern XBT_PRIVATE double sg_bandwidth_factor;
36 extern XBT_PRIVATE double sg_weight_S_parameter;
37 extern XBT_PRIVATE int sg_network_crosstraffic;
38 extern XBT_PRIVATE xbt_dynar_t surf_path;
41 XBT_PUBLIC(double) surf_get_clock(void);
43 /** \ingroup SURF_simulation
44 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
46 XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
49 extern XBT_PRIVATE double sg_sender_gap;
54 extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
59 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
61 static inline char* sg_storage_name(sg_storage_t storage) {
69 enum heap_action_type{
79 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
80 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
86 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
88 /** \ingroup SURF_models
89 * \brief List of initialized models
91 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
96 /** @ingroup SURF_interface
97 * @brief SURF action interface class
98 * @details An action is an event generated by a resource (e.g.: a communication for the network)
100 XBT_PUBLIC_CLASS Action {
102 boost::intrusive::list_member_hook<> action_hook;
103 boost::intrusive::list_member_hook<> action_lmm_hook;
104 typedef boost::intrusive::member_hook<
105 Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
106 typedef boost::intrusive::list<Action, ActionOptions> ActionList;
109 ready = 0, /**< Ready */
110 running, /**< Running */
111 failed, /**< Task Failure */
112 done, /**< Completed */
113 to_free, /**< Action to free in next cleanup */
114 not_in_the_system /**< Not in the system anymore. Why did you ask ? */
119 * @brief Common initializations for the constructors
121 void initialize(simgrid::surf::Model *model, double cost, bool failed,
122 lmm_variable_t var = nullptr);
126 * @brief Action constructor
128 * @param model The Model associated to this Action
129 * @param cost The cost of the Action
130 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
132 Action(simgrid::surf::Model *model, double cost, bool failed);
135 * @brief Action constructor
137 * @param model The Model associated to this Action
138 * @param cost The cost of the Action
139 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
140 * @param var The lmm variable associated to this Action if it is part of a LMM component
142 Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
144 /** @brief Destructor */
147 /** @brief Mark that the action is now finished */
150 /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
151 Action::State getState(); /**< get the state*/
152 /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
153 virtual void setState(Action::State state);
155 /** @brief Get the bound of the current Action */
157 /** @brief Set the bound of the current Action */
158 void setBound(double bound);
160 /** @brief Get the start time of the current action */
161 double getStartTime();
162 /** @brief Get the finish time of the current action */
163 double getFinishTime();
165 /** @brief Get the user data associated to the current action */
166 void *getData() {return data_;}
167 /** @brief Set the user data associated to the current action */
168 void setData(void* data);
170 /** @brief Get the cost of the current action */
171 double getCost() {return cost_;}
172 /** @brief Set the cost of the current action */
173 void setCost(double cost) {cost_ = cost;}
175 /** @brief Update the maximum duration of the current action
176 * @param delta Amount to remove from the MaxDuration */
177 void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
179 /** @brief Update the remaining time of the current action
180 * @param delta Amount to remove from the remaining time */
181 void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
183 /** @brief Set the remaining time of the current action */
184 void setRemains(double value) {remains_ = value;}
185 /** @brief Get the remaining time of the current action after updating the resource */
186 virtual double getRemains();
187 /** @brief Get the remaining time of the current action without updating the resource */
188 double getRemainsNoUpdate();
190 /** @brief Set the finish time of the current action */
191 void setFinishTime(double value) {finishTime_ = value;}
193 /**@brief Add a reference to the current action (refcounting) */
195 /** @brief Unref that action (and destroy it if refcount reaches 0)
196 * @return true if the action was destroyed and false if someone still has references on it
200 /** @brief Cancel the current Action if running */
201 virtual void cancel();
203 /** @brief Suspend the current Action */
204 virtual void suspend();
206 /** @brief Resume the current Action */
207 virtual void resume();
209 /** @brief Returns true if the current action is running */
210 virtual bool isSuspended();
212 /** @brief Get the maximum duration of the current action */
213 double getMaxDuration() {return maxDuration_;}
214 /** @brief Set the maximum duration of the current Action */
215 virtual void setMaxDuration(double duration);
217 /** @brief Get the tracing category associated to the current action */
218 char *getCategory() {return category_;}
219 /** @brief Set the tracing category of the current Action */
220 void setCategory(const char *category);
222 /** @brief Get the priority of the current Action */
223 double getPriority() {return priority_;};
224 /** @brief Set the priority of the current Action */
225 virtual void setPriority(double priority);
227 /** @brief Get the state set in which the action is */
228 ActionList* getStateSet() {return stateSet_;};
230 s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
232 simgrid::surf::Model *getModel() {return model_;}
235 ActionList* stateSet_;
236 double priority_ = 1.0; /**< priority (1.0 by default) */
238 double remains_; /**< How much of that cost remains to be done in the currently running task */
239 double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
240 double finishTime_ = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
243 double start_; /**< start time */
244 char *category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
247 simgrid::surf::Model *model_;
248 void *data_ = nullptr; /**< for your convenience */
252 virtual void updateRemainingLazy(double now);
253 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
254 void heapRemove(xbt_heap_t heap);
255 void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
256 void updateIndexHeap(int i);
257 lmm_variable_t getVariable() {return variable_;}
258 double getLastUpdate() {return lastUpdate_;}
259 void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
260 enum heap_action_type getHat() {return hat_;}
261 bool is_linked() {return action_lmm_hook.is_linked();}
265 lmm_variable_t variable_ = nullptr;
266 double lastValue_ = 0;
267 double lastUpdate_ = 0;
270 enum heap_action_type hat_ = NOTSET;
273 typedef Action::ActionList ActionList;
275 typedef boost::intrusive::member_hook<
276 Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
277 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
278 typedef ActionLmmList* ActionLmmListPtr;
284 /** @ingroup SURF_interface
285 * @brief SURF model interface class
286 * @details A model is an object which handle the interactions between its Resources and its Actions
288 XBT_PUBLIC_CLASS Model {
293 /** @brief Get the set of [actions](@ref Action) in *ready* state */
294 virtual ActionList* getReadyActionSet() {return readyActionSet_;}
296 /** @brief Get the set of [actions](@ref Action) in *running* state */
297 virtual ActionList* getRunningActionSet() {return runningActionSet_;}
299 /** @brief Get the set of [actions](@ref Action) in *failed* state */
300 virtual ActionList* getFailedActionSet() {return failedActionSet_;}
302 /** @brief Get the set of [actions](@ref Action) in *done* state */
303 virtual ActionList* getDoneActionSet() {return doneActionSet_;}
305 /** @brief Get the set of modified [actions](@ref Action) */
306 virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
308 /** @brief Get the maxmin system of the current Model */
309 lmm_system_t getMaxminSystem() {return maxminSystem_;}
312 * @brief Get the update mechanism of the current Model
315 e_UM_t getUpdateMechanism() {return updateMechanism_;}
317 /** @brief Get Action heap */
318 xbt_heap_t getActionHeap() {return actionHeap_;}
321 * @brief Share the resources between the actions
323 * @param now The current time of the simulation
324 * @return The delta of time till the next action will finish
326 virtual double next_occuring_event(double now);
327 virtual double next_occuring_event_lazy(double now);
328 virtual double next_occuring_event_full(double now);
329 double shareResourcesMaxMin(ActionList* running_actions,
330 lmm_system_t sys, void (*solve) (lmm_system_t));
333 * @brief Update action to the current time
335 * @param now The current time of the simulation
336 * @param delta The delta of time since the last update
338 virtual void updateActionsState(double now, double delta);
339 virtual void updateActionsStateLazy(double now, double delta);
340 virtual void updateActionsStateFull(double now, double delta);
342 /** @brief Returns whether this model have an idempotent shareResource()
344 * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
345 * so we need to call it only when the next timestamp of other sources is computed.
347 virtual bool next_occuring_event_isIdempotent()=0;
350 ActionLmmListPtr modifiedSet_;
351 lmm_system_t maxminSystem_ = nullptr;
352 e_UM_t updateMechanism_ = UM_UNDEFINED;
353 int selectiveUpdate_;
354 xbt_heap_t actionHeap_;
357 ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
358 ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
359 ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
360 ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
370 /** @ingroup SURF_interface
371 * @brief Resource which have a metric handled by a maxmin system
374 double peak; /**< The peak of the metric, ie its max value */
375 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
376 tmgr_trace_iterator_t event; /**< The associated trace event associated to the metric */
382 /** @ingroup SURF_interface
383 * @brief SURF resource interface class
384 * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
386 XBT_PUBLIC_CLASS Resource {
389 * @brief Constructor of non-LMM Resources
391 * @param model Model associated to this Resource
392 * @param name The name of the Resource
394 Resource(Model *model, const char *name);
397 * @brief Constructor of LMM Resources
399 * @param model Model associated to this Resource
400 * @param name The name of the Resource
401 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
403 Resource(Model *model, const char *name, lmm_constraint_t constraint);
407 /** @brief Get the Model of the current Resource */
408 Model *getModel() const;
410 /** @brief Get the name of the current Resource */
411 const char *getName() const;
413 bool operator==(const Resource &other) const;
416 * @brief Apply an event of external load event to that resource
418 * @param event What happened
419 * @param value [TODO]
421 virtual void apply_event(tmgr_trace_iterator_t event, double value)=0;
423 /** @brief Check if the current Resource is used (if it currently serves an action) */
424 virtual bool isUsed()=0;
426 /** @brief Check if the current Resource is active */
427 virtual bool isOn() const;
428 /** @brief Check if the current Resource is shut down */
429 virtual bool isOff() const;
430 /** @brief Turn on the current Resource */
431 virtual void turnOn();
432 /** @brief Turn off the current Resource */
433 virtual void turnOff();
441 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
442 lmm_constraint_t getConstraint() const;
444 lmm_constraint_t constraint_ = nullptr;
452 struct hash<simgrid::surf::Resource>
454 std::size_t operator()(const simgrid::surf::Resource& r) const
456 return (std::size_t) xbt_str_hash(r.getName());
461 #endif /* SURF_MODEL_H_ */