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"
20 /* Actions and models are higly connected structures... */
22 /** \brief Action datatype
23 * \ingroup SURF_actions
25 * An action is some working amount on a model.
26 * It is represented as a cost, a priority, a duration and a state.
28 * \see e_surf_action_state_t
30 typedef struct surf_action *surf_action_t;
32 /** \brief Resource datatype
33 * \ingroup SURF_models
35 * Generic data structure for a model. The workstations,
36 * the CPUs and the network links are examples of models.
38 typedef struct surf_model *surf_model_t;
40 /** \brief Resource model description
42 typedef struct surf_model_description {
45 void (* model_init) (const char *filename);
46 void (* create_ws) (void);
47 } s_surf_model_description_t, *surf_model_description_t;
49 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t *table,
54 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t *table,
58 /** \brief Action structure
59 * \ingroup SURF_actions
61 * Never create s_surf_action_t by yourself ! The actions are created
62 * on the fly when you call execute or communicate on a model.
64 * \see e_surf_action_state_t
66 typedef struct surf_action {
67 s_xbt_swag_hookup_t state_hookup;
69 double cost; /**< cost */
70 double priority; /**< priority (1.0 by default) */
71 double max_duration; /**< max_duration (may fluctuate until
72 the task is completed) */
73 double remains; /**< How much of that cost remains to
74 * be done in the currently running task */
75 double start; /**< start time */
76 double finish; /**< finish time : this is modified during the run
77 * and fluctuates until the task is completed */
78 void *data; /**< for your convenience */
80 surf_model_t model_type;
83 /** \brief Action states
84 * \ingroup SURF_actions
88 * \see surf_action_t, surf_action_state_t
91 SURF_ACTION_READY = 0, /**< Ready */
92 SURF_ACTION_RUNNING, /**< Running */
93 SURF_ACTION_FAILED, /**< Task Failure */
94 SURF_ACTION_DONE, /**< Completed */
95 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
96 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
97 } e_surf_action_state_t;
99 /** \brief Action state sets
100 * \ingroup SURF_actions
102 * This structure contains some sets of actions.
103 * It provides a fast access to the actions in each state.
105 * \see surf_action_t, e_surf_action_state_t
107 typedef struct surf_action_state {
108 xbt_swag_t ready_action_set; /**< Actions in state SURF_ACTION_READY */
109 xbt_swag_t running_action_set; /**< Actions in state SURF_ACTION_RUNNING */
110 xbt_swag_t failed_action_set; /**< Actions in state SURF_ACTION_FAILED */
111 xbt_swag_t done_action_set; /**< Actions in state SURF_ACTION_DONE */
112 } s_surf_action_state_t, *surf_action_state_t;
114 /***************************/
115 /* Generic model object */
116 /***************************/
118 /** \brief Public data available on all models
119 * \ingroup SURF_models
121 * These functions are implemented by all models.
123 typedef struct surf_model_public {
124 s_surf_action_state_t states; /**< Any living action on this model */
125 void *(*name_service) (const char *name); /**< Return a model given its name */
126 const char *(*get_resource_name) (void *resource_id); /**< Return the name of a resource */
128 e_surf_action_state_t(*action_get_state) (surf_action_t action); /**< Return the state of an action */
129 double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
130 double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
131 void (*action_use) (surf_action_t action); /**< Set an action used */
132 int (*action_free) (surf_action_t action); /**< Free an action */
133 void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
134 void (*action_recycle) (surf_action_t action); /**< Recycle an action */
135 void (*action_change_state) (surf_action_t action, /**< Change an action state*/
136 e_surf_action_state_t state);
137 void (*action_set_data) (surf_action_t action, void *data); /**< Set the user data of an action */
138 void (*suspend) (surf_action_t action); /**< Suspend an action */
139 void (*resume) (surf_action_t action); /**< Resume a suspended action */
140 int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
141 void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
142 void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
143 const char *name; /**< Name of this model */
145 xbt_dict_t (*get_properties) (void* link); /**< Return the properties dictionary */
147 } s_surf_model_public_t, *surf_model_public_t;
149 /** \brief Private data available on all models
150 * \ingroup SURF_models
152 typedef struct surf_model_private *surf_model_private_t;
154 /** \brief Resource datatype
155 * \ingroup SURF_models
157 * Generic data structure for a model. The workstations,
158 * the CPUs and the network links are examples of models.
160 typedef struct surf_model {
161 surf_model_private_t common_private;
162 surf_model_public_t common_public;
165 /**************************************/
166 /* Implementations of model object */
167 /**************************************/
169 /** \brief Timer model extension public
170 * \ingroup SURF_model
172 * Additionnal functions specific to the timer model
174 typedef struct surf_timer_model_extension_public {
175 void (*set) (double date, void *function, void *arg);
176 int (*get) (void **function, void **arg);
177 } s_surf_timer_model_extension_public_t,
178 *surf_timer_model_extension_public_t;
180 /** \brief Timer model
181 * \ingroup SURF_models
183 typedef struct surf_timer_model {
184 surf_model_private_t common_private;
185 surf_model_public_t common_public;
186 surf_timer_model_extension_public_t extension_public;
187 } s_surf_timer_model_t, *surf_timer_model_t;
189 /** \brief The timer model
190 * \ingroup SURF_models
192 XBT_PUBLIC_DATA(surf_timer_model_t) surf_timer_model;
194 /** \brief Initializes the timer model
195 * \ingroup SURF_models
197 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
202 * \ingroup SURF_models
205 SURF_CPU_ON = 1, /**< Up & ready */
206 SURF_CPU_OFF = 0 /**< Down & broken */
207 } e_surf_cpu_state_t;
209 /** \brief CPU model extension public
210 * \ingroup SURF_models
212 * Public functions specific to the CPU model.
214 typedef struct surf_cpu_model_extension_public {
215 surf_action_t(*execute) (void *cpu, double size);
216 surf_action_t(*sleep) (void *cpu, double duration);
217 e_surf_cpu_state_t(*get_state) (void *cpu);
218 double (*get_speed) (void *cpu, double load);
219 double (*get_available_speed) (void *cpu);
220 } s_surf_cpu_model_extension_public_t,
221 *surf_cpu_model_extension_public_t;
223 /** \brief CPU model datatype
224 * \ingroup SURF_models
226 typedef struct surf_cpu_model {
227 surf_model_private_t common_private;
228 surf_model_public_t common_public;
229 surf_cpu_model_extension_public_t extension_public;
230 } s_surf_cpu_model_t, *surf_cpu_model_t;
232 /** \brief The CPU model
233 * \ingroup SURF_models
235 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
237 /** \brief Initializes the CPU model with the model Cas01
238 * \ingroup SURF_models
240 * This function is called by surf_workstation_model_init_CLM03
241 * so you shouldn't have to call it by yourself.
243 * \see surf_workstation_model_init_CLM03()
245 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
247 #define surf_cpu_model_description_size 1
248 /** \brief The list of all available cpu model models
249 * \ingroup SURF_models
251 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[surf_cpu_model_description_size];
255 /** \brief Network model extension public
256 * \ingroup SURF_models
258 * Public functions specific to the network model
260 typedef struct surf_network_model_extension_public {
261 surf_action_t(*communicate) (void *src, void *dst, double size,
263 const void** (*get_route) (void *src, void *dst);
264 int (*get_route_size) (void *src, void *dst);
265 const char* (*get_link_name) (const void *link);
266 double (*get_link_bandwidth) (const void *link);
267 double (*get_link_latency) (const void *link);
268 } s_surf_network_model_extension_public_t,
269 *surf_network_model_extension_public_t;
271 /** \brief Network model datatype
272 * \ingroup SURF_models
274 typedef struct surf_network_model {
275 surf_model_private_t common_private;
276 surf_model_public_t common_public;
277 surf_network_model_extension_public_t extension_public;
278 } s_surf_network_model_t, *surf_network_model_t;
280 XBT_PUBLIC(void) create_workstations(void);
282 /** \brief The network model
283 * \ingroup SURF_models
285 * When creating a new API on top on SURF, you shouldn't use the
286 * network model unless you know what you are doing. Only the workstation
287 * model should be accessed because depending on the platform model,
288 * the network model can be NULL.
290 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
293 /** \brief Initializes the platform with the network model 'Constant'
294 * \ingroup SURF_models
295 * \param filename XML platform file name
297 * In this model, the communication time between two network cards is
298 * constant, hence no need for a routing table. This is particularly
299 * usefull when simulating huge distributed algorithms where
300 * scalability is really an issue. This function is called in
301 * conjunction with surf_workstation_model_init_compound.
303 * \see surf_workstation_model_init_compound()
305 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
307 /** \brief Initializes the platform with the network model CM02
308 * \ingroup SURF_models
309 * \param filename XML platform file name
311 * This function is called by surf_workstation_model_init_CLM03
312 * or by yourself only if you plan using surf_workstation_model_init_compound
314 * \see surf_workstation_model_init_CLM03()
316 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
319 /** \brief Initializes the platform with the network model GTNETS
320 * \ingroup SURF_models
321 * \param filename XML platform file name
323 * This function is called by surf_workstation_model_init_GTNETS
324 * or by yourself only if you plan using surf_workstation_model_init_compound
326 * \see surf_workstation_model_init_GTNETS()
328 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
331 /** \brief Initializes the platform with the network model Reno
332 * \ingroup SURF_models
333 * \param filename XML platform file name
335 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
338 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
339 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
341 * Call this function only if you plan using surf_workstation_model_init_compound.
344 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
346 /** \brief Initializes the platform with the network model Vegas
347 * \ingroup SURF_models
348 * \param filename XML platform file name
350 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
351 * to the proportional fairness.
354 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
355 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
357 * Call this function only if you plan using surf_workstation_model_init_compound.
360 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
363 /** \brief Initializes the platform with the network model based on SDP
364 * \ingroup SURF_models
365 * \param filename XML platform file name
367 * This function implements the proportional fairness known as the maximization
372 * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
373 * Semi-definite programming approach for bandwidth allocation and routing in networks.
374 * Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
376 * Call this function only if you plan using surf_workstation_model_init_compound.
378 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
381 #if defined(HAVE_GTNETS) && defined(HAVE_SDP)
382 # define surf_network_model_description_size 6
383 #elsif defined(HAVE_GTNETS) || defined(HAVE_SDP)
384 # define surf_network_model_description_size 5
386 # define surf_network_model_description_size 4
388 /** \brief The list of all available network model models
389 * \ingroup SURF_models
391 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[surf_network_model_description_size];
393 /** \brief Workstation model extension public
394 * \ingroup SURF_models
396 * Public functions specific to the workstation model.
398 typedef struct surf_workstation_model_extension_public {
399 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
400 and create the corresponding action */
401 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
402 e_surf_cpu_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
403 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
404 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
405 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
406 void *workstation_dst, double size,
409 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
410 void **workstation_list,
411 double *computation_amount,
412 double *communication_amount,
415 const void** (*get_route) (void *src, void *dst); /**< Return the network link list between two workstations */
416 int (*get_route_size) (void *src, void *dst); /**< Return the route size between two workstations */
417 const char* (*get_link_name) (const void *link); /**< Return the name of a network link */
418 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
419 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
420 } s_surf_workstation_model_extension_public_t,
421 *surf_workstation_model_extension_public_t;
423 /** \brief Workstation model datatype.
424 * \ingroup SURF_models
427 typedef struct surf_workstation_model {
428 surf_model_private_t common_private;
429 surf_model_public_t common_public;
430 surf_workstation_model_extension_public_t extension_public;
431 } s_surf_workstation_model_t, *surf_workstation_model_t;
433 /** \brief The workstation model
434 * \ingroup SURF_models
436 * Note that when you create an API on top of SURF,
437 * the workstation model should be the only one you use
438 * because depending on the platform model, the network model and the CPU model
441 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
443 /** \brief Initializes the platform with a compound workstation model
444 * \ingroup SURF_models
445 * \param filename XML platform file name
447 * This function should be called after a cpu_model and a
448 * network_model have been set up.
451 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
453 /** \brief Initializes the platform with the workstation model CLM03
454 * \ingroup SURF_models
455 * \param filename XML platform file name
457 * This platform model seperates the workstation model and the network model.
458 * The workstation model will be initialized with the model CLM03, the network
459 * model with the model CM02 and the CPU model with the model Cas01.
460 * In future releases, some other network models will be implemented and will be
461 * combined with the workstation model CLM03.
463 * \see surf_workstation_model_init_KCCFLN05()
465 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
467 /** \brief Initializes the platform with the model KCCFLN05
468 * \ingroup SURF_models
469 * \param filename XML platform file name
471 * With this model, the workstations and the network are handled
472 * together. The network model is roughly the same as in CM02 but
473 * interference between computations and communications can be taken
474 * into account. This platform model is the default one for MSG and
478 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
480 /** \brief Initializes the platform with the model KCCFLN05
481 * \ingroup SURF_models
482 * \param filename XML platform file name
484 * With this model, only parallel tasks can be used. Resource sharing
485 * is done by identifying bottlenecks and giving an equal share of
486 * the model to each action.
489 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
491 #define surf_workstation_model_description_size 4
492 /** \brief The list of all available workstation model models
493 * \ingroup SURF_models
495 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[surf_workstation_model_description_size];
497 /** \brief The network links
498 * \ingroup SURF_models
500 * This dict contains all network links.
502 * \see workstation_set
504 XBT_PUBLIC_DATA(xbt_dict_t) link_set;
506 /** \brief The workstations
507 * \ingroup SURF_models
509 * This dict contains all workstations.
513 XBT_PUBLIC_DATA(xbt_dict_t) workstation_set;
514 XBT_PUBLIC_DATA(xbt_dict_t) cpu_set;
515 /** \brief List of initialized models
516 * \ingroup SURF_models
518 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
520 /*******************************************/
521 /*** SURF Globals **************************/
522 /*******************************************/
524 /** \brief Initialize SURF
525 * \ingroup SURF_simulation
526 * \param argc argument number
527 * \param argv arguments
529 * This function has to be called to initialize the common
530 * structures. Then you will have to create the environment by
531 * calling surf_timer_model_init() and
532 * e.g. surf_workstation_model_init_CLM03() or
533 * surf_workstation_model_init_KCCFLN05().
535 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
536 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
538 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
540 /** \brief Finish simulation initialization
541 * \ingroup SURF_simulation
543 * This function must be called before the first call to surf_solve()
545 XBT_PUBLIC(void) surf_presolve(void);
547 /** \brief Performs a part of the simulation
548 * \ingroup SURF_simulation
549 * \return the elapsed time, or -1.0 if no event could be executed
551 * This function execute all possible events, update the action states
552 * and returns the time elapsed.
553 * When you call execute or communicate on a model, the corresponding actions
554 * are not executed immediately but only when you call surf_solve.
555 * Note that the returned elapsed time can be zero.
557 XBT_PUBLIC(double) surf_solve(void);
559 /** \brief Return the current time
560 * \ingroup SURF_simulation
562 * Return the current time in millisecond.
564 XBT_PUBLIC(double)surf_get_clock(void);
567 * \ingroup SURF_simulation
573 XBT_PUBLIC(void) surf_exit(void);
575 /* Prototypes of the functions that handle the properties */
576 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
577 void parse_properties(void);
578 void free_string(void*);
580 /* Prototypes for functions handling routing and were factorized succesfully from the models */
581 void init_data(void);
582 void parse_route_elem(void);
584 /* surf parse file related (public because called from a test suite) */
585 XBT_PUBLIC(void) parse_platform_file(const char* file);
587 /* Stores the sets */
588 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
590 void parse_foreach(void);
591 void parse_sets(void);
592 void parse_route_multi_set_endpoints(void);
593 void parse_route_multi_set_route(void);
594 void parse_cluster(void);
595 void parse_trace_init(void);
596 void parse_trace_finalize(void);
597 void parse_trace_c_connect(void);
599 void manage_route(xbt_dict_t route_table, const char* route_name, int action, int isMultiRoute);
600 XBT_PUBLIC_DATA(int) route_action;
602 /* This is used by all models when creating the routing table while parsing */
603 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
604 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
605 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
606 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
607 XBT_PUBLIC_DATA(xbt_dynar_t) route_link_list;
609 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
610 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
611 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
612 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
613 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
614 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
615 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
618 double get_cpu_power(const char* power);
619 void init_randomness(void);
620 void add_randomness(void);
624 #endif /* _SURF_SURF_H */