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);
39 /** \brief Resource model description
41 typedef struct surf_model_description {
43 const char *description;
45 void (*model_init_preparse) (const char *filename);
46 void (*model_init_postparse) (void);
47 } s_surf_model_description_t, *surf_model_description_t;
49 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
52 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
54 XBT_PUBLIC(void) model_help(const char* category, 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 typedef struct surf_action_lmm {
82 s_surf_action_t generic_action;
83 lmm_variable_t variable;
85 } s_surf_action_lmm_t, *surf_action_lmm_t;
87 /** \brief Action states
88 * \ingroup SURF_actions
92 * \see surf_action_t, surf_action_state_t
95 SURF_ACTION_READY = 0, /**< Ready */
96 SURF_ACTION_RUNNING, /**< Running */
97 SURF_ACTION_FAILED, /**< Task Failure */
98 SURF_ACTION_DONE, /**< Completed */
99 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
100 SURF_ACTION_NOT_IN_THE_SYSTEM
101 /**< Not in the system anymore. Why did you ask ? */
102 } e_surf_action_state_t;
104 /** \brief Action state sets
105 * \ingroup SURF_actions
107 * This structure contains some sets of actions.
108 * It provides a fast access to the actions in each state.
110 * \see surf_action_t, e_surf_action_state_t
112 typedef struct surf_action_state {
113 xbt_swag_t ready_action_set;
114 /**< Actions in state SURF_ACTION_READY */
115 xbt_swag_t running_action_set;
116 /**< Actions in state SURF_ACTION_RUNNING */
117 xbt_swag_t failed_action_set;
118 /**< Actions in state SURF_ACTION_FAILED */
119 xbt_swag_t done_action_set;
120 /**< Actions in state SURF_ACTION_DONE */
121 } s_surf_action_state_t, *surf_action_state_t;
123 /***************************/
124 /* Generic model object */
125 /***************************/
126 typedef struct s_routing s_routing_t, *routing_t;
127 XBT_PUBLIC_DATA(routing_t) used_routing;
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;
146 /** \brief CPU model extension public
147 * \ingroup SURF_models
149 * Public functions specific to the CPU model.
151 typedef struct surf_cpu_model_extension_public {
152 surf_action_t(*execute) (void *cpu, double size);
153 surf_action_t(*sleep) (void *cpu, double duration);
154 e_surf_resource_state_t(*get_state) (void *cpu);
155 double (*get_speed) (void *cpu, double load);
156 double (*get_available_speed) (void *cpu);
157 void (*create_resource)(char *name, double power_peak,
159 tmgr_trace_t power_trace,
160 e_surf_resource_state_t state_initial,
161 tmgr_trace_t state_trace,
162 xbt_dict_t cpu_properties);
163 } s_surf_model_extension_cpu_t;
167 /** \brief Network model extension public
168 * \ingroup SURF_models
170 * Public functions specific to the network model
172 typedef struct surf_network_model_extension_public {
173 surf_action_t(*communicate) (const char *src_name,
174 const char *dst_name, int src, int dst,
175 double size, double rate);
176 xbt_dynar_t(*get_route) (int src, int dst);
177 double (*get_link_bandwidth) (const void *link);
178 double (*get_link_latency) (const void *link);
179 int (*link_shared) (const void *link);
180 void (*create_resource) (char *name,double bw_initial,double lat_initial);
181 } s_surf_model_extension_network_t;
183 /** \brief Workstation model extension public
184 * \ingroup SURF_models
186 * Public functions specific to the workstation model.
188 typedef struct surf_workstation_model_extension_public {
189 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
190 and create the corresponding action */
191 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
192 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
193 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
194 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
195 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
196 void *workstation_dst, double size,
198 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
200 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
201 void **workstation_list,
202 double *computation_amount,
203 double *communication_amount,
204 double amount, double rate);
205 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
206 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
207 int (*link_shared) (const void *link);
208 xbt_dict_t(*get_properties) (const void *resource);
209 } s_surf_model_extension_workstation_t;
211 /** \brief Model datatype
212 * \ingroup SURF_models
214 * Generic data structure for a model. The workstations,
215 * the CPUs and the network links are examples of models.
217 typedef struct surf_model {
218 const char *name;/**< Name of this model */
219 s_surf_action_state_t states; /**< Any living action on this model */
221 e_surf_action_state_t(*action_state_get) (surf_action_t action);
222 /**< Return the state of an action */
223 void (*action_state_set) (surf_action_t action,
224 e_surf_action_state_t state);
225 /**< Change an action state*/
227 double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
228 double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
229 int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
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_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
233 void (*suspend) (surf_action_t action);/**< Suspend an action */
234 void (*resume) (surf_action_t action);/**< Resume a suspended action */
235 int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
236 void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
237 void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
238 double (*get_remains) (surf_action_t action);/**< Get the remains of an action */
240 xbt_dict_t resource_set;
244 surf_model_private_t model_private;
249 s_surf_model_extension_timer_t timer;
250 s_surf_model_extension_cpu_t cpu;
251 s_surf_model_extension_network_t network;
252 s_surf_model_extension_workstation_t workstation;
256 surf_model_t surf_model_init(void);
257 void surf_model_exit(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
262 typedef struct surf_resource {
265 xbt_dict_t properties;
266 } s_surf_resource_t, *surf_resource_t;
271 * Resource which have a metric handled by a maxmin system
276 tmgr_trace_event_t event;
279 typedef struct surf_resource_lmm {
280 s_surf_resource_t generic_resource;
281 lmm_constraint_t constraint;
282 e_surf_resource_state_t state_current;
283 tmgr_trace_event_t state_event;
284 s_surf_metric_t power;
285 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
287 /**************************************/
288 /* Implementations of model object */
289 /**************************************/
292 /** \brief The timer model
293 * \ingroup SURF_models
295 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
297 /** \brief Initializes the timer model
298 * \ingroup SURF_models
300 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
302 /** \brief The CPU model
303 * \ingroup SURF_models
305 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
307 /** \brief Initializes the CPU model with the model Cas01
308 * \ingroup SURF_models
310 * This function is called by surf_workstation_model_init_CLM03
311 * so you shouldn't have to call it by yourself.
313 * \see surf_workstation_model_init_CLM03()
315 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
317 /** \brief Initializes the CPU model with trace integration
318 * \ingroup SURF_models
321 XBT_PUBLIC(void) surf_cpu_model_init_ti(const char *filename);
323 /** \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.
324 * \ingroup SURF_models
326 * This function is called by surf_workstation_model_init_CLM03
327 * so you shouldn't have to call it by yourself.
329 * \see surf_workstation_model_init_CLM03()
331 XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(const char *filename);
333 /**brief Initialise the cpu_im model bypassing the parser
336 XBT_PUBLIC(void) surf_cpu_model_init_bypass_im(const char*id,double power);
338 /** \brief The list of all available cpu model models
339 * \ingroup SURF_models
341 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
343 XBT_PUBLIC(void) create_workstations(void);
345 /**\brief create new host bypass the parser
350 /** \brief The network model
351 * \ingroup SURF_models
353 * When creating a new API on top on SURF, you shouldn't use the
354 * network model unless you know what you are doing. Only the workstation
355 * model should be accessed because depending on the platform model,
356 * the network model can be NULL.
358 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
360 /** \brief Same as network model 'LagrangeVelho', only with different correction factors.
361 * \ingroup SURF_models
362 * \param filename XML platform file name
364 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
365 * based on the model 'LV08' and different correction factors depending on the communication
366 * size (< 1KiB, < 64KiB, >= 64KiB).
368 * \see surf_workstation_model_init_SMPI()
370 XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename);
372 /** \brief Initializes the platform with the network model 'LagrangeVelho'
373 * \ingroup SURF_models
374 * \param filename XML platform file name
376 * This model is proposed by Arnaud Legrand and Pedro Velho based on
377 * the results obtained with the GTNets simulator for onelink and
378 * dogbone sharing scenarios.
380 * \see surf_workstation_model_init_LegrandVelho()
382 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
384 /** \brief Initializes the platform with the network model 'Constant'
385 * \ingroup SURF_models
386 * \param filename XML platform file name
388 * In this model, the communication time between two network cards is
389 * constant, hence no need for a routing table. This is particularly
390 * usefull when simulating huge distributed algorithms where
391 * scalability is really an issue. This function is called in
392 * conjunction with surf_workstation_model_init_compound.
394 * \see surf_workstation_model_init_compound()
396 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
398 XBT_PUBLIC(void) surf_network_model_init_Vivaldi(const char *filename);
400 /** \brief Initializes the platform with the network model CM02
401 * \ingroup SURF_models
402 * \param filename XML platform file name
404 * This function is called by surf_workstation_model_init_CLM03
405 * or by yourself only if you plan using surf_workstation_model_init_compound
407 * \see surf_workstation_model_init_CLM03()
409 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
412 * brief initialize the the network model bypassing the XML parser
414 XBT_PUBLIC(void) surf_network_model_init_bypass(const char* id,double initial_bw,double initial_lat);
417 /** \brief Initializes the platform with the network model GTNETS
418 * \ingroup SURF_models
419 * \param filename XML platform file name
421 * This function is called by surf_workstation_model_init_GTNETS
422 * or by yourself only if you plan using surf_workstation_model_init_compound
424 * \see surf_workstation_model_init_GTNETS()
426 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
429 /** \brief Initializes the platform with the network model Reno
430 * \ingroup SURF_models
431 * \param filename XML platform file name
433 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
436 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
437 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
439 * Call this function only if you plan using surf_workstation_model_init_compound.
442 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
444 /** \brief Initializes the platform with the network model Reno2
445 * \ingroup SURF_models
446 * \param filename XML platform file name
448 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
451 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
452 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
454 * Call this function only if you plan using surf_workstation_model_init_compound.
457 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
459 /** \brief Initializes the platform with the network model Vegas
460 * \ingroup SURF_models
461 * \param filename XML platform file name
463 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
464 * to the proportional fairness.
467 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
468 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
470 * Call this function only if you plan using surf_workstation_model_init_compound.
473 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
475 /** \brief The list of all available network model models
476 * \ingroup SURF_models
478 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
481 /** \brief The workstation model
482 * \ingroup SURF_models
484 * Note that when you create an API on top of SURF,
485 * the workstation model should be the only one you use
486 * because depending on the platform model, the network model and the CPU model
489 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
491 /** \brief Initializes the platform with a compound workstation model
492 * \ingroup SURF_models
493 * \param filename XML platform file name
495 * This function should be called after a cpu_model and a
496 * network_model have been set up.
499 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
501 /** \brief Initializes the platform with the workstation model CLM03
502 * \ingroup SURF_models
503 * \param filename XML platform file name
505 * This platform model seperates the workstation model and the network model.
506 * The workstation model will be initialized with the model CLM03, the network
507 * model with the model CM02 and the CPU model with the model Cas01.
508 * In future releases, some other network models will be implemented and will be
509 * combined with the workstation model CLM03.
511 * \see surf_workstation_model_init_KCCFLN05()
513 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
515 /** \brief Initializes the platform with the model KCCFLN05
516 * \ingroup SURF_models
517 * \param filename XML platform file name
519 * With this model, the workstations and the network are handled
520 * together. The network model is roughly the same as in CM02 but
521 * interference between computations and communications can be taken
522 * into account. This platform model is the default one for MSG and
526 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
528 /** \brief Initializes the platform with the model KCCFLN05
529 * \ingroup SURF_models
530 * \param filename XML platform file name
532 * With this model, only parallel tasks can be used. Resource sharing
533 * is done by identifying bottlenecks and giving an equal share of
534 * the model to each action.
537 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
539 /** \brief The list of all available workstation model models
540 * \ingroup SURF_models
542 XBT_PUBLIC_DATA(s_surf_model_description_t)
543 surf_workstation_model_description[];
545 /** \brief List of initialized models
546 * \ingroup SURF_models
548 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
550 /*******************************************/
551 /*** SURF Globals **************************/
552 /*******************************************/
553 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
555 /** \brief Initialize SURF
556 * \ingroup SURF_simulation
557 * \param argc argument number
558 * \param argv arguments
560 * This function has to be called to initialize the common
561 * structures. Then you will have to create the environment by
562 * calling surf_timer_model_init() and
563 * e.g. surf_workstation_model_init_CLM03() or
564 * surf_workstation_model_init_KCCFLN05().
566 * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
567 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
569 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
571 /** \brief Initialize the used models.
573 * Must be called after the surf_init so that configuration infrastructure is created
574 * Must be called before parsing/creating the environment
575 * Must not be called within the initialization process so that the use get a chance to change the settings from
576 * its code between, say, MSG_init and MSG_create_environment using MSG_config
578 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
580 /** \brief create the elements of the models
582 * Must be called after parsing the platform file and before using any elements
584 XBT_PUBLIC(void) surf_config_models_create_elms(void);
586 /** \brief Finish simulation initialization
587 * \ingroup SURF_simulation
589 * This function must be called before the first call to surf_solve()
591 XBT_PUBLIC(void) surf_presolve(void);
593 /** \brief Performs a part of the simulation
594 * \ingroup SURF_simulation
595 * \return the elapsed time, or -1.0 if no event could be executed
597 * This function execute all possible events, update the action states
598 * and returns the time elapsed.
599 * When you call execute or communicate on a model, the corresponding actions
600 * are not executed immediately but only when you call surf_solve.
601 * Note that the returned elapsed time can be zero.
603 XBT_PUBLIC(double) surf_solve(void);
605 /** \brief Return the current time
606 * \ingroup SURF_simulation
608 * Return the current time in millisecond.
610 XBT_PUBLIC(double) surf_get_clock(void);
613 * \ingroup SURF_simulation
619 XBT_PUBLIC(void) surf_exit(void);
621 /* Prototypes of the functions that handle the properties */
622 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
623 XBT_PUBLIC_DATA(void) parse_properties(void);
625 /* surf parse file related (public because called from a test suite) */
626 XBT_PUBLIC(void) parse_platform_file(const char *file);
628 /* Stores the sets */
629 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
631 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
632 const char *route_name, int action,
634 XBT_PUBLIC_DATA(int) route_action;
636 /* This is used by all models when creating the routing table while parsing */
637 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
638 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
641 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
642 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
643 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
644 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
645 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
646 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
647 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
650 XBT_PUBLIC(double) get_cpu_power(const char *power);
652 /*public interface to create resource bypassing the parser via cpu/network model
654 * see surfxml_parse.c
656 XBT_PUBLIC(void) surf_host_create_resource(char *name, double power_peak,
658 tmgr_trace_t power_trace,
659 e_surf_resource_state_t state_initial,
660 tmgr_trace_t state_trace,
661 xbt_dict_t cpu_properties);
664 * create link resource
666 * FIXME : shoudl have the same prototype as net_link_new
668 XBT_PUBLIC(void) surf_link_create_resouce(char *name,
669 double bw_initial,double lat_initial);
673 * add route element (link_ctn) bypassing the parser
675 * see surfxml_parse.c
678 XBT_PUBLIC(void) surf_add_route_element(char *link_ctn_id);
680 #include "surf/surf_resource.h"
681 #include "surf/surf_resource_lmm.h"
684 #endif /* _SURF_SURF_H */