3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include "xbt/dynar.h"
16 #include "xbt/config.h"
17 #include "surf/datatypes.h"
20 /* Actions and models are highly connected structures... */
22 SURF_RESOURCE_ON = 1, /**< Up & ready */
23 SURF_RESOURCE_OFF = 0 /**< Down & broken */
24 } e_surf_resource_state_t;
26 /** @Brief Specify that we use that action */
27 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
28 /** @brief Creates a new action.
30 * @param size The size is the one of the subtype you want to create
31 * @param cost initial value
32 * @param model to which model we should attach this action
33 * @param failed whether we should start this action in failed mode
35 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
36 surf_model_t model, int failed);
40 /** \brief Resource model description
42 typedef struct surf_model_description {
44 const char *description;
46 void (*model_init_preparse) (const char *filename);
47 void (*model_init_postparse) (void);
48 } s_surf_model_description_t, *surf_model_description_t;
50 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
53 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
55 XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * table);
57 /** \brief Action structure
58 * \ingroup SURF_actions
60 * Never create s_surf_action_t by yourself ! The actions are created
61 * on the fly when you call execute or communicate on a model.
63 * \see e_surf_action_state_t
65 typedef struct surf_action {
66 s_xbt_swag_hookup_t state_hookup;
68 double cost; /**< cost */
69 double priority; /**< priority (1.0 by default) */
70 double max_duration; /**< max_duration (may fluctuate until
71 the task is completed) */
72 double remains; /**< How much of that cost remains to
73 * be done in the currently running task */
74 double start; /**< start time */
75 double finish; /**< finish time : this is modified during the run
76 * and fluctuates until the task is completed */
77 void *data; /**< for your convenience */
79 surf_model_t model_type;
82 typedef struct surf_action_lmm {
83 s_surf_action_t generic_action;
84 lmm_variable_t variable;
86 } s_surf_action_lmm_t, *surf_action_lmm_t;
88 /** \brief Action states
89 * \ingroup SURF_actions
93 * \see surf_action_t, surf_action_state_t
96 SURF_ACTION_READY = 0, /**< Ready */
97 SURF_ACTION_RUNNING, /**< Running */
98 SURF_ACTION_FAILED, /**< Task Failure */
99 SURF_ACTION_DONE, /**< Completed */
100 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
101 SURF_ACTION_NOT_IN_THE_SYSTEM
102 /**< Not in the system anymore. Why did you ask ? */
103 } e_surf_action_state_t;
105 /** \brief Action state sets
106 * \ingroup SURF_actions
108 * This structure contains some sets of actions.
109 * It provides a fast access to the actions in each state.
111 * \see surf_action_t, e_surf_action_state_t
113 typedef struct surf_action_state {
114 xbt_swag_t ready_action_set;
115 /**< Actions in state SURF_ACTION_READY */
116 xbt_swag_t running_action_set;
117 /**< Actions in state SURF_ACTION_RUNNING */
118 xbt_swag_t failed_action_set;
119 /**< Actions in state SURF_ACTION_FAILED */
120 xbt_swag_t done_action_set;
121 /**< Actions in state SURF_ACTION_DONE */
122 } s_surf_action_state_t, *surf_action_state_t;
124 /***************************/
125 /* Generic model object */
126 /***************************/
127 typedef struct s_routing s_routing_t, *routing_t;
128 XBT_PUBLIC_DATA(routing_t) used_routing;
130 /** \brief Private data available on all models
131 * \ingroup SURF_models
133 typedef struct surf_model_private *surf_model_private_t;
135 /** \brief Timer model extension public
136 * \ingroup SURF_model
138 * Additionnal functions specific to the timer model
140 typedef struct surf_timer_model_extension_public {
141 void (*set) (double date, void *function, void *arg);
142 int (*get) (void **function, void **arg);
143 } s_surf_model_extension_timer_t;
147 /** \brief CPU model extension public
148 * \ingroup SURF_models
150 * Public functions specific to the CPU model.
152 typedef struct surf_cpu_model_extension_public {
153 surf_action_t(*execute) (void *cpu, double size);
154 surf_action_t(*sleep) (void *cpu, double duration);
155 e_surf_resource_state_t(*get_state) (void *cpu);
156 double (*get_speed) (void *cpu, double load);
157 double (*get_available_speed) (void *cpu);
158 } s_surf_model_extension_cpu_t;
162 /** \brief Network model extension public
163 * \ingroup SURF_models
165 * Public functions specific to the network model
167 typedef struct surf_network_model_extension_public {
168 surf_action_t(*communicate) (const char *src_name,
169 const char *dst_name, int src, int dst,
170 double size, double rate);
171 xbt_dynar_t(*get_route) (int src, int dst);
172 double (*get_link_bandwidth) (const void *link);
173 double (*get_link_latency) (const void *link);
174 int (*link_shared) (const void *link);
175 } s_surf_model_extension_network_t;
177 /** \brief Workstation model extension public
178 * \ingroup SURF_models
180 * Public functions specific to the workstation model.
182 typedef struct surf_workstation_model_extension_public {
183 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
184 and create the corresponding action */
185 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
186 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
187 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
188 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
189 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
190 void *workstation_dst, double size,
192 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
194 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
195 void **workstation_list,
196 double *computation_amount,
197 double *communication_amount,
198 double amount, double rate);
199 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
200 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
201 int (*link_shared) (const void *link);
202 xbt_dict_t(*get_properties) (const void *resource);
203 } s_surf_model_extension_workstation_t;
205 /** \brief Model datatype
206 * \ingroup SURF_models
208 * Generic data structure for a model. The workstations,
209 * the CPUs and the network links are examples of models.
211 typedef struct surf_model {
212 const char *name;/**< Name of this model */
213 s_surf_action_state_t states; /**< Any living action on this model */
215 e_surf_action_state_t(*action_state_get) (surf_action_t action);
216 /**< Return the state of an action */
217 void (*action_state_set) (surf_action_t action,
218 e_surf_action_state_t state);
219 /**< Change an action state*/
221 double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
222 double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
223 int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
224 void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
225 void (*action_recycle) (surf_action_t action);/**< Recycle an action */
226 void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
227 void (*suspend) (surf_action_t action);/**< Suspend an action */
228 void (*resume) (surf_action_t action);/**< Resume a suspended action */
229 int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
230 void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
231 void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
232 double (*get_remains) (surf_action_t action);/**< Get the remains of an action */
234 xbt_dict_t resource_set;
238 surf_model_private_t model_private;
243 s_surf_model_extension_timer_t timer;
244 s_surf_model_extension_cpu_t cpu;
245 s_surf_model_extension_network_t network;
246 s_surf_model_extension_workstation_t workstation;
250 surf_model_t surf_model_init(void);
251 void surf_model_exit(surf_model_t model);
253 void *surf_model_resource_by_name(surf_model_t model, const char *name);
254 #define surf_model_resource_set(model) (model)->resource_set
256 typedef struct surf_resource {
259 xbt_dict_t properties;
260 } s_surf_resource_t, *surf_resource_t;
265 * Resource which have a metric handled by a maxmin system
270 tmgr_trace_event_t event;
273 typedef struct surf_resource_lmm {
274 s_surf_resource_t generic_resource;
275 lmm_constraint_t constraint;
276 e_surf_resource_state_t state_current;
277 tmgr_trace_event_t state_event;
278 s_surf_metric_t power;
279 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
281 /**************************************/
282 /* Implementations of model object */
283 /**************************************/
286 /** \brief The timer model
287 * \ingroup SURF_models
289 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
291 /** \brief Initializes the timer model
292 * \ingroup SURF_models
294 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
296 /** \brief The CPU model
297 * \ingroup SURF_models
299 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
301 /** \brief Initializes the CPU model with the model Cas01
302 * \ingroup SURF_models
304 * This function is called by surf_workstation_model_init_CLM03
305 * so you shouldn't have to call it by yourself.
307 * \see surf_workstation_model_init_CLM03()
309 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
311 /** \brief Initializes the CPU model with trace integration
312 * \ingroup SURF_models
315 XBT_PUBLIC(void) surf_cpu_model_init_ti(const char *filename);
317 /** \brief Initializes the CPU model with the model Cas01 Improved. This model uses a heap to order the events, decreasing the time complexity to get the minimum next event.
318 * \ingroup SURF_models
320 * This function is called by surf_workstation_model_init_CLM03
321 * so you shouldn't have to call it by yourself.
323 * \see surf_workstation_model_init_CLM03()
325 XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(const char *filename);
327 /** \brief The list of all available cpu model models
328 * \ingroup SURF_models
330 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
332 XBT_PUBLIC(void) create_workstations(void);
334 /** \brief The network model
335 * \ingroup SURF_models
337 * When creating a new API on top on SURF, you shouldn't use the
338 * network model unless you know what you are doing. Only the workstation
339 * model should be accessed because depending on the platform model,
340 * the network model can be NULL.
342 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
344 /** \brief Initializes the platform with the network model 'LagrangeVelho'
345 * \ingroup SURF_models
346 * \param filename XML platform file name
348 * This model is proposed by Arnaud Legrand and Pedro Velho based on
349 * the results obtained with the GTNets simulator for onelink and
350 * dogbone sharing scenarios.
352 * \see surf_workstation_model_init_LegrandVelho()
354 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
356 /** \brief Initializes the platform with the network model 'Constant'
357 * \ingroup SURF_models
358 * \param filename XML platform file name
360 * In this model, the communication time between two network cards is
361 * constant, hence no need for a routing table. This is particularly
362 * usefull when simulating huge distributed algorithms where
363 * scalability is really an issue. This function is called in
364 * conjunction with surf_workstation_model_init_compound.
366 * \see surf_workstation_model_init_compound()
368 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
370 XBT_PUBLIC(void) surf_network_model_init_Vivaldi(const char *filename);
372 /** \brief Initializes the platform with the network model CM02
373 * \ingroup SURF_models
374 * \param filename XML platform file name
376 * This function is called by surf_workstation_model_init_CLM03
377 * or by yourself only if you plan using surf_workstation_model_init_compound
379 * \see surf_workstation_model_init_CLM03()
381 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
384 /** \brief Initializes the platform with the network model GTNETS
385 * \ingroup SURF_models
386 * \param filename XML platform file name
388 * This function is called by surf_workstation_model_init_GTNETS
389 * or by yourself only if you plan using surf_workstation_model_init_compound
391 * \see surf_workstation_model_init_GTNETS()
393 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
396 /** \brief Initializes the platform with the network model Reno
397 * \ingroup SURF_models
398 * \param filename XML platform file name
400 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
403 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
404 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
406 * Call this function only if you plan using surf_workstation_model_init_compound.
409 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
411 /** \brief Initializes the platform with the network model Reno2
412 * \ingroup SURF_models
413 * \param filename XML platform file name
415 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
418 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
419 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
421 * Call this function only if you plan using surf_workstation_model_init_compound.
424 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
426 /** \brief Initializes the platform with the network model Vegas
427 * \ingroup SURF_models
428 * \param filename XML platform file name
430 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
431 * to the proportional fairness.
434 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
435 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
437 * Call this function only if you plan using surf_workstation_model_init_compound.
440 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
442 /** \brief The list of all available network model models
443 * \ingroup SURF_models
445 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
448 /** \brief The workstation model
449 * \ingroup SURF_models
451 * Note that when you create an API on top of SURF,
452 * the workstation model should be the only one you use
453 * because depending on the platform model, the network model and the CPU model
456 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
458 /** \brief Initializes the platform with a compound workstation model
459 * \ingroup SURF_models
460 * \param filename XML platform file name
462 * This function should be called after a cpu_model and a
463 * network_model have been set up.
466 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
468 /** \brief Initializes the platform with the workstation model CLM03
469 * \ingroup SURF_models
470 * \param filename XML platform file name
472 * This platform model seperates the workstation model and the network model.
473 * The workstation model will be initialized with the model CLM03, the network
474 * model with the model CM02 and the CPU model with the model Cas01.
475 * In future releases, some other network models will be implemented and will be
476 * combined with the workstation model CLM03.
478 * \see surf_workstation_model_init_KCCFLN05()
480 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
482 /** \brief Initializes the platform with the model KCCFLN05
483 * \ingroup SURF_models
484 * \param filename XML platform file name
486 * With this model, the workstations and the network are handled
487 * together. The network model is roughly the same as in CM02 but
488 * interference between computations and communications can be taken
489 * into account. This platform model is the default one for MSG and
493 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
495 /** \brief Initializes the platform with the model KCCFLN05
496 * \ingroup SURF_models
497 * \param filename XML platform file name
499 * With this model, only parallel tasks can be used. Resource sharing
500 * is done by identifying bottlenecks and giving an equal share of
501 * the model to each action.
504 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
506 /** \brief The list of all available workstation model models
507 * \ingroup SURF_models
509 XBT_PUBLIC_DATA(s_surf_model_description_t)
510 surf_workstation_model_description[];
512 /** \brief List of initialized models
513 * \ingroup SURF_models
515 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
517 /*******************************************/
518 /*** SURF Globals **************************/
519 /*******************************************/
520 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
522 /** \brief Initialize SURF
523 * \ingroup SURF_simulation
524 * \param argc argument number
525 * \param argv arguments
527 * This function has to be called to initialize the common
528 * structures. Then you will have to create the environment by
529 * calling surf_timer_model_init() and
530 * e.g. surf_workstation_model_init_CLM03() or
531 * surf_workstation_model_init_KCCFLN05().
533 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
534 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
536 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
538 /** \brief Initialize the used models.
540 * Must be called after the surf_init so that configuration infrastructure is created
541 * Must be called before parsing/creating the environment
542 * Must not be called within the initialization process so that the use get a chance to change the settings from
543 * its code between, say, MSG_init and MSG_create_environment using MSG_config
545 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
547 /** \brief create the elements of the models
549 * Must be called after parsing the platform file and before using any elements
551 XBT_PUBLIC(void) surf_config_models_create_elms(void);
553 /** \brief Finish simulation initialization
554 * \ingroup SURF_simulation
556 * This function must be called before the first call to surf_solve()
558 XBT_PUBLIC(void) surf_presolve(void);
560 /** \brief Performs a part of the simulation
561 * \ingroup SURF_simulation
562 * \return the elapsed time, or -1.0 if no event could be executed
564 * This function execute all possible events, update the action states
565 * and returns the time elapsed.
566 * When you call execute or communicate on a model, the corresponding actions
567 * are not executed immediately but only when you call surf_solve.
568 * Note that the returned elapsed time can be zero.
570 XBT_PUBLIC(double) surf_solve(void);
572 /** \brief Return the current time
573 * \ingroup SURF_simulation
575 * Return the current time in millisecond.
577 XBT_PUBLIC(double) surf_get_clock(void);
580 * \ingroup SURF_simulation
586 XBT_PUBLIC(void) surf_exit(void);
588 /* Prototypes of the functions that handle the properties */
589 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
590 XBT_PUBLIC_DATA(void) parse_properties(void);
592 /* surf parse file related (public because called from a test suite) */
593 XBT_PUBLIC(void) parse_platform_file(const char *file);
595 /* Stores the sets */
596 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
598 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
599 const char *route_name, int action,
601 XBT_PUBLIC_DATA(int) route_action;
603 /* This is used by all models when creating the routing table while parsing */
604 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
605 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
608 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
609 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
610 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
611 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
612 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
613 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
614 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
617 XBT_PUBLIC(double) get_cpu_power(const char *power);
619 #include "surf/surf_resource.h"
620 #include "surf/surf_resource_lmm.h"
623 #endif /* _SURF_SURF_H */