1 /* Copyright (c) 2004-2017. 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.hpp"
12 #include "surf/surf.hpp"
16 #include <boost/intrusive/list.hpp>
19 #include <unordered_map>
21 #define NO_MAX_DURATION -1.0
27 /* user-visible parameters */
28 extern XBT_PRIVATE double sg_tcp_gamma;
29 extern XBT_PRIVATE double sg_latency_factor;
30 extern XBT_PRIVATE double sg_bandwidth_factor;
31 extern XBT_PRIVATE double sg_weight_S_parameter;
32 extern XBT_PRIVATE int sg_network_crosstraffic;
33 extern XBT_PRIVATE std::vector<std::string> surf_path;
34 extern XBT_PRIVATE std::unordered_map<std::string, tmgr_trace_t> traces_set_list;
35 extern XBT_PRIVATE std::set<std::string> watched_hosts;
38 XBT_PUBLIC(double) surf_get_clock();
40 /** \ingroup SURF_simulation
41 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
43 XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
48 extern XBT_PRIVATE simgrid::xbt::signal<void()> surfExitCallbacks;
52 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
58 enum heap_action_type{
69 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
71 /** \ingroup SURF_models
72 * \brief List of initialized models
74 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
79 /** @ingroup SURF_interface
80 * @brief SURF action interface class
81 * @details An action is an event generated by a resource (e.g.: a communication for the network)
83 XBT_PUBLIC_CLASS Action {
85 boost::intrusive::list_member_hook<> action_hook;
86 boost::intrusive::list_member_hook<> action_lmm_hook;
87 typedef boost::intrusive::member_hook<
88 Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
89 typedef boost::intrusive::list<Action, ActionOptions> ActionList;
92 ready = 0, /**< Ready */
93 running, /**< Running */
94 failed, /**< Task Failure */
95 done, /**< Completed */
96 to_free, /**< Action to free in next cleanup */
97 not_in_the_system /**< Not in the system anymore. Why did you ask ? */
101 * @brief Action constructor
103 * @param model The Model associated to this Action
104 * @param cost The cost of the Action
105 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
107 Action(simgrid::surf::Model *model, double cost, bool failed);
110 * @brief Action constructor
112 * @param model The Model associated to this Action
113 * @param cost The cost of the Action
114 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
115 * @param var The lmm variable associated to this Action if it is part of a LMM component
117 Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
119 /** @brief Destructor */
123 * @brief Mark that the action is now finished
125 * @param state the new [state](\ref simgrid::surf::Action::State) of the current Action
127 void finish(Action::State state);
129 /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
130 Action::State getState(); /**< get the state*/
131 /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
132 virtual void setState(Action::State state);
134 /** @brief Get the bound of the current Action */
136 /** @brief Set the bound of the current Action */
137 void setBound(double bound);
139 /** @brief Get the start time of the current action */
140 double getStartTime();
141 /** @brief Get the finish time of the current action */
142 double getFinishTime();
144 /** @brief Get the user data associated to the current action */
145 void *getData() {return data_;}
146 /** @brief Set the user data associated to the current action */
147 void setData(void* data);
149 /** @brief Get the cost of the current action */
150 double getCost() {return cost_;}
151 /** @brief Set the cost of the current action */
152 void setCost(double cost) {cost_ = cost;}
154 /** @brief Update the maximum duration of the current action
155 * @param delta Amount to remove from the MaxDuration */
156 void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
158 /** @brief Update the remaining time of the current action
159 * @param delta Amount to remove from the remaining time */
160 void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
162 /** @brief Set the remaining time of the current action */
163 void setRemains(double value) {remains_ = value;}
164 /** @brief Get the remaining time of the current action after updating the resource */
165 virtual double getRemains();
166 /** @brief Get the remaining time of the current action without updating the resource */
167 double getRemainsNoUpdate();
169 /** @brief Set the finish time of the current action */
170 void setFinishTime(double value) {finishTime_ = value;}
172 /**@brief Add a reference to the current action (refcounting) */
174 /** @brief Unref that action (and destroy it if refcount reaches 0)
175 * @return true if the action was destroyed and false if someone still has references on it
179 /** @brief Cancel the current Action if running */
180 virtual void cancel();
182 /** @brief Suspend the current Action */
183 virtual void suspend();
185 /** @brief Resume the current Action */
186 virtual void resume();
188 /** @brief Returns true if the current action is running */
189 virtual bool isSuspended();
191 /** @brief Get the maximum duration of the current action */
192 double getMaxDuration() {return maxDuration_;}
193 /** @brief Set the maximum duration of the current Action */
194 virtual void setMaxDuration(double duration);
196 /** @brief Get the tracing category associated to the current action */
197 char *getCategory() {return category_;}
198 /** @brief Set the tracing category of the current Action */
199 void setCategory(const char *category);
201 /** @brief Get the priority of the current Action */
202 double getPriority() { return sharingWeight_; };
203 /** @brief Set the priority of the current Action */
204 virtual void setSharingWeight(double priority);
205 void setSharingWeightNoUpdate(double weight) { sharingWeight_ = weight; }
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_;
219 double sharingWeight_ = 1.0; /**< priority (1.0 by default) */
220 double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
221 double remains_; /**< How much of that cost remains to be done in the currently running task */
222 double start_; /**< start time */
223 char *category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
225 -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
228 simgrid::surf::Model *model_;
229 void *data_ = nullptr; /**< for your convenience */
232 double lastUpdate_ = 0;
233 double lastValue_ = 0;
234 lmm_variable_t variable_ = nullptr;
235 enum heap_action_type hat_ = NOTSET;
239 virtual void updateRemainingLazy(double now) { THROW_IMPOSSIBLE; };
240 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
241 void heapRemove(xbt_heap_t heap);
242 void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
243 void updateIndexHeap(int i);
244 lmm_variable_t getVariable() {return variable_;}
245 void setVariable(lmm_variable_t var) { variable_ = var; }
246 double getLastUpdate() {return lastUpdate_;}
247 void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
248 double getLastValue() { return lastValue_; }
249 void setLastValue(double val) { lastValue_ = val; }
250 enum heap_action_type getHat() { return hat_; }
251 bool is_linked() {return action_lmm_hook.is_linked();}
252 int getIndexHeap() { return indexHeap_; }
257 typedef Action::ActionList ActionList;
259 typedef boost::intrusive::member_hook<
260 Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
261 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
262 typedef ActionLmmList* ActionLmmListPtr;
268 /** @ingroup SURF_interface
269 * @brief SURF model interface class
270 * @details A model is an object which handle the interactions between its Resources and its Actions
272 XBT_PUBLIC_CLASS Model {
277 /** @brief Get the set of [actions](@ref Action) in *ready* state */
278 virtual ActionList* getReadyActionSet() {return readyActionSet_;}
280 /** @brief Get the set of [actions](@ref Action) in *running* state */
281 virtual ActionList* getRunningActionSet() {return runningActionSet_;}
283 /** @brief Get the set of [actions](@ref Action) in *failed* state */
284 virtual ActionList* getFailedActionSet() {return failedActionSet_;}
286 /** @brief Get the set of [actions](@ref Action) in *done* state */
287 virtual ActionList* getDoneActionSet() {return doneActionSet_;}
289 /** @brief Get the set of modified [actions](@ref Action) */
290 virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
292 /** @brief Get the maxmin system of the current Model */
293 lmm_system_t getMaxminSystem() {return maxminSystem_;}
296 * @brief Get the update mechanism of the current Model
299 e_UM_t getUpdateMechanism() {return updateMechanism_;}
300 void setUpdateMechanism(e_UM_t mechanism) { updateMechanism_ = mechanism; }
302 /** @brief Get Action heap */
303 xbt_heap_t getActionHeap() {return actionHeap_;}
306 * @brief Share the resources between the actions
308 * @param now The current time of the simulation
309 * @return The delta of time till the next action will finish
311 virtual double nextOccuringEvent(double now);
312 virtual double nextOccuringEventLazy(double now);
313 virtual double nextOccuringEventFull(double now);
316 * @brief Update action to the current time
318 * @param now The current time of the simulation
319 * @param delta The delta of time since the last update
321 virtual void updateActionsState(double now, double delta);
322 virtual void updateActionsStateLazy(double now, double delta);
323 virtual void updateActionsStateFull(double now, double delta);
325 /** @brief Returns whether this model have an idempotent shareResource()
327 * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
328 * so we need to call it only when the next timestamp of other sources is computed.
330 virtual bool nextOccuringEventIsIdempotent() { return true;}
333 ActionLmmListPtr modifiedSet_;
334 lmm_system_t maxminSystem_ = nullptr;
335 bool selectiveUpdate_;
336 xbt_heap_t actionHeap_;
339 e_UM_t updateMechanism_ = UM_UNDEFINED;
340 ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
341 ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
342 ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
343 ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
353 /** @ingroup SURF_interface
354 * @brief Resource which have a metric handled by a maxmin system
356 struct s_surf_metric_t {
357 double peak; /**< The peak of the metric, ie its max value */
358 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
359 tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
365 /** @ingroup SURF_interface
366 * @brief SURF resource interface class
367 * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
369 XBT_PUBLIC_CLASS Resource {
372 * @brief Constructor of LMM Resources
374 * @param model Model associated to this Resource
375 * @param name The name of the Resource
376 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
378 Resource(Model * model, const std::string& name, lmm_constraint_t constraint);
382 /** @brief Get the Model of the current Resource */
383 Model* model() const;
385 /** @brief Get the name of the current Resource */
386 const std::string& getName() const;
387 /** @brief Get the name of the current Resource */
388 const char* getCname() const;
390 bool operator==(const Resource &other) const;
393 * @brief Apply an event of external load event to that resource
395 * @param event What happened
396 * @param value [TODO]
398 virtual void apply_event(tmgr_trace_event_t event, double value) = 0;
400 /** @brief Check if the current Resource is used (if it currently serves an action) */
401 virtual bool isUsed()=0;
403 /** @brief Check if the current Resource is active */
404 virtual bool isOn() const;
405 /** @brief Check if the current Resource is shut down */
406 virtual bool isOff() const;
407 /** @brief Turn on the current Resource */
408 virtual void turnOn();
409 /** @brief Turn off the current Resource */
410 virtual void turnOff();
418 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
419 lmm_constraint_t constraint() const;
422 const lmm_constraint_t constraint_ = nullptr;
429 template <> class hash<simgrid::surf::Resource> {
431 std::size_t operator()(const simgrid::surf::Resource& r) const { return (std::size_t)xbt_str_hash(r.getCname()); }
435 #endif /* SURF_MODEL_H_ */