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"
21 /* 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 Resource 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) (const char *filename);
47 void (* create_ws) (void);
48 } s_surf_model_description_t, *surf_model_description_t;
50 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,
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 /** \brief Action states
83 * \ingroup SURF_actions
87 * \see surf_action_t, surf_action_state_t
90 SURF_ACTION_READY = 0, /**< Ready */
91 SURF_ACTION_RUNNING, /**< Running */
92 SURF_ACTION_FAILED, /**< Task Failure */
93 SURF_ACTION_DONE, /**< Completed */
94 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
95 SURF_ACTION_NOT_IN_THE_SYSTEM /**< 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; /**< Actions in state SURF_ACTION_READY */
108 xbt_swag_t running_action_set; /**< Actions in state SURF_ACTION_RUNNING */
109 xbt_swag_t failed_action_set; /**< Actions in state SURF_ACTION_FAILED */
110 xbt_swag_t done_action_set; /**< Actions in state SURF_ACTION_DONE */
111 } s_surf_action_state_t, *surf_action_state_t;
113 /***************************/
114 /* Generic model object */
115 /***************************/
117 /** \brief Public data available on all models
118 * \ingroup SURF_models
120 * These functions are implemented by all models.
122 typedef struct surf_model_public {
123 s_surf_action_state_t states; /**< Any living action on this model */
124 void *(*name_service) (const char *name); /**< Return a model given its name */
125 const char *(*get_resource_name) (void *resource_id); /**< Return the name of a resource */
127 e_surf_action_state_t(*action_get_state) (surf_action_t action); /**< Return the state of an action */
128 double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
129 double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
130 void (*action_use) (surf_action_t action); /**< Set an action used */
131 int (*action_free) (surf_action_t action); /**< Free an action */
132 void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
133 void (*action_recycle) (surf_action_t action); /**< Recycle an action */
134 void (*action_change_state) (surf_action_t action, /**< Change an action state*/
135 e_surf_action_state_t state);
136 void (*action_set_data) (surf_action_t action, void *data); /**< Set the user data of an action */
137 void (*suspend) (surf_action_t action); /**< Suspend an action */
138 void (*resume) (surf_action_t action); /**< Resume a suspended action */
139 int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
140 void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
141 void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
142 xbt_dict_t (*get_properties) (void* resource_id); /**< Return the properties dictionary */
143 const char *name; /**< Name of this model */
144 } s_surf_model_public_t, *surf_model_public_t;
146 /** \brief Private data available on all models
147 * \ingroup SURF_models
149 typedef struct surf_model_private *surf_model_private_t;
151 /** \brief Resource datatype
152 * \ingroup SURF_models
154 * Generic data structure for a model. The workstations,
155 * the CPUs and the network links are examples of models.
157 typedef struct surf_model {
158 surf_model_private_t common_private;
159 surf_model_public_t common_public;
162 /**************************************/
163 /* Implementations of model object */
164 /**************************************/
166 /** \brief Timer model extension public
167 * \ingroup SURF_model
169 * Additionnal functions specific to the timer model
171 typedef struct surf_timer_model_extension_public {
172 void (*set) (double date, void *function, void *arg);
173 int (*get) (void **function, void **arg);
174 } s_surf_timer_model_extension_public_t,
175 *surf_timer_model_extension_public_t;
177 /** \brief Timer model
178 * \ingroup SURF_models
180 typedef struct surf_timer_model {
181 surf_model_private_t common_private;
182 surf_model_public_t common_public;
183 surf_timer_model_extension_public_t extension_public;
184 } s_surf_timer_model_t, *surf_timer_model_t;
186 /** \brief The timer model
187 * \ingroup SURF_models
189 XBT_PUBLIC_DATA(surf_timer_model_t) surf_timer_model;
191 /** \brief Initializes the timer model
192 * \ingroup SURF_models
194 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
199 * \ingroup SURF_models
202 SURF_CPU_ON = 1, /**< Up & ready */
203 SURF_CPU_OFF = 0 /**< Down & broken */
204 } e_surf_cpu_state_t;
206 /** \brief CPU model extension public
207 * \ingroup SURF_models
209 * Public functions specific to the CPU model.
211 typedef struct surf_cpu_model_extension_public {
212 surf_action_t(*execute) (void *cpu, double size);
213 surf_action_t(*sleep) (void *cpu, double duration);
214 e_surf_cpu_state_t(*get_state) (void *cpu);
215 double (*get_speed) (void *cpu, double load);
216 double (*get_available_speed) (void *cpu);
217 } s_surf_cpu_model_extension_public_t,
218 *surf_cpu_model_extension_public_t;
220 /** \brief CPU model datatype
221 * \ingroup SURF_models
223 typedef struct surf_cpu_model {
224 surf_model_private_t common_private;
225 surf_model_public_t common_public;
226 surf_cpu_model_extension_public_t extension_public;
227 } s_surf_cpu_model_t, *surf_cpu_model_t;
229 /** \brief The CPU model
230 * \ingroup SURF_models
232 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
234 /** \brief Initializes the CPU model with the model Cas01
235 * \ingroup SURF_models
237 * This function is called by surf_workstation_model_init_CLM03
238 * so you shouldn't have to call it by yourself.
240 * \see surf_workstation_model_init_CLM03()
242 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
244 /** \brief The list of all available cpu model models
245 * \ingroup SURF_models
247 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
251 /** \brief Network model extension public
252 * \ingroup SURF_models
254 * Public functions specific to the network model
256 typedef struct surf_network_model_extension_public {
257 surf_action_t(*communicate) (void *src, void *dst, double size,
259 const void** (*get_route) (void *src, void *dst);
260 int (*get_route_size) (void *src, void *dst);
261 const char* (*get_link_name) (const void *link);
262 double (*get_link_bandwidth) (const void *link);
263 double (*get_link_latency) (const void *link);
264 int (*link_shared) (const void *link);
265 } s_surf_network_model_extension_public_t,
266 *surf_network_model_extension_public_t;
268 /** \brief Network model datatype
269 * \ingroup SURF_models
271 typedef struct surf_network_model {
272 surf_model_private_t common_private;
273 surf_model_public_t common_public;
274 surf_network_model_extension_public_t extension_public;
275 } s_surf_network_model_t, *surf_network_model_t;
277 XBT_PUBLIC(void) create_workstations(void);
279 /** \brief The network model
280 * \ingroup SURF_models
282 * When creating a new API on top on SURF, you shouldn't use the
283 * network model unless you know what you are doing. Only the workstation
284 * model should be accessed because depending on the platform model,
285 * the network model can be NULL.
287 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
290 /** \brief Initializes the platform with the network model 'Constant'
291 * \ingroup SURF_models
292 * \param filename XML platform file name
294 * In this model, the communication time between two network cards is
295 * constant, hence no need for a routing table. This is particularly
296 * usefull when simulating huge distributed algorithms where
297 * scalability is really an issue. This function is called in
298 * conjunction with surf_workstation_model_init_compound.
300 * \see surf_workstation_model_init_compound()
302 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
304 /** \brief Initializes the platform with the network model CM02
305 * \ingroup SURF_models
306 * \param filename XML platform file name
308 * This function is called by surf_workstation_model_init_CLM03
309 * or by yourself only if you plan using surf_workstation_model_init_compound
311 * \see surf_workstation_model_init_CLM03()
313 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
316 /** \brief Initializes the platform with the network model GTNETS
317 * \ingroup SURF_models
318 * \param filename XML platform file name
320 * This function is called by surf_workstation_model_init_GTNETS
321 * or by yourself only if you plan using surf_workstation_model_init_compound
323 * \see surf_workstation_model_init_GTNETS()
325 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
328 /** \brief Initializes the platform with the network model Reno
329 * \ingroup SURF_models
330 * \param filename XML platform file name
332 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
335 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
336 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
338 * Call this function only if you plan using surf_workstation_model_init_compound.
341 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
343 /** \brief Initializes the platform with the network model Reno2
344 * \ingroup SURF_models
345 * \param filename XML platform file name
347 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
350 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
351 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
353 * Call this function only if you plan using surf_workstation_model_init_compound.
356 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
358 /** \brief Initializes the platform with the network model Vegas
359 * \ingroup SURF_models
360 * \param filename XML platform file name
362 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
363 * to the proportional fairness.
366 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
367 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
369 * Call this function only if you plan using surf_workstation_model_init_compound.
372 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
375 /** \brief Initializes the platform with the network model based on SDP
376 * \ingroup SURF_models
377 * \param filename XML platform file name
379 * This function implements the proportional fairness known as the maximization
384 * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
385 * Semi-definite programming approach for bandwidth allocation and routing in networks.
386 * Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
388 * Call this function only if you plan using surf_workstation_model_init_compound.
390 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
393 /** \brief The list of all available network model models
394 * \ingroup SURF_models
396 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
398 /** \brief Workstation model extension public
399 * \ingroup SURF_models
401 * Public functions specific to the workstation model.
403 typedef struct surf_workstation_model_extension_public {
404 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
405 and create the corresponding action */
406 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
407 e_surf_cpu_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
408 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
409 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
410 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
411 void *workstation_dst, double size,
414 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
415 void **workstation_list,
416 double *computation_amount,
417 double *communication_amount,
420 const void** (*get_route) (void *src, void *dst); /**< Return the network link list between two workstations */
421 int (*get_route_size) (void *src, void *dst); /**< Return the route size between two workstations */
422 const char* (*get_link_name) (const void *link); /**< Return the name of a network link */
423 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
424 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
425 int (*link_shared) (const void *link);
426 } s_surf_workstation_model_extension_public_t,
427 *surf_workstation_model_extension_public_t;
429 /** \brief Workstation model datatype.
430 * \ingroup SURF_models
433 typedef struct surf_workstation_model {
434 surf_model_private_t common_private;
435 surf_model_public_t common_public;
436 surf_workstation_model_extension_public_t extension_public;
437 } s_surf_workstation_model_t, *surf_workstation_model_t;
439 /** \brief The workstation model
440 * \ingroup SURF_models
442 * Note that when you create an API on top of SURF,
443 * the workstation model should be the only one you use
444 * because depending on the platform model, the network model and the CPU model
447 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
449 /** \brief Initializes the platform with a compound workstation model
450 * \ingroup SURF_models
451 * \param filename XML platform file name
453 * This function should be called after a cpu_model and a
454 * network_model have been set up.
457 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
459 /** \brief Initializes the platform with the workstation model CLM03
460 * \ingroup SURF_models
461 * \param filename XML platform file name
463 * This platform model seperates the workstation model and the network model.
464 * The workstation model will be initialized with the model CLM03, the network
465 * model with the model CM02 and the CPU model with the model Cas01.
466 * In future releases, some other network models will be implemented and will be
467 * combined with the workstation model CLM03.
469 * \see surf_workstation_model_init_KCCFLN05()
471 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
473 /** \brief Initializes the platform with the model KCCFLN05
474 * \ingroup SURF_models
475 * \param filename XML platform file name
477 * With this model, the workstations and the network are handled
478 * together. The network model is roughly the same as in CM02 but
479 * interference between computations and communications can be taken
480 * into account. This platform model is the default one for MSG and
484 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
486 /** \brief Initializes the platform with the model KCCFLN05
487 * \ingroup SURF_models
488 * \param filename XML platform file name
490 * With this model, only parallel tasks can be used. Resource sharing
491 * is done by identifying bottlenecks and giving an equal share of
492 * the model to each action.
495 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
497 /** \brief The list of all available workstation model models
498 * \ingroup SURF_models
500 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[];
502 /** \brief The network links
503 * \ingroup SURF_models
505 * This dict contains all network links.
507 * \see workstation_set
509 XBT_PUBLIC_DATA(xbt_dict_t) link_set;
511 /** \brief The workstations
512 * \ingroup SURF_models
514 * This dict contains all workstations.
518 XBT_PUBLIC_DATA(xbt_dict_t) workstation_set;
519 XBT_PUBLIC_DATA(xbt_dict_t) cpu_set;
520 /** \brief List of initialized models
521 * \ingroup SURF_models
523 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
525 /*******************************************/
526 /*** SURF Globals **************************/
527 /*******************************************/
529 /** \brief Initialize SURF
530 * \ingroup SURF_simulation
531 * \param argc argument number
532 * \param argv arguments
534 * This function has to be called to initialize the common
535 * structures. Then you will have to create the environment by
536 * calling surf_timer_model_init() and
537 * e.g. surf_workstation_model_init_CLM03() or
538 * surf_workstation_model_init_KCCFLN05().
540 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
541 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
543 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
545 /** \brief Finish simulation initialization
546 * \ingroup SURF_simulation
548 * This function must be called before the first call to surf_solve()
550 XBT_PUBLIC(void) surf_presolve(void);
552 /** \brief Performs a part of the simulation
553 * \ingroup SURF_simulation
554 * \return the elapsed time, or -1.0 if no event could be executed
556 * This function execute all possible events, update the action states
557 * and returns the time elapsed.
558 * When you call execute or communicate on a model, the corresponding actions
559 * are not executed immediately but only when you call surf_solve.
560 * Note that the returned elapsed time can be zero.
562 XBT_PUBLIC(double) surf_solve(void);
564 /** \brief Return the current time
565 * \ingroup SURF_simulation
567 * Return the current time in millisecond.
569 XBT_PUBLIC(double)surf_get_clock(void);
572 * \ingroup SURF_simulation
578 XBT_PUBLIC(void) surf_exit(void);
580 /* Prototypes of the functions that handle the properties */
581 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
582 XBT_PUBLIC_DATA(void) parse_properties(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 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table, const char* route_name, int action, int isMultiRoute);
591 XBT_PUBLIC_DATA(int) route_action;
593 /* This is used by all models when creating the routing table while parsing */
594 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
595 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
598 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
599 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
600 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
601 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
602 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
603 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
604 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
607 XBT_PUBLIC_DATA(double) get_cpu_power(const char* power);
612 #endif /* _SURF_SURF_H */