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{
83 typedef struct surf_resource {
86 xbt_dict_t properties;
87 } s_surf_resource_t, *surf_resource_t;
89 /** \ingroup SURF_actions
90 * \brief Action structure
92 * Never create s_surf_action_t by yourself ! The actions are created
93 * on the fly when you call execute or communicate on a model.
95 * \see e_surf_action_state_t
97 typedef struct surf_action {
98 s_xbt_swag_hookup_t state_hookup;
100 double cost; /**< cost */
101 double priority; /**< priority (1.0 by default) */
102 double bound; /**< the capping of the CPU use */
103 double max_duration; /**< max_duration (may fluctuate until
104 the task is completed) */
105 double remains; /**< How much of that cost remains to
106 * be done in the currently running task */
107 #ifdef HAVE_LATENCY_BOUND_TRACKING
108 int latency_limited; /**< Set to 1 if is limited by latency, 0 otherwise */
111 double start; /**< start time */
112 double finish; /**< finish time : this is modified during the run
113 * and fluctuates until the task is completed */
114 void *data; /**< for your convenience */
117 /* The previous name was model_type. For VM support, we have to distinguish a
118 * model type and its model object. Thus, we use model_obj here. The type of
119 * a model object is available by looking at the inside of the model object. */
120 surf_model_t model_obj; /**< the surf model object */
123 char *category; /**< tracing category for categorized resource utilization monitoring */
125 surf_file_t file; /**< surf_file_t for storage model */
129 typedef struct surf_action_lmm {
130 s_surf_action_t generic_action;
131 lmm_variable_t variable;
133 s_xbt_swag_hookup_t action_list_hookup;
137 enum heap_action_type hat;
138 } s_surf_action_lmm_t, *surf_action_lmm_t;
140 /** \ingroup SURF_actions
141 * \brief Action states
145 * \see surf_action_t, surf_action_state_t
148 SURF_ACTION_READY = 0, /**< Ready */
149 SURF_ACTION_RUNNING, /**< Running */
150 SURF_ACTION_FAILED, /**< Task Failure */
151 SURF_ACTION_DONE, /**< Completed */
152 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
153 SURF_ACTION_NOT_IN_THE_SYSTEM
154 /**< Not in the system anymore. Why did you ask ? */
155 } e_surf_action_state_t;
157 /** \ingroup SURF_actions
158 * \brief Action state sets
160 * This structure contains some sets of actions.
161 * It provides a fast access to the actions in each state.
163 * \see surf_action_t, e_surf_action_state_t
165 typedef struct surf_action_state {
166 xbt_swag_t ready_action_set;
167 /**< Actions in state SURF_ACTION_READY */
168 xbt_swag_t running_action_set;
169 /**< Actions in state SURF_ACTION_RUNNING */
170 xbt_swag_t failed_action_set;
171 /**< Actions in state SURF_ACTION_FAILED */
172 xbt_swag_t done_action_set;
173 /**< Actions in state SURF_ACTION_DONE */
174 } s_surf_action_state_t, *surf_action_state_t;
176 /***************************/
177 /* Generic model object */
178 /***************************/
179 typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
180 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
182 /*******************************************
183 * TUTORIAL: New model
184 * New model extension public
185 * Public functions specific to a New model.
187 typedef struct surf_new_model_extension_public {
188 surf_action_t(*fct) ();
189 void* (*create_resource) ();
190 } s_surf_model_extension_new_model_t;
191 /*******************************************/
193 /** \ingroup SURF_models
194 * \brief Private data available on all models
196 typedef struct surf_model_private *surf_model_private_t;
200 /** \ingroup SURF_models
201 * \brief CPU model extension public
203 * Public functions specific to the CPU model.
205 typedef struct surf_cpu_model_extension_public {
206 surf_action_t(*execute) (void *cpu, double size);
207 surf_action_t(*sleep) (void *cpu, double duration);
208 e_surf_resource_state_t(*get_state) (void *cpu);
209 void(*set_state) (void *cpu, e_surf_resource_state_t state);
211 int (*get_core) (void *cpu);
212 double (*get_speed) (void *cpu, double load);
213 double (*get_available_speed) (void *cpu);
214 void (*add_traces) (void);
215 } s_surf_model_extension_cpu_t;
219 /** \ingroup SURF_models
220 * \brief Network model extension public
222 * Public functions specific to the network model
224 typedef struct surf_network_model_extension_public {
225 surf_action_t (*communicate) (sg_routing_edge_t src,
226 sg_routing_edge_t dst,
227 double size, double rate);
228 xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
229 double (*get_link_bandwidth) (const void *link);
230 double (*get_link_latency) (const void *link);
231 int (*link_shared) (const void *link);
232 void (*add_traces) (void);
233 } s_surf_model_extension_network_t;
237 /** \ingroup SURF_models
238 * \brief Storage model extension public
240 * Public functions specific to the Storage model.
243 typedef struct surf_storage_model_extension_public {
244 surf_action_t(*open) (void *storage, const char* mount, const char* path);
245 surf_action_t(*close) (void *storage, surf_file_t fd);
246 surf_action_t(*read) (void *storage, void* ptr, size_t size,
248 surf_action_t(*write) (void *storage, const void* ptr, size_t size,
250 surf_action_t(*stat) (void *storage, surf_file_t fd);
251 surf_action_t(*ls) (void *storage, const char *path);
252 } s_surf_model_extension_storage_t;
254 /** \ingroup SURF_models
255 * \brief Workstation model extension public
257 * Public functions specific to the workstation model.
259 typedef struct surf_workstation_model_extension_public {
260 /* This points to the surf cpu model object bound to the workstation model. */
261 surf_model_t cpu_model;
263 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
264 and create the corresponding action */
265 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
266 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
267 void(*set_state) (void *workstation, e_surf_resource_state_t state);
268 int (*get_core) (void *workstation);
269 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
270 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
271 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
272 void *workstation_dst, double size,
274 // FIXME: kill next field, which duplicates the routing
275 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
277 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
278 void **workstation_list,
279 double *computation_amount,
280 double *communication_amount,
282 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
283 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
284 surf_action_t(*open) (void *workstation, const char* storage,
286 surf_action_t(*close) (void *workstation, surf_file_t fd);
287 surf_action_t(*read) (void *workstation, void* ptr, size_t size,
289 surf_action_t(*write) (void *workstation, const void* ptr, size_t size,
291 surf_action_t(*stat) (void *workstation, surf_file_t fd);
292 int(*unlink) (void *workstation, surf_file_t fd);
293 surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
294 size_t (*get_size) (void *workstation, surf_file_t fd);
296 int (*link_shared) (const void *link);
297 xbt_dict_t(*get_properties) (const void *resource);
298 void (*add_traces) (void);
300 void (*get_params) (void *ind_vm_ws, ws_params_t param);
301 void (*set_params) (void *ind_vm_ws, ws_params_t param);
302 xbt_dynar_t (*get_vms) (void *ind_vm_ws);
304 } s_surf_model_extension_workstation_t;
306 typedef struct surf_vm_workstation_model_extension_public {
307 /* The vm workstation model object has all members of the physical machine
308 * workstation model object. If these members are correctly initialized also
309 * in the vm workstation model object, we can access the vm workstation model
310 * object as if it is the pm workstatoin model object.
312 * But, it's not so clean. Think it again later.
314 s_surf_model_extension_workstation_t basic;
316 // start does not appear here as it corresponds to turn the state from created to running (see smx_vm.c)
318 void (*create) (const char *name, void *ind_phys_workstation); // First operation of the VM model
319 void (*destroy) (void *ind_vm_ws); // will be vm_ws_destroy(), which destroies the vm-workstation-specific data
321 void (*suspend) (void *ind_vm_ws);
322 void (*resume) (void *ind_vm_ws);
324 void (*save) (void *ind_vm_ws);
325 void (*restore) (void *ind_vm_ws);
327 void (*migrate) (void *ind_vm_ws, void *ind_vm_ws_dest); // will be vm_ws_migrate()
329 int (*get_state) (void *ind_vm_ws);
330 void (*set_state) (void *ind_vm_ws, int state);
332 void * (*get_pm) (void *ind_vm_ws); // will be vm_ws_get_pm()
334 void (*set_vm_bound) (void *ind_vm_ws, double bound); // will be vm_ws_set_vm_bound()
336 } s_surf_model_extension_vm_workstation_t;
338 /** \ingroup SURF_models
341 * The type of the model object. For example, we will have two model objects
342 * of the surf cpu model. One is for physical machines, and the other is for
347 SURF_MODEL_TYPE_CPU = 0,
348 SURF_MODEL_TYPE_NETWORK,
349 SURF_MODEL_TYPE_STORAGE,
350 SURF_MODEL_TYPE_WORKSTATION,
351 SURF_MODEL_TYPE_VM_WORKSTATION,
352 SURF_MODEL_TYPE_NEW_MODEL
353 } e_surf_model_type_t;
355 /** \ingroup SURF_models
356 * \brief Model datatype
358 * Generic data structure for a model. The workstations,
359 * the CPUs and the network links are examples of models.
361 typedef struct surf_model {
362 const char *name; /**< Name of this model */
363 s_surf_action_state_t states; /**< Any living action on this model */
365 e_surf_model_type_t type; /**< See e_surf_model_type_t */
367 e_surf_action_state_t(*action_state_get) (surf_action_t action);
368 /**< Return the state of an action */
369 void (*action_state_set) (surf_action_t action,
370 e_surf_action_state_t state);
371 /**< Change an action state*/
373 double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
374 double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
375 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. */
376 void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
377 void (*action_recycle) (surf_action_t action); /**< Recycle an action */
378 void (*action_data_set) (surf_action_t action, void *data); /**< Set the user data of an action */
379 void (*suspend) (surf_action_t action); /**< Suspend an action */
380 void (*resume) (surf_action_t action); /**< Resume a suspended action */
381 int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
382 void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
383 void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
384 void (*set_bound) (surf_action_t action, double bound); /**< Set the bound (the maximum CPU utilization) of an action */
386 void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
388 double (*get_remains) (surf_action_t action); /**< Get the remains of an action */
389 #ifdef HAVE_LATENCY_BOUND_TRACKING
390 int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */
393 void (*gap_remove) (surf_action_lmm_t action);
395 surf_model_private_t model_private;
398 s_surf_model_extension_cpu_t cpu;
399 s_surf_model_extension_network_t network;
400 s_surf_model_extension_storage_t storage;
401 s_surf_model_extension_workstation_t workstation;
402 // TODO Implement the corresponding model
403 s_surf_model_extension_vm_workstation_t vm_workstation;
404 /*******************************************/
405 /* TUTORIAL: New model */
406 s_surf_model_extension_new_model_t new_model;
407 /*******************************************/
411 surf_model_t surf_model_init(void);
412 void surf_model_exit(surf_model_t model);
414 static inline void *surf_cpu_resource_priv(const void *host) {
415 return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
417 static inline void *surf_workstation_resource_priv(const void *host){
418 return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
420 static inline void *surf_storage_resource_priv(const void *host){
421 return xbt_lib_get_level((void *)host, SURF_STORAGE_LEVEL);
424 static inline void *surf_cpu_resource_by_name(const char *name) {
425 return xbt_lib_get_elm_or_null(host_lib, name);
427 static inline void *surf_workstation_resource_by_name(const char *name){
428 return xbt_lib_get_elm_or_null(host_lib, name);
430 static inline void *surf_storage_resource_by_name(const char *name){
431 return xbt_lib_get_elm_or_null(storage_lib, name);
434 static inline surf_model_t surf_resource_model(const void *host, int level) {
435 /* If level is SURF_WKS_LEVEL, ws is a workstation_CLM03 object. It has
436 * surf_resource at the generic_resource field. */
437 surf_resource_t ws = xbt_lib_get_level((void *) host, level);
444 * Resource which have a metric handled by a maxmin system
449 tmgr_trace_event_t event;
452 typedef struct surf_resource_lmm {
453 s_surf_resource_t generic_resource;
454 lmm_constraint_t constraint;
455 e_surf_resource_state_t state_current;
456 tmgr_trace_event_t state_event;
457 s_surf_metric_t power;
458 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
460 /**************************************/
461 /* Implementations of model object */
462 /**************************************/
465 /** \ingroup SURF_models
466 * \brief The CPU model object for the physical machine layer
468 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_pm;
470 /** \ingroup SURF_models
471 * \brief The CPU model object for the virtual machine layer
473 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_vm;
475 /** \ingroup SURF_models
476 * \brief Initializes the CPU model with the model Cas01
478 * By default, this model uses the lazy optimization mechanism that
479 * relies on partial invalidation in LMM and a heap for lazy action update.
480 * You can change this behavior by setting the cpu/optim configuration
481 * variable to a different value.
483 * You shouldn't have to call it by yourself.
485 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
487 /** \ingroup SURF_models
488 * \brief Initializes the CPU model with trace integration [Deprecated]
490 * You shouldn't have to call it by yourself.
492 XBT_PUBLIC(surf_model_t) surf_cpu_model_init_ti(void);
494 /** \ingroup SURF_models
495 * \brief The list of all available optimization modes (both for cpu and networks).
496 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
498 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
500 /** \ingroup SURF_models
501 * \brief The list of all available cpu model models
503 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
505 /**\brief create new host bypass the parser
510 /** \ingroup SURF_models
511 * \brief The network model
513 * When creating a new API on top on SURF, you shouldn't use the
514 * network model unless you know what you are doing. Only the workstation
515 * model should be accessed because depending on the platform model,
516 * the network model can be NULL.
518 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
520 /** \ingroup SURF_models
521 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
523 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
524 * based on the model 'LV08' and different correction factors depending on the communication
525 * size (< 1KiB, < 64KiB, >= 64KiB).
526 * See comments in the code for more information.
528 * \see surf_workstation_model_init_SMPI()
530 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
532 /** \ingroup SURF_models
533 * \brief Initializes the platform with the network model 'LegrandVelho'
535 * This model is proposed by Arnaud Legrand and Pedro Velho based on
536 * the results obtained with the GTNets simulator for onelink and
537 * dogbone sharing scenarios. See comments in the code for more information.
539 * \see surf_workstation_model_init_LegrandVelho()
541 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
543 /** \ingroup SURF_models
544 * \brief Initializes the platform with the network model 'Constant'
546 * In this model, the communication time between two network cards is
547 * constant, hence no need for a routing table. This is particularly
548 * usefull when simulating huge distributed algorithms where
549 * scalability is really an issue. This function is called in
550 * conjunction with surf_workstation_model_init_compound.
552 * \see surf_workstation_model_init_compound()
554 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
556 /** \ingroup SURF_models
557 * \brief Initializes the platform with the network model CM02
559 * You sould call this function by yourself only if you plan using
560 * surf_workstation_model_init_compound.
561 * See comments in the code for more information.
563 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
566 /** \ingroup SURF_models
567 * \brief Initializes the platform with the network model GTNETS
568 * \param filename XML platform file name
570 * This function is called by surf_workstation_model_init_GTNETS
571 * or by yourself only if you plan using surf_workstation_model_init_compound
573 * \see surf_workstation_model_init_GTNETS()
575 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
579 /** \ingroup SURF_models
580 * \brief Initializes the platform with the network model NS3
581 * \param filename XML platform file name
583 * This function is called by surf_workstation_model_init_NS3
584 * or by yourself only if you plan using surf_workstation_model_init_compound
586 * \see surf_workstation_model_init_NS3()
588 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
591 /** \ingroup SURF_models
592 * \brief Initializes the platform with the network model Reno
593 * \param filename XML platform file name
595 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
598 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
599 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
601 * Call this function only if you plan using surf_workstation_model_init_compound.
604 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
606 /** \ingroup SURF_models
607 * \brief Initializes the platform with the network model Reno2
608 * \param filename XML platform file name
610 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
613 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
614 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
616 * Call this function only if you plan using surf_workstation_model_init_compound.
619 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
621 /** \ingroup SURF_models
622 * \brief Initializes the platform with the network model Vegas
623 * \param filename XML platform file name
625 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
626 * to the proportional fairness.
629 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
630 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
632 * Call this function only if you plan using surf_workstation_model_init_compound.
635 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
637 /** \ingroup SURF_models
638 * \brief The list of all available network model models
640 XBT_PUBLIC_DATA(s_surf_model_description_t)
641 surf_network_model_description[];
643 /** \ingroup SURF_models
644 * \brief The storage model
646 XBT_PUBLIC(void) surf_storage_model_init_default(void);
648 /** \ingroup SURF_models
649 * \brief The list of all available storage modes.
650 * This storage mode can be set using --cfg=storage/model:...
652 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
654 /** \ingroup SURF_models
655 * \brief The workstation model
657 * Note that when you create an API on top of SURF,
658 * the workstation model should be the only one you use
659 * because depending on the platform model, the network model and the CPU model
662 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
664 /** \ingroup SURF_models
665 * \brief The vm_workstation model
667 * Note that when you create an API on top of SURF,
668 * the vm_workstation model should be the only one you use
669 * because depending on the platform model, the network model and the CPU model
672 XBT_PUBLIC_DATA(surf_model_t) surf_vm_workstation_model;
674 /** \ingroup SURF_models
675 * \brief Initializes the platform with a compound workstation model
677 * This function should be called after a cpu_model and a
678 * network_model have been set up.
681 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
683 /** \ingroup SURF_models
684 * \brief Initializes the platform with the current best network and cpu models at hand
686 * This platform model seperates the workstation model and the network model.
687 * The workstation model will be initialized with the model compound, the network
688 * model with the model LV08 (with cross traffic support) and the CPU model with
690 * Such model is subject to modification with warning in the ChangeLog so monitor it!
693 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
695 /** \ingroup SURF_models
696 * \brief Initializes the platform with the model KCCFLN05
698 * With this model, only parallel tasks can be used. Resource sharing
699 * is done by identifying bottlenecks and giving an equal share of
700 * the model to each action.
703 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
705 /** \ingroup SURF_models
706 * \brief The list of all available workstation model models
708 XBT_PUBLIC_DATA(s_surf_model_description_t)
709 surf_workstation_model_description[];
711 /*******************************************
712 * TUTORIAL: New model
714 XBT_PUBLIC(void) surf_new_model_init_default(void);
715 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
716 /*******************************************/
718 /** \ingroup SURF_models
719 * \brief List of initialized models
721 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
722 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
724 /*******************************************/
725 /*** SURF Platform *************************/
726 /*******************************************/
727 typedef struct s_as *AS_t;
729 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
730 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
731 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
732 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
733 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
735 /*******************************************/
736 /*** SURF Globals **************************/
737 /*******************************************/
739 /** \ingroup SURF_simulation
740 * \brief Initialize SURF
741 * \param argc argument number
742 * \param argv arguments
744 * This function has to be called to initialize the common
745 * structures. Then you will have to create the environment by
747 * e.g. surf_workstation_model_init_CM02()
749 * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
751 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
753 /** \ingroup SURF_simulation
754 * \brief Finish simulation initialization
756 * This function must be called before the first call to surf_solve()
758 XBT_PUBLIC(void) surf_presolve(void);
760 /** \ingroup SURF_simulation
761 * \brief Performs a part of the simulation
762 * \param max_date Maximum date to update the simulation to, or -1
763 * \return the elapsed time, or -1.0 if no event could be executed
765 * This function execute all possible events, update the action states
766 * and returns the time elapsed.
767 * When you call execute or communicate on a model, the corresponding actions
768 * are not executed immediately but only when you call surf_solve.
769 * Note that the returned elapsed time can be zero.
771 XBT_PUBLIC(double) surf_solve(double max_date);
773 /** \ingroup SURF_simulation
774 * \brief Return the current time
776 * Return the current time in millisecond.
778 XBT_PUBLIC(double) surf_get_clock(void);
780 /** \ingroup SURF_simulation
787 XBT_PUBLIC(void) surf_exit(void);
789 /* Prototypes of the functions that handle the properties */
790 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
792 /* surf parse file related (public because called from a test suite) */
793 XBT_PUBLIC(void) parse_platform_file(const char *file);
795 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
796 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
797 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
798 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
799 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
800 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
801 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
804 XBT_PUBLIC(double) get_cpu_power(const char *power);
806 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
808 int surf_get_nthreads(void);
809 void surf_set_nthreads(int nthreads);
811 void surf_watched_hosts(void);
814 * Returns the initial path. On Windows the initial path is
815 * the current directory for the current process in the other
816 * case the function returns "./" that represents the current
817 * directory on Unix/Linux platforms.
819 const char *__surf_get_initial_path(void);
821 /********** Tracing **********/
822 /* from surf_instr.c */
823 void TRACE_surf_action(surf_action_t surf_action, const char *category);
824 void TRACE_surf_alloc(void);
825 void TRACE_surf_release(void);
827 /* instr_routing.c */
828 void instr_routing_define_callbacks (void);
829 void instr_new_variable_type (const char *new_typename, const char *color);
830 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
831 void instr_new_user_state_type (const char *father_type, const char *new_typename);
832 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
833 int instr_platform_traced (void);
834 xbt_graph_t instr_routing_platform_graph (void);
835 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
838 #endif /* _SURF_SURF_H */