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"
16 #include "xbt/config.h"
17 #include "surf/datatypes.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/platf_interface.h"
23 /* Actions and models are highly connected structures... */
25 /* user-visible parameters */
26 extern double sg_tcp_gamma;
27 extern double sg_sender_gap;
28 extern double sg_latency_factor;
29 extern double sg_bandwidth_factor;
30 extern double sg_weight_S_parameter;
31 extern int sg_network_crosstraffic;
33 extern double sg_gtnets_jitter;
34 extern int sg_gtnets_jitter_seed;
36 extern xbt_dynar_t surf_path;
40 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
41 SURF_NETWORK_ELEMENT_HOST, /* host type */
42 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
43 SURF_NETWORK_ELEMENT_AS /* AS type */
44 } e_surf_network_element_type_t;
46 XBT_PUBLIC(e_surf_network_element_type_t)
47 routing_get_network_element_type(const char* name);
49 /** @Brief Specify that we use that action */
50 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
52 /** @brief Creates a new action.
54 * @param size The size is the one of the subtype you want to create
55 * @param cost initial value
56 * @param model to which model we should attach this action
57 * @param failed whether we should start this action in failed mode
59 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
60 surf_model_t model, int failed);
62 /** \brief Resource model description
64 typedef struct surf_model_description {
66 const char *description;
67 void_f_void_t model_init_preparse;
68 } s_surf_model_description_t, *surf_model_description_t;
70 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
72 XBT_PUBLIC(void) model_help(const char *category,
73 s_surf_model_description_t * table);
75 enum heap_action_type{
82 /** \ingroup SURF_actions
83 * \brief Action structure
85 * Never create s_surf_action_t by yourself ! The actions are created
86 * on the fly when you call execute or communicate on a model.
88 * \see e_surf_action_state_t
90 typedef struct surf_action {
91 s_xbt_swag_hookup_t state_hookup;
93 double cost; /**< cost */
94 double priority; /**< priority (1.0 by default) */
95 double max_duration; /**< max_duration (may fluctuate until
96 the task is completed) */
97 double remains; /**< How much of that cost remains to
98 * be done in the currently running task */
99 #ifdef HAVE_LATENCY_BOUND_TRACKING
100 int latency_limited; /**< Set to 1 if is limited by latency, 0 otherwise */
103 double start; /**< start time */
104 double finish; /**< finish time : this is modified during the run
105 * and fluctuates until the task is completed */
106 void *data; /**< for your convenience */
108 surf_model_t model_type;
110 char *category; /**< tracing category for categorized resource utilization monitoring */
112 surf_file_t file; /**< surf_file_t for storage model */
116 typedef struct surf_action_lmm {
117 s_surf_action_t generic_action;
118 lmm_variable_t variable;
120 s_xbt_swag_hookup_t action_list_hookup;
124 enum heap_action_type hat;
125 } s_surf_action_lmm_t, *surf_action_lmm_t;
127 /** \ingroup SURF_actions
128 * \brief Action states
132 * \see surf_action_t, surf_action_state_t
135 SURF_ACTION_READY = 0, /**< Ready */
136 SURF_ACTION_RUNNING, /**< Running */
137 SURF_ACTION_FAILED, /**< Task Failure */
138 SURF_ACTION_DONE, /**< Completed */
139 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
140 SURF_ACTION_NOT_IN_THE_SYSTEM
141 /**< Not in the system anymore. Why did you ask ? */
142 } e_surf_action_state_t;
144 /** \ingroup SURF_actions
145 * \brief Action state sets
147 * This structure contains some sets of actions.
148 * It provides a fast access to the actions in each state.
150 * \see surf_action_t, e_surf_action_state_t
152 typedef struct surf_action_state {
153 xbt_swag_t ready_action_set;
154 /**< Actions in state SURF_ACTION_READY */
155 xbt_swag_t running_action_set;
156 /**< Actions in state SURF_ACTION_RUNNING */
157 xbt_swag_t failed_action_set;
158 /**< Actions in state SURF_ACTION_FAILED */
159 xbt_swag_t done_action_set;
160 /**< Actions in state SURF_ACTION_DONE */
161 } s_surf_action_state_t, *surf_action_state_t;
163 /***************************/
164 /* Generic model object */
165 /***************************/
166 typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
167 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
169 /*******************************************
170 * TUTORIAL: New model
171 * New model extension public
172 * Public functions specific to a New model.
174 typedef struct surf_new_model_extension_public {
175 surf_action_t(*fct) ();
176 void* (*create_resource) ();
177 } s_surf_model_extension_new_model_t;
178 /*******************************************/
180 /** \ingroup SURF_models
181 * \brief Private data available on all models
183 typedef struct surf_model_private *surf_model_private_t;
187 /** \ingroup SURF_models
188 * \brief CPU model extension public
190 * Public functions specific to the CPU model.
192 typedef struct surf_cpu_model_extension_public {
193 surf_action_t(*execute) (void *cpu, double size);
194 surf_action_t(*sleep) (void *cpu, double duration);
195 e_surf_resource_state_t(*get_state) (void *cpu);
196 int (*get_core) (void *cpu);
197 double (*get_speed) (void *cpu, double load);
198 double (*get_available_speed) (void *cpu);
199 double (*get_current_power_peak) (void *cpu);
200 double (*get_power_peak_at) (void *cpu, int pstate_index);
201 int (*get_nb_pstates) (void *cpu);
202 void (*set_power_peak_at) (void *cpu, int pstate_index);
203 double (*get_consumed_energy) (void *cpu);
204 void (*add_traces) (void);
205 } s_surf_model_extension_cpu_t;
209 /** \ingroup SURF_models
210 * \brief Network model extension public
212 * Public functions specific to the network model
214 typedef struct surf_network_model_extension_public {
215 surf_action_t (*communicate) (sg_routing_edge_t src,
216 sg_routing_edge_t dst,
217 double size, double rate);
218 xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
219 double (*get_link_bandwidth) (const void *link);
220 double (*get_link_latency) (const void *link);
221 int (*link_shared) (const void *link);
222 void (*add_traces) (void);
223 } s_surf_model_extension_network_t;
227 /** \ingroup SURF_models
228 * \brief Storage model extension public
230 * Public functions specific to the Storage model.
233 typedef struct surf_storage_model_extension_public {
234 surf_action_t(*open) (void *storage, const char* mount, const char* path);
235 surf_action_t(*close) (void *storage, surf_file_t fd);
236 surf_action_t(*read) (void *storage, size_t size, surf_file_t fd);
237 surf_action_t(*write) (void *storage, size_t size, surf_file_t fd);
238 surf_action_t(*stat) (void *storage, surf_file_t fd);
239 surf_action_t(*ls) (void *storage, const char *path);
240 xbt_dict_t(*get_properties) (const void *resource);
241 } s_surf_model_extension_storage_t;
243 /** \ingroup SURF_models
244 * \brief Workstation model extension public
246 * Public functions specific to the workstation model.
248 typedef struct surf_workstation_model_extension_public {
249 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
250 and create the corresponding action */
251 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
252 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
254 int (*get_core) (void *workstation);
255 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
256 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
258 double (*get_current_power_peak) (void *workstation); /**< Return the current CPU speed of a workstation */
259 double (*get_power_peak_at) (void *workstation, int pstate_index); /**< Return the speed of a workstation for a specific pstate,
260 (where higher pstate values represent lower processor speeds) */
261 int (*get_nb_pstates) (void *workstation); /**< Return the number of pstates defined for a workstation (default is 1) */
262 void (*set_power_peak_at) (void *workstation, int pstate_index); /**< Set the processor speed of a workstation to the speed associated with the pstate_index pstate */
263 double (*get_consumed_energy) (void *workstation); /**< Return the total energy consumed by a workstation */
265 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
266 void *workstation_dst, double size,
268 // FIXME: kill next field, which duplicates the routing
269 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
271 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
272 void **workstation_list,
273 double *computation_amount,
274 double *communication_amount,
276 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
277 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
278 surf_action_t(*open) (void *workstation, const char* storage,
280 surf_action_t(*close) (void *workstation, surf_file_t fd);
281 surf_action_t(*read) (void *workstation, size_t size, surf_file_t fd);
282 surf_action_t(*write) (void *workstation, size_t size, surf_file_t fd);
283 surf_action_t(*stat) (void *workstation, surf_file_t fd);
284 int(*unlink) (void *workstation, surf_file_t fd);
285 surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
286 size_t (*get_size) (void *workstation, surf_file_t fd);
287 xbt_dynar_t (*get_info) (void *workstation, surf_file_t fd);
289 int (*link_shared) (const void *link);
290 xbt_dict_t(*get_properties) (const void *resource);
291 void (*add_traces) (void);
293 size_t (*get_free_size) (void *workstation,const char* name);
294 size_t (*get_used_size) (void *workstation,const char* name);
295 xbt_dynar_t (*get_storage_list) (void *workstation);
297 } s_surf_model_extension_workstation_t;
302 /** \ingroup SURF_models
303 * \brief Model datatype
305 * Generic data structure for a model. The workstations,
306 * the CPUs and the network links are examples of models.
308 typedef struct surf_model {
309 const char *name; /**< Name of this model */
310 s_surf_action_state_t states; /**< Any living action on this model */
312 e_surf_action_state_t(*action_state_get) (surf_action_t action);
313 /**< Return the state of an action */
314 void (*action_state_set) (surf_action_t action,
315 e_surf_action_state_t state);
316 /**< Change an action state*/
318 double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
319 double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
320 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. */
321 void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
322 void (*action_recycle) (surf_action_t action); /**< Recycle an action */
323 void (*action_data_set) (surf_action_t action, void *data); /**< Set the user data of an action */
324 void (*suspend) (surf_action_t action); /**< Suspend an action */
325 void (*resume) (surf_action_t action); /**< Resume a suspended action */
326 int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
327 void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
328 void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
330 void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
332 double (*get_remains) (surf_action_t action); /**< Get the remains of an action */
333 #ifdef HAVE_LATENCY_BOUND_TRACKING
334 int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */
337 void (*gap_remove) (surf_action_lmm_t action);
339 surf_model_private_t model_private;
342 s_surf_model_extension_cpu_t cpu;
343 s_surf_model_extension_network_t network;
344 s_surf_model_extension_storage_t storage;
345 s_surf_model_extension_workstation_t workstation;
346 /*******************************************/
347 /* TUTORIAL: New model */
348 s_surf_model_extension_new_model_t new_model;
349 /*******************************************/
353 surf_model_t surf_model_init(void);
354 void surf_model_exit(surf_model_t model);
356 static inline void *surf_cpu_resource_priv(const void *host) {
357 return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
359 static inline void *surf_workstation_resource_priv(const void *host){
360 return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
362 static inline void *surf_storage_resource_priv(const void *host){
363 return xbt_lib_get_level((void *)host, SURF_STORAGE_LEVEL);
366 static inline void *surf_cpu_resource_by_name(const char *name) {
367 return xbt_lib_get_elm_or_null(host_lib, name);
369 static inline void *surf_workstation_resource_by_name(const char *name){
370 return xbt_lib_get_elm_or_null(host_lib, name);
372 static inline void *surf_storage_resource_by_name(const char *name){
373 return xbt_lib_get_elm_or_null(storage_lib, name);
376 typedef struct surf_resource {
379 xbt_dict_t properties;
380 void_f_pvoid_t free_f;
381 } s_surf_resource_t, *surf_resource_t;
384 * Resource which have a metric handled by a maxmin system
389 tmgr_trace_event_t event;
392 typedef struct surf_resource_lmm {
393 s_surf_resource_t generic_resource;
394 lmm_constraint_t constraint;
395 e_surf_resource_state_t state_current;
396 tmgr_trace_event_t state_event;
397 s_surf_metric_t power;
398 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
400 /**************************************/
401 /* Implementations of model object */
402 /**************************************/
405 /** \ingroup SURF_models
406 * \brief The CPU model
408 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
410 /** \ingroup SURF_models
411 * \brief Initializes the CPU model with the model Cas01
413 * By default, this model uses the lazy optimization mechanism that
414 * relies on partial invalidation in LMM and a heap for lazy action update.
415 * You can change this behavior by setting the cpu/optim configuration
416 * variable to a different value.
418 * You shouldn't have to call it by yourself.
420 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
422 /** \ingroup SURF_models
423 * \brief Initializes the CPU model with trace integration [Deprecated]
425 * You shouldn't have to call it by yourself.
427 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
429 /** \ingroup SURF_models
430 * \brief The list of all available optimization modes (both for cpu and networks).
431 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
433 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
435 /** \ingroup SURF_models
436 * \brief The list of all available cpu model models
438 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
440 /**\brief create new host bypass the parser
445 /** \ingroup SURF_models
446 * \brief The network model
448 * When creating a new API on top on SURF, you shouldn't use the
449 * network model unless you know what you are doing. Only the workstation
450 * model should be accessed because depending on the platform model,
451 * the network model can be NULL.
453 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
455 /** \ingroup SURF_models
456 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
458 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
459 * based on the model 'LV08' and different correction factors depending on the communication
460 * size (< 1KiB, < 64KiB, >= 64KiB).
461 * See comments in the code for more information.
463 * \see surf_workstation_model_init_SMPI()
465 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
467 /** \ingroup SURF_models
468 * \brief Initializes the platform with the network model 'LegrandVelho'
470 * This model is proposed by Arnaud Legrand and Pedro Velho based on
471 * the results obtained with the GTNets simulator for onelink and
472 * dogbone sharing scenarios. See comments in the code for more information.
474 * \see surf_workstation_model_init_LegrandVelho()
476 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
478 /** \ingroup SURF_models
479 * \brief Initializes the platform with the network model 'Constant'
481 * In this model, the communication time between two network cards is
482 * constant, hence no need for a routing table. This is particularly
483 * usefull when simulating huge distributed algorithms where
484 * scalability is really an issue. This function is called in
485 * conjunction with surf_workstation_model_init_compound.
487 * \see surf_workstation_model_init_compound()
489 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
491 /** \ingroup SURF_models
492 * \brief Initializes the platform with the network model CM02
494 * You sould call this function by yourself only if you plan using
495 * surf_workstation_model_init_compound.
496 * See comments in the code for more information.
498 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
501 /** \ingroup SURF_models
502 * \brief Initializes the platform with the network model GTNETS
503 * \param filename XML platform file name
505 * This function is called by surf_workstation_model_init_GTNETS
506 * or by yourself only if you plan using surf_workstation_model_init_compound
508 * \see surf_workstation_model_init_GTNETS()
510 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
514 /** \ingroup SURF_models
515 * \brief Initializes the platform with the network model NS3
516 * \param filename XML platform file name
518 * This function is called by surf_workstation_model_init_NS3
519 * or by yourself only if you plan using surf_workstation_model_init_compound
521 * \see surf_workstation_model_init_NS3()
523 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
526 /** \ingroup SURF_models
527 * \brief Initializes the platform with the network model Reno
528 * \param filename XML platform file name
530 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
533 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
534 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
536 * Call this function only if you plan using surf_workstation_model_init_compound.
539 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
541 /** \ingroup SURF_models
542 * \brief Initializes the platform with the network model Reno2
543 * \param filename XML platform file name
545 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
548 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
549 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
551 * Call this function only if you plan using surf_workstation_model_init_compound.
554 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
556 /** \ingroup SURF_models
557 * \brief Initializes the platform with the network model Vegas
558 * \param filename XML platform file name
560 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
561 * to the proportional fairness.
564 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
565 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
567 * Call this function only if you plan using surf_workstation_model_init_compound.
570 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
572 /** \ingroup SURF_models
573 * \brief The list of all available network model models
575 XBT_PUBLIC_DATA(s_surf_model_description_t)
576 surf_network_model_description[];
578 /** \ingroup SURF_models
579 * \brief The storage model
581 XBT_PUBLIC(void) surf_storage_model_init_default(void);
583 /** \ingroup SURF_models
584 * \brief The list of all available storage modes.
585 * This storage mode can be set using --cfg=storage/model:...
587 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
589 XBT_PUBLIC_DATA(surf_model_t) surf_storage_model;
591 /** \ingroup SURF_models
592 * \brief The workstation model
594 * Note that when you create an API on top of SURF,
595 * the workstation model should be the only one you use
596 * because depending on the platform model, the network model and the CPU model
599 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
601 /** \ingroup SURF_models
602 * \brief Initializes the platform with a compound workstation model
604 * This function should be called after a cpu_model and a
605 * network_model have been set up.
608 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
610 /** \ingroup SURF_models
611 * \brief Initializes the platform with the current best network and cpu models at hand
613 * This platform model seperates the workstation model and the network model.
614 * The workstation model will be initialized with the model compound, the network
615 * model with the model LV08 (with cross traffic support) and the CPU model with
617 * Such model is subject to modification with warning in the ChangeLog so monitor it!
620 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
622 /** \ingroup SURF_models
623 * \brief Initializes the platform with the model KCCFLN05
625 * With this model, only parallel tasks can be used. Resource sharing
626 * is done by identifying bottlenecks and giving an equal share of
627 * the model to each action.
630 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
632 /** \ingroup SURF_models
633 * \brief The list of all available workstation model models
635 XBT_PUBLIC_DATA(s_surf_model_description_t)
636 surf_workstation_model_description[];
638 /*******************************************
639 * TUTORIAL: New model
641 XBT_PUBLIC(void) surf_new_model_init_default(void);
642 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
643 /*******************************************/
645 /** \ingroup SURF_models
646 * \brief List of initialized models
648 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
650 /** \ingroup SURF_simulation
651 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
653 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
655 /** \ingroup SURF_simulation
656 * \brief List of hosts for which one want to be notified if they ever restart.
658 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
660 /*******************************************/
661 /*** SURF Platform *************************/
662 /*******************************************/
663 typedef struct s_as *AS_t;
665 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
666 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
667 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
668 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
669 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
671 /*******************************************/
672 /*** SURF Globals **************************/
673 /*******************************************/
675 /** \ingroup SURF_simulation
676 * \brief Initialize SURF
677 * \param argc argument number
678 * \param argv arguments
680 * This function has to be called to initialize the common
681 * structures. Then you will have to create the environment by
683 * e.g. surf_workstation_model_init_CM02()
685 * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
687 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
689 /** \ingroup SURF_simulation
690 * \brief Finish simulation initialization
692 * This function must be called before the first call to surf_solve()
694 XBT_PUBLIC(void) surf_presolve(void);
696 /** \ingroup SURF_simulation
697 * \brief Performs a part of the simulation
698 * \param max_date Maximum date to update the simulation to, or -1
699 * \return the elapsed time, or -1.0 if no event could be executed
701 * This function execute all possible events, update the action states
702 * and returns the time elapsed.
703 * When you call execute or communicate on a model, the corresponding actions
704 * are not executed immediately but only when you call surf_solve.
705 * Note that the returned elapsed time can be zero.
707 XBT_PUBLIC(double) surf_solve(double max_date);
709 /** \ingroup SURF_simulation
710 * \brief Return the current time
712 * Return the current time in millisecond.
714 XBT_PUBLIC(double) surf_get_clock(void);
716 /** \ingroup SURF_simulation
723 XBT_PUBLIC(void) surf_exit(void);
725 /* Prototypes of the functions that handle the properties */
726 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
728 /* surf parse file related (public because called from a test suite) */
729 XBT_PUBLIC(void) parse_platform_file(const char *file);
731 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
732 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
733 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
734 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
735 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
736 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
737 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
740 XBT_PUBLIC(double) get_cpu_power(const char *power);
742 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
744 int surf_get_nthreads(void);
745 void surf_set_nthreads(int nthreads);
748 * Returns the initial path. On Windows the initial path is
749 * the current directory for the current process in the other
750 * case the function returns "./" that represents the current
751 * directory on Unix/Linux platforms.
753 const char *__surf_get_initial_path(void);
755 /********** Tracing **********/
756 /* from surf_instr.c */
757 void TRACE_surf_action(surf_action_t surf_action, const char *category);
758 void TRACE_surf_alloc(void);
759 void TRACE_surf_release(void);
761 /* instr_routing.c */
762 void instr_routing_define_callbacks (void);
763 void instr_new_variable_type (const char *new_typename, const char *color);
764 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
765 void instr_new_user_state_type (const char *father_type, const char *new_typename);
766 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
767 int instr_platform_traced (void);
768 xbt_graph_t instr_routing_platform_graph (void);
769 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
772 #endif /* _SURF_SURF_H */