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"
17 #include "surf/datatypes.h"
20 /* Actions and models are highly connected structures... */
24 SURF_RESOURCE_ON = 1, /**< Up & ready */
25 SURF_RESOURCE_OFF = 0 /**< Down & broken */
26 } e_surf_resource_state_t;
28 /** @Brief Specify that we use that action */
29 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
30 /** @brief Creates a new action.
32 * @param size The size is the one of the subtype you want to create
33 * @param cost initial value
34 * @param model to which model we should attach this action
35 * @param failed whether we should start this action in failed mode
37 XBT_PUBLIC(void*) surf_action_new(size_t size,double cost,surf_model_t model, int failed);
41 /** \brief Resource model description
43 typedef struct surf_model_description {
46 void (*model_init_preparse) (const char *filename);
47 void (*model_init_postparse) (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;
82 s_surf_action_t generic_action;
83 lmm_variable_t variable;
85 } s_surf_action_lmm_t,*surf_action_lmm_t;
86 /** \brief Action states
87 * \ingroup SURF_actions
91 * \see surf_action_t, surf_action_state_t
94 SURF_ACTION_READY = 0, /**< Ready */
95 SURF_ACTION_RUNNING, /**< Running */
96 SURF_ACTION_FAILED, /**< Task Failure */
97 SURF_ACTION_DONE, /**< Completed */
98 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
99 SURF_ACTION_NOT_IN_THE_SYSTEM
100 /**< Not in the system anymore. Why did you ask ? */
101 } e_surf_action_state_t;
103 /** \brief Action state sets
104 * \ingroup SURF_actions
106 * This structure contains some sets of actions.
107 * It provides a fast access to the actions in each state.
109 * \see surf_action_t, e_surf_action_state_t
111 typedef struct surf_action_state {
112 xbt_swag_t ready_action_set;
113 /**< Actions in state SURF_ACTION_READY */
114 xbt_swag_t running_action_set;
115 /**< Actions in state SURF_ACTION_RUNNING */
116 xbt_swag_t failed_action_set;
117 /**< Actions in state SURF_ACTION_FAILED */
118 xbt_swag_t done_action_set;
119 /**< Actions in state SURF_ACTION_DONE */
120 } s_surf_action_state_t, *surf_action_state_t;
122 /***************************/
123 /* Generic model object */
124 /***************************/
125 typedef struct s_routing s_routing_t, *routing_t;
126 XBT_PUBLIC_DATA(routing_t) used_routing;
128 /** \brief Private data available on all models
129 * \ingroup SURF_models
131 typedef struct surf_model_private *surf_model_private_t;
133 /** \brief Timer model extension public
134 * \ingroup SURF_model
136 * Additionnal functions specific to the timer model
138 typedef struct surf_timer_model_extension_public {
139 void (*set) (double date, void *function, void *arg);
140 int (*get) (void **function, void **arg);
141 } s_surf_model_extension_timer_t;
145 /** \brief CPU model extension public
146 * \ingroup SURF_models
148 * Public functions specific to the CPU model.
150 typedef struct surf_cpu_model_extension_public {
151 surf_action_t(*execute) (void *cpu, double size);
152 surf_action_t(*sleep) (void *cpu, double duration);
153 e_surf_resource_state_t (*get_state) (void *cpu);
154 double (*get_speed) (void *cpu, double load);
155 double (*get_available_speed) (void *cpu);
156 } s_surf_model_extension_cpu_t;
160 /** \brief Network model extension public
161 * \ingroup SURF_models
163 * Public functions specific to the network model
165 typedef struct surf_network_model_extension_public {
166 surf_action_t(*communicate) (const char *src_name,const char *dst_name,int src, int dst, double size,
168 xbt_dynar_t (*get_route) (int src, int dst);
169 double (*get_link_bandwidth) (const void *link);
170 double (*get_link_latency) (const void *link);
171 int (*link_shared) (const void *link);
172 } s_surf_model_extension_network_t;
174 /** \brief Workstation model extension public
175 * \ingroup SURF_models
177 * Public functions specific to the workstation model.
179 typedef struct surf_workstation_model_extension_public {
180 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
181 and create the corresponding action */
182 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
183 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
184 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
185 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
186 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
187 void *workstation_dst, double size,
189 xbt_dynar_t(*get_route)(void *workstation_src,void *workstation_dst); /**< Get the list of links between two ws */
191 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
192 void **workstation_list,
193 double *computation_amount,
194 double *communication_amount,
195 double amount, double rate);
196 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
197 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
198 int (*link_shared) (const void *link);
199 xbt_dict_t (*get_properties)(const void*resource);
200 } s_surf_model_extension_workstation_t;
202 /** \brief Model datatype
203 * \ingroup SURF_models
205 * Generic data structure for a model. The workstations,
206 * the CPUs and the network links are examples of models.
208 typedef struct surf_model {
209 const char *name;/**< Name of this model */
210 s_surf_action_state_t states; /**< Any living action on this model */
212 e_surf_action_state_t(*action_state_get) (surf_action_t action);/**< Return the state of an action */
213 void (*action_state_set) (surf_action_t action,
214 e_surf_action_state_t state); /**< Change an action state*/
216 double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
217 double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
218 int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
219 void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
220 void (*action_recycle) (surf_action_t action);/**< Recycle an action */
221 void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
222 void (*suspend) (surf_action_t action);/**< Suspend an action */
223 void (*resume) (surf_action_t action);/**< Resume a suspended action */
224 int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
225 void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
226 void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
228 xbt_dict_t resource_set;
232 surf_model_private_t model_private;
237 s_surf_model_extension_timer_t timer;
238 s_surf_model_extension_cpu_t cpu;
239 s_surf_model_extension_network_t network;
240 s_surf_model_extension_workstation_t workstation;
244 surf_model_t surf_model_init(void);
245 void surf_model_exit(surf_model_t model);
247 void *surf_model_resource_by_name(surf_model_t model, const char *name);
248 #define surf_model_resource_set(model) (model)->resource_set
250 typedef struct surf_resource {
253 xbt_dict_t properties;
254 } s_surf_resource_t, *surf_resource_t;
256 XBT_PUBLIC(const char*) surf_resource_name(const void *resource);
257 XBT_PUBLIC(void) surf_resource_free(void* resource);
260 * Resource which have a metric handled by a maxmin system
262 typedef struct surf_resource_lmm {
263 s_surf_resource_t generic_resource;
264 lmm_constraint_t constraint;
265 e_surf_resource_state_t state_current;
266 tmgr_trace_event_t state_event;
267 double metric_current;
268 tmgr_trace_event_t metric_event;
269 }s_surf_resource_lmm_t, *surf_resource_lmm_t;
271 /**************************************/
272 /* Implementations of model object */
273 /**************************************/
276 /** \brief The timer model
277 * \ingroup SURF_models
279 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
281 /** \brief Initializes the timer model
282 * \ingroup SURF_models
284 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
286 /** \brief The CPU model
287 * \ingroup SURF_models
289 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
291 /** \brief Initializes the CPU model with the model Cas01
292 * \ingroup SURF_models
294 * This function is called by surf_workstation_model_init_CLM03
295 * so you shouldn't have to call it by yourself.
297 * \see surf_workstation_model_init_CLM03()
299 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
301 /** \brief The list of all available cpu model models
302 * \ingroup SURF_models
304 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
306 XBT_PUBLIC(void) create_workstations(void);
308 /** \brief The network model
309 * \ingroup SURF_models
311 * When creating a new API on top on SURF, you shouldn't use the
312 * network model unless you know what you are doing. Only the workstation
313 * model should be accessed because depending on the platform model,
314 * the network model can be NULL.
316 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
318 /** \brief Initializes the platform with the network model 'LagrangeVelho'
319 * \ingroup SURF_models
320 * \param filename XML platform file name
322 * This model is proposed by Arnaud Legrand and Pedro Velho based on
323 * the results obtained with the GTNets simulator for onelink and
324 * dogbone sharing scenarios.
326 * \see surf_workstation_model_init_LegrandVelho()
328 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
330 /** \brief Initializes the platform with the network model 'Constant'
331 * \ingroup SURF_models
332 * \param filename XML platform file name
334 * In this model, the communication time between two network cards is
335 * constant, hence no need for a routing table. This is particularly
336 * usefull when simulating huge distributed algorithms where
337 * scalability is really an issue. This function is called in
338 * conjunction with surf_workstation_model_init_compound.
340 * \see surf_workstation_model_init_compound()
342 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
344 /** \brief Initializes the platform with the network model CM02
345 * \ingroup SURF_models
346 * \param filename XML platform file name
348 * This function is called by surf_workstation_model_init_CLM03
349 * or by yourself only if you plan using surf_workstation_model_init_compound
351 * \see surf_workstation_model_init_CLM03()
353 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
356 /** \brief Initializes the platform with the network model GTNETS
357 * \ingroup SURF_models
358 * \param filename XML platform file name
360 * This function is called by surf_workstation_model_init_GTNETS
361 * or by yourself only if you plan using surf_workstation_model_init_compound
363 * \see surf_workstation_model_init_GTNETS()
365 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
368 /** \brief Initializes the platform with the network model Reno
369 * \ingroup SURF_models
370 * \param filename XML platform file name
372 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
375 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
376 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
378 * Call this function only if you plan using surf_workstation_model_init_compound.
381 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
383 /** \brief Initializes the platform with the network model Reno2
384 * \ingroup SURF_models
385 * \param filename XML platform file name
387 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
390 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
391 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
393 * Call this function only if you plan using surf_workstation_model_init_compound.
396 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
398 /** \brief Initializes the platform with the network model Vegas
399 * \ingroup SURF_models
400 * \param filename XML platform file name
402 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
403 * to the proportional fairness.
406 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
407 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
409 * Call this function only if you plan using surf_workstation_model_init_compound.
412 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
415 /** \brief Initializes the platform with the network model based on SDP
416 * \ingroup SURF_models
417 * \param filename XML platform file name
419 * This function implements the proportional fairness known as the maximization
424 * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
425 * Semi-definite programming approach for bandwidth allocation and routing in networks.
426 * Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
428 * Call this function only if you plan using surf_workstation_model_init_compound.
430 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
433 /** \brief The list of all available network model models
434 * \ingroup SURF_models
436 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
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_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)
501 surf_workstation_model_description[];
503 /** \brief List of initialized models
504 * \ingroup SURF_models
506 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
508 /*******************************************/
509 /*** SURF Globals **************************/
510 /*******************************************/
511 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
513 /** \brief Initialize SURF
514 * \ingroup SURF_simulation
515 * \param argc argument number
516 * \param argv arguments
518 * This function has to be called to initialize the common
519 * structures. Then you will have to create the environment by
520 * calling surf_timer_model_init() and
521 * e.g. surf_workstation_model_init_CLM03() or
522 * surf_workstation_model_init_KCCFLN05().
524 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
525 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
527 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
529 /** \brief Initialize the used models.
531 * Must be called after the surf_init so that configuration infrastructure is created
532 * Must be called before parsing/creating the environment
533 * Must not be called within the initialization process so that the use get a chance to change the settings from
534 * its code between, say, MSG_init and MSG_create_environment using MSG_config
536 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
538 /** \brief create the elements of the models
540 * Must be called after parsing the platform file and before using any elements
542 XBT_PUBLIC(void) surf_config_models_create_elms(void);
544 /** \brief Finish simulation initialization
545 * \ingroup SURF_simulation
547 * This function must be called before the first call to surf_solve()
549 XBT_PUBLIC(void) surf_presolve(void);
551 /** \brief Performs a part of the simulation
552 * \ingroup SURF_simulation
553 * \return the elapsed time, or -1.0 if no event could be executed
555 * This function execute all possible events, update the action states
556 * and returns the time elapsed.
557 * When you call execute or communicate on a model, the corresponding actions
558 * are not executed immediately but only when you call surf_solve.
559 * Note that the returned elapsed time can be zero.
561 XBT_PUBLIC(double) surf_solve(void);
563 /** \brief Return the current time
564 * \ingroup SURF_simulation
566 * Return the current time in millisecond.
568 XBT_PUBLIC(double) surf_get_clock(void);
571 * \ingroup SURF_simulation
577 XBT_PUBLIC(void) surf_exit(void);
579 /* Prototypes of the functions that handle the properties */
580 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
581 XBT_PUBLIC_DATA(void) parse_properties(void);
583 /* surf parse file related (public because called from a test suite) */
584 XBT_PUBLIC(void) parse_platform_file(const char *file);
586 /* Stores the sets */
587 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
589 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
590 const char *route_name, int action,
592 XBT_PUBLIC_DATA(int) route_action;
594 /* This is used by all models when creating the routing table while parsing */
595 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
596 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
599 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
600 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
601 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
602 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
603 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
604 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
605 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
608 XBT_PUBLIC(double) get_cpu_power(const char *power);
612 #endif /* _SURF_SURF_H */