Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
339df0da7f7b9d8631bc1bf566975a9103b03ae4
[simgrid.git] / src / surf / surf_interface.hpp
1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef SURF_MODEL_H_
7 #define SURF_MODEL_H_
8
9 #include "xbt/signal.hpp"
10 #include "xbt/utility.hpp"
11
12 #include "src/surf/surf_private.hpp"
13 #include "surf/surf.hpp"
14 #include "xbt/str.h"
15
16 #include <boost/heap/pairing_heap.hpp>
17 #include <boost/intrusive/list.hpp>
18 #include <boost/optional.hpp>
19 #include <cmath>
20 #include <set>
21 #include <string>
22 #include <unordered_map>
23
24 #define NO_MAX_DURATION -1.0
25
26 /*********
27  * Utils *
28  *********/
29
30 /* user-visible parameters */
31 XBT_PUBLIC_DATA(double) sg_maxmin_precision;
32 XBT_PUBLIC_DATA(double) sg_surf_precision;
33 XBT_PUBLIC_DATA(int) sg_concurrency_limit;
34
35 extern XBT_PRIVATE double sg_tcp_gamma;
36 extern XBT_PRIVATE double sg_latency_factor;
37 extern XBT_PRIVATE double sg_bandwidth_factor;
38 extern XBT_PRIVATE double sg_weight_S_parameter;
39 extern XBT_PRIVATE int sg_network_crosstraffic;
40 extern XBT_PRIVATE std::vector<std::string> surf_path;
41 extern XBT_PRIVATE std::unordered_map<std::string, tmgr_trace_t> traces_set_list;
42 extern XBT_PRIVATE std::set<std::string> watched_hosts;
43
44 static inline void double_update(double* variable, double value, double precision)
45 {
46   // printf("Updating %g -= %g +- %g\n",*variable,value,precision);
47   // xbt_assert(value==0  || value>precision);
48   // Check that precision is higher than the machine-dependent size of the mantissa. If not, brutal rounding  may
49   // happen, and the precision mechanism is not active...
50   // xbt_assert(*variable< (2<<DBL_MANT_DIG)*precision && FLT_RADIX==2);
51   *variable -= value;
52   if (*variable < precision)
53     *variable = 0.0;
54 }
55
56 static inline int double_positive(double value, double precision)
57 {
58   return (value > precision);
59 }
60
61 static inline int double_equals(double value1, double value2, double precision)
62 {
63   return (fabs(value1 - value2) < precision);
64 }
65
66 extern "C" {
67 XBT_PUBLIC(double) surf_get_clock();
68 }
69 /** \ingroup SURF_simulation
70  *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
71  */
72 XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
73
74 namespace simgrid {
75 namespace surf {
76
77 extern XBT_PRIVATE simgrid::xbt::signal<void()> surfExitCallbacks;
78 }
79 }
80
81 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
82
83 /***********
84  * Classes *
85  ***********/
86
87 enum heap_action_type{
88   LATENCY = 100,
89   MAX_DURATION,
90   NORMAL,
91   NOTSET
92 };
93
94 /**********
95  * Action *
96  **********/
97
98 /** \ingroup SURF_models
99  *  \brief List of initialized models
100  */
101 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
102
103 namespace simgrid {
104 namespace surf {
105
106 typedef std::pair<double, simgrid::surf::Action*> heap_element_type;
107 typedef boost::heap::pairing_heap<heap_element_type, boost::heap::constant_time_size<false>, boost::heap::stable<true>,
108                                   boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>
109     heap_type;
110
111 /** @ingroup SURF_interface
112  * @brief SURF action interface class
113  * @details An action is an event generated by a resource (e.g.: a communication for the network)
114  */
115 XBT_PUBLIC_CLASS Action {
116 public:
117   boost::intrusive::list_member_hook<> action_hook;
118   boost::intrusive::list_member_hook<> action_lmm_hook;
119   typedef boost::intrusive::member_hook<
120     Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
121   typedef boost::intrusive::list<Action, ActionOptions> ActionList;
122
123   enum class State {
124     ready = 0,        /**< Ready        */
125     running,          /**< Running      */
126     failed,           /**< Task Failure */
127     done,             /**< Completed    */
128     to_free,          /**< Action to free in next cleanup */
129     not_in_the_system /**< Not in the system anymore. Why did you ask ? */
130   };
131
132   /**
133    * @brief Action constructor
134    *
135    * @param model The Model associated to this Action
136    * @param cost The cost of the Action
137    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
138    */
139   Action(simgrid::surf::Model *model, double cost, bool failed);
140
141   /**
142    * @brief Action constructor
143    *
144    * @param model The Model associated to this Action
145    * @param cost The cost of the Action
146    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
147    * @param var The lmm variable associated to this Action if it is part of a LMM component
148    */
149   Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
150
151   /** @brief Destructor */
152   virtual ~Action();
153
154   /**
155    * @brief Mark that the action is now finished
156    *
157    * @param state the new [state](\ref simgrid::surf::Action::State) of the current Action
158    */
159   void finish(Action::State state);
160
161   /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
162   Action::State getState() const; /**< get the state*/
163   /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
164   virtual void setState(Action::State state);
165
166   /** @brief Get the bound of the current Action */
167   double getBound() const;
168   /** @brief Set the bound of the current Action */
169   void setBound(double bound);
170
171   /** @brief Get the start time of the current action */
172   double getStartTime() const { return start_; }
173   /** @brief Get the finish time of the current action */
174   double getFinishTime() const { return finishTime_; }
175
176   /** @brief Get the user data associated to the current action */
177   void* getData() const { return data_; }
178   /** @brief Set the user data associated to the current action */
179   void setData(void* data) { data_ = data; }
180
181   /** @brief Get the cost of the current action */
182   double getCost() const { return cost_; }
183   /** @brief Set the cost of the current action */
184   void setCost(double cost) {cost_ = cost;}
185
186   /** @brief Update the maximum duration of the current action
187    *  @param delta Amount to remove from the MaxDuration */
188   void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
189
190   /** @brief Update the remaining time of the current action
191    *  @param delta Amount to remove from the remaining time */
192   void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
193
194   /** @brief Set the remaining time of the current action */
195   void setRemains(double value) {remains_ = value;}
196   /** @brief Get the remaining time of the current action after updating the resource */
197   virtual double getRemains();
198   /** @brief Get the remaining time of the current action without updating the resource */
199   double getRemainsNoUpdate() const { return remains_; }
200
201   /** @brief Set the finish time of the current action */
202   void setFinishTime(double value) {finishTime_ = value;}
203
204   /**@brief Add a reference to the current action (refcounting) */
205   void ref();
206   /** @brief Unref that action (and destroy it if refcount reaches 0)
207    *  @return true if the action was destroyed and false if someone still has references on it
208    */
209   virtual int unref();
210
211   /** @brief Cancel the current Action if running */
212   virtual void cancel();
213
214   /** @brief Suspend the current Action */
215   virtual void suspend();
216
217   /** @brief Resume the current Action */
218   virtual void resume();
219
220   /** @brief Returns true if the current action is running */
221   virtual bool isSuspended();
222
223   /** @brief Get the maximum duration of the current action */
224   double getMaxDuration() const { return maxDuration_; }
225   /** @brief Set the maximum duration of the current Action */
226   virtual void setMaxDuration(double duration);
227
228   /** @brief Get the tracing category associated to the current action */
229   char* getCategory() const { return category_; }
230   /** @brief Set the tracing category of the current Action */
231   void setCategory(const char *category);
232
233   /** @brief Get the priority of the current Action */
234   double getPriority() const { return sharingWeight_; };
235   /** @brief Set the priority of the current Action */
236   virtual void setSharingWeight(double priority);
237   void setSharingWeightNoUpdate(double weight) { sharingWeight_ = weight; }
238
239   /** @brief Get the state set in which the action is */
240   ActionList* getStateSet() const { return stateSet_; };
241
242   simgrid::surf::Model* getModel() const { return model_; }
243
244 protected:
245   ActionList* stateSet_;
246   int    refcount_ = 1;
247
248 private:
249   double sharingWeight_ = 1.0;             /**< priority (1.0 by default) */
250   double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
251   double remains_;                       /**< How much of that cost remains to be done in the currently running task */
252   double start_; /**< start time  */
253   char *category_ = nullptr;            /**< tracing category for categorized resource utilization monitoring */
254   double finishTime_ =
255       -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
256
257   double    cost_;
258   simgrid::surf::Model *model_;
259   void *data_ = nullptr; /**< for your convenience */
260
261   /* LMM */
262   double lastUpdate_         = 0;
263   double lastValue_          = 0;
264   lmm_variable_t variable_   = nullptr;
265   enum heap_action_type hat_ = NOTSET;
266   boost::optional<heap_type::handle_type> heapHandle_ = boost::none;
267
268 public:
269   virtual void updateRemainingLazy(double now) { THROW_IMPOSSIBLE; };
270   void heapInsert(heap_type& heap, double key, enum heap_action_type hat);
271   void heapRemove(heap_type& heap);
272   void heapUpdate(heap_type& heap, double key, enum heap_action_type hat);
273   void clearHeapHandle() { heapHandle_ = boost::none; }
274   lmm_variable_t getVariable() const { return variable_; }
275   void setVariable(lmm_variable_t var) { variable_ = var; }
276   double getLastUpdate() const { return lastUpdate_; }
277   void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
278   double getLastValue() const { return lastValue_; }
279   void setLastValue(double val) { lastValue_ = val; }
280   enum heap_action_type getHat() const { return hat_; }
281   bool is_linked() const { return action_lmm_hook.is_linked(); }
282 protected:
283   int suspended_ = 0;
284 };
285
286 typedef Action::ActionList ActionList;
287
288 typedef boost::intrusive::member_hook<
289   Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
290 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
291 typedef ActionLmmList* ActionLmmListPtr;
292
293 /*********
294  * Model *
295  *********/
296
297 /** @ingroup SURF_interface
298  * @brief SURF model interface class
299  * @details A model is an object which handle the interactions between its Resources and its Actions
300  */
301 XBT_PUBLIC_CLASS Model {
302 public:
303   Model();
304   virtual ~Model();
305
306   /** @brief Get the set of [actions](@ref Action) in *ready* state */
307   virtual ActionList* getReadyActionSet() const { return readyActionSet_; }
308
309   /** @brief Get the set of [actions](@ref Action) in *running* state */
310   virtual ActionList* getRunningActionSet() const { return runningActionSet_; }
311
312   /** @brief Get the set of [actions](@ref Action) in *failed* state */
313   virtual ActionList* getFailedActionSet() const { return failedActionSet_; }
314
315   /** @brief Get the set of [actions](@ref Action) in *done* state */
316   virtual ActionList* getDoneActionSet() const { return doneActionSet_; }
317
318   /** @brief Get the set of modified [actions](@ref Action) */
319   virtual ActionLmmListPtr getModifiedSet() const { return modifiedSet_; }
320
321   /** @brief Get the maxmin system of the current Model */
322   lmm_system_t getMaxminSystem() const { return maxminSystem_; }
323
324   /**
325    * @brief Get the update mechanism of the current Model
326    * @see e_UM_t
327    */
328   e_UM_t getUpdateMechanism() const { return updateMechanism_; }
329   void setUpdateMechanism(e_UM_t mechanism) { updateMechanism_ = mechanism; }
330
331   /** @brief Get Action heap */
332   heap_type& getActionHeap() { return actionHeap_; }
333
334   double actionHeapTopDate() const { return actionHeap_.top().first; }
335   Action* actionHeapPop();
336   bool actionHeapIsEmpty() const { return actionHeap_.empty(); }
337
338   /**
339    * @brief Share the resources between the actions
340    *
341    * @param now The current time of the simulation
342    * @return The delta of time till the next action will finish
343    */
344   virtual double nextOccuringEvent(double now);
345   virtual double nextOccuringEventLazy(double now);
346   virtual double nextOccuringEventFull(double now);
347
348   /**
349    * @brief Update action to the current time
350    *
351    * @param now The current time of the simulation
352    * @param delta The delta of time since the last update
353    */
354   virtual void updateActionsState(double now, double delta);
355   virtual void updateActionsStateLazy(double now, double delta);
356   virtual void updateActionsStateFull(double now, double delta);
357
358   /** @brief Returns whether this model have an idempotent shareResource()
359    *
360    * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
361    * so we need to call it only when the next timestamp of other sources is computed.
362    */
363   virtual bool nextOccuringEventIsIdempotent() { return true;}
364
365 protected:
366   ActionLmmListPtr modifiedSet_;
367   lmm_system_t maxminSystem_ = nullptr;
368   bool selectiveUpdate_;
369
370 private:
371   e_UM_t updateMechanism_ = UM_UNDEFINED;
372   ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
373   ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
374   ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
375   ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
376   heap_type actionHeap_;
377 };
378
379 }
380 }
381
382 /************
383  * Resource *
384  ************/
385
386 /** @ingroup SURF_interface
387  * @brief Resource which have a metric handled by a maxmin system
388  */
389 struct s_surf_metric_t {
390   double peak;              /**< The peak of the metric, ie its max value */
391   double scale;             /**< Current availability of the metric according to the traces, in [0,1] */
392   tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
393 };
394
395 namespace simgrid {
396 namespace surf {
397
398 /** @ingroup SURF_interface
399  * @brief SURF resource interface class
400  * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
401  */
402 XBT_PUBLIC_CLASS Resource {
403 public:
404   /**
405    * @brief Constructor of LMM Resources
406    *
407    * @param model Model associated to this Resource
408    * @param name The name of the Resource
409    * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
410    */
411   Resource(Model * model, const std::string& name, lmm_constraint_t constraint);
412
413   virtual ~Resource();
414
415   /** @brief Get the Model of the current Resource */
416   Model* model() const;
417
418   /** @brief Get the name of the current Resource */
419   const std::string& getName() const;
420   /** @brief Get the name of the current Resource */
421   const char* getCname() const;
422
423   bool operator==(const Resource &other) const;
424
425   /**
426    * @brief Apply an event of external load event to that resource
427    *
428    * @param event What happened
429    * @param value [TODO]
430    */
431   virtual void apply_event(tmgr_trace_event_t event, double value) = 0;
432
433   /** @brief Check if the current Resource is used (if it currently serves an action) */
434   virtual bool isUsed()=0;
435
436   /** @brief Check if the current Resource is active */
437   virtual bool isOn() const;
438   /** @brief Check if the current Resource is shut down */
439   virtual bool isOff() const;
440   /** @brief Turn on the current Resource */
441   virtual void turnOn();
442   /** @brief Turn off the current Resource */
443   virtual void turnOff();
444
445 private:
446   std::string name_;
447   Model *model_;
448   bool isOn_ = true;
449
450 public: /* LMM */
451   /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
452   lmm_constraint_t constraint() const;
453
454 protected:
455   const lmm_constraint_t constraint_ = nullptr;
456 };
457
458 }
459 }
460
461 namespace std {
462 template <> class hash<simgrid::surf::Resource> {
463 public:
464   std::size_t operator()(const simgrid::surf::Resource& r) const { return (std::size_t)xbt_str_hash(r.getCname()); }
465 };
466 }
467
468 #endif /* SURF_MODEL_H_ */