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>
18 #include <xbt/signal.hpp>
21 #include "surf/surf_routing.h"
22 #include "surf/surf.h"
23 #include "src/surf/surf_private.h"
24 #include "src/internal_config.h"
26 #define NO_MAX_DURATION -1.0
32 /* user-visible parameters */
33 extern XBT_PRIVATE double sg_tcp_gamma;
34 extern XBT_PRIVATE double sg_sender_gap;
35 extern XBT_PRIVATE double sg_latency_factor;
36 extern XBT_PRIVATE double sg_bandwidth_factor;
37 extern XBT_PRIVATE double sg_weight_S_parameter;
38 extern XBT_PRIVATE int sg_network_crosstraffic;
39 extern XBT_PRIVATE xbt_dynar_t surf_path;
42 XBT_PUBLIC(double) surf_get_clock(void);
45 extern XBT_PRIVATE double sg_sender_gap;
50 extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
55 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
57 static inline char* sg_storage_name(sg_storage_t storage) {
65 enum heap_action_type{
75 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
76 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
82 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
84 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
89 /** @ingroup SURF_interface
90 * @brief SURF action interface class
91 * @details An action is an event generated by a resource (e.g.: a communication for the network)
93 XBT_PUBLIC_CLASS Action {
95 boost::intrusive::list_member_hook<> action_hook;
96 boost::intrusive::list_member_hook<> action_lmm_hook;
97 typedef boost::intrusive::member_hook<
98 Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
99 typedef boost::intrusive::list<Action, ActionOptions> ActionList;
102 * @brief Common initializations for the constructors
104 void initialize(simgrid::surf::Model *model, double cost, bool failed,
105 lmm_variable_t var = NULL);
109 * @brief Action constructor
111 * @param model The Model associated to this Action
112 * @param cost The cost of the Action
113 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
115 Action(simgrid::surf::Model *model, double cost, bool failed);
118 * @brief Action constructor
120 * @param model The Model associated to this Action
121 * @param cost The cost of the Action
122 * @param failed If the action is impossible (e.g.: execute something on a switched off host)
123 * @param var The lmm variable associated to this Action if it is part of a LMM component
125 Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
127 /** @brief Destructor */
130 /** @brief Mark that the action is now finished */
133 /** @brief Get the [state](\ref e_surf_action_state_t) of the current Action */
134 e_surf_action_state_t getState(); /**< get the state*/
135 /** @brief Set the [state](\ref e_surf_action_state_t) of the current Action */
136 virtual void setState(e_surf_action_state_t state);
138 /** @brief Get the bound of the current Action */
140 /** @brief Set the bound of the current Action */
141 void setBound(double bound);
143 /** @brief Get the start time of the current action */
144 double getStartTime();
145 /** @brief Get the finish time of the current action */
146 double getFinishTime();
148 /** @brief Get the user data associated to the current action */
149 void *getData() {return p_data;}
150 /** @brief Set the user data associated to the current action */
151 void setData(void* data);
153 /** @brief Get the cost of the current action */
154 double getCost() {return m_cost;}
155 /** @brief Set the cost of the current action */
156 void setCost(double cost) {m_cost = cost;}
158 /** @brief Update the maximum duration of the current action
159 * @param delta Amount to remove from the MaxDuration */
160 void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
162 /** @brief Update the remaining time of the current action
163 * @param delta Amount to remove from the remaining time */
164 void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
166 /** @brief Set the remaining time of the current action */
167 void setRemains(double value) {m_remains = value;}
168 /** @brief Get the remaining time of the current action after updating the resource */
169 virtual double getRemains();
170 /** @brief Get the remaining time of the current action without updating the resource */
171 double getRemainsNoUpdate();
173 /** @brief Set the finish time of the current action */
174 void setFinishTime(double value) {m_finish = value;}
176 /**@brief Add a reference to the current action (refcounting) */
178 /** @brief Unref that action (and destroy it if refcount reaches 0)
179 * @return true if the action was destroyed and false if someone still has references on it
183 /** @brief Cancel the current Action if running */
184 virtual void cancel();
186 /** @brief Suspend the current Action */
187 virtual void suspend();
189 /** @brief Resume the current Action */
190 virtual void resume();
192 /** @brief Returns true if the current action is running */
193 virtual bool isSuspended();
195 /** @brief Get the maximum duration of the current action */
196 double getMaxDuration() {return m_maxDuration;}
197 /** @brief Set the maximum duration of the current Action */
198 virtual void setMaxDuration(double duration);
200 /** @brief Get the tracing category associated to the current action */
201 char *getCategory() {return p_category;}
202 /** @brief Set the tracing category of the current Action */
203 void setCategory(const char *category);
205 /** @brief Get the priority of the current Action */
206 double getPriority() {return m_priority;};
207 /** @brief Set the priority of the current Action */
208 virtual void setPriority(double priority);
210 /** @brief Get the state set in which the action is */
211 ActionList* getStateSet() {return p_stateSet;};
213 s_xbt_swag_hookup_t p_stateHookup = {NULL,NULL};
215 simgrid::surf::Model *getModel() {return p_model;}
218 ActionList* p_stateSet;
219 double m_priority = 1.0; /**< priority (1.0 by default) */
221 double m_remains; /**< How much of that cost remains to be done in the currently running task */
222 double m_maxDuration = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
223 double m_finish = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
226 double m_start; /**< start time */
227 char *p_category = NULL; /**< tracing category for categorized resource utilization monitoring */
229 #ifdef HAVE_LATENCY_BOUND_TRACKING
230 int m_latencyLimited; /**< Set to 1 if is limited by latency, 0 otherwise */
233 simgrid::surf::Model *p_model;
234 void *p_data = NULL; /**< for your convenience */
238 virtual void updateRemainingLazy(double now);
239 void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
240 void heapRemove(xbt_heap_t heap);
241 void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
242 void updateIndexHeap(int i);
243 lmm_variable_t getVariable() {return p_variable;}
244 double getLastUpdate() {return m_lastUpdate;}
245 void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
246 enum heap_action_type getHat() {return m_hat;}
247 bool is_linked() {return action_lmm_hook.is_linked();}
251 lmm_variable_t p_variable;
252 double m_lastValue = 0;
253 double m_lastUpdate = 0;
256 enum heap_action_type m_hat = NOTSET;
259 typedef Action::ActionList ActionList;
261 typedef boost::intrusive::member_hook<
262 Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
263 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
264 typedef ActionLmmList* ActionLmmListPtr;
270 /** @ingroup SURF_interface
271 * @brief SURF model interface class
272 * @details A model is an object which handle the interactions between its Resources and its Actions
274 XBT_PUBLIC_CLASS Model {
279 /** @brief Get the set of [actions](@ref Action) in *ready* state */
280 virtual ActionList* getReadyActionSet() {return p_readyActionSet;}
282 /** @brief Get the set of [actions](@ref Action) in *running* state */
283 virtual ActionList* getRunningActionSet() {return p_runningActionSet;}
285 /** @brief Get the set of [actions](@ref Action) in *failed* state */
286 virtual ActionList* getFailedActionSet() {return p_failedActionSet;}
288 /** @brief Get the set of [actions](@ref Action) in *done* state */
289 virtual ActionList* getDoneActionSet() {return p_doneActionSet;}
291 /** @brief Get the set of modified [actions](@ref Action) */
292 virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
294 /** @brief Get the maxmin system of the current Model */
295 lmm_system_t getMaxminSystem() {return p_maxminSystem;}
298 * @brief Get the update mechanism of the current Model
301 e_UM_t getUpdateMechanism() {return p_updateMechanism;}
303 /** @brief Get Action heap */
304 xbt_heap_t getActionHeap() {return p_actionHeap;}
307 * @brief Share the resources between the actions
309 * @param now The current time of the simulation
310 * @return The delta of time till the next action will finish
312 virtual double next_occuring_event(double now);
313 virtual double next_occuring_event_lazy(double now);
314 virtual double next_occuring_event_full(double now);
315 double shareResourcesMaxMin(ActionList* running_actions,
316 lmm_system_t sys, void (*solve) (lmm_system_t));
319 * @brief Update action to the current time
321 * @param now The current time of the simulation
322 * @param delta The delta of time since the last update
324 virtual void updateActionsState(double now, double delta);
325 virtual void updateActionsStateLazy(double now, double delta);
326 virtual void updateActionsStateFull(double now, double delta);
328 /** @brief Returns whether this model have an idempotent shareResource()
330 * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
331 * so we need to call it only when the next timestamp of other sources is computed.
333 virtual bool next_occuring_event_isIdempotent()=0;
336 ActionLmmListPtr p_modifiedSet;
337 lmm_system_t p_maxminSystem = nullptr;
338 e_UM_t p_updateMechanism = UM_UNDEFINED;
339 int m_selectiveUpdate;
340 xbt_heap_t p_actionHeap;
343 ActionList* p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
344 ActionList* p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
345 ActionList* p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
346 ActionList* p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
356 /** @ingroup SURF_interface
357 * @brief Resource which have a metric handled by a maxmin system
360 double peak; /**< The peak of the metric, ie its max value */
361 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
362 tmgr_trace_iterator_t event; /**< The associated trace event associated to the metric */
368 /** @ingroup SURF_interface
369 * @brief SURF resource interface class
370 * @details A resource represent an element of a component (e.g.: a link for the network)
372 XBT_PUBLIC_CLASS Resource {
375 * @brief Constructor of non-LMM Resources
377 * @param model Model associated to this Resource
378 * @param name The name of the Resource
380 Resource(Model *model, const char *name);
383 * @brief Constructor of LMM Resources
385 * @param model Model associated to this Resource
386 * @param name The name of the Resource
387 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
389 Resource(Model *model, const char *name, lmm_constraint_t constraint);
391 Resource(Model *model, const char *name, lmm_constraint_t constraint, int initiallyOn);
394 * @brief Resource constructor
396 * @param model Model associated to this Resource
397 * @param name The name of the Resource
398 * @param initiallyOn the initial state of the Resource
400 Resource(Model *model, const char *name, int initiallyOn);
404 /** @brief Get the Model of the current Resource */
407 /** @brief Get the name of the current Resource */
408 const char *getName();
411 * @brief Apply an event of external load event to that storage
413 * @param event What happened
414 * @param value [TODO]
416 virtual void apply_event(tmgr_trace_iterator_t event, double value)=0;
418 /** @brief Check if the current Resource is used (if it currently serves an action) */
419 virtual bool isUsed()=0;
421 /** @brief Check if the current Resource is active */
423 /** @brief Check if the current Resource is shut down */
424 virtual bool isOff();
425 /** @brief Turn on the current Resource */
426 virtual void turnOn();
427 /** @brief Turn off the current Resource */
428 virtual void turnOff();
436 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component */
437 lmm_constraint_t getConstraint();
439 lmm_constraint_t p_constraint = nullptr;
445 #endif /* SURF_MODEL_H_ */