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;
39 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
40 SURF_NETWORK_ELEMENT_HOST, /* host type */
41 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
42 SURF_NETWORK_ELEMENT_AS /* AS type */
43 } e_surf_network_element_type_t;
48 class WorkstationModel;
49 class NetworkCm02Model;
52 class WorkstationCLM03;
53 class NetworkCm02Link;
57 class StorageActionLmm;
62 typedef struct Model Model;
63 typedef struct CpuModel CpuModel;
64 typedef struct WorkstationModel WorkstationModel;
65 typedef struct NetworkCm02Model NetworkCm02Model;
66 typedef struct Resource Resource;
67 typedef struct ResourceLmm ResourceLmm;
68 typedef struct WorkstationCLM03 WorkstationCLM03;
69 typedef struct NetworkCm02Link NetworkCm02Link;
70 typedef struct Cpu Cpu;
71 typedef struct Action Action;
72 typedef struct ActionLmm ActionLmm;
73 typedef struct StorageActionLmm StorageActionLmm;
75 typedef struct RoutingEdge RoutingEdge;
76 typedef struct RoutingPlatf RoutingPlatf;
79 /** \ingroup SURF_models
80 * \brief Model datatype
82 * Generic data structure for a model. The workstations,
83 * the CPUs and the network links are examples of models.
85 typedef Model *surf_model_t;
86 typedef CpuModel *surf_cpu_model_t;
87 typedef WorkstationModel *surf_workstation_model_t;
88 typedef NetworkCm02Model *surf_network_model_t;
90 typedef Resource *surf_resource_t;
91 typedef ResourceLmm *surf_resource_lmm_t;
92 typedef WorkstationCLM03 *surf_workstation_CLM03_t;
93 typedef xbt_dictelm_t surf_workstation_t;
94 typedef NetworkCm02Link *surf_network_link_t;
95 typedef Cpu *surf_cpu_t;
97 /** \ingroup SURF_actions
98 * \brief Action structure
100 * Never create s_surf_action_t by yourself ! The actions are created
101 * on the fly when you call execute or communicate on a model.
103 * \see e_surf_action_state_t
105 typedef Action *surf_action_t;
106 typedef ActionLmm *surf_action_lmm_t;
107 typedef StorageActionLmm *surf_storage_action_lmm_t;
110 typedef RoutingEdge *routing_edge_t;
111 typedef RoutingPlatf *routing_platf_t;
113 typedef struct surf_file *surf_file_t;
115 XBT_PUBLIC(e_surf_network_element_type_t)
116 routing_get_network_element_type(const char* name);
118 /** @Brief Specify that we use that action */
119 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
121 /** @brief Creates a new action.
123 * @param size The size is the one of the subtype you want to create
124 * @param cost initial value
125 * @param model to which model we should attach this action
126 * @param failed whether we should start this action in failed mode
128 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
129 surf_model_t model, int failed);
131 /** \brief Resource model description
133 typedef struct surf_model_description {
135 const char *description;
136 void_f_void_t model_init_preparse;
137 } s_surf_model_description_t, *surf_model_description_t;
139 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
141 XBT_PUBLIC(void) model_help(const char *category,
142 s_surf_model_description_t * table);
146 /** \ingroup SURF_actions
147 * \brief Action states
151 * \see surf_action_t, surf_action_state_t
155 SURF_ACTION_READY = 0, /**< Ready */
156 SURF_ACTION_RUNNING, /**< Running */
157 SURF_ACTION_FAILED, /**< Task Failure */
158 SURF_ACTION_DONE, /**< Completed */
159 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
160 SURF_ACTION_NOT_IN_THE_SYSTEM
161 /**< Not in the system anymore. Why did you ask ? */
162 } e_surf_action_state_t;
164 /***************************/
165 /* Generic model object */
166 /***************************/
167 //FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
168 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
170 /*******************************************
171 * TUTORIAL: New model
172 * New model extension public
173 * Public functions specific to a New model.
175 typedef struct surf_new_model_extension_public {
176 surf_action_t(*fct) ();
177 void* (*create_resource) ();
178 } s_surf_model_extension_new_model_t;
179 /*******************************************/
181 /** \ingroup SURF_models
182 * \brief Private data available on all models
184 typedef struct surf_model_private *surf_model_private_t;
188 /** \ingroup SURF_models
189 * \brief CPU model extension public
191 * Public functions specific to the CPU model.
193 typedef struct surf_cpu_model_extension_public {
194 surf_action_t(*execute) (void *cpu, double size);
195 surf_action_t(*sleep) (void *cpu, double duration);
196 e_surf_resource_state_t(*get_state) (void *cpu);
197 int (*get_core) (void *cpu);
198 double (*get_speed) (void *cpu, double load);
199 double (*get_available_speed) (void *cpu);
200 void (*add_traces) (void);
201 } s_surf_model_extension_cpu_t;
205 /** \ingroup SURF_models
206 * \brief Network model extension public
208 * Public functions specific to the network model
210 typedef struct surf_network_model_extension_public {
211 surf_action_t (*communicate) (sg_routing_edge_t src,
212 sg_routing_edge_t dst,
213 double size, double rate);
214 xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
215 double (*get_link_bandwidth) (const void *link);
216 double (*get_link_latency) (const void *link);
217 int (*link_shared) (const void *link);
218 void (*add_traces) (void);
219 } s_surf_model_extension_network_t;
223 /** \ingroup SURF_models
224 * \brief Storage model extension public
226 * Public functions specific to the Storage model.
229 typedef struct surf_storage_model_extension_public {
230 surf_action_t(*open) (void *storage, const char* mount, const char* path);
231 surf_action_t(*close) (void *storage, surf_file_t fd);
232 surf_action_t(*read) (void *storage, void* ptr, size_t size,
234 surf_action_t(*write) (void *storage, const void* ptr, size_t size,
236 surf_action_t(*stat) (void *storage, surf_file_t fd);
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 {
246 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
247 and create the corresponding action */
248 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
249 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
250 int (*get_core) (void *workstation);
251 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
252 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
253 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
254 void *workstation_dst, double size,
256 // FIXME: kill next field, which duplicates the routing
257 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
259 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
260 void **workstation_list,
261 double *computation_amount,
262 double *communication_amount,
264 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
265 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
266 surf_action_t(*open) (void *workstation, const char* storage,
268 surf_action_t(*close) (void *workstation, surf_file_t fd);
269 surf_action_t(*read) (void *workstation, void* ptr, size_t size,
271 surf_action_t(*write) (void *workstation, const void* ptr, size_t size,
273 surf_action_t(*stat) (void *workstation, surf_file_t fd);
274 int(*unlink) (void *workstation, surf_file_t fd);
275 surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
276 size_t (*get_size) (void *workstation, surf_file_t fd);
278 int (*link_shared) (const void *link);
279 xbt_dict_t(*get_properties) (const void *resource);
280 void (*add_traces) (void);
282 } s_surf_model_extension_workstation_t;
285 static inline void *surf_cpu_resource_priv(const void *host) {
286 return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
288 static inline void *surf_workstation_resource_priv(const void *host){
289 return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
291 static inline void *surf_storage_resource_priv(const void *host){
292 return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_STORAGE_LEVEL);
295 static inline void *surf_cpu_resource_by_name(const char *name) {
296 return xbt_lib_get_elm_or_null(host_lib, name);
298 static inline void *surf_workstation_resource_by_name(const char *name){
299 return xbt_lib_get_elm_or_null(host_lib, name);
301 static inline void *surf_storage_resource_by_name(const char *name){
302 return xbt_lib_get_elm_or_null(storage_lib, name);
308 char *surf_routing_edge_name(sg_routing_edge_t edge);
310 const char *surf_model_name(surf_model_t model);
311 xbt_swag_t surf_model_done_action_set(surf_model_t model);
312 xbt_swag_t surf_model_failed_action_set(surf_model_t model);
313 xbt_swag_t surf_model_ready_action_set(surf_model_t model);
314 xbt_swag_t surf_model_running_action_set(surf_model_t model);
315 surf_action_t surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
317 void **workstation_list,
318 double *computation_amount,
319 double *communication_amount,
321 surf_action_t surf_workstation_model_communicate(surf_workstation_model_t model, surf_workstation_t src, surf_workstation_t dst, double size, double rate);
322 xbt_dynar_t surf_workstation_model_get_route(surf_workstation_model_t model, surf_workstation_t src, surf_workstation_t dst);
323 surf_action_t surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate);
324 const char *surf_resource_name(surf_resource_t resource);
325 xbt_dict_t surf_resource_get_properties(surf_resource_t resource);
326 e_surf_resource_state_t surf_resource_get_state(surf_resource_t resource);
327 double surf_workstation_get_speed(surf_workstation_t resource, double load);
328 double surf_workstation_get_available_speed(surf_workstation_t resource);
329 int surf_workstation_get_core(surf_workstation_t resource);
330 surf_action_t surf_workstation_execute(surf_workstation_t resource, double size);
331 surf_action_t surf_workstation_sleep(surf_workstation_t resource, double duration);
332 surf_action_t surf_workstation_open(surf_workstation_t workstation, const char* mount, const char* path);
333 surf_action_t surf_workstation_close(surf_workstation_t workstation, surf_file_t fd);
334 const char *surf_cpu_name(surf_cpu_t resource);
335 surf_action_t surf_cpu_execute(surf_cpu_t cpu, double size);
336 surf_action_t surf_cpu_sleep(surf_cpu_t cpu, double duration);
337 int surf_workstation_unlink(surf_workstation_t workstation, surf_file_t fd);
338 surf_action_t surf_workstation_ls(surf_workstation_t workstation, const char* mount, const char *path);
339 size_t surf_workstation_get_size(surf_workstation_t workstation, surf_file_t fd);
340 surf_action_t surf_workstation_read(surf_workstation_t resource, void *ptr, size_t size, surf_file_t fd);
341 surf_action_t surf_workstation_write(surf_workstation_t resource, const void *ptr, size_t size, surf_file_t fd);
342 int surf_network_link_is_shared(surf_network_link_t link);
343 double surf_network_link_get_bandwidth(surf_network_link_t link);
344 double surf_network_link_get_latency(surf_network_link_t link);
345 void *surf_action_get_data(surf_action_t action);
346 void surf_action_set_data(surf_action_t action, void *data);
347 void surf_action_unref(surf_action_t action);
348 double surf_action_get_start_time(surf_action_t action);
349 double surf_action_get_finish_time(surf_action_t action);
350 double surf_action_get_remains(surf_action_t action);
351 void surf_action_suspend(surf_action_t action);
352 void surf_action_resume(surf_action_t action);
353 void surf_action_cancel(surf_action_t action);
354 void surf_action_set_priority(surf_action_t action, double priority);
355 void surf_action_set_category(surf_action_t action, const char *category);
356 e_surf_action_state_t surf_action_get_state(surf_action_t action);
357 int surf_action_get_cost(surf_action_t action);
358 surf_file_t surf_storage_action_get_file(surf_storage_action_lmm_t action);
359 xbt_dict_t surf_storage_action_get_ls_dict(surf_storage_action_lmm_t action);
365 /**************************************/
366 /* Implementations of model object */
367 /**************************************/
370 /** \ingroup SURF_models
371 * \brief The CPU model
373 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
375 /** \ingroup SURF_models
376 * \brief Initializes the CPU model with the model Cas01
378 * By default, this model uses the lazy optimization mechanism that
379 * relies on partial invalidation in LMM and a heap for lazy action update.
380 * You can change this behavior by setting the cpu/optim configuration
381 * variable to a different value.
383 * You shouldn't have to call it by yourself.
385 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
387 /** \ingroup SURF_models
388 * \brief Initializes the CPU model with trace integration [Deprecated]
390 * You shouldn't have to call it by yourself.
392 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
394 /** \ingroup SURF_models
395 * \brief The list of all available optimization modes (both for cpu and networks).
396 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
398 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
400 /** \ingroup SURF_models
401 * \brief The list of all available cpu model models
403 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
405 /**\brief create new host bypass the parser
410 /** \ingroup SURF_models
411 * \brief The network model
413 * When creating a new API on top on SURF, you shouldn't use the
414 * network model unless you know what you are doing. Only the workstation
415 * model should be accessed because depending on the platform model,
416 * the network model can be NULL.
418 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
420 /** \ingroup SURF_models
421 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
423 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
424 * based on the model 'LV08' and different correction factors depending on the communication
425 * size (< 1KiB, < 64KiB, >= 64KiB).
426 * See comments in the code for more information.
428 * \see surf_workstation_model_init_SMPI()
430 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
432 /** \ingroup SURF_models
433 * \brief Initializes the platform with the network model 'LegrandVelho'
435 * This model is proposed by Arnaud Legrand and Pedro Velho based on
436 * the results obtained with the GTNets simulator for onelink and
437 * dogbone sharing scenarios. See comments in the code for more information.
439 * \see surf_workstation_model_init_LegrandVelho()
441 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
443 /** \ingroup SURF_models
444 * \brief Initializes the platform with the network model 'Constant'
446 * In this model, the communication time between two network cards is
447 * constant, hence no need for a routing table. This is particularly
448 * usefull when simulating huge distributed algorithms where
449 * scalability is really an issue. This function is called in
450 * conjunction with surf_workstation_model_init_compound.
452 * \see surf_workstation_model_init_compound()
454 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
456 /** \ingroup SURF_models
457 * \brief Initializes the platform with the network model CM02
459 * You sould call this function by yourself only if you plan using
460 * surf_workstation_model_init_compound.
461 * See comments in the code for more information.
463 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
466 /** \ingroup SURF_models
467 * \brief Initializes the platform with the network model GTNETS
468 * \param filename XML platform file name
470 * This function is called by surf_workstation_model_init_GTNETS
471 * or by yourself only if you plan using surf_workstation_model_init_compound
473 * \see surf_workstation_model_init_GTNETS()
475 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
479 /** \ingroup SURF_models
480 * \brief Initializes the platform with the network model NS3
481 * \param filename XML platform file name
483 * This function is called by surf_workstation_model_init_NS3
484 * or by yourself only if you plan using surf_workstation_model_init_compound
486 * \see surf_workstation_model_init_NS3()
488 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
491 /** \ingroup SURF_models
492 * \brief Initializes the platform with the network model Reno
493 * \param filename XML platform file name
495 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
498 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
499 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
501 * Call this function only if you plan using surf_workstation_model_init_compound.
504 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
506 /** \ingroup SURF_models
507 * \brief Initializes the platform with the network model Reno2
508 * \param filename XML platform file name
510 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
513 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
514 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
516 * Call this function only if you plan using surf_workstation_model_init_compound.
519 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
521 /** \ingroup SURF_models
522 * \brief Initializes the platform with the network model Vegas
523 * \param filename XML platform file name
525 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
526 * to the proportional fairness.
529 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
530 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
532 * Call this function only if you plan using surf_workstation_model_init_compound.
535 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
537 /** \ingroup SURF_models
538 * \brief The list of all available network model models
540 XBT_PUBLIC_DATA(s_surf_model_description_t)
541 surf_network_model_description[];
543 /** \ingroup SURF_models
544 * \brief The storage model
546 XBT_PUBLIC(void) surf_storage_model_init_default(void);
548 /** \ingroup SURF_models
549 * \brief The list of all available storage modes.
550 * This storage mode can be set using --cfg=storage/model:...
552 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
554 /** \ingroup SURF_models
555 * \brief The workstation model
557 * Note that when you create an API on top of SURF,
558 * the workstation model should be the only one you use
559 * because depending on the platform model, the network model and the CPU model
562 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
564 /** \ingroup SURF_models
565 * \brief Initializes the platform with a compound workstation model
567 * This function should be called after a cpu_model and a
568 * network_model have been set up.
571 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
573 /** \ingroup SURF_models
574 * \brief Initializes the platform with the current best network and cpu models at hand
576 * This platform model seperates the workstation model and the network model.
577 * The workstation model will be initialized with the model compound, the network
578 * model with the model LV08 (with cross traffic support) and the CPU model with
580 * Such model is subject to modification with warning in the ChangeLog so monitor it!
583 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
585 /** \ingroup SURF_models
586 * \brief Initializes the platform with the model KCCFLN05
588 * With this model, only parallel tasks can be used. Resource sharing
589 * is done by identifying bottlenecks and giving an equal share of
590 * the model to each action.
593 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
595 /** \ingroup SURF_models
596 * \brief The list of all available workstation model models
598 XBT_PUBLIC_DATA(s_surf_model_description_t)
599 surf_workstation_model_description[];
601 /*******************************************
602 * TUTORIAL: New model
604 XBT_PUBLIC(void) surf_new_model_init_default(void);
606 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
608 /*******************************************/
610 /** \ingroup SURF_models
611 * \brief List of initialized models
613 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
615 /*******************************************/
616 /*** SURF Platform *************************/
617 /*******************************************/
621 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
622 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
623 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
624 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
625 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
626 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
627 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
628 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
633 /*******************************************/
634 /*** SURF Globals **************************/
635 /*******************************************/
637 /** \ingroup SURF_simulation
638 * \brief Initialize SURF
639 * \param argc argument number
640 * \param argv arguments
642 * This function has to be called to initialize the common
643 * structures. Then you will have to create the environment by
645 * e.g. surf_workstation_model_init_CM02()
647 * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
649 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
651 /** \ingroup SURF_simulation
652 * \brief Finish simulation initialization
654 * This function must be called before the first call to surf_solve()
656 XBT_PUBLIC(void) surf_presolve(void);
658 /** \ingroup SURF_simulation
659 * \brief Performs a part of the simulation
660 * \param max_date Maximum date to update the simulation to, or -1
661 * \return the elapsed time, or -1.0 if no event could be executed
663 * This function execute all possible events, update the action states
664 * and returns the time elapsed.
665 * When you call execute or communicate on a model, the corresponding actions
666 * are not executed immediately but only when you call surf_solve.
667 * Note that the returned elapsed time can be zero.
669 XBT_PUBLIC(double) surf_solve(double max_date);
671 /** \ingroup SURF_simulation
672 * \brief Return the current time
674 * Return the current time in millisecond.
676 XBT_PUBLIC(double) surf_get_clock(void);
678 /** \ingroup SURF_simulation
685 XBT_PUBLIC(void) surf_exit(void);
687 /* Prototypes of the functions that handle the properties */
688 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
690 /* surf parse file related (public because called from a test suite) */
691 XBT_PUBLIC(void) parse_platform_file(const char *file);
693 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
694 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
695 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
696 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
697 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
698 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
699 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
702 XBT_PUBLIC(double) get_cpu_power(const char *power);
704 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
706 int surf_get_nthreads(void);
707 void surf_set_nthreads(int nthreads);
709 void surf_watched_hosts(void);
712 * Returns the initial path. On Windows the initial path is
713 * the current directory for the current process in the other
714 * case the function returns "./" that represents the current
715 * directory on Unix/Linux platforms.
717 const char *__surf_get_initial_path(void);
719 /********** Tracing **********/
720 /* from surf_instr.c */
721 void TRACE_surf_action(surf_action_t surf_action, const char *category);
722 void TRACE_surf_alloc(void);
723 void TRACE_surf_release(void);
725 /* instr_routing.c */
726 void instr_routing_define_callbacks (void);
727 void instr_new_variable_type (const char *new_typename, const char *color);
728 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
729 void instr_new_user_state_type (const char *father_type, const char *new_typename);
730 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
731 int instr_platform_traced (void);
732 xbt_graph_t instr_routing_platform_graph (void);
733 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
736 #endif /* _SURF_SURF_H */