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"
19 /* Actions and models are higly connected structures... */
22 /** \brief Model datatype
23 * \ingroup SURF_models
25 * Generic data structure for a model. The workstations,
26 * the CPUs and the network links are examples of models.
28 typedef struct surf_model *surf_model_t;
31 /** \brief Action datatype
32 * \ingroup SURF_actions
34 * An action is some working amount on a model.
35 * It is represented as a cost, a priority, a duration and a state.
37 * \see e_surf_action_state_t
39 typedef struct surf_action *surf_action_t;
40 /** @Brief Specify that we use that action */
41 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
42 /** @brief Creates a new action.
44 * @param size The size is the one of the subtype you want to create
45 * @param cost initial value
46 * @param model to which model we should attach this action
47 * @param failed whether we should start this action in failed mode
49 XBT_PUBLIC(void*) surf_action_new(size_t size,double cost,surf_model_t model, int failed);
53 /** \brief Resource model description
55 typedef struct surf_model_description {
58 void (*model_init_preparse) (const char *filename);
59 void (*model_init_postparse) (void);
60 } s_surf_model_description_t, *surf_model_description_t;
62 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
65 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
68 /** \brief Action structure
69 * \ingroup SURF_actions
71 * Never create s_surf_action_t by yourself ! The actions are created
72 * on the fly when you call execute or communicate on a model.
74 * \see e_surf_action_state_t
76 typedef struct surf_action {
77 s_xbt_swag_hookup_t state_hookup;
79 double cost; /**< cost */
80 double priority; /**< priority (1.0 by default) */
81 double max_duration; /**< max_duration (may fluctuate until
82 the task is completed) */
83 double remains; /**< How much of that cost remains to
84 * be done in the currently running task */
85 double start; /**< start time */
86 double finish; /**< finish time : this is modified during the run
87 * and fluctuates until the task is completed */
88 void *data; /**< for your convenience */
90 surf_model_t model_type;
94 s_surf_action_t generic_action;
95 void *variable; /* of type lmm_variable_t, which is only visible by loading maxmin */
97 } s_surf_action_maxmin_t,*surf_action_maxmin_t;
98 /** \brief Action states
99 * \ingroup SURF_actions
103 * \see surf_action_t, surf_action_state_t
106 SURF_ACTION_READY = 0, /**< Ready */
107 SURF_ACTION_RUNNING, /**< Running */
108 SURF_ACTION_FAILED, /**< Task Failure */
109 SURF_ACTION_DONE, /**< Completed */
110 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
111 SURF_ACTION_NOT_IN_THE_SYSTEM
112 /**< Not in the system anymore. Why did you ask ? */
113 } e_surf_action_state_t;
115 /** \brief Action state sets
116 * \ingroup SURF_actions
118 * This structure contains some sets of actions.
119 * It provides a fast access to the actions in each state.
121 * \see surf_action_t, e_surf_action_state_t
123 typedef struct surf_action_state {
124 xbt_swag_t ready_action_set;
125 /**< Actions in state SURF_ACTION_READY */
126 xbt_swag_t running_action_set;
127 /**< Actions in state SURF_ACTION_RUNNING */
128 xbt_swag_t failed_action_set;
129 /**< Actions in state SURF_ACTION_FAILED */
130 xbt_swag_t done_action_set;
131 /**< Actions in state SURF_ACTION_DONE */
132 } s_surf_action_state_t, *surf_action_state_t;
134 /***************************/
135 /* Generic model object */
136 /***************************/
137 typedef struct s_routing s_routing_t, *routing_t;
138 XBT_PUBLIC_DATA(routing_t) used_routing;
140 /** \brief Private data available on all models
141 * \ingroup SURF_models
143 typedef struct surf_model_private *surf_model_private_t;
145 /** \brief Timer model extension public
146 * \ingroup SURF_model
148 * Additionnal functions specific to the timer model
150 typedef struct surf_timer_model_extension_public {
151 void (*set) (double date, void *function, void *arg);
152 int (*get) (void **function, void **arg);
153 } s_surf_model_extension_timer_t;
158 * \ingroup SURF_models
161 SURF_CPU_ON = 1, /**< Up & ready */
162 SURF_CPU_OFF = 0 /**< Down & broken */
163 } e_surf_cpu_state_t;
165 /** \brief CPU model extension public
166 * \ingroup SURF_models
168 * Public functions specific to the CPU model.
170 typedef struct surf_cpu_model_extension_public {
171 surf_action_t(*execute) (void *cpu, double size);
172 surf_action_t(*sleep) (void *cpu, double duration);
173 e_surf_cpu_state_t(*get_state) (void *cpu);
174 double (*get_speed) (void *cpu, double load);
175 double (*get_available_speed) (void *cpu);
176 } s_surf_model_extension_cpu_t;
180 /** \brief Network model extension public
181 * \ingroup SURF_models
183 * Public functions specific to the network model
185 typedef struct surf_network_model_extension_public {
186 surf_action_t(*communicate) (const char *src_name,const char *dst_name,int src, int dst, double size,
188 xbt_dynar_t (*get_route) (int src, int dst);
189 double (*get_link_bandwidth) (const void *link);
190 double (*get_link_latency) (const void *link);
191 int (*link_shared) (const void *link);
192 } s_surf_model_extension_network_t;
194 /** \brief Workstation model extension public
195 * \ingroup SURF_models
197 * Public functions specific to the workstation model.
199 typedef struct surf_workstation_model_extension_public {
200 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
201 and create the corresponding action */
202 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
203 e_surf_cpu_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
204 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
205 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
206 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
207 void *workstation_dst, double size,
209 xbt_dynar_t(*get_route)(void *workstation_src,void *workstation_dst); /**< Get the list of links between two ws */
211 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
212 void **workstation_list,
213 double *computation_amount,
214 double *communication_amount,
215 double amount, double rate);
216 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
217 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
218 int (*link_shared) (const void *link);
219 xbt_dict_t (*get_properties)(const void*resource);
220 } s_surf_model_extension_workstation_t;
222 /** \brief Model datatype
223 * \ingroup SURF_models
225 * Generic data structure for a model. The workstations,
226 * the CPUs and the network links are examples of models.
228 typedef struct surf_model {
229 const char *name;/**< Name of this model */
230 s_surf_action_state_t states; /**< Any living action on this model */
232 e_surf_action_state_t(*action_state_get) (surf_action_t action);/**< Return the state of an action */
233 void (*action_state_set) (surf_action_t action,
234 e_surf_action_state_t state); /**< Change an action state*/
236 double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
237 double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
238 int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
239 void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
240 void (*action_recycle) (surf_action_t action);/**< Recycle an action */
241 void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
242 void (*suspend) (surf_action_t action);/**< Suspend an action */
243 void (*resume) (surf_action_t action);/**< Resume a suspended action */
244 int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
245 void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
246 void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
248 xbt_dict_t resource_set;
252 surf_model_private_t model_private;
257 s_surf_model_extension_timer_t timer;
258 s_surf_model_extension_cpu_t cpu;
259 s_surf_model_extension_network_t network;
260 s_surf_model_extension_workstation_t workstation;
264 surf_model_t surf_model_init(void);
265 void surf_model_exit(surf_model_t model);
267 void *surf_model_resource_by_name(surf_model_t model, const char *name);
268 #define surf_model_resource_set(model) (model)->resource_set
270 typedef struct surf_resource {
273 xbt_dict_t properties;
274 } s_surf_resource_t, *surf_resource_t;
276 XBT_PUBLIC(const char*) surf_resource_name(const void *resource);
277 XBT_PUBLIC(void) surf_resource_free(void* resource);
278 /**************************************/
279 /* Implementations of model object */
280 /**************************************/
283 /** \brief The timer model
284 * \ingroup SURF_models
286 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
288 /** \brief Initializes the timer model
289 * \ingroup SURF_models
291 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
293 /** \brief The CPU model
294 * \ingroup SURF_models
296 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
298 /** \brief Initializes the CPU model with the model Cas01
299 * \ingroup SURF_models
301 * This function is called by surf_workstation_model_init_CLM03
302 * so you shouldn't have to call it by yourself.
304 * \see surf_workstation_model_init_CLM03()
306 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
308 /** \brief The list of all available cpu model models
309 * \ingroup SURF_models
311 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
313 XBT_PUBLIC(void) create_workstations(void);
315 /** \brief The network model
316 * \ingroup SURF_models
318 * When creating a new API on top on SURF, you shouldn't use the
319 * network model unless you know what you are doing. Only the workstation
320 * model should be accessed because depending on the platform model,
321 * the network model can be NULL.
323 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
325 /** \brief Initializes the platform with the network model 'LagrangeVelho'
326 * \ingroup SURF_models
327 * \param filename XML platform file name
329 * This model is proposed by Arnaud Legrand and Pedro Velho based on
330 * the results obtained with the GTNets simulator for onelink and
331 * dogbone sharing scenarios.
333 * \see surf_workstation_model_init_LegrandVelho()
335 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
337 /** \brief Initializes the platform with the network model 'Constant'
338 * \ingroup SURF_models
339 * \param filename XML platform file name
341 * In this model, the communication time between two network cards is
342 * constant, hence no need for a routing table. This is particularly
343 * usefull when simulating huge distributed algorithms where
344 * scalability is really an issue. This function is called in
345 * conjunction with surf_workstation_model_init_compound.
347 * \see surf_workstation_model_init_compound()
349 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
351 /** \brief Initializes the platform with the network model CM02
352 * \ingroup SURF_models
353 * \param filename XML platform file name
355 * This function is called by surf_workstation_model_init_CLM03
356 * or by yourself only if you plan using surf_workstation_model_init_compound
358 * \see surf_workstation_model_init_CLM03()
360 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
363 /** \brief Initializes the platform with the network model GTNETS
364 * \ingroup SURF_models
365 * \param filename XML platform file name
367 * This function is called by surf_workstation_model_init_GTNETS
368 * or by yourself only if you plan using surf_workstation_model_init_compound
370 * \see surf_workstation_model_init_GTNETS()
372 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
375 /** \brief Initializes the platform with the network model Reno
376 * \ingroup SURF_models
377 * \param filename XML platform file name
379 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
382 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
383 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
385 * Call this function only if you plan using surf_workstation_model_init_compound.
388 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
390 /** \brief Initializes the platform with the network model Reno2
391 * \ingroup SURF_models
392 * \param filename XML platform file name
394 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
397 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
398 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
400 * Call this function only if you plan using surf_workstation_model_init_compound.
403 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
405 /** \brief Initializes the platform with the network model Vegas
406 * \ingroup SURF_models
407 * \param filename XML platform file name
409 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
410 * to the proportional fairness.
413 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
414 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
416 * Call this function only if you plan using surf_workstation_model_init_compound.
419 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
422 /** \brief Initializes the platform with the network model based on SDP
423 * \ingroup SURF_models
424 * \param filename XML platform file name
426 * This function implements the proportional fairness known as the maximization
431 * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
432 * Semi-definite programming approach for bandwidth allocation and routing in networks.
433 * Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
435 * Call this function only if you plan using surf_workstation_model_init_compound.
437 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
440 /** \brief The list of all available network model models
441 * \ingroup SURF_models
443 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
446 /** \brief The workstation model
447 * \ingroup SURF_models
449 * Note that when you create an API on top of SURF,
450 * the workstation model should be the only one you use
451 * because depending on the platform model, the network model and the CPU model
454 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
456 /** \brief Initializes the platform with a compound workstation model
457 * \ingroup SURF_models
458 * \param filename XML platform file name
460 * This function should be called after a cpu_model and a
461 * network_model have been set up.
464 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
466 /** \brief Initializes the platform with the workstation model CLM03
467 * \ingroup SURF_models
468 * \param filename XML platform file name
470 * This platform model seperates the workstation model and the network model.
471 * The workstation model will be initialized with the model CLM03, the network
472 * model with the model CM02 and the CPU model with the model Cas01.
473 * In future releases, some other network models will be implemented and will be
474 * combined with the workstation model CLM03.
476 * \see surf_workstation_model_init_KCCFLN05()
478 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(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, the workstations and the network are handled
485 * together. The network model is roughly the same as in CM02 but
486 * interference between computations and communications can be taken
487 * into account. This platform model is the default one for MSG and
491 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
493 /** \brief Initializes the platform with the model KCCFLN05
494 * \ingroup SURF_models
495 * \param filename XML platform file name
497 * With this model, only parallel tasks can be used. Resource sharing
498 * is done by identifying bottlenecks and giving an equal share of
499 * the model to each action.
502 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
504 /** \brief The list of all available workstation model models
505 * \ingroup SURF_models
507 XBT_PUBLIC_DATA(s_surf_model_description_t)
508 surf_workstation_model_description[];
510 /** \brief List of initialized models
511 * \ingroup SURF_models
513 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
515 /*******************************************/
516 /*** SURF Globals **************************/
517 /*******************************************/
518 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
520 /** \brief Initialize SURF
521 * \ingroup SURF_simulation
522 * \param argc argument number
523 * \param argv arguments
525 * This function has to be called to initialize the common
526 * structures. Then you will have to create the environment by
527 * calling surf_timer_model_init() and
528 * e.g. surf_workstation_model_init_CLM03() or
529 * surf_workstation_model_init_KCCFLN05().
531 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
532 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
534 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
536 /** \brief Initialize the used models.
538 * Must be called after the surf_init so that configuration infrastructure is created
539 * Must be called before parsing/creating the environment
540 * Must not be called within the initialization process so that the use get a chance to change the settings from
541 * its code between, say, MSG_init and MSG_create_environment using MSG_config
543 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
545 /** \brief create the elements of the models
547 * Must be called after parsing the platform file and before using any elements
549 XBT_PUBLIC(void) surf_config_models_create_elms(void);
551 /** \brief Finish simulation initialization
552 * \ingroup SURF_simulation
554 * This function must be called before the first call to surf_solve()
556 XBT_PUBLIC(void) surf_presolve(void);
558 /** \brief Performs a part of the simulation
559 * \ingroup SURF_simulation
560 * \return the elapsed time, or -1.0 if no event could be executed
562 * This function execute all possible events, update the action states
563 * and returns the time elapsed.
564 * When you call execute or communicate on a model, the corresponding actions
565 * are not executed immediately but only when you call surf_solve.
566 * Note that the returned elapsed time can be zero.
568 XBT_PUBLIC(double) surf_solve(void);
570 /** \brief Return the current time
571 * \ingroup SURF_simulation
573 * Return the current time in millisecond.
575 XBT_PUBLIC(double) surf_get_clock(void);
578 * \ingroup SURF_simulation
584 XBT_PUBLIC(void) surf_exit(void);
586 /* Prototypes of the functions that handle the properties */
587 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
588 XBT_PUBLIC_DATA(void) parse_properties(void);
590 /* surf parse file related (public because called from a test suite) */
591 XBT_PUBLIC(void) parse_platform_file(const char *file);
593 /* Stores the sets */
594 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
596 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
597 const char *route_name, int action,
599 XBT_PUBLIC_DATA(int) route_action;
601 /* This is used by all models when creating the routing table while parsing */
602 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
603 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
606 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
607 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
608 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
609 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
610 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
611 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
612 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
615 XBT_PUBLIC(double) get_cpu_power(const char *power);
619 #endif /* _SURF_SURF_H */