1 /* Copyright (c) 2004-2014. The SimGrid Team.
2 * All rights reserved. */
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. */
14 #include <boost/function.hpp>
15 #include <boost/intrusive/list.hpp>
16 #include "surf/trace_mgr.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"
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__)
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__)
36 extern tmgr_history_t history;
37 #define NO_MAX_DURATION -1.0
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;
53 extern double sg_gtnets_jitter;
54 extern int sg_gtnets_jitter_seed;
56 extern xbt_dynar_t surf_path;
59 XBT_PUBLIC(double) surf_get_clock(void);
62 extern double sg_sender_gap;
63 XBT_PUBLIC(int) SURF_CPU_LEVEL; //Surf cpu level
65 extern surf_callback(void, void) surfExitCallbacks;
67 int __surf_is_absolute_file_path(const char *file_path);
73 typedef Model* ModelPtr;
76 typedef Resource* ResourcePtr;
79 typedef Action* ActionPtr;
81 typedef boost::intrusive::list<Action> ActionList;
82 typedef ActionList* ActionListPtr;
83 typedef boost::intrusive::list_base_hook<> actionHook;
86 typedef boost::intrusive::list<Action, boost::intrusive::base_hook<boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > > > ActionLmmList;
87 typedef ActionLmmList* ActionLmmListPtr;
88 typedef boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > actionLmmHook;
91 enum heap_action_type{
101 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
102 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
103 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
104 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
105 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
106 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
107 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
112 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
114 /** @ingroup SURF_interface
115 * @brief SURF model interface class
116 * @details A model is an object which handle the interactions between its Resources and its Actions
118 XBT_PUBLIC_CLASS Model {
121 * @brief Model constructor
123 * @param name the name of the model
125 Model(const char *name);
128 * @brief Model destructor
132 virtual void addTraces() =0;
135 * @brief Get the name of the current Model
137 * @return The name of the current Model
139 const char *getName() {return p_name;}
142 * @brief Get the set of [actions](@ref Action) in *ready* state
144 * @return The set of [actions](@ref Action) in *ready* state
146 virtual ActionListPtr getReadyActionSet() {return p_readyActionSet;}
149 * @brief Get the set of [actions](@ref Action) in *running* state
151 * @return The set of [actions](@ref Action) in *running* state
153 virtual ActionListPtr getRunningActionSet() {return p_runningActionSet;}
156 * @brief Get the set of [actions](@ref Action) in *failed* state
158 * @return The set of [actions](@ref Action) in *failed* state
160 virtual ActionListPtr getFailedActionSet() {return p_failedActionSet;}
163 * @brief Get the set of [actions](@ref Action) in *done* state
165 * @return The set of [actions](@ref Action) in *done* state
167 virtual ActionListPtr getDoneActionSet() {return p_doneActionSet;}
170 * @brief Get the set of modified [actions](@ref Action)
172 * @return The set of modified [actions](@ref Action)
174 virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
177 * @brief Get the maxmin system of the current Model
179 * @return The maxmin system of the current Model
181 lmm_system_t getMaxminSystem() {return p_maxminSystem;}
184 * @brief Get the update mechanism of the current Model
187 * @return [description]
189 e_UM_t getUpdateMechanism() {return p_updateMechanism;}
192 * @brief Get Action heap
195 * @return The Action heap
197 xbt_heap_t getActionHeap() {return p_actionHeap;}
200 * @brief share the resources
201 * @details Share the resources between the actions
203 * @param now The current time of the simulation
204 * @return The delta of time till the next action will finish
206 virtual double shareResources(double now);
207 virtual double shareResourcesLazy(double now);
208 virtual double shareResourcesFull(double now);
209 double shareResourcesMaxMin(ActionListPtr running_actions,
211 void (*solve) (lmm_system_t));
214 * @brief Update state of actions
215 * @details Update action to the current time
217 * @param now The current time of the simulation
218 * @param delta The delta of time since the last update
220 virtual void updateActionsState(double now, double delta);
221 virtual void updateActionsStateLazy(double now, double delta);
222 virtual void updateActionsStateFull(double now, double delta);
225 ActionLmmListPtr p_modifiedSet;
226 lmm_system_t p_maxminSystem;
227 e_UM_t p_updateMechanism;
228 int m_selectiveUpdate;
229 xbt_heap_t p_actionHeap;
234 ActionListPtr p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
235 ActionListPtr p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
236 ActionListPtr p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
237 ActionListPtr p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
244 /** @ingroup SURF_interface
245 * @brief Resource which have a metric handled by a maxmin system
248 double scale; /**< The scale of the metric */
249 double peak; /**< The peak of the metric */
250 tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
253 /** @ingroup SURF_interface
254 * @brief SURF resource interface class
255 * @details A resource represent an element of a component (e.g.: a link for the network)
257 XBT_PUBLIC_CLASS Resource {
260 * @brief Resource constructor
265 * @brief Resource constructor
267 * @param model Model associated to this Resource
268 * @param name The name of the Resource
269 * @param props Dictionary of properties associated to this Resource
271 Resource(ModelPtr model, const char *name, xbt_dict_t props);
274 * @brief Resource constructor
276 * @param model Model associated to this Resource
277 * @param name The name of the Resource
278 * @param props Dictionary of properties associated to this Resource
279 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
281 Resource(ModelPtr model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
284 * @brief Resource constructor
286 * @param model Model associated to this Resource
287 * @param name The name of the Resource
288 * @param props Dictionary of properties associated to this Resource
289 * @param stateInit the initial state of the Resource
291 Resource(ModelPtr model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit);
294 * @brief Resource destructor
299 * @brief Get the Model of the current Resource
301 * @return The Model of the current Resource
306 * @brief Get the name of the current Resource
308 * @return The name of the current Resource
310 const char *getName();
313 * @brief Get the properties of the current Resource
315 * @return The properties of the current Resource
317 virtual xbt_dict_t getProperties();
320 * @brief Update the state of the current Resource
323 * @param event_type [TODO]
324 * @param value [TODO]
327 virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
330 * @brief Check if the current Resource is used
331 * @return true if the current Resource is used, false otherwise
333 virtual bool isUsed()=0;
336 * @brief Check if the current Resource is active
338 * @return true if the current Resource is active, false otherwise
343 * @brief Turn on the current Resource
348 * @brief Turn off the current Resource
353 * @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource
355 * @return The state of the currenrt Resource
357 virtual e_surf_resource_state_t getState();
360 * @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource
362 * @param state The new state of the current Resource
364 virtual void setState(e_surf_resource_state_t state);
368 xbt_dict_t p_properties;
371 e_surf_resource_state_t m_stateCurrent;
376 * @brief Get the lmm constraint associated to this Resource if it is part of a LMM component
378 * @return The lmm constraint associated to this Resource
380 lmm_constraint_t getConstraint();
382 lmm_constraint_t p_constraint;
388 void surf_action_lmm_update_index_heap(void *action, int i);
390 /** @ingroup SURF_interface
391 * @brief SURF action interface class
392 * @details An action is an event generated by a resource (e.g.: a communication for the network)
394 XBT_PUBLIC_CLASS Action : public actionHook, public actionLmmHook {
397 * @brief Common initializations for the constructors
399 void initialize(ModelPtr model, double cost, bool failed,
400 lmm_variable_t var = NULL);
404 * @brief Action constructor
406 * @param model The Model associated to this Action
407 * @param cost The cost of the Action
408 * @param failed If the action is impossible (e.g.: execute something on a switched off workstation)
410 Action(ModelPtr model, double cost, bool failed);
413 * @brief Action constructor
415 * @param model The Model associated to this Action
416 * @param cost The cost of the Action
417 * @param failed If the action is impossible (e.g.: execute something on a switched off workstation)
418 * @param var The lmm variable associated to this Action if it is part of a LMM component
420 Action(ModelPtr model, double cost, bool failed, lmm_variable_t var);
423 * @brief Action destructor
428 * @brief Finish the action
433 * @brief Get the [state](\ref e_surf_action_state_t) of the current Action
435 * @return The state of the current Action
437 e_surf_action_state_t getState(); /**< get the state*/
440 * @brief Set the [state](\ref e_surf_action_state_t) of the current Action
442 * @param state The new state of the current Action
444 virtual void setState(e_surf_action_state_t state);
447 * @brief Get the bound of the current Action
449 * @return The bound of the current Action
454 * @brief Set the bound of the current Action
456 * @param bound The new bound of the current Action
458 void setBound(double bound);
461 * @brief Get the start time of the current action
463 * @return The start time of the current action
465 double getStartTime();
468 * @brief Get the finish time of the current action
470 * @return The finish time of the current action
472 double getFinishTime();
475 * @brief Get the data associated to the current action
477 * @return The data associated to the current action
479 void *getData() {return p_data;}
482 * @brief Set the data associated to the current action
484 * @param data The new data associated to the current action
486 void setData(void* data);
489 * @brief Get the maximum duration of the current action
491 * @return The maximum duration of the current action
493 double getMaxDuration() {return m_maxDuration;}
496 * @brief Get the category associated to the current action
498 * @return The category associated to the current action
500 char *getCategory() {return p_category;}
503 * @brief Get the cost of the current action
505 * @return The cost of the current action
507 double getCost() {return m_cost;}
510 * @brief Set the cost of the current action
512 * @param cost The new cost of the current action
514 void setCost(double cost) {m_cost = cost;}
517 * @brief Update the maximum duration of the current action
519 * @param delta [TODO]
521 void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
524 * @brief Update the remaining time of the current action
526 * @param delta [TODO]
528 void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
531 * @brief Set the remaining time of the current action
533 * @param value The new remaining time of the current action
535 void setRemains(double value) {m_remains = value;}
538 * @brief Set the finish time of the current action
540 * @param value The new Finush time of the current action
542 void setFinishTime(double value) {m_finish = value;}
545 * @brief Add a reference to the current action
550 * @brief Remove a reference to the current action
551 * @details If the Action has no more reference, we destroy it
553 * @return true if the action was destroyed and false if someone still has references on it
558 * @brief Cancel the current Action if running
560 virtual void cancel();
563 * @brief Recycle an Action
565 virtual void recycle(){};
568 * @brief Suspend the current Action
570 virtual void suspend();
573 * @brief Resume the current Action
575 virtual void resume();
578 * @brief Check if the current action is running
580 * @return true if the current Action is suspended, false otherwise
582 virtual bool isSuspended();
585 * @brief Set the maximum duration of the current Action
587 * @param duration The new maximum duration of the current Action
589 virtual void setMaxDuration(double duration);
592 * @brief Set the priority of the current Action
594 * @param priority The new priority of the current Action
596 virtual void setPriority(double priority);
600 * @brief Set the category of the current Action
602 * @param category The new category of the current Action
604 void setCategory(const char *category);
608 * @brief Get the remaining time of the current action after updating the resource
610 * @return The remaining time
612 virtual double getRemains();
615 * @brief Get the remaining time of the current action without updating the resource
617 * @return The remaining time
619 double getRemainsNoUpdate();
622 * @brief Get the priority of the current Action
624 * @return The priority of the current Action
626 double getPriority() {return m_priority;};
629 * @brief Get the state set in which the action is
631 * @return The state set in which the action is
633 ActionListPtr getStateSet() {return p_stateSet;};
635 s_xbt_swag_hookup_t p_stateHookup;
637 ModelPtr getModel() {return p_model;}
640 ActionListPtr p_stateSet;
641 double m_priority; /**< priority (1.0 by default) */
643 double m_remains; /**< How much of that cost remains to be done in the currently running task */
644 double m_maxDuration; /*< max_duration (may fluctuate until the task is completed) */
645 double m_finish; /**< finish time : this is modified during the run and fluctuates until the task is completed */
648 int resourceUsed(void *resource_id);
651 * @brief Share the resources to the actions
654 * @return In how much time the next action may terminate
656 double shareResources(double now);
659 * @brief Update the current action state
663 * @param delta [TODO]
665 void updateActionsState(double now, double delta);
668 * @brief Update the [TODO]
672 * @param event_type [TODO]
673 * @param value [TODO]
676 void updateResourceState(void *id, tmgr_trace_event_t event_type,
677 double value, double time);
679 ActionLmmListPtr p_modifiedSet;
680 xbt_heap_t p_actionHeap;
681 int m_selectiveUpdate;
683 double m_start; /**< start time */
684 char *p_category; /**< tracing category for categorized resource utilization monitoring */
686 #ifdef HAVE_LATENCY_BOUND_TRACKING
687 int m_latencyLimited; /**< Set to 1 if is limited by latency, 0 otherwise */
691 void *p_data; /**< for your convenience */
695 virtual void updateRemainingLazy(double now);
696 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
697 void heapRemove(xbt_heap_t heap);
698 void updateIndexHeap(int i);
699 lmm_variable_t getVariable() {return p_variable;}
700 double getLastUpdate() {return m_lastUpdate;}
701 void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
702 enum heap_action_type getHat() {return m_hat;}
703 bool is_linked() {return actionLmmHook::is_linked();}
707 lmm_variable_t p_variable;
712 enum heap_action_type m_hat;
715 #endif /* SURF_MODEL_H_ */