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;
32 /** @Brief Specify that we use that action */
33 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
36 /** \brief Model datatype
37 * \ingroup SURF_models
39 * Generic data structure for a model. The workstations,
40 * the CPUs and the network links are examples of models.
42 typedef struct surf_model *surf_model_t;
44 /** \brief Resource model description
46 typedef struct surf_model_description {
49 void (*model_init_preparse) (const char *filename);
50 void (*model_init_postparse) (void);
51 } s_surf_model_description_t, *surf_model_description_t;
53 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
56 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
59 /** \brief Action structure
60 * \ingroup SURF_actions
62 * Never create s_surf_action_t by yourself ! The actions are created
63 * on the fly when you call execute or communicate on a model.
65 * \see e_surf_action_state_t
67 typedef struct surf_action {
68 s_xbt_swag_hookup_t state_hookup;
70 double cost; /**< cost */
71 double priority; /**< priority (1.0 by default) */
72 double max_duration; /**< max_duration (may fluctuate until
73 the task is completed) */
74 double remains; /**< How much of that cost remains to
75 * be done in the currently running task */
76 double start; /**< start time */
77 double finish; /**< finish time : this is modified during the run
78 * and fluctuates until the task is completed */
79 void *data; /**< for your convenience */
81 surf_model_t model_type;
84 /** \brief Action states
85 * \ingroup SURF_actions
89 * \see surf_action_t, surf_action_state_t
92 SURF_ACTION_READY = 0, /**< Ready */
93 SURF_ACTION_RUNNING, /**< Running */
94 SURF_ACTION_FAILED, /**< Task Failure */
95 SURF_ACTION_DONE, /**< Completed */
96 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
97 SURF_ACTION_NOT_IN_THE_SYSTEM
98 /**< Not in the system anymore. Why did you ask ? */
99 } e_surf_action_state_t;
101 /** \brief Action state sets
102 * \ingroup SURF_actions
104 * This structure contains some sets of actions.
105 * It provides a fast access to the actions in each state.
107 * \see surf_action_t, e_surf_action_state_t
109 typedef struct surf_action_state {
110 xbt_swag_t ready_action_set;
111 /**< Actions in state SURF_ACTION_READY */
112 xbt_swag_t running_action_set;
113 /**< Actions in state SURF_ACTION_RUNNING */
114 xbt_swag_t failed_action_set;
115 /**< Actions in state SURF_ACTION_FAILED */
116 xbt_swag_t done_action_set;
117 /**< Actions in state SURF_ACTION_DONE */
118 } s_surf_action_state_t, *surf_action_state_t;
120 /***************************/
121 /* Generic model object */
122 /***************************/
123 typedef struct s_routing s_routing_t, *routing_t;
124 XBT_PUBLIC_DATA(routing_t) used_routing;
126 /** \brief Private data available on all models
127 * \ingroup SURF_models
129 typedef struct surf_model_private *surf_model_private_t;
131 /** \brief Timer model extension public
132 * \ingroup SURF_model
134 * Additionnal functions specific to the timer model
136 typedef struct surf_timer_model_extension_public {
137 void (*set) (double date, void *function, void *arg);
138 int (*get) (void **function, void **arg);
139 } s_surf_model_extension_timer_t;
144 * \ingroup SURF_models
147 SURF_CPU_ON = 1, /**< Up & ready */
148 SURF_CPU_OFF = 0 /**< Down & broken */
149 } e_surf_cpu_state_t;
151 /** \brief CPU model extension public
152 * \ingroup SURF_models
154 * Public functions specific to the CPU model.
156 typedef struct surf_cpu_model_extension_public {
157 surf_action_t(*execute) (void *cpu, double size);
158 surf_action_t(*sleep) (void *cpu, double duration);
159 e_surf_cpu_state_t(*get_state) (void *cpu);
160 double (*get_speed) (void *cpu, double load);
161 double (*get_available_speed) (void *cpu);
162 } s_surf_model_extension_cpu_t;
166 /** \brief Network model extension public
167 * \ingroup SURF_models
169 * Public functions specific to the network model
171 typedef struct surf_network_model_extension_public {
172 surf_action_t(*communicate) (const char *src_name,const char *dst_name,int src, int dst, double size,
174 xbt_dynar_t (*get_route) (int src, int dst);
175 double (*get_link_bandwidth) (const void *link);
176 double (*get_link_latency) (const void *link);
177 int (*link_shared) (const void *link);
178 } s_surf_model_extension_network_t;
180 /** \brief Workstation model extension public
181 * \ingroup SURF_models
183 * Public functions specific to the workstation model.
185 typedef struct surf_workstation_model_extension_public {
186 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
187 and create the corresponding action */
188 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
189 e_surf_cpu_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
190 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
191 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
192 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
193 void *workstation_dst, double size,
195 xbt_dynar_t(*get_route)(void *workstation_src,void *workstation_dst); /**< Get the list of links between two ws */
197 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
198 void **workstation_list,
199 double *computation_amount,
200 double *communication_amount,
201 double amount, double rate);
202 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
203 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
204 int (*link_shared) (const void *link);
205 } s_surf_model_extension_workstation_t;
207 /** \brief Model datatype
208 * \ingroup SURF_models
210 * Generic data structure for a model. The workstations,
211 * the CPUs and the network links are examples of models.
213 typedef struct surf_model {
214 const char *name;/**< Name of this model */
215 s_surf_action_state_t states; /**< Any living action on this model */
217 e_surf_action_state_t(*action_state_get) (surf_action_t action);/**< Return the state of an action */
218 void (*action_state_set) (surf_action_t action,
219 e_surf_action_state_t state); /**< Change an action state*/
221 double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
222 double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
223 int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
224 void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
225 void (*action_recycle) (surf_action_t action);/**< Recycle an action */
226 void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
227 void (*suspend) (surf_action_t action);/**< Suspend an action */
228 void (*resume) (surf_action_t action);/**< Resume a suspended action */
229 int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
230 void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
231 void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
233 xbt_dict_t resource_set;
237 surf_model_private_t model_private;
242 s_surf_model_extension_timer_t timer;
243 s_surf_model_extension_cpu_t cpu;
244 s_surf_model_extension_network_t network;
245 s_surf_model_extension_workstation_t workstation;
249 surf_model_t surf_model_init(void);
250 void surf_model_exit(surf_model_t model);
252 void *surf_model_resource_by_name(surf_model_t model, const char *name);
253 #define surf_model_resource_set(model) (model)->resource_set
255 typedef struct surf_resource {
258 xbt_dict_t properties;
259 } s_surf_resource_t, *surf_resource_t;
261 XBT_PUBLIC(const char*) surf_resource_name(const void *resource);
262 XBT_PUBLIC(xbt_dict_t) surf_resource_properties(const void *resource);
263 XBT_PUBLIC(void) surf_resource_free(void* resource);
264 /**************************************/
265 /* Implementations of model object */
266 /**************************************/
269 /** \brief The timer model
270 * \ingroup SURF_models
272 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
274 /** \brief Initializes the timer model
275 * \ingroup SURF_models
277 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
279 /** \brief The CPU model
280 * \ingroup SURF_models
282 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
284 /** \brief Initializes the CPU model with the model Cas01
285 * \ingroup SURF_models
287 * This function is called by surf_workstation_model_init_CLM03
288 * so you shouldn't have to call it by yourself.
290 * \see surf_workstation_model_init_CLM03()
292 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
294 /** \brief The list of all available cpu model models
295 * \ingroup SURF_models
297 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
299 XBT_PUBLIC(void) create_workstations(void);
301 /** \brief The network model
302 * \ingroup SURF_models
304 * When creating a new API on top on SURF, you shouldn't use the
305 * network model unless you know what you are doing. Only the workstation
306 * model should be accessed because depending on the platform model,
307 * the network model can be NULL.
309 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
311 /** \brief Initializes the platform with the network model 'LagrangeVelho'
312 * \ingroup SURF_models
313 * \param filename XML platform file name
315 * This model is proposed by Arnaud Legrand and Pedro Velho based on
316 * the results obtained with the GTNets simulator for onelink and
317 * dogbone sharing scenarios.
319 * \see surf_workstation_model_init_LegrandVelho()
321 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
323 /** \brief Initializes the platform with the network model 'Constant'
324 * \ingroup SURF_models
325 * \param filename XML platform file name
327 * In this model, the communication time between two network cards is
328 * constant, hence no need for a routing table. This is particularly
329 * usefull when simulating huge distributed algorithms where
330 * scalability is really an issue. This function is called in
331 * conjunction with surf_workstation_model_init_compound.
333 * \see surf_workstation_model_init_compound()
335 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
337 /** \brief Initializes the platform with the network model CM02
338 * \ingroup SURF_models
339 * \param filename XML platform file name
341 * This function is called by surf_workstation_model_init_CLM03
342 * or by yourself only if you plan using surf_workstation_model_init_compound
344 * \see surf_workstation_model_init_CLM03()
346 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
349 /** \brief Initializes the platform with the network model GTNETS
350 * \ingroup SURF_models
351 * \param filename XML platform file name
353 * This function is called by surf_workstation_model_init_GTNETS
354 * or by yourself only if you plan using surf_workstation_model_init_compound
356 * \see surf_workstation_model_init_GTNETS()
358 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
361 /** \brief Initializes the platform with the network model Reno
362 * \ingroup SURF_models
363 * \param filename XML platform file name
365 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
368 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
369 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
371 * Call this function only if you plan using surf_workstation_model_init_compound.
374 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
376 /** \brief Initializes the platform with the network model Reno2
377 * \ingroup SURF_models
378 * \param filename XML platform file name
380 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
383 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
384 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
386 * Call this function only if you plan using surf_workstation_model_init_compound.
389 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
391 /** \brief Initializes the platform with the network model Vegas
392 * \ingroup SURF_models
393 * \param filename XML platform file name
395 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
396 * to the proportional fairness.
399 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
400 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
402 * Call this function only if you plan using surf_workstation_model_init_compound.
405 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
408 /** \brief Initializes the platform with the network model based on SDP
409 * \ingroup SURF_models
410 * \param filename XML platform file name
412 * This function implements the proportional fairness known as the maximization
417 * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
418 * Semi-definite programming approach for bandwidth allocation and routing in networks.
419 * Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
421 * Call this function only if you plan using surf_workstation_model_init_compound.
423 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
426 /** \brief The list of all available network model models
427 * \ingroup SURF_models
429 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
432 /** \brief The workstation model
433 * \ingroup SURF_models
435 * Note that when you create an API on top of SURF,
436 * the workstation model should be the only one you use
437 * because depending on the platform model, the network model and the CPU model
440 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
442 /** \brief Initializes the platform with a compound workstation model
443 * \ingroup SURF_models
444 * \param filename XML platform file name
446 * This function should be called after a cpu_model and a
447 * network_model have been set up.
450 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
452 /** \brief Initializes the platform with the workstation model CLM03
453 * \ingroup SURF_models
454 * \param filename XML platform file name
456 * This platform model seperates the workstation model and the network model.
457 * The workstation model will be initialized with the model CLM03, the network
458 * model with the model CM02 and the CPU model with the model Cas01.
459 * In future releases, some other network models will be implemented and will be
460 * combined with the workstation model CLM03.
462 * \see surf_workstation_model_init_KCCFLN05()
464 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
466 /** \brief Initializes the platform with the model KCCFLN05
467 * \ingroup SURF_models
468 * \param filename XML platform file name
470 * With this model, the workstations and the network are handled
471 * together. The network model is roughly the same as in CM02 but
472 * interference between computations and communications can be taken
473 * into account. This platform model is the default one for MSG and
477 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
479 /** \brief Initializes the platform with the model KCCFLN05
480 * \ingroup SURF_models
481 * \param filename XML platform file name
483 * With this model, only parallel tasks can be used. Resource sharing
484 * is done by identifying bottlenecks and giving an equal share of
485 * the model to each action.
488 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
490 /** \brief The list of all available workstation model models
491 * \ingroup SURF_models
493 XBT_PUBLIC_DATA(s_surf_model_description_t)
494 surf_workstation_model_description[];
496 /** \brief List of initialized models
497 * \ingroup SURF_models
499 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
501 /*******************************************/
502 /*** SURF Globals **************************/
503 /*******************************************/
504 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
506 /** \brief Initialize SURF
507 * \ingroup SURF_simulation
508 * \param argc argument number
509 * \param argv arguments
511 * This function has to be called to initialize the common
512 * structures. Then you will have to create the environment by
513 * calling surf_timer_model_init() and
514 * e.g. surf_workstation_model_init_CLM03() or
515 * surf_workstation_model_init_KCCFLN05().
517 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
518 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
520 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
522 /** \brief Initialize the used models.
524 * Must be called after the surf_init so that configuration infrastructure is created
525 * Must be called before parsing/creating the environment
526 * Must not be called within the initialization process so that the use get a chance to change the settings from
527 * its code between, say, MSG_init and MSG_create_environment using MSG_config
529 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
531 /** \brief create the elements of the models
533 * Must be called after parsing the platform file and before using any elements
535 XBT_PUBLIC(void) surf_config_models_create_elms(void);
537 /** \brief Finish simulation initialization
538 * \ingroup SURF_simulation
540 * This function must be called before the first call to surf_solve()
542 XBT_PUBLIC(void) surf_presolve(void);
544 /** \brief Performs a part of the simulation
545 * \ingroup SURF_simulation
546 * \return the elapsed time, or -1.0 if no event could be executed
548 * This function execute all possible events, update the action states
549 * and returns the time elapsed.
550 * When you call execute or communicate on a model, the corresponding actions
551 * are not executed immediately but only when you call surf_solve.
552 * Note that the returned elapsed time can be zero.
554 XBT_PUBLIC(double) surf_solve(void);
556 /** \brief Return the current time
557 * \ingroup SURF_simulation
559 * Return the current time in millisecond.
561 XBT_PUBLIC(double) surf_get_clock(void);
564 * \ingroup SURF_simulation
570 XBT_PUBLIC(void) surf_exit(void);
572 /* Prototypes of the functions that handle the properties */
573 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
574 XBT_PUBLIC_DATA(void) parse_properties(void);
576 /* surf parse file related (public because called from a test suite) */
577 XBT_PUBLIC(void) parse_platform_file(const char *file);
579 /* Stores the sets */
580 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
582 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
583 const char *route_name, int action,
585 XBT_PUBLIC_DATA(int) route_action;
587 /* This is used by all models when creating the routing table while parsing */
588 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
589 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
592 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
593 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
594 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
595 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
596 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
597 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
598 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
601 XBT_PUBLIC(double) get_cpu_power(const char *power);
605 #endif /* _SURF_SURF_H */