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
121 * @brief Model constructor
123 * @param name the name of the model
125 Model(const char *name);
128 * @brief Model destructor
133 * @brief Get the name of the current Model
135 * @return The name of the current Model
137 const char *getName() {return p_name;}
140 * @brief Get the set of [actions](@ref Action) in *ready* state
142 * @return The set of [actions](@ref Action) in *ready* state
144 virtual ActionListPtr getReadyActionSet() {return p_readyActionSet;}
147 * @brief Get the set of [actions](@ref Action) in *running* state
149 * @return The set of [actions](@ref Action) in *running* state
151 virtual ActionListPtr getRunningActionSet() {return p_runningActionSet;}
154 * @brief Get the set of [actions](@ref Action) in *failed* state
156 * @return The set of [actions](@ref Action) in *failed* state
158 virtual ActionListPtr getFailedActionSet() {return p_failedActionSet;}
161 * @brief Get the set of [actions](@ref Action) in *done* state
163 * @return The set of [actions](@ref Action) in *done* state
165 virtual ActionListPtr getDoneActionSet() {return p_doneActionSet;}
168 * @brief Get the set of modified [actions](@ref Action)
170 * @return The set of modified [actions](@ref Action)
172 virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
175 * @brief Get the maxmin system of the current Model
177 * @return The maxmin system of the current Model
179 lmm_system_t getMaxminSystem() {return p_maxminSystem;}
182 * @brief Get the update mechanism of the current Model
185 * @return [description]
187 e_UM_t getUpdateMechanism() {return p_updateMechanism;}
190 * @brief Get Action heap
193 * @return The Action heap
195 xbt_heap_t getActionHeap() {return p_actionHeap;}
198 * @brief share the resources
199 * @details Share the resources between the actions
202 * @return the date of the next action will finish
204 virtual double shareResources(double now);
205 virtual double shareResourcesLazy(double now);
206 virtual double shareResourcesFull(double now);
207 double shareResourcesMaxMin(ActionListPtr running_actions,
209 void (*solve) (lmm_system_t));
212 * @brief Update state of actions
216 * @param delta [TODO]
218 virtual void updateActionsState(double now, double delta);
219 virtual void updateActionsStateLazy(double now, double delta);
220 virtual void updateActionsStateFull(double now, double delta);
223 ActionLmmListPtr p_modifiedSet;
224 lmm_system_t p_maxminSystem;
225 e_UM_t p_updateMechanism;
226 int m_selectiveUpdate;
227 xbt_heap_t p_actionHeap;
232 ActionListPtr p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
233 ActionListPtr p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
234 ActionListPtr p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
235 ActionListPtr p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
242 /** @ingroup SURF_interface
243 * @brief Resource which have a metric handled by a maxmin system
246 double scale; /**< The scale of the metric */
247 double peak; /**< The peak of the metric */
248 tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
251 /** @ingroup SURF_interface
252 * @brief SURF resource interface class
253 * @details A resource represent an element of a component (e.g.: a link for the network)
258 * @brief Resource constructor
263 * @brief Resource constructor
265 * @param model Model associated to this Resource
266 * @param name The name of the Resource
267 * @param props Dictionary of properties associated to this Resource
269 Resource(ModelPtr model, const char *name, xbt_dict_t props);
272 * @brief Resource constructor
274 * @param model Model associated to this Resource
275 * @param name The name of the Resource
276 * @param props Dictionary of properties associated to this Resource
277 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
279 Resource(ModelPtr model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
282 * @brief Resource constructor
284 * @param model Model associated to this Resource
285 * @param name The name of the Resource
286 * @param props Dictionary of properties associated to this Resource
287 * @param stateInit the initial state of the Resource
289 Resource(ModelPtr model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit);
292 * @brief Resource destructor
297 * @brief Get the Model of the current Resource
299 * @return The Model of the current Resource
304 * @brief Get the name of the current Resource
306 * @return The name of the current Resource
308 const char *getName();
311 * @brief Get the properties of the current Resource
313 * @return The properties of the current Resource
315 virtual xbt_dict_t getProperties();
318 * @brief Update the state of the current Resource
321 * @param event_type [TODO]
322 * @param value [TODO]
325 virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
328 * @brief Check if the current Resource is used
329 * @return true if the current Resource is used, false otherwise
331 virtual bool isUsed()=0;
334 * @brief Check if the current Resource is active
336 * @return true if the current Resource is active, false otherwise
341 * @brief Turn on the current Resource
346 * @brief Turn off the current Resource
351 * @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource
353 * @return The state of the currenrt Resource
355 virtual e_surf_resource_state_t getState();
358 * @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource
360 * @param state The new state of the current Resource
362 virtual void setState(e_surf_resource_state_t state);
366 xbt_dict_t p_properties;
369 e_surf_resource_state_t m_stateCurrent;
374 * @brief Get the lmm constraint associated to this Resource if it is part of a LMM component
376 * @return The lmm constraint associated to this Resource
378 lmm_constraint_t getConstraint();
380 lmm_constraint_t p_constraint;
386 void surf_action_lmm_update_index_heap(void *action, int i);
388 /** @ingroup SURF_interface
389 * @brief SURF action interface class
390 * @details An action is an event generated by a resource (e.g.: a communication for the network)
392 class Action : public actionHook, public actionLmmHook {
395 * @brief Action constructor
400 * @brief Action constructor
402 * @param model The Model associated to this Action
403 * @param cost The cost of the Action
404 * @param failed If the action is impossible (e.g.: execute something on a switched off workstation)
406 Action(ModelPtr model, double cost, bool failed);
409 * @brief Action constructor
411 * @param model The Model associated to this Action
412 * @param cost The cost of the Action
413 * @param failed If the action is impossible (e.g.: execute something on a switched off workstation)
414 * @param var The lmm variable associated to this Action if it is part of a LMM component
416 Action(ModelPtr model, double cost, bool failed, lmm_variable_t var);
419 * @brief Action destructor
424 * @brief Finish the action
429 * @brief Get the [state](\ref e_surf_action_state_t) of the current Action
431 * @return The state of the current Action
433 e_surf_action_state_t getState(); /**< get the state*/
436 * @brief Set the [state](\ref e_surf_action_state_t) of the current Action
438 * @param state The new state of the current Action
440 virtual void setState(e_surf_action_state_t state);
443 * @brief Get the bound of the current Action
445 * @return The bound of the current Action
450 * @brief Set the bound of the current Action
452 * @param bound The new bound of the current Action
454 void setBound(double bound);
457 * @brief Get the start time of the current action
459 * @return The start time of the current action
461 double getStartTime();
464 * @brief Get the finish time of the current action
466 * @return The finish time of the current action
468 double getFinishTime();
471 * @brief Get the data associated to the current action
473 * @return The data associated to the current action
475 void *getData() {return p_data;}
478 * @brief Set the data associated to the current action
480 * @param data The new data associated to the current action
482 void setData(void* data);
485 * @brief Get the maximum duration of the current action
487 * @return The maximum duration of the current action
489 double getMaxDuration() {return m_maxDuration;}
492 * @brief Get the category associated to the current action
494 * @return The category associated to the current action
496 char *getCategory() {return p_category;}
499 * @brief Get the cost of the current action
501 * @return The cost of the current action
503 double getCost() {return m_cost;}
506 * @brief Set the cost of the current action
508 * @param cost The new cost of the current action
510 void setCost(double cost) {m_cost = cost;}
513 * @brief Update the maximum duration of the current action
515 * @param delta [TODO]
517 void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta);}
520 * @brief Update the remaining time of the current action
522 * @param delta [TODO]
524 void updateRemains(double delta) {double_update(&m_remains, delta);}
527 * @brief Set the remaining time of the current action
529 * @param value The new remaining time of the current action
531 void setRemains(double value) {m_remains = value;}
534 * @brief Set the finish time of the current action
536 * @param value The new Finush time of the current action
538 void setFinishTime(double value) {m_finish = value;}
541 * @brief Add a reference to the current action
546 * @brief Remove a reference to the current action
547 * @details If the Action has no more reference, we destroy it
549 * @return true if the action was destroyed and false if someone still has references on it
554 * @brief Cancel the current Action if running
556 virtual void cancel();
559 * @brief Recycle an Action
561 virtual void recycle(){};
564 * @brief Suspend the current Action
566 virtual void suspend();
569 * @brief Resume the current Action
571 virtual void resume();
574 * @brief Check if the current action is running
576 * @return true if the current Action is suspended, false otherwise
578 virtual bool isSuspended();
581 * @brief Set the maximum duration of the current Action
583 * @param duration The new maximum duration of the current Action
585 virtual void setMaxDuration(double duration);
588 * @brief Set the priority of the current Action
590 * @param priority The new priority of the current Action
592 virtual void setPriority(double priority);
596 * @brief Set the category of the current Action
598 * @param category The new category of the current Action
600 void setCategory(const char *category);
604 * @brief Get the remaining time of the current action after updating the resource
606 * @return The remaining time
608 virtual double getRemains();
611 * @brief Get the remaining time of the current action without updating the resource
613 * @return The remaining time
615 double getRemainsNoUpdate();
618 * @brief Get the priority of the current Action
620 * @return The priority of the current Action
622 double getPriority() {return m_priority;};
625 * @brief Get the state set in which the action is
628 * @return The state set in which the action is
630 ActionListPtr getStateSet() {return p_stateSet;};
632 s_xbt_swag_hookup_t p_stateHookup;
635 ActionListPtr p_stateSet;
636 double m_priority; /**< priority (1.0 by default) */
638 double m_remains; /**< How much of that cost remains to be done in the currently running task */
639 double m_maxDuration; /*< max_duration (may fluctuate until the task is completed) */
640 double m_finish; /**< finish time : this is modified during the run and fluctuates until the task is completed */
642 ModelPtr getModel() {return p_model;}
645 int resourceUsed(void *resource_id);
648 * @brief Share the resources to the actions
652 * @return in how much time the next action may terminatedescription]
654 double shareResources(double now);
657 * @brief Update the current action state
661 * @param delta [TODO]
663 void updateActionsState(double now, double delta);
666 * @brief Update the [TODO]
670 * @param event_type [TODO]
671 * @param value [TODO]
674 void updateResourceState(void *id, tmgr_trace_event_t event_type,
675 double value, double time);
677 ActionLmmListPtr p_modifiedSet;
678 xbt_heap_t p_actionHeap;
679 int m_selectiveUpdate;
681 double m_start; /**< start time */
682 char *p_category; /**< tracing category for categorized resource utilization monitoring */
684 #ifdef HAVE_LATENCY_BOUND_TRACKING
685 int m_latencyLimited; /**< Set to 1 if is limited by latency, 0 otherwise */
689 void *p_data; /**< for your convenience */
693 virtual void updateRemainingLazy(double now);
694 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
695 void heapRemove(xbt_heap_t heap);
696 void updateIndexHeap(int i);
697 lmm_variable_t getVariable() {return p_variable;}
698 double getLastUpdate() {return m_lastUpdate;}
699 void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
700 enum heap_action_type getHat() {return m_hat;}
701 bool is_linked() {return actionLmmHook::is_linked();}
705 lmm_variable_t p_variable;
710 enum heap_action_type m_hat;
713 #endif /* SURF_MODEL_H_ */