1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "xbt/dynar.h"
15 #include "xbt/config.h"
16 #include "surf/datatypes.h"
19 /* Actions and models are highly connected structures... */
21 SURF_RESOURCE_ON = 1, /**< Up & ready */
22 SURF_RESOURCE_OFF = 0 /**< Down & broken */
23 } e_surf_resource_state_t;
25 /** @Brief Specify that we use that action */
26 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
27 /** @brief Creates a new action.
29 * @param size The size is the one of the subtype you want to create
30 * @param cost initial value
31 * @param model to which model we should attach this action
32 * @param failed whether we should start this action in failed mode
34 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
35 surf_model_t model, int failed);
38 * FIXME : this should be done in the binding code !!
40 XBT_PUBLIC(void) network_create_resource(char *name,
41 double initial_bandwidth,double initial_latency);
44 /** \brief Resource model description
46 typedef struct surf_model_description {
48 const char *description;
50 void (*model_init_preparse) (const char *filename);
51 void (*model_init_postparse) (void);
52 } s_surf_model_description_t, *surf_model_description_t;
54 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
57 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
59 XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * table);
61 /** \brief Action structure
62 * \ingroup SURF_actions
64 * Never create s_surf_action_t by yourself ! The actions are created
65 * on the fly when you call execute or communicate on a model.
67 * \see e_surf_action_state_t
69 typedef struct surf_action {
70 s_xbt_swag_hookup_t state_hookup;
72 double cost; /**< cost */
73 double priority; /**< priority (1.0 by default) */
74 double max_duration; /**< max_duration (may fluctuate until
75 the task is completed) */
76 double remains; /**< How much of that cost remains to
77 * be done in the currently running task */
78 double start; /**< start time */
79 double finish; /**< finish time : this is modified during the run
80 * and fluctuates until the task is completed */
81 void *data; /**< for your convenience */
83 surf_model_t model_type;
86 typedef struct surf_action_lmm {
87 s_surf_action_t generic_action;
88 lmm_variable_t variable;
90 } s_surf_action_lmm_t, *surf_action_lmm_t;
92 /** \brief Action states
93 * \ingroup SURF_actions
97 * \see surf_action_t, surf_action_state_t
100 SURF_ACTION_READY = 0, /**< Ready */
101 SURF_ACTION_RUNNING, /**< Running */
102 SURF_ACTION_FAILED, /**< Task Failure */
103 SURF_ACTION_DONE, /**< Completed */
104 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
105 SURF_ACTION_NOT_IN_THE_SYSTEM
106 /**< Not in the system anymore. Why did you ask ? */
107 } e_surf_action_state_t;
109 /** \brief Action state sets
110 * \ingroup SURF_actions
112 * This structure contains some sets of actions.
113 * It provides a fast access to the actions in each state.
115 * \see surf_action_t, e_surf_action_state_t
117 typedef struct surf_action_state {
118 xbt_swag_t ready_action_set;
119 /**< Actions in state SURF_ACTION_READY */
120 xbt_swag_t running_action_set;
121 /**< Actions in state SURF_ACTION_RUNNING */
122 xbt_swag_t failed_action_set;
123 /**< Actions in state SURF_ACTION_FAILED */
124 xbt_swag_t done_action_set;
125 /**< Actions in state SURF_ACTION_DONE */
126 } s_surf_action_state_t, *surf_action_state_t;
128 /***************************/
129 /* Generic model object */
130 /***************************/
131 typedef struct s_routing s_routing_t, *routing_t;
132 XBT_PUBLIC_DATA(routing_t) used_routing;
134 /** \brief Private data available on all models
135 * \ingroup SURF_models
137 typedef struct surf_model_private *surf_model_private_t;
139 /** \brief Timer model extension public
140 * \ingroup SURF_model
142 * Additionnal functions specific to the timer model
144 typedef struct surf_timer_model_extension_public {
145 void (*set) (double date, void *function, void *arg);
146 int (*get) (void **function, void **arg);
147 } s_surf_model_extension_timer_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_resource_state_t(*get_state) (void *cpu);
160 double (*get_speed) (void *cpu, double load);
161 double (*get_available_speed) (void *cpu);
162 void (*create_resource)(char *name, double power_peak,
164 tmgr_trace_t power_trace,
165 e_surf_resource_state_t state_initial,
166 tmgr_trace_t state_trace,
167 xbt_dict_t cpu_properties);
168 } s_surf_model_extension_cpu_t;
172 /** \brief Network model extension public
173 * \ingroup SURF_models
175 * Public functions specific to the network model
177 typedef struct surf_network_model_extension_public {
178 surf_action_t(*communicate) (const char *src_name,
179 const char *dst_name, int src, int dst,
180 double size, double rate);
181 xbt_dynar_t(*get_route) (int src, int dst);
182 double (*get_link_bandwidth) (const void *link);
183 double (*get_link_latency) (const void *link);
184 int (*link_shared) (const void *link);
185 void (*create_resource) (char *name,double bw_initial,double lat_initial);
186 } s_surf_model_extension_network_t;
188 /** \brief Workstation model extension public
189 * \ingroup SURF_models
191 * Public functions specific to the workstation model.
193 typedef struct surf_workstation_model_extension_public {
194 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
195 and create the corresponding action */
196 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
197 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
198 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
199 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
200 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
201 void *workstation_dst, double size,
203 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
205 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
206 void **workstation_list,
207 double *computation_amount,
208 double *communication_amount,
209 double amount, double rate);
210 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
211 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
212 int (*link_shared) (const void *link);
213 xbt_dict_t(*get_properties) (const void *resource);
214 } s_surf_model_extension_workstation_t;
216 /** \brief Model datatype
217 * \ingroup SURF_models
219 * Generic data structure for a model. The workstations,
220 * the CPUs and the network links are examples of models.
222 typedef struct surf_model {
223 const char *name;/**< Name of this model */
224 s_surf_action_state_t states; /**< Any living action on this model */
226 e_surf_action_state_t(*action_state_get) (surf_action_t action);
227 /**< Return the state of an action */
228 void (*action_state_set) (surf_action_t action,
229 e_surf_action_state_t state);
230 /**< Change an action state*/
232 double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
233 double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
234 int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
235 void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
236 void (*action_recycle) (surf_action_t action);/**< Recycle an action */
237 void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
238 void (*suspend) (surf_action_t action);/**< Suspend an action */
239 void (*resume) (surf_action_t action);/**< Resume a suspended action */
240 int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
241 void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
242 void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
243 double (*get_remains) (surf_action_t action);/**< Get the remains of an action */
245 xbt_dict_t resource_set;
249 surf_model_private_t model_private;
254 s_surf_model_extension_timer_t timer;
255 s_surf_model_extension_cpu_t cpu;
256 s_surf_model_extension_network_t network;
257 s_surf_model_extension_workstation_t workstation;
261 surf_model_t surf_model_init(void);
262 void surf_model_exit(surf_model_t model);
264 void *surf_model_resource_by_name(surf_model_t model, const char *name);
265 #define surf_model_resource_set(model) (model)->resource_set
267 typedef struct surf_resource {
270 xbt_dict_t properties;
271 } s_surf_resource_t, *surf_resource_t;
276 * Resource which have a metric handled by a maxmin system
281 tmgr_trace_event_t event;
284 typedef struct surf_resource_lmm {
285 s_surf_resource_t generic_resource;
286 lmm_constraint_t constraint;
287 e_surf_resource_state_t state_current;
288 tmgr_trace_event_t state_event;
289 s_surf_metric_t power;
290 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
292 /**************************************/
293 /* Implementations of model object */
294 /**************************************/
297 /** \brief The timer model
298 * \ingroup SURF_models
300 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
302 /** \brief Initializes the timer model
303 * \ingroup SURF_models
305 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
307 /** \brief The CPU model
308 * \ingroup SURF_models
310 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
312 /** \brief Initializes the CPU model with the model Cas01
313 * \ingroup SURF_models
315 * This function is called by surf_workstation_model_init_CLM03
316 * so you shouldn't have to call it by yourself.
318 * \see surf_workstation_model_init_CLM03()
320 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
322 /** \brief Initializes the CPU model with trace integration
323 * \ingroup SURF_models
326 XBT_PUBLIC(void) surf_cpu_model_init_ti(const char *filename);
328 /** \brief Initializes the CPU model with the model Cas01 Improved. This model uses a heap to order the events, decreasing the time complexity to get the minimum next event.
329 * \ingroup SURF_models
331 * This function is called by surf_workstation_model_init_CLM03
332 * so you shouldn't have to call it by yourself.
334 * \see surf_workstation_model_init_CLM03()
336 XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(const char *filename);
338 /**brief Initialise the cpu_im model bypassing the parser
341 XBT_PUBLIC(void) surf_cpu_model_init_bypass_im(const char*id,double power);
343 /** \brief The list of all available cpu model models
344 * \ingroup SURF_models
346 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
348 XBT_PUBLIC(void) create_workstations(void);
350 /**\brief create new host bypass the parser
355 /** \brief The network model
356 * \ingroup SURF_models
358 * When creating a new API on top on SURF, you shouldn't use the
359 * network model unless you know what you are doing. Only the workstation
360 * model should be accessed because depending on the platform model,
361 * the network model can be NULL.
363 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
365 /** \brief Same as network model 'LagrangeVelho', only with different correction factors.
366 * \ingroup SURF_models
367 * \param filename XML platform file name
369 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
370 * based on the model 'LV08' and different correction factors depending on the communication
371 * size (< 1KiB, < 64KiB, >= 64KiB).
373 * \see surf_workstation_model_init_SMPI()
375 XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename);
377 /** \brief Initializes the platform with the network model 'LagrangeVelho'
378 * \ingroup SURF_models
379 * \param filename XML platform file name
381 * This model is proposed by Arnaud Legrand and Pedro Velho based on
382 * the results obtained with the GTNets simulator for onelink and
383 * dogbone sharing scenarios.
385 * \see surf_workstation_model_init_LegrandVelho()
387 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
389 /** \brief Initializes the platform with the network model 'Constant'
390 * \ingroup SURF_models
391 * \param filename XML platform file name
393 * In this model, the communication time between two network cards is
394 * constant, hence no need for a routing table. This is particularly
395 * usefull when simulating huge distributed algorithms where
396 * scalability is really an issue. This function is called in
397 * conjunction with surf_workstation_model_init_compound.
399 * \see surf_workstation_model_init_compound()
401 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
403 XBT_PUBLIC(void) surf_network_model_init_Vivaldi(const char *filename);
405 /** \brief Initializes the platform with the network model CM02
406 * \ingroup SURF_models
407 * \param filename XML platform file name
409 * This function is called by surf_workstation_model_init_CLM03
410 * or by yourself only if you plan using surf_workstation_model_init_compound
412 * \see surf_workstation_model_init_CLM03()
414 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
417 * brief initialize the the network model bypassing the XML parser
419 XBT_PUBLIC(void) surf_network_model_init_bypass(const char* id,double initial_bw,double initial_lat);
422 /** \brief Initializes the platform with the network model GTNETS
423 * \ingroup SURF_models
424 * \param filename XML platform file name
426 * This function is called by surf_workstation_model_init_GTNETS
427 * or by yourself only if you plan using surf_workstation_model_init_compound
429 * \see surf_workstation_model_init_GTNETS()
431 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
434 /** \brief Initializes the platform with the network model Reno
435 * \ingroup SURF_models
436 * \param filename XML platform file name
438 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
441 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
442 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
444 * Call this function only if you plan using surf_workstation_model_init_compound.
447 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
449 /** \brief Initializes the platform with the network model Reno2
450 * \ingroup SURF_models
451 * \param filename XML platform file name
453 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
456 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
457 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
459 * Call this function only if you plan using surf_workstation_model_init_compound.
462 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
464 /** \brief Initializes the platform with the network model Vegas
465 * \ingroup SURF_models
466 * \param filename XML platform file name
468 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
469 * to the proportional fairness.
472 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
473 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
475 * Call this function only if you plan using surf_workstation_model_init_compound.
478 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
480 /** \brief The list of all available network model models
481 * \ingroup SURF_models
483 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
486 /** \brief The workstation model
487 * \ingroup SURF_models
489 * Note that when you create an API on top of SURF,
490 * the workstation model should be the only one you use
491 * because depending on the platform model, the network model and the CPU model
494 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
496 /** \brief Initializes the platform with a compound workstation model
497 * \ingroup SURF_models
498 * \param filename XML platform file name
500 * This function should be called after a cpu_model and a
501 * network_model have been set up.
504 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
506 /** \brief Initializes the platform with the workstation model CLM03
507 * \ingroup SURF_models
508 * \param filename XML platform file name
510 * This platform model seperates the workstation model and the network model.
511 * The workstation model will be initialized with the model CLM03, the network
512 * model with the model CM02 and the CPU model with the model Cas01.
513 * In future releases, some other network models will be implemented and will be
514 * combined with the workstation model CLM03.
516 * \see surf_workstation_model_init_KCCFLN05()
518 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
520 /** \brief Initializes the platform with the model KCCFLN05
521 * \ingroup SURF_models
522 * \param filename XML platform file name
524 * With this model, the workstations and the network are handled
525 * together. The network model is roughly the same as in CM02 but
526 * interference between computations and communications can be taken
527 * into account. This platform model is the default one for MSG and
531 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
533 /** \brief Initializes the platform with the model KCCFLN05
534 * \ingroup SURF_models
535 * \param filename XML platform file name
537 * With this model, only parallel tasks can be used. Resource sharing
538 * is done by identifying bottlenecks and giving an equal share of
539 * the model to each action.
542 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
544 /** \brief The list of all available workstation model models
545 * \ingroup SURF_models
547 XBT_PUBLIC_DATA(s_surf_model_description_t)
548 surf_workstation_model_description[];
550 /** \brief List of initialized models
551 * \ingroup SURF_models
553 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
555 /*******************************************/
556 /*** SURF Globals **************************/
557 /*******************************************/
558 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
560 /** \brief Initialize SURF
561 * \ingroup SURF_simulation
562 * \param argc argument number
563 * \param argv arguments
565 * This function has to be called to initialize the common
566 * structures. Then you will have to create the environment by
567 * calling surf_timer_model_init() and
568 * e.g. surf_workstation_model_init_CLM03() or
569 * surf_workstation_model_init_KCCFLN05().
571 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
572 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
574 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
576 /** \brief Initialize the used models.
578 * Must be called after the surf_init so that configuration infrastructure is created
579 * Must be called before parsing/creating the environment
580 * Must not be called within the initialization process so that the use get a chance to change the settings from
581 * its code between, say, MSG_init and MSG_create_environment using MSG_config
583 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
585 /** \brief create the elements of the models
587 * Must be called after parsing the platform file and before using any elements
589 XBT_PUBLIC(void) surf_config_models_create_elms(void);
591 /** \brief Finish simulation initialization
592 * \ingroup SURF_simulation
594 * This function must be called before the first call to surf_solve()
596 XBT_PUBLIC(void) surf_presolve(void);
598 /** \brief Performs a part of the simulation
599 * \ingroup SURF_simulation
600 * \return the elapsed time, or -1.0 if no event could be executed
602 * This function execute all possible events, update the action states
603 * and returns the time elapsed.
604 * When you call execute or communicate on a model, the corresponding actions
605 * are not executed immediately but only when you call surf_solve.
606 * Note that the returned elapsed time can be zero.
608 XBT_PUBLIC(double) surf_solve(void);
610 /** \brief Return the current time
611 * \ingroup SURF_simulation
613 * Return the current time in millisecond.
615 XBT_PUBLIC(double) surf_get_clock(void);
618 * \ingroup SURF_simulation
624 XBT_PUBLIC(void) surf_exit(void);
626 /* Prototypes of the functions that handle the properties */
627 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
628 XBT_PUBLIC_DATA(void) parse_properties(void);
630 /* surf parse file related (public because called from a test suite) */
631 XBT_PUBLIC(void) parse_platform_file(const char *file);
633 /* Stores the sets */
634 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
636 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
637 const char *route_name, int action,
639 XBT_PUBLIC_DATA(int) route_action;
641 /* This is used by all models when creating the routing table while parsing */
642 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
643 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
646 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
647 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
648 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
649 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
650 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
651 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
652 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
655 XBT_PUBLIC(double) get_cpu_power(const char *power);
657 /*public interface to create resource bypassing the parser via cpu/network model
659 * see surfxml_parse.c
661 XBT_PUBLIC(void) surf_host_create_resource(char *name, double power_peak,
663 tmgr_trace_t power_trace,
664 e_surf_resource_state_t state_initial,
665 tmgr_trace_t state_trace,
666 xbt_dict_t cpu_properties);
669 * create link resource
671 * FIXME : shoudl have the same prototype as net_link_new
673 XBT_PUBLIC(void) surf_link_create_resouce(char *name,
674 double bw_initial,double lat_initial);
677 * add route element (link_ctn) bypassing the parser
679 * see surfxml_parse.c
682 XBT_PUBLIC(void) surf_add_route_element(char *link_ctn_id);
685 * set route src_id,dest_id, and create a route resource
689 XBT_PUBLIC(void) surf_route_set_resource(char* src_id,char *dest_id,xbt_dynar_t links_id,int action);
692 * add host to routing model ( xbt_dict )
695 XBT_PUBLIC(void) surf_route_add_host(char * host_id);
697 #include "surf/surf_resource.h"
698 #include "surf/surf_resource_lmm.h"
701 #endif /* _SURF_SURF_H */