1 /* Copyright (c) 2004-2016. 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. */
15 #include <boost/function.hpp>
16 #include <boost/intrusive/list.hpp>
17 #include "surf/trace_mgr.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/platf_interface.h"
21 #include "surf/surf.h"
22 #include "src/surf/surf_private.h"
23 #include "src/internal_config.h"
26 #include <sigc++/sigc++.h>
29 // Wraps sigc++ signals with the interface of boost::signals2:
30 template<class T> class signal;
31 template<class R, class... P>
32 class signal<R(P...)> {
34 sigc::signal<R, P...> sig_;
36 template<class T> XBT_ALWAYS_INLINE
37 void connect(T&& slot)
39 sig_.connect(std::forward<T>(slot));
41 template<class Res, class... Args> XBT_ALWAYS_INLINE
42 void connect(Res(*slot)(Args...))
44 sig_.connect(sigc::ptr_fun(slot));
46 template<class... Args>
47 R operator()(Args&&... args) const
49 return sig_.emit(std::forward<Args>(args)...);
55 #include <boost/signals2.hpp>
59 using signal = ::boost::signals2::signal<T>;
64 extern XBT_PRIVATE tmgr_history_t history;
65 #define NO_MAX_DURATION -1.0
71 /* user-visible parameters */
72 extern XBT_PRIVATE double sg_tcp_gamma;
73 extern XBT_PRIVATE double sg_sender_gap;
74 extern XBT_PRIVATE double sg_latency_factor;
75 extern XBT_PRIVATE double sg_bandwidth_factor;
76 extern XBT_PRIVATE double sg_weight_S_parameter;
77 extern XBT_PRIVATE int sg_network_crosstraffic;
78 extern XBT_PRIVATE xbt_dynar_t surf_path;
81 XBT_PUBLIC(double) surf_get_clock(void);
84 extern XBT_PRIVATE double sg_sender_gap;
89 extern XBT_PRIVATE simgrid::surf::signal<void(void)> surfExitCallbacks;
94 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
100 enum heap_action_type{
110 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
111 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
112 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
113 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
114 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
115 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
116 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
122 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
124 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
129 /** @ingroup SURF_interface
130 * @brief SURF action interface class
131 * @details An action is an event generated by a resource (e.g.: a communication for the network)
133 XBT_PUBLIC_CLASS Action {
135 boost::intrusive::list_member_hook<> action_hook;
136 boost::intrusive::list_member_hook<> action_lmm_hook;
137 typedef boost::intrusive::member_hook<
138 Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
139 typedef boost::intrusive::list<Action, ActionOptions> ActionList;
142 * @brief Common initializations for the constructors
144 void initialize(simgrid::surf::Model *model, double cost, bool failed,
145 lmm_variable_t var = NULL);
149 * @brief Action constructor
151 * @param model The Model associated to this Action
152 * @param cost The cost of the Action
153 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
155 Action(simgrid::surf::Model *model, double cost, bool failed);
158 * @brief Action constructor
160 * @param model The Model associated to this Action
161 * @param cost The cost of the Action
162 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
163 * @param var The lmm variable associated to this Action if it is part of a LMM component
165 Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
167 /** @brief Destructor */
170 /** @brief Mark that the action is now finished */
173 /** @brief Get the [state](\ref e_surf_action_state_t) of the current Action */
174 e_surf_action_state_t getState(); /**< get the state*/
175 /** @brief Set the [state](\ref e_surf_action_state_t) of the current Action */
176 virtual void setState(e_surf_action_state_t state);
178 /** @brief Get the bound of the current Action */
180 /** @brief Set the bound of the current Action */
181 void setBound(double bound);
183 /** @brief Get the start time of the current action */
184 double getStartTime();
185 /** @brief Get the finish time of the current action */
186 double getFinishTime();
188 /** @brief Get the user data associated to the current action */
189 void *getData() {return p_data;}
190 /** @brief Set the user data associated to the current action */
191 void setData(void* data);
193 /** @brief Get the cost of the current action */
194 double getCost() {return m_cost;}
195 /** @brief Set the cost of the current action */
196 void setCost(double cost) {m_cost = cost;}
198 /** @brief Update the maximum duration of the current action
199 * @param delta Amount to remove from the MaxDuration */
200 void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
202 /** @brief Update the remaining time of the current action
203 * @param delta Amount to remove from the remaining time */
204 void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
206 /** @brief Set the remaining time of the current action */
207 void setRemains(double value) {m_remains = value;}
208 /** @brief Get the remaining time of the current action after updating the resource */
209 virtual double getRemains();
210 /** @brief Get the remaining time of the current action without updating the resource */
211 double getRemainsNoUpdate();
213 /** @brief Set the finish time of the current action */
214 void setFinishTime(double value) {m_finish = value;}
216 /**@brief Add a reference to the current action (refcounting) */
218 /** @brief Unref that action (and destroy it if refcount reaches 0)
219 * @return true if the action was destroyed and false if someone still has references on it
223 /** @brief Cancel the current Action if running */
224 virtual void cancel();
226 /** @brief Suspend the current Action */
227 virtual void suspend();
229 /** @brief Resume the current Action */
230 virtual void resume();
232 /** @brief Returns true if the current action is running */
233 virtual bool isSuspended();
235 /** @brief Get the maximum duration of the current action */
236 double getMaxDuration() {return m_maxDuration;}
237 /** @brief Set the maximum duration of the current Action */
238 virtual void setMaxDuration(double duration);
240 /** @brief Get the tracing category associated to the current action */
241 char *getCategory() {return p_category;}
242 /** @brief Set the tracing category of the current Action */
243 void setCategory(const char *category);
245 /** @brief Get the priority of the current Action */
246 double getPriority() {return m_priority;};
247 /** @brief Set the priority of the current Action */
248 virtual void setPriority(double priority);
250 /** @brief Get the state set in which the action is */
251 ActionList* getStateSet() {return p_stateSet;};
253 s_xbt_swag_hookup_t p_stateHookup = {NULL,NULL};
255 simgrid::surf::Model *getModel() {return p_model;}
258 ActionList* p_stateSet;
259 double m_priority = 1.0; /**< priority (1.0 by default) */
261 double m_remains; /**< How much of that cost remains to be done in the currently running task */
262 double m_maxDuration = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
263 double m_finish = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
266 double m_start; /**< start time */
267 char *p_category = NULL; /**< tracing category for categorized resource utilization monitoring */
269 #ifdef HAVE_LATENCY_BOUND_TRACKING
270 int m_latencyLimited; /**< Set to 1 if is limited by latency, 0 otherwise */
273 simgrid::surf::Model *p_model;
274 void *p_data = NULL; /**< for your convenience */
278 virtual void updateRemainingLazy(double now);
279 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
280 void heapRemove(xbt_heap_t heap);
281 void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
282 void updateIndexHeap(int i);
283 lmm_variable_t getVariable() {return p_variable;}
284 double getLastUpdate() {return m_lastUpdate;}
285 void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
286 enum heap_action_type getHat() {return m_hat;}
287 bool is_linked() {return action_lmm_hook.is_linked();}
291 lmm_variable_t p_variable;
292 double m_lastValue = 0;
293 double m_lastUpdate = 0;
296 enum heap_action_type m_hat = NOTSET;
299 typedef Action::ActionList ActionList;
301 typedef boost::intrusive::member_hook<
302 Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
303 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
304 typedef ActionLmmList* ActionLmmListPtr;
310 /** @ingroup SURF_interface
311 * @brief SURF model interface class
312 * @details A model is an object which handle the interactions between its Resources and its Actions
314 XBT_PUBLIC_CLASS Model {
319 virtual void addTraces() =0;
321 /** @brief Get the set of [actions](@ref Action) in *ready* state */
322 virtual ActionList* getReadyActionSet() {return p_readyActionSet;}
324 /** @brief Get the set of [actions](@ref Action) in *running* state */
325 virtual ActionList* getRunningActionSet() {return p_runningActionSet;}
327 /** @brief Get the set of [actions](@ref Action) in *failed* state */
328 virtual ActionList* getFailedActionSet() {return p_failedActionSet;}
330 /** @brief Get the set of [actions](@ref Action) in *done* state */
331 virtual ActionList* getDoneActionSet() {return p_doneActionSet;}
333 /** @brief Get the set of modified [actions](@ref Action) */
334 virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
336 /** @brief Get the maxmin system of the current Model */
337 lmm_system_t getMaxminSystem() {return p_maxminSystem;}
340 * @brief Get the update mechanism of the current Model
343 e_UM_t getUpdateMechanism() {return p_updateMechanism;}
345 /** @brief Get Action heap */
346 xbt_heap_t getActionHeap() {return p_actionHeap;}
349 * @brief Share the resources between the actions
351 * @param now The current time of the simulation
352 * @return The delta of time till the next action will finish
354 virtual double shareResources(double now);
355 virtual double shareResourcesLazy(double now);
356 virtual double shareResourcesFull(double now);
357 double shareResourcesMaxMin(ActionList* running_actions,
359 void (*solve) (lmm_system_t));
362 * @brief Update action to the current time
364 * @param now The current time of the simulation
365 * @param delta The delta of time since the last update
367 virtual void updateActionsState(double now, double delta);
368 virtual void updateActionsStateLazy(double now, double delta);
369 virtual void updateActionsStateFull(double now, double delta);
371 /** @brief Returns whether this model have an idempotent shareResource()
373 * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
374 * so we need to call it only when the next timestamp of other sources is computed.
376 virtual bool shareResourcesIsIdempotent()=0;
379 ActionLmmListPtr p_modifiedSet;
380 lmm_system_t p_maxminSystem = nullptr;
381 e_UM_t p_updateMechanism = UM_UNDEFINED;
382 int m_selectiveUpdate;
383 xbt_heap_t p_actionHeap;
386 ActionList* p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
387 ActionList* p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
388 ActionList* p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
389 ActionList* p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
399 /** @ingroup SURF_interface
400 * @brief Resource which have a metric handled by a maxmin system
403 double peak; /**< The peak of the metric, ie its max value */
404 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
405 tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
411 /** @ingroup SURF_interface
412 * @brief SURF resource interface class
413 * @details A resource represent an element of a component (e.g.: a link for the network)
415 XBT_PUBLIC_CLASS Resource {
420 * @brief Constructor of non-LMM Resources
422 * @param model Model associated to this Resource
423 * @param name The name of the Resource
425 Resource(Model *model, const char *name);
428 * @brief Constructor of LMM Resources
430 * @param model Model associated to this Resource
431 * @param name The name of the Resource
432 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
434 Resource(Model *model, const char *name, lmm_constraint_t constraint);
436 Resource(Model *model, const char *name, lmm_constraint_t constraint, e_surf_resource_state_t stateInit);
439 * @brief Resource constructor
441 * @param model Model associated to this Resource
442 * @param name The name of the Resource
443 * @param stateInit the initial state of the Resource
445 Resource(Model *model, const char *name, e_surf_resource_state_t stateInit);
449 /** @brief Get the Model of the current Resource */
452 /** @brief Get the name of the current Resource */
453 const char *getName();
456 * @brief Update the state of the current Resource
459 * @param event_type [TODO]
460 * @param value [TODO]
463 virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
465 /** @brief Check if the current Resource is used (if it currently serves an action) */
466 virtual bool isUsed()=0;
468 /** @brief Check if the current Resource is active */
470 /** @brief Turn on the current Resource */
472 /** @brief Turn off the current Resource */
475 /** @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource */
476 virtual e_surf_resource_state_t getState();
477 /** @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource */
478 virtual void setState(e_surf_resource_state_t state);
484 e_surf_resource_state_t m_stateCurrent;
488 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component */
489 lmm_constraint_t getConstraint();
491 lmm_constraint_t p_constraint;
497 #endif /* SURF_MODEL_H_ */