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) (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,
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 Public data available on all models
122 * \ingroup SURF_models
124 * These functions are implemented by all models.
126 typedef struct surf_model_public {
127 } s_surf_model_public_t, *surf_model_public_t;
129 /** \brief Private data available on all models
130 * \ingroup SURF_models
132 typedef struct surf_model_private *surf_model_private_t;
134 /** \brief Timer model extension public
135 * \ingroup SURF_model
137 * Additionnal functions specific to the timer model
139 typedef struct surf_timer_model_extension_public {
140 void (*set) (double date, void *function, void *arg);
141 int (*get) (void **function, void **arg);
142 } s_surf_model_extension_timer_t;
147 * \ingroup SURF_models
150 SURF_CPU_ON = 1, /**< Up & ready */
151 SURF_CPU_OFF = 0 /**< Down & broken */
152 } e_surf_cpu_state_t;
154 /** \brief CPU model extension public
155 * \ingroup SURF_models
157 * Public functions specific to the CPU model.
159 typedef struct surf_cpu_model_extension_public {
160 surf_action_t(*execute) (void *cpu, double size);
161 surf_action_t(*sleep) (void *cpu, double duration);
162 e_surf_cpu_state_t(*get_state) (void *cpu);
163 double (*get_speed) (void *cpu, double load);
164 double (*get_available_speed) (void *cpu);
165 } s_surf_model_extension_cpu_t;
169 /** \brief Network model extension public
170 * \ingroup SURF_models
172 * Public functions specific to the network model
174 typedef struct surf_network_model_extension_public {
175 surf_action_t(*communicate) (void *src, void *dst, double size,
177 const void **(*get_route) (void *src, void *dst);
178 int (*get_route_size) (void *src, void *dst);
179 const char *(*get_link_name) (const void *link);
180 double (*get_link_bandwidth) (const void *link);
181 double (*get_link_latency) (const void *link);
182 int (*link_shared) (const void *link);
183 } s_surf_model_extension_network_t;
185 /** \brief Workstation model extension public
186 * \ingroup SURF_models
188 * Public functions specific to the workstation model.
190 typedef struct surf_workstation_model_extension_public {
191 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
192 and create the corresponding action */
193 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
194 e_surf_cpu_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
195 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
196 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
197 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
198 void *workstation_dst, double size,
201 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
202 void **workstation_list,
203 double *computation_amount,
204 double *communication_amount,
205 double amount, double rate);
206 const void **(*get_route) (void *src, void *dst); /**< Return the network link list between two workstations */
207 int (*get_route_size) (void *src, void *dst); /**< Return the route size between two workstations */
208 const char *(*get_link_name) (const void *link); /**< Return the name of a network link */
209 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
210 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
211 int (*link_shared) (const void *link);
212 } s_surf_model_extension_workstation_t;
214 /** \brief Model datatype
215 * \ingroup SURF_models
217 * Generic data structure for a model. The workstations,
218 * the CPUs and the network links are examples of models.
220 typedef struct surf_model {
221 const char *name;/**< Name of this model */
222 s_surf_action_state_t states; /**< Any living action on this model */
223 const char *(*get_resource_name) (void *resource_id);/**< Return the name of a resource */
225 e_surf_action_state_t(*action_get_state) (surf_action_t action);/**< Return the state of an action */
226 double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
227 double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
228 void (*action_use) (surf_action_t action);/**< Set an action used */
229 int (*action_free) (surf_action_t action);/**< Free an action */
230 void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
231 void (*action_recycle) (surf_action_t action);/**< Recycle an action */
232 void (*action_change_state) (surf_action_t action,
233 e_surf_action_state_t state);
234 /**< Change an action state*/
235 void (*action_set_data) (surf_action_t action, void *data);/**< Set the user data of an action */
236 void (*suspend) (surf_action_t action);/**< Suspend an action */
237 void (*resume) (surf_action_t action);/**< Resume a suspended action */
238 int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
239 void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
240 void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
241 xbt_dict_t(*get_properties) (void *resource_id);/**< Return the properties dictionary */
242 xbt_dict_t resource_set;
246 surf_model_private_t model_private;
251 s_surf_model_extension_timer_t timer;
252 s_surf_model_extension_cpu_t cpu;
253 s_surf_model_extension_network_t network;
254 s_surf_model_extension_workstation_t workstation;
258 void surf_model_init(surf_model_t model);
259 void *surf_model_resource_by_name(surf_model_t model, const char *name);
260 #define surf_model_resource_set(model) (model)->resource_set
261 void surf_model_exit(surf_model_t model);
263 typedef struct surf_resource {
265 } s_surf_resource_t, *surf_resource_t;
267 /**************************************/
268 /* Implementations of model object */
269 /**************************************/
272 /** \brief The timer model
273 * \ingroup SURF_models
275 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
277 /** \brief Initializes the timer model
278 * \ingroup SURF_models
280 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
282 /** \brief The CPU model
283 * \ingroup SURF_models
285 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
287 /** \brief Initializes the CPU model with the model Cas01
288 * \ingroup SURF_models
290 * This function is called by surf_workstation_model_init_CLM03
291 * so you shouldn't have to call it by yourself.
293 * \see surf_workstation_model_init_CLM03()
295 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
297 /** \brief The list of all available cpu model models
298 * \ingroup SURF_models
300 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
302 XBT_PUBLIC(void) create_workstations(void);
304 /** \brief The network model
305 * \ingroup SURF_models
307 * When creating a new API on top on SURF, you shouldn't use the
308 * network model unless you know what you are doing. Only the workstation
309 * model should be accessed because depending on the platform model,
310 * the network model can be NULL.
312 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
314 /** \brief Initializes the platform with the network model 'LagrangeVelho'
315 * \ingroup SURF_models
316 * \param filename XML platform file name
318 * This model is proposed by Arnaud Legrand and Pedro Velho based on
319 * the results obtained with the GTNets simulator for onelink and
320 * dogbone sharing scenarios.
322 * \see surf_workstation_model_init_LegrandVelho()
324 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
326 /** \brief Initializes the platform with the network model 'Constant'
327 * \ingroup SURF_models
328 * \param filename XML platform file name
330 * In this model, the communication time between two network cards is
331 * constant, hence no need for a routing table. This is particularly
332 * usefull when simulating huge distributed algorithms where
333 * scalability is really an issue. This function is called in
334 * conjunction with surf_workstation_model_init_compound.
336 * \see surf_workstation_model_init_compound()
338 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
340 /** \brief Initializes the platform with the network model CM02
341 * \ingroup SURF_models
342 * \param filename XML platform file name
344 * This function is called by surf_workstation_model_init_CLM03
345 * or by yourself only if you plan using surf_workstation_model_init_compound
347 * \see surf_workstation_model_init_CLM03()
349 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
352 /** \brief Initializes the platform with the network model GTNETS
353 * \ingroup SURF_models
354 * \param filename XML platform file name
356 * This function is called by surf_workstation_model_init_GTNETS
357 * or by yourself only if you plan using surf_workstation_model_init_compound
359 * \see surf_workstation_model_init_GTNETS()
361 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
364 /** \brief Initializes the platform with the network model Reno
365 * \ingroup SURF_models
366 * \param filename XML platform file name
368 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
371 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
372 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
374 * Call this function only if you plan using surf_workstation_model_init_compound.
377 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
379 /** \brief Initializes the platform with the network model Reno2
380 * \ingroup SURF_models
381 * \param filename XML platform file name
383 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
386 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
387 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
389 * Call this function only if you plan using surf_workstation_model_init_compound.
392 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
394 /** \brief Initializes the platform with the network model Vegas
395 * \ingroup SURF_models
396 * \param filename XML platform file name
398 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
399 * to the proportional fairness.
402 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
403 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
405 * Call this function only if you plan using surf_workstation_model_init_compound.
408 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
411 /** \brief Initializes the platform with the network model based on SDP
412 * \ingroup SURF_models
413 * \param filename XML platform file name
415 * This function implements the proportional fairness known as the maximization
420 * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
421 * Semi-definite programming approach for bandwidth allocation and routing in networks.
422 * Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
424 * Call this function only if you plan using surf_workstation_model_init_compound.
426 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
429 /** \brief The list of all available network model models
430 * \ingroup SURF_models
432 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
435 /** \brief The workstation model
436 * \ingroup SURF_models
438 * Note that when you create an API on top of SURF,
439 * the workstation model should be the only one you use
440 * because depending on the platform model, the network model and the CPU model
443 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
445 /** \brief Initializes the platform with a compound workstation model
446 * \ingroup SURF_models
447 * \param filename XML platform file name
449 * This function should be called after a cpu_model and a
450 * network_model have been set up.
453 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
455 /** \brief Initializes the platform with the workstation model CLM03
456 * \ingroup SURF_models
457 * \param filename XML platform file name
459 * This platform model seperates the workstation model and the network model.
460 * The workstation model will be initialized with the model CLM03, the network
461 * model with the model CM02 and the CPU model with the model Cas01.
462 * In future releases, some other network models will be implemented and will be
463 * combined with the workstation model CLM03.
465 * \see surf_workstation_model_init_KCCFLN05()
467 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
469 /** \brief Initializes the platform with the model KCCFLN05
470 * \ingroup SURF_models
471 * \param filename XML platform file name
473 * With this model, the workstations and the network are handled
474 * together. The network model is roughly the same as in CM02 but
475 * interference between computations and communications can be taken
476 * into account. This platform model is the default one for MSG and
480 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(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, only parallel tasks can be used. Resource sharing
487 * is done by identifying bottlenecks and giving an equal share of
488 * the model to each action.
491 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
493 /** \brief The list of all available workstation model models
494 * \ingroup SURF_models
496 XBT_PUBLIC_DATA(s_surf_model_description_t)
497 surf_workstation_model_description[];
499 /** \brief The network links
500 * \ingroup SURF_models
502 * This dict contains all network links.
504 * \see workstation_set
506 XBT_PUBLIC_DATA(xbt_dict_t) link_set;
508 /** \brief The workstations
509 * \ingroup SURF_models
511 * This dict contains all workstations.
515 /** \brief List of initialized models
516 * \ingroup SURF_models
518 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
520 /*******************************************/
521 /*** SURF Globals **************************/
522 /*******************************************/
523 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
525 /** \brief Initialize SURF
526 * \ingroup SURF_simulation
527 * \param argc argument number
528 * \param argv arguments
530 * This function has to be called to initialize the common
531 * structures. Then you will have to create the environment by
532 * calling surf_timer_model_init() and
533 * e.g. surf_workstation_model_init_CLM03() or
534 * surf_workstation_model_init_KCCFLN05().
536 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
537 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
539 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
541 /** \brief Initialize the used models.
543 * Must be called after the surf_init so that configuration infrastructure is created
544 * Must be called before parsing/creating the environment
545 * Must not be called within the initialization process so that the use get a chance to change the settings from
546 * its code between, say, MSG_init and MSG_create_environment using MSG_config
548 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
550 /** \brief create the elements of the models
552 * Must be called after parsing the platform file and before using any elements
554 XBT_PUBLIC(void) surf_config_models_create_elms(void);
556 /** \brief Finish simulation initialization
557 * \ingroup SURF_simulation
559 * This function must be called before the first call to surf_solve()
561 XBT_PUBLIC(void) surf_presolve(void);
563 /** \brief Performs a part of the simulation
564 * \ingroup SURF_simulation
565 * \return the elapsed time, or -1.0 if no event could be executed
567 * This function execute all possible events, update the action states
568 * and returns the time elapsed.
569 * When you call execute or communicate on a model, the corresponding actions
570 * are not executed immediately but only when you call surf_solve.
571 * Note that the returned elapsed time can be zero.
573 XBT_PUBLIC(double) surf_solve(void);
575 /** \brief Return the current time
576 * \ingroup SURF_simulation
578 * Return the current time in millisecond.
580 XBT_PUBLIC(double) surf_get_clock(void);
583 * \ingroup SURF_simulation
589 XBT_PUBLIC(void) surf_exit(void);
591 /* Prototypes of the functions that handle the properties */
592 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
593 XBT_PUBLIC_DATA(void) parse_properties(void);
595 /* surf parse file related (public because called from a test suite) */
596 XBT_PUBLIC(void) parse_platform_file(const char *file);
598 /* Stores the sets */
599 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
601 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
602 const char *route_name, int action,
604 XBT_PUBLIC_DATA(int) route_action;
606 /* This is used by all models when creating the routing table while parsing */
607 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
608 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
611 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
612 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
613 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
614 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
615 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
616 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
617 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
620 XBT_PUBLIC_DATA(double) get_cpu_power(const char *power);
624 #endif /* _SURF_SURF_H */