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_network_crosstraffic;
34 extern double sg_gtnets_jitter;
35 extern int sg_gtnets_jitter_seed;
37 extern xbt_dynar_t surf_path;
41 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
42 SURF_NETWORK_ELEMENT_HOST, /* host type */
43 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
44 SURF_NETWORK_ELEMENT_AS /* AS type */
45 } e_surf_network_element_type_t;
47 XBT_PUBLIC(e_surf_network_element_type_t)
48 routing_get_network_element_type(const char* name);
50 /** @Brief Specify that we use that action */
51 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
53 /** @brief Creates a new action.
55 * @param size The size is the one of the subtype you want to create
56 * @param cost initial value
57 * @param model to which model we should attach this action
58 * @param failed whether we should start this action in failed mode
60 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
61 surf_model_t model, int failed);
63 /** \brief Resource model description
65 typedef struct surf_model_description {
67 const char *description;
68 void_f_void_t model_init_preparse;
69 } s_surf_model_description_t, *surf_model_description_t;
71 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
73 XBT_PUBLIC(void) model_help(const char *category,
74 s_surf_model_description_t * table);
76 enum heap_action_type{
84 typedef struct surf_resource {
87 xbt_dict_t properties;
88 } s_surf_resource_t, *surf_resource_t;
90 /** \ingroup SURF_actions
91 * \brief Action structure
93 * Never create s_surf_action_t by yourself ! The actions are created
94 * on the fly when you call execute or communicate on a model.
96 * \see e_surf_action_state_t
98 typedef struct surf_action {
99 s_xbt_swag_hookup_t state_hookup;
100 xbt_swag_t state_set;
101 double cost; /**< cost */
102 double priority; /**< priority (1.0 by default) */
103 double bound; /**< the capping of the CPU use */
104 double max_duration; /**< max_duration (may fluctuate until
105 the task is completed) */
106 double remains; /**< How much of that cost remains to
107 * be done in the currently running task */
108 #ifdef HAVE_LATENCY_BOUND_TRACKING
109 int latency_limited; /**< Set to 1 if is limited by latency, 0 otherwise */
112 double start; /**< start time */
113 double finish; /**< finish time : this is modified during the run
114 * and fluctuates until the task is completed */
115 void *data; /**< for your convenience */
118 /* The previous name was model_type. For VM support, we have to distinguish a
119 * model type and its model object. Thus, we use model_obj here. The type of
120 * a model object is available by looking at the inside of the model object. */
121 surf_model_t model_obj; /**< the surf model object */
124 char *category; /**< tracing category for categorized resource utilization monitoring */
126 surf_file_t file; /**< surf_file_t for storage model */
127 s_file_stat_t stat; /**< surf_file_t for storage model */
131 typedef struct surf_action_lmm {
132 s_surf_action_t generic_action;
133 lmm_variable_t variable;
135 s_xbt_swag_hookup_t action_list_hookup;
139 enum heap_action_type hat;
140 } s_surf_action_lmm_t, *surf_action_lmm_t;
142 /** \ingroup SURF_actions
143 * \brief Action states
147 * \see surf_action_t, surf_action_state_t
150 SURF_ACTION_READY = 0, /**< Ready */
151 SURF_ACTION_RUNNING, /**< Running */
152 SURF_ACTION_FAILED, /**< Task Failure */
153 SURF_ACTION_DONE, /**< Completed */
154 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
155 SURF_ACTION_NOT_IN_THE_SYSTEM
156 /**< Not in the system anymore. Why did you ask ? */
157 } e_surf_action_state_t;
159 /** \ingroup SURF_actions
160 * \brief Action state sets
162 * This structure contains some sets of actions.
163 * It provides a fast access to the actions in each state.
165 * \see surf_action_t, e_surf_action_state_t
167 typedef struct surf_action_state {
168 xbt_swag_t ready_action_set;
169 /**< Actions in state SURF_ACTION_READY */
170 xbt_swag_t running_action_set;
171 /**< Actions in state SURF_ACTION_RUNNING */
172 xbt_swag_t failed_action_set;
173 /**< Actions in state SURF_ACTION_FAILED */
174 xbt_swag_t done_action_set;
175 /**< Actions in state SURF_ACTION_DONE */
176 } s_surf_action_state_t, *surf_action_state_t;
178 /***************************/
179 /* Generic model object */
180 /***************************/
181 typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
182 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
184 /*******************************************
185 * TUTORIAL: New model
186 * New model extension public
187 * Public functions specific to a New model.
189 typedef struct surf_new_model_extension_public {
190 surf_action_t(*fct) ();
191 void* (*create_resource) ();
192 } s_surf_model_extension_new_model_t;
193 /*******************************************/
195 /** \ingroup SURF_models
196 * \brief Private data available on all models
198 typedef struct surf_model_private *surf_model_private_t;
202 /** \ingroup SURF_models
203 * \brief CPU model extension public
205 * Public functions specific to the CPU model.
207 typedef struct surf_cpu_model_extension_public {
208 surf_action_t(*execute) (void *cpu, double size);
209 surf_action_t(*sleep) (void *cpu, double duration);
210 e_surf_resource_state_t(*get_state) (void *cpu);
211 double (*get_speed) (void *cpu, double load);
212 double (*get_available_speed) (void *cpu);
213 void (*add_traces) (void);
214 } s_surf_model_extension_cpu_t;
218 /** \ingroup SURF_models
219 * \brief Network model extension public
221 * Public functions specific to the network model
223 typedef struct surf_network_model_extension_public {
224 surf_action_t (*communicate) (sg_routing_edge_t src,
225 sg_routing_edge_t dst,
226 double size, double rate);
227 xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
228 double (*get_link_bandwidth) (const void *link);
229 double (*get_link_latency) (const void *link);
230 int (*link_shared) (const void *link);
231 void (*add_traces) (void);
232 } s_surf_model_extension_network_t;
236 /** \ingroup SURF_models
237 * \brief Storage model extension public
239 * Public functions specific to the Storage model.
242 typedef struct surf_storage_model_extension_public {
243 surf_action_t(*open) (void *storage, const char* mount, const char* path, const char* mode);
244 surf_action_t(*close) (void *storage, surf_file_t fp);
245 surf_action_t(*read) (void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream);
246 surf_action_t(*write) (void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
247 surf_action_t(*stat) (void *storage, surf_file_t stream);
248 surf_action_t(*unlink) (void *storage, surf_file_t stream);
249 surf_action_t(*ls) (void *storage, const char *path);
250 } s_surf_model_extension_storage_t;
252 /** \ingroup SURF_models
253 * \brief Workstation model extension public
255 * Public functions specific to the workstation model.
257 typedef struct surf_workstation_model_extension_public {
258 /* This points to the surf cpu model object bound to the workstation model. */
259 surf_model_t cpu_model;
261 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
262 and create the corresponding action */
263 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
264 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
265 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
266 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
267 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
268 void *workstation_dst, double size,
270 // FIXME: kill next field, which duplicates the routing
271 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
273 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
274 void **workstation_list,
275 double *computation_amount,
276 double *communication_amount,
278 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
279 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
280 surf_action_t(*open) (void *workstation, const char* storage, const char* path, const char* mode);
281 surf_action_t(*close) (void *workstation, surf_file_t fp);
282 surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
283 surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
284 surf_action_t(*stat) (void *workstation, surf_file_t stream);
285 surf_action_t(*unlink) (void *workstation, surf_file_t stream);
286 surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
288 int (*link_shared) (const void *link);
289 xbt_dict_t(*get_properties) (const void *resource);
290 void (*add_traces) (void);
292 void (*get_params) (void *ind_vm_ws, ws_params_t param);
293 void (*set_params) (void *ind_vm_ws, ws_params_t param);
294 xbt_dynar_t (*get_vms) (void *ind_vm_ws);
296 } s_surf_model_extension_workstation_t;
298 typedef struct surf_vm_workstation_model_extension_public {
299 /* The vm workstation model object has all members of the physical machine
300 * workstation model object. If these members are correctly initialized also
301 * in the vm workstation model object, we can access the vm workstation model
302 * object as if it is the pm workstatoin model object.
304 * But, it's not so clean. Think it again later.
306 s_surf_model_extension_workstation_t basic;
308 // start does not appear here as it corresponds to turn the state from created to running (see smx_vm.c)
310 void (*create) (const char *name, void *ind_phys_workstation); // First operation of the VM model
311 void (*destroy) (void *ind_vm_ws); // will be vm_ws_destroy(), which destroies the vm-workstation-specific data
313 void (*suspend) (void *ind_vm_ws);
314 void (*resume) (void *ind_vm_ws);
316 void (*save) (void *ind_vm_ws);
317 void (*restore) (void *ind_vm_ws);
319 void (*migrate) (void *ind_vm_ws, void *ind_vm_ws_dest); // will be vm_ws_migrate()
321 int (*get_state) (void *ind_vm_ws);
322 void (*set_state) (void *ind_vm_ws, int state);
324 void * (*get_pm) (void *ind_vm_ws); // will be vm_ws_get_pm()
326 void (*set_vm_bound) (void *ind_vm_ws, double bound); // will be vm_ws_set_vm_bound()
328 } s_surf_model_extension_vm_workstation_t;
330 /** \ingroup SURF_models
333 * The type of the model object. For example, we will have two model objects
334 * of the surf cpu model. One is for physical machines, and the other is for
339 SURF_MODEL_TYPE_CPU = 0,
340 SURF_MODEL_TYPE_NETWORK,
341 SURF_MODEL_TYPE_STORAGE,
342 SURF_MODEL_TYPE_WORKSTATION,
343 SURF_MODEL_TYPE_VM_WORKSTATION,
344 SURF_MODEL_TYPE_NEW_MODEL
345 } e_surf_model_type_t;
347 /** \ingroup SURF_models
348 * \brief Model datatype
350 * Generic data structure for a model. The workstations,
351 * the CPUs and the network links are examples of models.
353 typedef struct surf_model {
354 const char *name; /**< Name of this model */
355 s_surf_action_state_t states; /**< Any living action on this model */
357 e_surf_model_type_t type; /**< See e_surf_model_type_t */
359 e_surf_action_state_t(*action_state_get) (surf_action_t action);
360 /**< Return the state of an action */
361 void (*action_state_set) (surf_action_t action,
362 e_surf_action_state_t state);
363 /**< Change an action state*/
365 double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
366 double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
367 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. */
368 void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
369 void (*action_recycle) (surf_action_t action); /**< Recycle an action */
370 void (*action_data_set) (surf_action_t action, void *data); /**< Set the user data of an action */
371 void (*suspend) (surf_action_t action); /**< Suspend an action */
372 void (*resume) (surf_action_t action); /**< Resume a suspended action */
373 int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
374 void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
375 void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
376 void (*set_bound) (surf_action_t action, double bound); /**< Set the bound (the maximum CPU utilization) of an action */
378 void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
380 double (*get_remains) (surf_action_t action); /**< Get the remains of an action */
381 #ifdef HAVE_LATENCY_BOUND_TRACKING
382 int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */
385 void (*gap_remove) (surf_action_lmm_t action);
387 surf_model_private_t model_private;
390 s_surf_model_extension_cpu_t cpu;
391 s_surf_model_extension_network_t network;
392 s_surf_model_extension_storage_t storage;
393 s_surf_model_extension_workstation_t workstation;
394 // TODO Implement the corresponding model
395 s_surf_model_extension_vm_workstation_t vm_workstation;
396 /*******************************************/
397 /* TUTORIAL: New model */
398 s_surf_model_extension_new_model_t new_model;
399 /*******************************************/
403 surf_model_t surf_model_init(void);
404 void surf_model_exit(surf_model_t model);
406 static inline void *surf_cpu_resource_priv(const void *host) {
407 return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
409 static inline void *surf_workstation_resource_priv(const void *host){
410 return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
412 static inline void *surf_storage_resource_priv(const void *host){
413 return xbt_lib_get_level((void *)host, SURF_STORAGE_LEVEL);
416 static inline void *surf_cpu_resource_by_name(const char *name) {
417 return xbt_lib_get_elm_or_null(host_lib, name);
419 static inline void *surf_workstation_resource_by_name(const char *name){
420 return xbt_lib_get_elm_or_null(host_lib, name);
422 static inline void *surf_storage_resource_by_name(const char *name){
423 return xbt_lib_get_elm_or_null(storage_lib, name);
426 static inline surf_model_t surf_resource_model(const void *host, int level) {
427 /* If level is SURF_WKS_LEVEL, ws is a workstation_CLM03 object. It has
428 * surf_resource at the generic_resource field. */
429 surf_resource_t ws = xbt_lib_get_level((void *) host, level);
436 * Resource which have a metric handled by a maxmin system
441 tmgr_trace_event_t event;
444 typedef struct surf_resource_lmm {
445 s_surf_resource_t generic_resource;
446 lmm_constraint_t constraint;
447 e_surf_resource_state_t state_current;
448 tmgr_trace_event_t state_event;
449 s_surf_metric_t power;
450 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
452 /**************************************/
453 /* Implementations of model object */
454 /**************************************/
457 /** \ingroup SURF_models
458 * \brief The CPU model object for the physical machine layer
460 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_pm;
462 /** \ingroup SURF_models
463 * \brief The CPU model object for the virtual machine layer
465 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_vm;
467 /** \ingroup SURF_models
468 * \brief Initializes the CPU model with the model Cas01
470 * By default, this model uses the lazy optimization mechanism that
471 * relies on partial invalidation in LMM and a heap for lazy action update.
472 * You can change this behavior by setting the cpu/optim configuration
473 * variable to a different value.
475 * You shouldn't have to call it by yourself.
477 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
479 /** \ingroup SURF_models
480 * \brief Initializes the CPU model with trace integration [Deprecated]
482 * You shouldn't have to call it by yourself.
484 XBT_PUBLIC(surf_model_t) surf_cpu_model_init_ti(void);
486 /** \ingroup SURF_models
487 * \brief The list of all available optimization modes (both for cpu and networks).
488 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
490 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
492 /** \ingroup SURF_models
493 * \brief The list of all available cpu model models
495 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
497 /**\brief create new host bypass the parser
502 /** \ingroup SURF_models
503 * \brief The network model
505 * When creating a new API on top on SURF, you shouldn't use the
506 * network model unless you know what you are doing. Only the workstation
507 * model should be accessed because depending on the platform model,
508 * the network model can be NULL.
510 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
512 /** \ingroup SURF_models
513 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
515 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
516 * based on the model 'LV08' and different correction factors depending on the communication
517 * size (< 1KiB, < 64KiB, >= 64KiB).
518 * See comments in the code for more information.
520 * \see surf_workstation_model_init_SMPI()
522 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
524 /** \ingroup SURF_models
525 * \brief Initializes the platform with the network model 'LegrandVelho'
527 * This model is proposed by Arnaud Legrand and Pedro Velho based on
528 * the results obtained with the GTNets simulator for onelink and
529 * dogbone sharing scenarios. See comments in the code for more information.
531 * \see surf_workstation_model_init_LegrandVelho()
533 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
535 /** \ingroup SURF_models
536 * \brief Initializes the platform with the network model 'Constant'
538 * In this model, the communication time between two network cards is
539 * constant, hence no need for a routing table. This is particularly
540 * usefull when simulating huge distributed algorithms where
541 * scalability is really an issue. This function is called in
542 * conjunction with surf_workstation_model_init_compound.
544 * \see surf_workstation_model_init_compound()
546 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
548 /** \ingroup SURF_models
549 * \brief Initializes the platform with the network model CM02
551 * You sould call this function by yourself only if you plan using
552 * surf_workstation_model_init_compound.
553 * See comments in the code for more information.
555 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
558 /** \ingroup SURF_models
559 * \brief Initializes the platform with the network model GTNETS
560 * \param filename XML platform file name
562 * This function is called by surf_workstation_model_init_GTNETS
563 * or by yourself only if you plan using surf_workstation_model_init_compound
565 * \see surf_workstation_model_init_GTNETS()
567 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
571 /** \ingroup SURF_models
572 * \brief Initializes the platform with the network model NS3
573 * \param filename XML platform file name
575 * This function is called by surf_workstation_model_init_NS3
576 * or by yourself only if you plan using surf_workstation_model_init_compound
578 * \see surf_workstation_model_init_NS3()
580 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
583 /** \ingroup SURF_models
584 * \brief Initializes the platform with the network model Reno
585 * \param filename XML platform file name
587 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
590 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
591 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
593 * Call this function only if you plan using surf_workstation_model_init_compound.
596 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
598 /** \ingroup SURF_models
599 * \brief Initializes the platform with the network model Reno2
600 * \param filename XML platform file name
602 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
605 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
606 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
608 * Call this function only if you plan using surf_workstation_model_init_compound.
611 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
613 /** \ingroup SURF_models
614 * \brief Initializes the platform with the network model Vegas
615 * \param filename XML platform file name
617 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
618 * to the proportional fairness.
621 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
622 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
624 * Call this function only if you plan using surf_workstation_model_init_compound.
627 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
629 /** \ingroup SURF_models
630 * \brief The list of all available network model models
632 XBT_PUBLIC_DATA(s_surf_model_description_t)
633 surf_network_model_description[];
635 /** \ingroup SURF_models
636 * \brief The storage model
638 XBT_PUBLIC(void) surf_storage_model_init_default(void);
640 /** \ingroup SURF_models
641 * \brief The list of all available storage modes.
642 * This storage mode can be set using --cfg=storage/model:...
644 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
646 /** \ingroup SURF_models
647 * \brief The workstation model
649 * Note that when you create an API on top of SURF,
650 * the workstation model should be the only one you use
651 * because depending on the platform model, the network model and the CPU model
654 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
656 /** \ingroup SURF_models
657 * \brief The vm_workstation model
659 * Note that when you create an API on top of SURF,
660 * the vm_workstation model should be the only one you use
661 * because depending on the platform model, the network model and the CPU model
664 XBT_PUBLIC_DATA(surf_model_t) surf_vm_workstation_model;
666 /** \ingroup SURF_models
667 * \brief Initializes the platform with a compound workstation model
669 * This function should be called after a cpu_model and a
670 * network_model have been set up.
673 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
675 /** \ingroup SURF_models
676 * \brief Initializes the platform with the current best network and cpu models at hand
678 * This platform model seperates the workstation model and the network model.
679 * The workstation model will be initialized with the model compound, the network
680 * model with the model LV08 (with cross traffic support) and the CPU model with
682 * Such model is subject to modification with warning in the ChangeLog so monitor it!
685 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
687 /** \ingroup SURF_models
688 * \brief Initializes the platform with the model KCCFLN05
690 * With this model, only parallel tasks can be used. Resource sharing
691 * is done by identifying bottlenecks and giving an equal share of
692 * the model to each action.
695 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
697 /** \ingroup SURF_models
698 * \brief The list of all available workstation model models
700 XBT_PUBLIC_DATA(s_surf_model_description_t)
701 surf_workstation_model_description[];
703 /*******************************************
704 * TUTORIAL: New model
706 XBT_PUBLIC(void) surf_new_model_init_default(void);
707 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
708 /*******************************************/
710 /** \ingroup SURF_models
711 * \brief List of initialized models
713 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
714 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
716 /*******************************************/
717 /*** SURF Platform *************************/
718 /*******************************************/
719 typedef struct s_as *AS_t;
721 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
722 XBT_PUBLIC_DATA(const char *)surf_AS_get_name(AS_t as);
723 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
726 /*******************************************/
727 /*** SURF Globals **************************/
728 /*******************************************/
730 /** \ingroup SURF_simulation
731 * \brief Initialize SURF
732 * \param argc argument number
733 * \param argv arguments
735 * This function has to be called to initialize the common
736 * structures. Then you will have to create the environment by
738 * e.g. surf_workstation_model_init_CM02()
740 * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
742 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
744 /** \ingroup SURF_simulation
745 * \brief Finish simulation initialization
747 * This function must be called before the first call to surf_solve()
749 XBT_PUBLIC(void) surf_presolve(void);
751 /** \ingroup SURF_simulation
752 * \brief Performs a part of the simulation
753 * \param max_date Maximum date to update the simulation to, or -1
754 * \return the elapsed time, or -1.0 if no event could be executed
756 * This function execute all possible events, update the action states
757 * and returns the time elapsed.
758 * When you call execute or communicate on a model, the corresponding actions
759 * are not executed immediately but only when you call surf_solve.
760 * Note that the returned elapsed time can be zero.
762 XBT_PUBLIC(double) surf_solve(double max_date);
764 /** \ingroup SURF_simulation
765 * \brief Return the current time
767 * Return the current time in millisecond.
769 XBT_PUBLIC(double) surf_get_clock(void);
771 /** \ingroup SURF_simulation
778 XBT_PUBLIC(void) surf_exit(void);
780 /* Prototypes of the functions that handle the properties */
781 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
783 /* surf parse file related (public because called from a test suite) */
784 XBT_PUBLIC(void) parse_platform_file(const char *file);
786 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
787 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
788 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
789 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
790 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
791 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
792 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
795 XBT_PUBLIC(double) get_cpu_power(const char *power);
797 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
799 int surf_get_nthreads(void);
800 void surf_set_nthreads(int nthreads);
802 void surf_watched_hosts(void);
805 * Returns the initial path. On Windows the initial path is
806 * the current directory for the current process in the other
807 * case the function returns "./" that represents the current
808 * directory on Unix/Linux platforms.
810 const char *__surf_get_initial_path(void);
812 /********** Tracing **********/
813 /* from surf_instr.c */
814 void TRACE_surf_action(surf_action_t surf_action, const char *category);
815 void TRACE_surf_alloc(void);
816 void TRACE_surf_release(void);
818 /* instr_routing.c */
819 void instr_routing_define_callbacks (void);
820 void instr_new_variable_type (const char *new_typename, const char *color);
821 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
822 void instr_new_user_state_type (const char *father_type, const char *new_typename);
823 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
824 int instr_platform_traced (void);
825 xbt_graph_t instr_routing_platform_graph (void);
826 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
829 #endif /* _SURF_SURF_H */