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"
22 /* Actions and models are higly connected structures... */
23 /** \brief Action datatype
24 * \ingroup SURF_actions
26 * An action is some working amount on a model.
27 * It is represented as a cost, a priority, a duration and a state.
29 * \see e_surf_action_state_t
31 typedef struct surf_action *surf_action_t;
33 /** \brief Model datatype
34 * \ingroup SURF_models
36 * Generic data structure for a model. The workstations,
37 * the CPUs and the network links are examples of models.
39 typedef struct surf_model *surf_model_t;
41 /** \brief Resource model description
43 typedef struct surf_model_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,
56 /** \brief Action structure
57 * \ingroup SURF_actions
59 * Never create s_surf_action_t by yourself ! The actions are created
60 * on the fly when you call execute or communicate on a model.
62 * \see e_surf_action_state_t
64 typedef struct surf_action {
65 s_xbt_swag_hookup_t state_hookup;
67 double cost; /**< cost */
68 double priority; /**< priority (1.0 by default) */
69 double max_duration; /**< max_duration (may fluctuate until
70 the task is completed) */
71 double remains; /**< How much of that cost remains to
72 * be done in the currently running task */
73 double start; /**< start time */
74 double finish; /**< finish time : this is modified during the run
75 * and fluctuates until the task is completed */
76 void *data; /**< for your convenience */
78 surf_model_t model_type;
81 /** \brief Action states
82 * \ingroup SURF_actions
86 * \see surf_action_t, surf_action_state_t
89 SURF_ACTION_READY = 0, /**< Ready */
90 SURF_ACTION_RUNNING, /**< Running */
91 SURF_ACTION_FAILED, /**< Task Failure */
92 SURF_ACTION_DONE, /**< Completed */
93 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
94 SURF_ACTION_NOT_IN_THE_SYSTEM
95 /**< Not in the system anymore. Why did you ask ? */
96 } e_surf_action_state_t;
98 /** \brief Action state sets
99 * \ingroup SURF_actions
101 * This structure contains some sets of actions.
102 * It provides a fast access to the actions in each state.
104 * \see surf_action_t, e_surf_action_state_t
106 typedef struct surf_action_state {
107 xbt_swag_t ready_action_set;
108 /**< Actions in state SURF_ACTION_READY */
109 xbt_swag_t running_action_set;
110 /**< Actions in state SURF_ACTION_RUNNING */
111 xbt_swag_t failed_action_set;
112 /**< Actions in state SURF_ACTION_FAILED */
113 xbt_swag_t done_action_set;
114 /**< Actions in state SURF_ACTION_DONE */
115 } s_surf_action_state_t, *surf_action_state_t;
117 /***************************/
118 /* Generic model object */
119 /***************************/
121 /** \brief Private data available on all models
122 * \ingroup SURF_models
124 typedef struct surf_model_private *surf_model_private_t;
126 /** \brief Timer model extension public
127 * \ingroup SURF_model
129 * Additionnal functions specific to the timer model
131 typedef struct surf_timer_model_extension_public {
132 void (*set) (double date, void *function, void *arg);
133 int (*get) (void **function, void **arg);
134 } s_surf_model_extension_timer_t;
139 * \ingroup SURF_models
142 SURF_CPU_ON = 1, /**< Up & ready */
143 SURF_CPU_OFF = 0 /**< Down & broken */
144 } e_surf_cpu_state_t;
146 /** \brief CPU model extension public
147 * \ingroup SURF_models
149 * Public functions specific to the CPU model.
151 typedef struct surf_cpu_model_extension_public {
152 surf_action_t(*execute) (void *cpu, double size);
153 surf_action_t(*sleep) (void *cpu, double duration);
154 e_surf_cpu_state_t(*get_state) (void *cpu);
155 double (*get_speed) (void *cpu, double load);
156 double (*get_available_speed) (void *cpu);
157 } s_surf_model_extension_cpu_t;
161 /** \brief Network model extension public
162 * \ingroup SURF_models
164 * Public functions specific to the network model
166 typedef struct surf_network_model_extension_public {
167 surf_action_t(*communicate) (void *src, void *dst, double size,
169 const void **(*get_route) (void *src, void *dst);
170 int (*get_route_size) (void *src, void *dst);
171 double (*get_link_bandwidth) (const void *link);
172 double (*get_link_latency) (const void *link);
173 int (*link_shared) (const void *link);
174 } s_surf_model_extension_network_t;
176 /** \brief Workstation model extension public
177 * \ingroup SURF_models
179 * Public functions specific to the workstation model.
181 typedef struct surf_workstation_model_extension_public {
182 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
183 and create the corresponding action */
184 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
185 e_surf_cpu_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
186 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
187 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
188 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
189 void *workstation_dst, double size,
192 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
193 void **workstation_list,
194 double *computation_amount,
195 double *communication_amount,
196 double amount, double rate);
197 const void **(*get_route) (void *src, void *dst); /**< Return the network link list between two workstations */
198 int (*get_route_size) (void *src, void *dst); /**< Return the route size between two workstations */
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 } s_surf_model_extension_workstation_t;
204 /** \brief Model datatype
205 * \ingroup SURF_models
207 * Generic data structure for a model. The workstations,
208 * the CPUs and the network links are examples of models.
210 typedef struct surf_model {
211 const char *name;/**< Name of this model */
212 s_surf_action_state_t states; /**< Any living action on this model */
214 e_surf_action_state_t(*action_state_get) (surf_action_t action);/**< Return the state of an action */
215 void (*action_state_set) (surf_action_t action,
216 e_surf_action_state_t state); /**< Change an action state*/
218 double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
219 double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
220 void (*action_ref) (surf_action_t action);/**< Specify that we use that action */
221 int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
222 void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
223 void (*action_recycle) (surf_action_t action);/**< Recycle an action */
224 void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
225 void (*suspend) (surf_action_t action);/**< Suspend an action */
226 void (*resume) (surf_action_t action);/**< Resume a suspended action */
227 int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
228 void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
229 void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
231 xbt_dict_t(*get_properties) (void *resource_id);/**< Return the properties dictionary */
232 xbt_dict_t resource_set;
236 surf_model_private_t model_private;
241 s_surf_model_extension_timer_t timer;
242 s_surf_model_extension_cpu_t cpu;
243 s_surf_model_extension_network_t network;
244 s_surf_model_extension_workstation_t workstation;
248 surf_model_t surf_model_init(void);
249 void surf_model_exit(surf_model_t model);
251 void *surf_model_resource_by_name(surf_model_t model, const char *name);
252 #define surf_model_resource_set(model) (model)->resource_set
254 typedef struct surf_resource {
257 } s_surf_resource_t, *surf_resource_t;
259 XBT_PUBLIC(const char*) surf_resource_name(const void *resource);
260 XBT_PUBLIC(void) surf_resource_free(void* resource);
261 /**************************************/
262 /* Implementations of model object */
263 /**************************************/
266 /** \brief The timer model
267 * \ingroup SURF_models
269 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
271 /** \brief Initializes the timer model
272 * \ingroup SURF_models
274 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
276 /** \brief The CPU model
277 * \ingroup SURF_models
279 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
281 /** \brief Initializes the CPU model with the model Cas01
282 * \ingroup SURF_models
284 * This function is called by surf_workstation_model_init_CLM03
285 * so you shouldn't have to call it by yourself.
287 * \see surf_workstation_model_init_CLM03()
289 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
291 /** \brief The list of all available cpu model models
292 * \ingroup SURF_models
294 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
296 XBT_PUBLIC(void) create_workstations(void);
298 /** \brief The network model
299 * \ingroup SURF_models
301 * When creating a new API on top on SURF, you shouldn't use the
302 * network model unless you know what you are doing. Only the workstation
303 * model should be accessed because depending on the platform model,
304 * the network model can be NULL.
306 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
308 /** \brief Initializes the platform with the network model 'LagrangeVelho'
309 * \ingroup SURF_models
310 * \param filename XML platform file name
312 * This model is proposed by Arnaud Legrand and Pedro Velho based on
313 * the results obtained with the GTNets simulator for onelink and
314 * dogbone sharing scenarios.
316 * \see surf_workstation_model_init_LegrandVelho()
318 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
320 /** \brief Initializes the platform with the network model 'Constant'
321 * \ingroup SURF_models
322 * \param filename XML platform file name
324 * In this model, the communication time between two network cards is
325 * constant, hence no need for a routing table. This is particularly
326 * usefull when simulating huge distributed algorithms where
327 * scalability is really an issue. This function is called in
328 * conjunction with surf_workstation_model_init_compound.
330 * \see surf_workstation_model_init_compound()
332 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
334 /** \brief Initializes the platform with the network model CM02
335 * \ingroup SURF_models
336 * \param filename XML platform file name
338 * This function is called by surf_workstation_model_init_CLM03
339 * or by yourself only if you plan using surf_workstation_model_init_compound
341 * \see surf_workstation_model_init_CLM03()
343 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
346 /** \brief Initializes the platform with the network model GTNETS
347 * \ingroup SURF_models
348 * \param filename XML platform file name
350 * This function is called by surf_workstation_model_init_GTNETS
351 * or by yourself only if you plan using surf_workstation_model_init_compound
353 * \see surf_workstation_model_init_GTNETS()
355 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
358 /** \brief Initializes the platform with the network model Reno
359 * \ingroup SURF_models
360 * \param filename XML platform file name
362 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
365 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
366 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
368 * Call this function only if you plan using surf_workstation_model_init_compound.
371 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
373 /** \brief Initializes the platform with the network model Reno2
374 * \ingroup SURF_models
375 * \param filename XML platform file name
377 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
380 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
381 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
383 * Call this function only if you plan using surf_workstation_model_init_compound.
386 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
388 /** \brief Initializes the platform with the network model Vegas
389 * \ingroup SURF_models
390 * \param filename XML platform file name
392 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
393 * to the proportional fairness.
396 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
397 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
399 * Call this function only if you plan using surf_workstation_model_init_compound.
402 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
405 /** \brief Initializes the platform with the network model based on SDP
406 * \ingroup SURF_models
407 * \param filename XML platform file name
409 * This function implements the proportional fairness known as the maximization
414 * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
415 * Semi-definite programming approach for bandwidth allocation and routing in networks.
416 * Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
418 * Call this function only if you plan using surf_workstation_model_init_compound.
420 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
423 /** \brief The list of all available network model models
424 * \ingroup SURF_models
426 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
429 /** \brief The workstation model
430 * \ingroup SURF_models
432 * Note that when you create an API on top of SURF,
433 * the workstation model should be the only one you use
434 * because depending on the platform model, the network model and the CPU model
437 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
439 /** \brief Initializes the platform with a compound workstation model
440 * \ingroup SURF_models
441 * \param filename XML platform file name
443 * This function should be called after a cpu_model and a
444 * network_model have been set up.
447 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
449 /** \brief Initializes the platform with the workstation model CLM03
450 * \ingroup SURF_models
451 * \param filename XML platform file name
453 * This platform model seperates the workstation model and the network model.
454 * The workstation model will be initialized with the model CLM03, the network
455 * model with the model CM02 and the CPU model with the model Cas01.
456 * In future releases, some other network models will be implemented and will be
457 * combined with the workstation model CLM03.
459 * \see surf_workstation_model_init_KCCFLN05()
461 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
463 /** \brief Initializes the platform with the model KCCFLN05
464 * \ingroup SURF_models
465 * \param filename XML platform file name
467 * With this model, the workstations and the network are handled
468 * together. The network model is roughly the same as in CM02 but
469 * interference between computations and communications can be taken
470 * into account. This platform model is the default one for MSG and
474 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
476 /** \brief Initializes the platform with the model KCCFLN05
477 * \ingroup SURF_models
478 * \param filename XML platform file name
480 * With this model, only parallel tasks can be used. Resource sharing
481 * is done by identifying bottlenecks and giving an equal share of
482 * the model to each action.
485 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
487 /** \brief The list of all available workstation model models
488 * \ingroup SURF_models
490 XBT_PUBLIC_DATA(s_surf_model_description_t)
491 surf_workstation_model_description[];
493 /** \brief The network links
494 * \ingroup SURF_models
496 * This dict contains all network links.
498 * \see workstation_set
500 XBT_PUBLIC_DATA(xbt_dict_t) link_set;
502 /** \brief The workstations
503 * \ingroup SURF_models
505 * This dict contains all workstations.
509 /** \brief List of initialized models
510 * \ingroup SURF_models
512 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
514 /*******************************************/
515 /*** SURF Globals **************************/
516 /*******************************************/
517 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
519 /** \brief Initialize SURF
520 * \ingroup SURF_simulation
521 * \param argc argument number
522 * \param argv arguments
524 * This function has to be called to initialize the common
525 * structures. Then you will have to create the environment by
526 * calling surf_timer_model_init() and
527 * e.g. surf_workstation_model_init_CLM03() or
528 * surf_workstation_model_init_KCCFLN05().
530 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
531 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
533 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
535 /** \brief Initialize the used models.
537 * Must be called after the surf_init so that configuration infrastructure is created
538 * Must be called before parsing/creating the environment
539 * Must not be called within the initialization process so that the use get a chance to change the settings from
540 * its code between, say, MSG_init and MSG_create_environment using MSG_config
542 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
544 /** \brief create the elements of the models
546 * Must be called after parsing the platform file and before using any elements
548 XBT_PUBLIC(void) surf_config_models_create_elms(void);
550 /** \brief Finish simulation initialization
551 * \ingroup SURF_simulation
553 * This function must be called before the first call to surf_solve()
555 XBT_PUBLIC(void) surf_presolve(void);
557 /** \brief Performs a part of the simulation
558 * \ingroup SURF_simulation
559 * \return the elapsed time, or -1.0 if no event could be executed
561 * This function execute all possible events, update the action states
562 * and returns the time elapsed.
563 * When you call execute or communicate on a model, the corresponding actions
564 * are not executed immediately but only when you call surf_solve.
565 * Note that the returned elapsed time can be zero.
567 XBT_PUBLIC(double) surf_solve(void);
569 /** \brief Return the current time
570 * \ingroup SURF_simulation
572 * Return the current time in millisecond.
574 XBT_PUBLIC(double) surf_get_clock(void);
577 * \ingroup SURF_simulation
583 XBT_PUBLIC(void) surf_exit(void);
585 /* Prototypes of the functions that handle the properties */
586 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
587 XBT_PUBLIC_DATA(void) parse_properties(void);
589 /* surf parse file related (public because called from a test suite) */
590 XBT_PUBLIC(void) parse_platform_file(const char *file);
592 /* Stores the sets */
593 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
595 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
596 const char *route_name, int action,
598 XBT_PUBLIC_DATA(int) route_action;
600 /* This is used by all models when creating the routing table while parsing */
601 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
602 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
605 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
606 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
607 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
608 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
609 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
610 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
611 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
614 XBT_PUBLIC_DATA(double) get_cpu_power(const char *power);
618 #endif /* _SURF_SURF_H */