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"
13 #include "xbt/graph.h"
15 #include "xbt/file_stat.h"
17 #include "xbt/config.h"
18 #include "surf/datatypes.h"
20 #include "surf/surf_routing.h"
21 #include "simgrid/platf_interface.h"
24 /* Actions and models are highly connected structures... */
26 /* user-visible parameters */
27 extern double sg_tcp_gamma;
28 extern double sg_sender_gap;
29 extern double sg_latency_factor;
30 extern double sg_bandwidth_factor;
31 extern double sg_weight_S_parameter;
32 extern int sg_maxmin_selective_update;
33 extern int sg_network_crosstraffic;
35 extern double sg_gtnets_jitter;
36 extern int sg_gtnets_jitter_seed;
38 extern xbt_dynar_t surf_path;
42 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
43 SURF_NETWORK_ELEMENT_HOST, /* host type */
44 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
45 SURF_NETWORK_ELEMENT_AS /* AS type */
46 } e_surf_network_element_type_t;
48 XBT_PUBLIC(e_surf_network_element_type_t)
49 routing_get_network_element_type(const char* name);
51 /** @Brief Specify that we use that action */
52 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
54 /** @brief Creates a new action.
56 * @param size The size is the one of the subtype you want to create
57 * @param cost initial value
58 * @param model to which model we should attach this action
59 * @param failed whether we should start this action in failed mode
61 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
62 surf_model_t model, int failed);
64 /** \brief Resource model description
66 typedef struct surf_model_description {
68 const char *description;
69 void_f_void_t model_init_preparse;
70 } s_surf_model_description_t, *surf_model_description_t;
72 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
74 XBT_PUBLIC(void) model_help(const char *category,
75 s_surf_model_description_t * table);
77 enum heap_action_type{
84 /** \ingroup SURF_actions
85 * \brief Action structure
87 * Never create s_surf_action_t by yourself ! The actions are created
88 * on the fly when you call execute or communicate on a model.
90 * \see e_surf_action_state_t
92 typedef struct surf_action {
93 s_xbt_swag_hookup_t state_hookup;
95 double cost; /**< cost */
96 double priority; /**< priority (1.0 by default) */
97 double max_duration; /**< max_duration (may fluctuate until
98 the task is completed) */
99 double remains; /**< How much of that cost remains to
100 * be done in the currently running task */
101 #ifdef HAVE_LATENCY_BOUND_TRACKING
102 int latency_limited; /**< Set to 1 if is limited by latency, 0 otherwise */
105 double start; /**< start time */
106 double finish; /**< finish time : this is modified during the run
107 * and fluctuates until the task is completed */
108 void *data; /**< for your convenience */
110 surf_model_t model_type;
112 char *category; /**< tracing category for categorized resource utilization monitoring */
114 surf_file_t file; /**< surf_file_t for storage model */
115 s_file_stat_t stat; /**< surf_file_t for storage model */
119 typedef struct surf_action_lmm {
120 s_surf_action_t generic_action;
121 lmm_variable_t variable;
123 s_xbt_swag_hookup_t action_list_hookup;
127 enum heap_action_type hat;
128 } s_surf_action_lmm_t, *surf_action_lmm_t;
130 /** \ingroup SURF_actions
131 * \brief Action states
135 * \see surf_action_t, surf_action_state_t
138 SURF_ACTION_READY = 0, /**< Ready */
139 SURF_ACTION_RUNNING, /**< Running */
140 SURF_ACTION_FAILED, /**< Task Failure */
141 SURF_ACTION_DONE, /**< Completed */
142 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
143 SURF_ACTION_NOT_IN_THE_SYSTEM
144 /**< Not in the system anymore. Why did you ask ? */
145 } e_surf_action_state_t;
147 /** \ingroup SURF_actions
148 * \brief Action state sets
150 * This structure contains some sets of actions.
151 * It provides a fast access to the actions in each state.
153 * \see surf_action_t, e_surf_action_state_t
155 typedef struct surf_action_state {
156 xbt_swag_t ready_action_set;
157 /**< Actions in state SURF_ACTION_READY */
158 xbt_swag_t running_action_set;
159 /**< Actions in state SURF_ACTION_RUNNING */
160 xbt_swag_t failed_action_set;
161 /**< Actions in state SURF_ACTION_FAILED */
162 xbt_swag_t done_action_set;
163 /**< Actions in state SURF_ACTION_DONE */
164 } s_surf_action_state_t, *surf_action_state_t;
166 /***************************/
167 /* Generic model object */
168 /***************************/
169 typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
170 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
172 /*******************************************
173 * TUTORIAL: New model
174 * New model extension public
175 * Public functions specific to a New model.
177 typedef struct surf_new_model_extension_public {
178 surf_action_t(*fct) ();
179 void* (*create_resource) ();
180 } s_surf_model_extension_new_model_t;
181 /*******************************************/
183 /** \ingroup SURF_models
184 * \brief Private data available on all models
186 typedef struct surf_model_private *surf_model_private_t;
190 /** \ingroup SURF_models
191 * \brief CPU model extension public
193 * Public functions specific to the CPU model.
195 typedef struct surf_cpu_model_extension_public {
196 surf_action_t(*execute) (void *cpu, double size);
197 surf_action_t(*sleep) (void *cpu, double duration);
198 e_surf_resource_state_t(*get_state) (void *cpu);
199 double (*get_speed) (void *cpu, double load);
200 double (*get_available_speed) (void *cpu);
201 void (*add_traces) (void);
202 } s_surf_model_extension_cpu_t;
206 /** \ingroup SURF_models
207 * \brief Network model extension public
209 * Public functions specific to the network model
211 typedef struct surf_network_model_extension_public {
212 surf_action_t (*communicate) (sg_routing_edge_t src,
213 sg_routing_edge_t dst,
214 double size, double rate);
215 xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
216 double (*get_link_bandwidth) (const void *link);
217 double (*get_link_latency) (const void *link);
218 int (*link_shared) (const void *link);
219 void (*add_traces) (void);
220 } s_surf_model_extension_network_t;
224 /** \ingroup SURF_models
225 * \brief Storage model extension public
227 * Public functions specific to the Storage model.
230 typedef struct surf_storage_model_extension_public {
231 surf_action_t(*open) (void *storage, const char* mount, const char* path, const char* mode);
232 surf_action_t(*close) (void *storage, surf_file_t fp);
233 surf_action_t(*read) (void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream);
234 surf_action_t(*write) (void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
235 surf_action_t(*stat) (void *storage, surf_file_t stream);
236 surf_action_t(*unlink) (void *storage, surf_file_t stream);
237 surf_action_t(*ls) (void *storage, const char *path);
238 } s_surf_model_extension_storage_t;
240 /** \ingroup SURF_models
241 * \brief Workstation model extension public
243 * Public functions specific to the workstation model.
245 typedef struct surf_workstation_model_extension_public {
248 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
249 and create the corresponding action */
250 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
251 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
252 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
253 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
254 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
255 void *workstation_dst, double size,
257 // FIXME: kill next field, which duplicates the routing
258 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
260 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
261 void **workstation_list,
262 double *computation_amount,
263 double *communication_amount,
265 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
266 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
267 surf_action_t(*open) (void *workstation, const char* storage, const char* path, const char* mode);
268 surf_action_t(*close) (void *workstation, surf_file_t fp);
269 surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
270 surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
271 surf_action_t(*stat) (void *workstation, surf_file_t stream);
272 surf_action_t(*unlink) (void *workstation, surf_file_t stream);
273 surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
275 int (*link_shared) (const void *link);
276 xbt_dict_t(*get_properties) (const void *resource);
277 void (*add_traces) (void);
279 } s_surf_model_extension_workstation_t;
281 typedef struct surf_vm_workstation_model_extension_public {
282 s_surf_model_extension_workstation_t basic;
283 void (*create) (const char *name, void *ind_phys_workstation); // First operation of the VM model
284 // start does not appear here as it corresponds to turn the state from created to running (see smx_vm.c)
285 int (*get_state) (void *ind_vm_workstation);
286 void (*set_state) (void *ind_vms_workstation, int state);
287 void (*migrate) (void *ind_vm_workstation, void *ind_dest_phys_workstation); // will be vm_ws_migrate()
288 const char * (*get_phys_host) (void *ind_vm_workstation); // will be vm_ws_get_phys_host()
289 void (*destroy) (void *ind_vm_workstation); // will be vm_ws_destroy(), which destroies the vm-workstation-specific data
290 } s_surf_model_extension_vm_workstation_t;
292 /** \ingroup SURF_models
293 * \brief Model datatype
295 * Generic data structure for a model. The workstations,
296 * the CPUs and the network links are examples of models.
298 typedef struct surf_model {
299 const char *name; /**< Name of this model */
300 s_surf_action_state_t states; /**< Any living action on this model */
302 e_surf_action_state_t(*action_state_get) (surf_action_t action);
303 /**< Return the state of an action */
304 void (*action_state_set) (surf_action_t action,
305 e_surf_action_state_t state);
306 /**< Change an action state*/
308 double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
309 double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
310 int (*action_unref) (surf_action_t action); /**< Specify that we don't use that action anymore. Returns true if the action was destroyed and false if someone still has references on it. */
311 void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
312 void (*action_recycle) (surf_action_t action); /**< Recycle an action */
313 void (*action_data_set) (surf_action_t action, void *data); /**< Set the user data of an action */
314 void (*suspend) (surf_action_t action); /**< Suspend an action */
315 void (*resume) (surf_action_t action); /**< Resume a suspended action */
316 int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
317 void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
318 void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
320 void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
322 double (*get_remains) (surf_action_t action); /**< Get the remains of an action */
323 #ifdef HAVE_LATENCY_BOUND_TRACKING
324 int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */
327 void (*gap_remove) (surf_action_lmm_t action);
329 surf_model_private_t model_private;
332 s_surf_model_extension_cpu_t cpu;
333 s_surf_model_extension_network_t network;
334 s_surf_model_extension_storage_t storage;
335 s_surf_model_extension_workstation_t workstation;
336 // TODO Implement the corresponding model
337 s_surf_model_extension_vm_workstation_t vm_workstation;
338 /*******************************************/
339 /* TUTORIAL: New model */
340 s_surf_model_extension_new_model_t new_model;
341 /*******************************************/
345 surf_model_t surf_model_init(void);
346 void surf_model_exit(surf_model_t model);
348 static inline void *surf_cpu_resource_priv(const void *host) {
349 return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
351 static inline void *surf_workstation_resource_priv(const void *host){
352 return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
354 static inline void *surf_storage_resource_priv(const void *host){
355 return xbt_lib_get_level((void *)host, SURF_STORAGE_LEVEL);
358 static inline void *surf_cpu_resource_by_name(const char *name) {
359 return xbt_lib_get_elm_or_null(host_lib, name);
361 static inline void *surf_workstation_resource_by_name(const char *name){
362 return xbt_lib_get_elm_or_null(host_lib, name);
364 static inline void *surf_storage_resource_by_name(const char *name){
365 return xbt_lib_get_elm_or_null(storage_lib, name);
368 typedef struct surf_resource {
371 xbt_dict_t properties;
372 } s_surf_resource_t, *surf_resource_t;
375 * Resource which have a metric handled by a maxmin system
380 tmgr_trace_event_t event;
383 typedef struct surf_resource_lmm {
384 s_surf_resource_t generic_resource;
385 lmm_constraint_t constraint;
386 e_surf_resource_state_t state_current;
387 tmgr_trace_event_t state_event;
388 s_surf_metric_t power;
389 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
391 /**************************************/
392 /* Implementations of model object */
393 /**************************************/
396 /** \ingroup SURF_models
397 * \brief The CPU model object for the physical machine layer
399 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_pm;
401 /** \ingroup SURF_models
402 * \brief The CPU model object for the virtual machine layer
404 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_vm;
406 /** \ingroup SURF_models
407 * \brief Initializes the CPU model with the model Cas01
409 * By default, this model uses the lazy optimization mechanism that
410 * relies on partial invalidation in LMM and a heap for lazy action update.
411 * You can change this behavior by setting the cpu/optim configuration
412 * variable to a different value.
414 * This function is called by surf_workstation_model_init_CLM03
415 * so you shouldn't have to call it by yourself.
417 * \see surf_workstation_model_init_CLM03()
419 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
421 /** \ingroup SURF_models
422 * \brief Initializes the CPU model with trace integration [Deprecated]
424 * You shouldn't have to call it by yourself.
425 * \see surf_workstation_model_init_CLM03()
427 XBT_PUBLIC(void) surf_cpu_model_init_ti(surf_model_t cpu_model);
429 /** \brief This function call the share resources function needed
432 XBT_PUBLIC(double) generic_share_resources(double now);
434 /** \brief This function call the update action state function needed
437 XBT_PUBLIC(void) generic_update_actions_state(double now, double delta);
439 /** \ingroup SURF_models
440 * \brief The list of all available optimization modes (both for cpu and networks).
441 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
443 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
445 /** \ingroup SURF_models
446 * \brief The list of all available cpu model models
448 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
450 XBT_PUBLIC(void) create_workstations(void);
452 /**\brief create new host bypass the parser
457 /** \ingroup SURF_models
458 * \brief The network model
460 * When creating a new API on top on SURF, you shouldn't use the
461 * network model unless you know what you are doing. Only the workstation
462 * model should be accessed because depending on the platform model,
463 * the network model can be NULL.
465 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
467 /** \ingroup SURF_models
468 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
470 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
471 * based on the model 'LV08' and different correction factors depending on the communication
472 * size (< 1KiB, < 64KiB, >= 64KiB).
473 * See comments in the code for more information.
475 * \see surf_workstation_model_init_SMPI()
477 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
479 /** \ingroup SURF_models
480 * \brief Initializes the platform with the network model 'LegrandVelho'
482 * This model is proposed by Arnaud Legrand and Pedro Velho based on
483 * the results obtained with the GTNets simulator for onelink and
484 * dogbone sharing scenarios. See comments in the code for more information.
486 * \see surf_workstation_model_init_LegrandVelho()
488 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
490 /** \ingroup SURF_models
491 * \brief Initializes the platform with the network model 'Constant'
493 * In this model, the communication time between two network cards is
494 * constant, hence no need for a routing table. This is particularly
495 * usefull when simulating huge distributed algorithms where
496 * scalability is really an issue. This function is called in
497 * conjunction with surf_workstation_model_init_compound.
499 * \see surf_workstation_model_init_compound()
501 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
503 /** \ingroup SURF_models
504 * \brief Initializes the platform with the network model CM02
506 * This function is called by surf_workstation_model_init_CLM03
507 * or by yourself only if you plan using surf_workstation_model_init_compound
508 * See comments in the code for more information.
510 * \see surf_workstation_model_init_CLM03()
512 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
515 * brief initialize the the network model bypassing the XML parser
517 XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
522 /** \ingroup SURF_models
523 * \brief Initializes the platform with the network model GTNETS
524 * \param filename XML platform file name
526 * This function is called by surf_workstation_model_init_GTNETS
527 * or by yourself only if you plan using surf_workstation_model_init_compound
529 * \see surf_workstation_model_init_GTNETS()
531 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
535 /** \ingroup SURF_models
536 * \brief Initializes the platform with the network model NS3
537 * \param filename XML platform file name
539 * This function is called by surf_workstation_model_init_NS3
540 * or by yourself only if you plan using surf_workstation_model_init_compound
542 * \see surf_workstation_model_init_NS3()
544 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
547 /** \ingroup SURF_models
548 * \brief Initializes the platform with the network model Reno
549 * \param filename XML platform file name
551 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
554 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
555 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
557 * Call this function only if you plan using surf_workstation_model_init_compound.
560 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
562 /** \ingroup SURF_models
563 * \brief Initializes the platform with the network model Reno2
564 * \param filename XML platform file name
566 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
569 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
570 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
572 * Call this function only if you plan using surf_workstation_model_init_compound.
575 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
577 /** \ingroup SURF_models
578 * \brief Initializes the platform with the network model Vegas
579 * \param filename XML platform file name
581 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
582 * to the proportional fairness.
585 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
586 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
588 * Call this function only if you plan using surf_workstation_model_init_compound.
591 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
593 /** \ingroup SURF_models
594 * \brief The list of all available network model models
596 XBT_PUBLIC_DATA(s_surf_model_description_t)
597 surf_network_model_description[];
599 /** \ingroup SURF_models
600 * \brief The storage model
602 XBT_PUBLIC(void) surf_storage_model_init_default(void);
604 /** \ingroup SURF_models
605 * \brief The list of all available storage modes.
606 * This storage mode can be set using --cfg=storage/model:...
608 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
610 /** \ingroup SURF_models
611 * \brief The workstation model
613 * Note that when you create an API on top of SURF,
614 * the workstation model should be the only one you use
615 * because depending on the platform model, the network model and the CPU model
618 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
620 /** \ingroup SURF_models
621 * \brief The vm_workstation model
623 * Note that when you create an API on top of SURF,
624 * the vm_workstation model should be the only one you use
625 * because depending on the platform model, the network model and the CPU model
628 XBT_PUBLIC_DATA(surf_model_t) surf_vm_workstation_model;
630 /** \ingroup SURF_models
631 * \brief Initializes the platform with a compound workstation model
633 * This function should be called after a cpu_model and a
634 * network_model have been set up.
637 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
639 /** \ingroup SURF_models
640 * \brief Initializes the platform with the current best network and cpu models at hand
642 * This platform model seperates the workstation model and the network model.
643 * The workstation model will be initialized with the model compound, the network
644 * model with the model LV08 (with cross traffic support) and the CPU model with
646 * Such model is subject to modification with warning in the ChangeLog so monitor it!
649 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
651 /** \ingroup SURF_models
652 * \brief Initializes the platform with the workstation model CLM03
654 * This platform model seperates the workstation model and the network model.
655 * The workstation model will be initialized with the model CLM03, the network
656 * model with the model CM02 and the CPU model with the model Cas01.
657 * In future releases, some other network models will be implemented and will be
658 * combined with the workstation model CLM03.
661 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
663 /** \ingroup SURF_models
664 * \brief Initializes the platform with the model KCCFLN05
666 * With this model, only parallel tasks can be used. Resource sharing
667 * is done by identifying bottlenecks and giving an equal share of
668 * the model to each action.
671 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
673 /** \ingroup SURF_models
674 * \brief The list of all available workstation model models
676 XBT_PUBLIC_DATA(s_surf_model_description_t)
677 surf_workstation_model_description[];
679 /*******************************************
680 * TUTORIAL: New model
682 XBT_PUBLIC(void) surf_new_model_init_default(void);
683 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
684 /*******************************************/
686 /** \ingroup SURF_models
687 * \brief List of initialized models
689 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
690 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
692 /*******************************************/
693 /*** SURF Globals **************************/
694 /*******************************************/
696 /** \ingroup SURF_simulation
697 * \brief Initialize SURF
698 * \param argc argument number
699 * \param argv arguments
701 * This function has to be called to initialize the common
702 * structures. Then you will have to create the environment by
704 * e.g. surf_workstation_model_init_CLM03()
706 * \see surf_workstation_model_init_CLM03(), surf_workstation_model_init_compound(), surf_exit()
708 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
710 /** \ingroup SURF_simulation
711 * \brief Finish simulation initialization
713 * This function must be called before the first call to surf_solve()
715 XBT_PUBLIC(void) surf_presolve(void);
717 /** \ingroup SURF_simulation
718 * \brief Performs a part of the simulation
719 * \param max_date Maximum date to update the simulation to, or -1
720 * \return the elapsed time, or -1.0 if no event could be executed
722 * This function execute all possible events, update the action states
723 * and returns the time elapsed.
724 * When you call execute or communicate on a model, the corresponding actions
725 * are not executed immediately but only when you call surf_solve.
726 * Note that the returned elapsed time can be zero.
728 XBT_PUBLIC(double) surf_solve(double max_date);
730 /** \ingroup SURF_simulation
731 * \brief Return the current time
733 * Return the current time in millisecond.
735 XBT_PUBLIC(double) surf_get_clock(void);
737 /** \ingroup SURF_simulation
744 XBT_PUBLIC(void) surf_exit(void);
746 /* Prototypes of the functions that handle the properties */
747 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
748 XBT_PUBLIC(void) parse_properties(void);
750 /* surf parse file related (public because called from a test suite) */
751 XBT_PUBLIC(void) parse_platform_file(const char *file);
753 /* Stores the sets */
754 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
756 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
757 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
758 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
759 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
760 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
761 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
762 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
765 XBT_PUBLIC(double) get_cpu_power(const char *power);
767 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
769 int surf_get_nthreads(void);
770 void surf_set_nthreads(int nthreads);
772 void surf_watched_hosts(void);
775 * Returns the initial path. On Windows the initial path is
776 * the current directory for the current process in the other
777 * case the function returns "./" that represents the current
778 * directory on Unix/Linux platforms.
780 const char *__surf_get_initial_path(void);
782 /********** Tracing **********/
783 /* from surf_instr.c */
784 void TRACE_surf_action(surf_action_t surf_action, const char *category);
785 void TRACE_surf_alloc(void);
786 void TRACE_surf_release(void);
788 /* instr_routing.c */
789 void instr_routing_define_callbacks (void);
790 void instr_new_variable_type (const char *new_typename, const char *color);
791 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
792 void instr_new_user_state_type (const char *father_type, const char *new_typename);
793 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
794 int instr_platform_traced (void);
795 xbt_graph_t instr_routing_platform_graph (void);
796 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
799 #endif /* _SURF_SURF_H */