Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics in the info message of L07 model starting up
[simgrid.git] / src / surf / surf_interface.hpp
1 /* Copyright (c) 2004-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef SURF_MODEL_H_
8 #define SURF_MODEL_H_
9
10 #include <xbt.h>
11 #include <string>
12 #include <vector>
13 #include <memory>
14 #include <boost/function.hpp>
15 #include <boost/intrusive/list.hpp>
16 #include "surf/trace_mgr.h"
17 #include "xbt/lib.h"
18 #include "surf/surf_routing.h"
19 #include "simgrid/platf_interface.h"
20 #include "surf/surf.h"
21 #include "surf/surf_private.h"
22 #include "internal_config.h"
23
24 #ifdef LIBSIGC
25 #include <sigc++/sigc++.h>
26 #define surf_callback(arg1, ...)  sigc::signal<arg1,__VA_ARGS__>
27 #define surf_callback_connect(callback, fun_ptr) callback.connect(sigc::ptr_fun(fun_ptr))
28 #define surf_callback_emit(callback, ...) callback.emit(__VA_ARGS__)
29 #else
30 #include <boost/signals2.hpp>
31 #define surf_callback(arg1, ...)  boost::signals2::signal<arg1(__VA_ARGS__)>
32 #define surf_callback_connect(callback, fun_ptr) callback.connect(fun_ptr)
33 #define surf_callback_emit(callback, ...) callback(__VA_ARGS__)
34 #endif
35
36 extern tmgr_history_t history;
37 #define NO_MAX_DURATION -1.0
38
39 using namespace std;
40
41 /*********
42  * Utils *
43  *********/
44
45 /* user-visible parameters */
46 extern double sg_tcp_gamma;
47 extern double sg_sender_gap;
48 extern double sg_latency_factor;
49 extern double sg_bandwidth_factor;
50 extern double sg_weight_S_parameter;
51 extern int sg_network_crosstraffic;
52 #ifdef HAVE_GTNETS
53 extern double sg_gtnets_jitter;
54 extern int sg_gtnets_jitter_seed;
55 #endif
56 extern xbt_dynar_t surf_path;
57
58 extern "C" {
59 XBT_PUBLIC(double) surf_get_clock(void);
60 }
61
62 extern double sg_sender_gap;
63
64 extern surf_callback(void, void) surfExitCallbacks;
65
66 int __surf_is_absolute_file_path(const char *file_path);
67
68 /***********
69  * Classes *
70  ***********/
71 typedef boost::intrusive::list<Action> ActionList;
72 typedef ActionList* ActionListPtr;
73 typedef boost::intrusive::list_base_hook<> actionHook;
74
75 struct lmmTag;
76 typedef boost::intrusive::list<Action, boost::intrusive::base_hook<boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > > > ActionLmmList;
77 typedef ActionLmmList* ActionLmmListPtr;
78 typedef boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > actionLmmHook;
79
80
81 enum heap_action_type{
82   LATENCY = 100,
83   MAX_DURATION,
84   NORMAL,
85   NOTSET
86 };
87
88 /*********
89  * Trace *
90  *********/
91 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
92 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
93 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
94 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
95 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
96 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
97 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
98
99 /*********
100  * Model *
101  *********/
102 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
103
104 /** @ingroup SURF_interface
105  * @brief SURF model interface class
106  * @details A model is an object which handle the interactions between its Resources and its Actions
107  */
108 XBT_PUBLIC_CLASS Model {
109 public:
110   /**
111    * @brief Model constructor
112    *
113    * @param name the name of the model
114    */
115   Model(const char *name);
116
117   /**
118    * @brief Model destructor
119    */
120   virtual ~Model();
121
122   virtual void addTraces() =0;
123
124   /**
125    * @brief Get the name of the current Model
126    *
127    * @return The name of the current Model
128    */
129   const char *getName() {return p_name;}
130
131   /**
132    * @brief Get the set of [actions](@ref Action) in *ready* state
133    *
134    * @return The set of [actions](@ref Action) in *ready* state
135    */
136   virtual ActionListPtr getReadyActionSet() {return p_readyActionSet;}
137
138   /**
139    * @brief Get the set of [actions](@ref Action) in *running* state
140    *
141    * @return The set of [actions](@ref Action) in *running* state
142    */
143   virtual ActionListPtr getRunningActionSet() {return p_runningActionSet;}
144
145   /**
146    * @brief Get the set of [actions](@ref Action) in *failed* state
147    *
148    * @return The set of [actions](@ref Action) in *failed* state
149    */
150   virtual ActionListPtr getFailedActionSet() {return p_failedActionSet;}
151
152   /**
153    * @brief Get the set of [actions](@ref Action) in *done* state
154    *
155    * @return The set of [actions](@ref Action) in *done* state
156    */
157   virtual ActionListPtr getDoneActionSet() {return p_doneActionSet;}
158
159   /**
160    * @brief Get the set of modified [actions](@ref Action)
161    *
162    * @return The set of modified [actions](@ref Action)
163    */
164   virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
165
166   /**
167    * @brief Get the maxmin system of the current Model
168    *
169    * @return The maxmin system of the current Model
170    */
171   lmm_system_t getMaxminSystem() {return p_maxminSystem;}
172
173   /**
174    * @brief Get the update mechanism of the current Model
175    * @see e_UM_t
176    *
177    * @return [description]
178    */
179   e_UM_t getUpdateMechanism() {return p_updateMechanism;}
180
181   /**
182    * @brief Get Action heap
183    * @details [TODO]
184    *
185    * @return The Action heap
186    */
187   xbt_heap_t getActionHeap() {return p_actionHeap;}
188
189   /**
190    * @brief share the resources
191    * @details Share the resources between the actions
192    *
193    * @param now The current time of the simulation
194    * @return The delta of time till the next action will finish
195    */
196   virtual double shareResources(double now);
197   virtual double shareResourcesLazy(double now);
198   virtual double shareResourcesFull(double now);
199   double shareResourcesMaxMin(ActionListPtr running_actions,
200                                       lmm_system_t sys,
201                                       void (*solve) (lmm_system_t));
202
203   /**
204    * @brief Update state of actions
205    * @details Update action to the current time
206    *
207    * @param now The current time of the simulation
208    * @param delta The delta of time since the last update
209    */
210   virtual void updateActionsState(double now, double delta);
211   virtual void updateActionsStateLazy(double now, double delta);
212   virtual void updateActionsStateFull(double now, double delta);
213
214 protected:
215   ActionLmmListPtr p_modifiedSet;
216   lmm_system_t p_maxminSystem;
217   e_UM_t p_updateMechanism;
218   int m_selectiveUpdate;
219   xbt_heap_t p_actionHeap;
220
221 private:
222   const char *p_name;
223
224   ActionListPtr p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
225   ActionListPtr p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
226   ActionListPtr p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
227   ActionListPtr p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
228 };
229
230 /************
231  * Resource *
232  ************/
233
234 /** @ingroup SURF_interface
235  * @brief Resource which have a metric handled by a maxmin system
236  */
237 typedef struct {
238   double scale;             /**< The scale of the metric */
239   double peak;              /**< The peak of the metric */
240   tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
241 } s_surf_metric_t;
242
243 /** @ingroup SURF_interface
244  * @brief SURF resource interface class
245  * @details A resource represent an element of a component (e.g.: a link for the network)
246  */
247 XBT_PUBLIC_CLASS Resource {
248 public:
249   /**
250    * @brief Resource constructor
251    */
252   Resource();
253
254   /**
255    * @brief Resource constructor
256    *
257    * @param model Model associated to this Resource
258    * @param name The name of the Resource
259    * @param props Dictionary of properties associated to this Resource
260    */
261   Resource(Model *model, const char *name, xbt_dict_t props);
262
263   /**
264    * @brief Resource constructor
265    *
266    * @param model Model associated to this Resource
267    * @param name The name of the Resource
268    * @param props Dictionary of properties associated to this Resource
269    * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
270    */
271   Resource(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
272   /**
273    * @brief Resource constructor
274    *
275    * @param model Model associated to this Resource
276    * @param name The name of the Resource
277    * @param props Dictionary of properties associated to this Resource
278    * @param stateInit the initial state of the Resource
279    */
280   Resource(Model *model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit);
281
282   /**
283    * @brief Resource destructor
284    */
285   virtual ~Resource();
286
287   /**
288    * @brief Get the Model of the current Resource
289    *
290    * @return The Model of the current Resource
291    */
292   Model *getModel();
293
294   /**
295    * @brief Get the name of the current Resource
296    *
297    * @return The name of the current Resource
298    */
299   const char *getName();
300
301   /**
302    * @brief Get the properties of the current Resource
303    *
304    * @return The properties of the current Resource
305    */
306   virtual xbt_dict_t getProperties();
307
308   /**
309    * @brief Update the state of the current Resource
310    * @details [TODO]
311    *
312    * @param event_type [TODO]
313    * @param value [TODO]
314    * @param date [TODO]
315    */
316   virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
317
318   /**
319    * @brief Check if the current Resource is used
320    * @return true if the current Resource is used, false otherwise
321    */
322   virtual bool isUsed()=0;
323
324   /**
325    * @brief Check if the current Resource is active
326    *
327    * @return true if the current Resource is active, false otherwise
328    */
329   bool isOn();
330
331   /**
332    * @brief Turn on the current Resource
333    */
334   void turnOn();
335
336   /**
337    * @brief Turn off the current Resource
338    */
339   void turnOff();
340
341   /**
342    * @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource
343    *
344    * @return The state of the currenrt Resource
345    */
346   virtual e_surf_resource_state_t getState();
347
348   /**
349    * @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource
350    *
351    * @param state The new state of the current Resource
352    */
353   virtual void setState(e_surf_resource_state_t state);
354
355 private:
356   const char *p_name;
357   xbt_dict_t p_properties;
358   Model *p_model;
359   bool m_running;
360   e_surf_resource_state_t m_stateCurrent;
361
362   /* LMM */
363 public:
364   /**
365    * @brief Get the lmm constraint associated to this Resource if it is part of a LMM component
366    *
367    * @return The lmm constraint associated to this Resource
368    */
369   lmm_constraint_t getConstraint();
370 private:
371   lmm_constraint_t p_constraint;
372 };
373
374 /**********
375  * Action *
376  **********/
377 void surf_action_lmm_update_index_heap(void *action, int i);
378
379 /** @ingroup SURF_interface
380  * @brief SURF action interface class
381  * @details An action is an event generated by a resource (e.g.: a communication for the network)
382  */
383 XBT_PUBLIC_CLASS Action : public actionHook, public actionLmmHook {
384 private:
385   /**
386    * @brief Common initializations for the constructors
387    */
388   void initialize(Model *model, double cost, bool failed,
389                   lmm_variable_t var = NULL);
390
391 public:
392   /**
393    * @brief Action constructor
394    *
395    * @param model The Model associated to this Action
396    * @param cost The cost of the Action
397    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
398    */
399   Action(Model *model, double cost, bool failed);
400
401   /**
402    * @brief Action constructor
403    *
404    * @param model The Model associated to this Action
405    * @param cost The cost of the Action
406    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
407    * @param var The lmm variable associated to this Action if it is part of a LMM component
408    */
409   Action(Model *model, double cost, bool failed, lmm_variable_t var);
410
411   /**
412    * @brief Action destructor
413    */
414   virtual ~Action();
415
416   /**
417    * @brief Finish the action
418    */
419   void finish();
420
421   /**
422    * @brief Get the [state](\ref e_surf_action_state_t) of the current Action
423    *
424    * @return The state of the current Action
425    */
426   e_surf_action_state_t getState(); /**< get the state*/
427
428   /**
429    * @brief Set the [state](\ref e_surf_action_state_t) of the current Action
430    *
431    * @param state The new state of the current Action
432    */
433   virtual void setState(e_surf_action_state_t state);
434
435   /**
436    * @brief Get the bound of the current Action
437    *
438    * @return The bound of the current Action
439    */
440   double getBound();
441
442   /**
443    * @brief Set the bound of the current Action
444    *
445    * @param bound The new bound of the current Action
446    */
447   void setBound(double bound);
448
449   /**
450    * @brief Get the start time of the current action
451    *
452    * @return The start time of the current action
453    */
454   double getStartTime();
455
456   /**
457    * @brief Get the finish time of the current action
458    *
459    * @return The finish time of the current action
460    */
461   double getFinishTime();
462
463   /**
464    * @brief Get the data associated to the current action
465    *
466    * @return The data associated to the current action
467    */
468   void *getData() {return p_data;}
469
470   /**
471    * @brief Set the data associated to the current action
472    *
473    * @param data The new data associated to the current action
474    */
475   void setData(void* data);
476
477   /**
478    * @brief Get the maximum duration of the current action
479    *
480    * @return The maximum duration of the current action
481    */
482   double getMaxDuration() {return m_maxDuration;}
483
484   /**
485    * @brief Get the category associated to the current action
486    *
487    * @return The category associated to the current action
488    */
489   char *getCategory() {return p_category;}
490
491   /**
492    * @brief Get the cost of the current action
493    *
494    * @return The cost of the current action
495    */
496   double getCost() {return m_cost;}
497
498   /**
499    * @brief Set the cost of the current action
500    *
501    * @param cost The new cost of the current action
502    */
503   void setCost(double cost) {m_cost = cost;}
504
505   /**
506    * @brief Update the maximum duration of the current action
507    *
508    * @param delta [TODO]
509    */
510   void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
511
512   /**
513    * @brief Update the remaining time of the current action
514    *
515    * @param delta [TODO]
516    */
517   void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
518
519   /**
520    * @brief Set the remaining time of the current action
521    *
522    * @param value The new remaining time of the current action
523    */
524   void setRemains(double value) {m_remains = value;}
525
526   /**
527    * @brief Set the finish time of the current action
528    *
529    * @param value The new Finush time of the current action
530    */
531   void setFinishTime(double value) {m_finish = value;}
532
533   /**
534    * @brief Add a reference to the current action
535    */
536   void ref();
537
538   /**
539    * @brief Remove a reference to the current action
540    * @details If the Action has no more reference, we destroy it
541    *
542    * @return true if the action was destroyed and false if someone still has references on it
543    */
544   virtual int unref();
545
546   /**
547    * @brief Cancel the current Action if running
548    */
549   virtual void cancel();
550
551   /**
552    * @brief Recycle an Action
553    */
554   virtual void recycle(){};
555
556   /**
557    * @brief Suspend the current Action
558    */
559   virtual void suspend();
560
561   /**
562    * @brief Resume the current Action
563    */
564   virtual void resume();
565
566   /**
567    * @brief Check if the current action is running
568    *
569    * @return true if the current Action is suspended, false otherwise
570    */
571   virtual bool isSuspended();
572
573   /**
574    * @brief Set the maximum duration of the current Action
575    *
576    * @param duration The new maximum duration of the current Action
577    */
578   virtual void setMaxDuration(double duration);
579
580   /**
581    * @brief Set the priority of the current Action
582    *
583    * @param priority The new priority of the current Action
584    */
585   virtual void setPriority(double priority);
586
587   /**
588    * @brief Set the category of the current Action
589    *
590    * @param category The new category of the current Action
591    */
592   void setCategory(const char *category);
593
594   /**
595    * @brief Get the remaining time of the current action after updating the resource
596    *
597    * @return The remaining time
598    */
599   virtual double getRemains();
600
601   /**
602    * @brief Get the remaining time of the current action without updating the resource
603    *
604    * @return The remaining time
605    */
606   double getRemainsNoUpdate();
607
608   /**
609    * @brief Get the priority of the current Action
610    *
611    * @return The priority of the current Action
612    */
613   double getPriority() {return m_priority;};
614
615   /**
616    * @brief Get the state set in which the action is
617    *
618    * @return The state set in which the action is
619    */
620   ActionListPtr getStateSet() {return p_stateSet;};
621
622   s_xbt_swag_hookup_t p_stateHookup;
623
624   Model *getModel() {return p_model;}
625
626 protected:
627   ActionListPtr p_stateSet;
628   double m_priority; /**< priority (1.0 by default) */
629   int    m_refcount;
630   double m_remains; /**< How much of that cost remains to be done in the currently running task */
631   double m_maxDuration; /*< max_duration (may fluctuate until the task is completed) */
632   double m_finish; /**< finish time : this is modified during the run and fluctuates until the task is completed */
633
634 private:
635   bool m_failed;
636   double m_start; /**< start time  */
637   char *p_category;               /**< tracing category for categorized resource utilization monitoring */
638
639   #ifdef HAVE_LATENCY_BOUND_TRACKING
640   int m_latencyLimited;               /**< Set to 1 if is limited by latency, 0 otherwise */
641   #endif
642   double    m_cost;
643   Model *p_model;
644   void *p_data; /**< for your convenience */
645
646   /* LMM */
647 public:
648   virtual void updateRemainingLazy(double now);
649   void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
650   void heapRemove(xbt_heap_t heap);
651   void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
652   void updateIndexHeap(int i);
653   lmm_variable_t getVariable() {return p_variable;}
654   double getLastUpdate() {return m_lastUpdate;}
655   void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
656   enum heap_action_type getHat() {return m_hat;}
657   bool is_linked() {return actionLmmHook::is_linked();}
658   void gapRemove();
659
660 protected:
661   lmm_variable_t p_variable;
662   double m_lastValue;
663   double m_lastUpdate;
664   int m_suspended;
665   int m_indexHeap;
666   enum heap_action_type m_hat;
667 };
668
669 #endif /* SURF_MODEL_H_ */