1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "xbt/dynar.h"
13 #include "xbt/graph.h"
15 #include "xbt/file_stat.h"
17 #include "xbt/config.h"
18 #include "surf/datatypes.h"
20 #include "surf/surf_routing.h"
21 #include "simgrid/platf_interface.h"
24 /* Actions and models are highly connected structures... */
26 /* user-visible parameters */
27 extern double sg_tcp_gamma;
28 extern double sg_sender_gap;
29 extern double sg_latency_factor;
30 extern double sg_bandwidth_factor;
31 extern double sg_weight_S_parameter;
32 extern int sg_maxmin_selective_update;
33 extern int sg_network_crosstraffic;
35 extern double sg_gtnets_jitter;
36 extern int sg_gtnets_jitter_seed;
38 extern xbt_dynar_t surf_path;
42 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
43 SURF_NETWORK_ELEMENT_HOST, /* host type */
44 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
45 SURF_NETWORK_ELEMENT_AS /* AS type */
46 } e_surf_network_element_type_t;
48 XBT_PUBLIC(e_surf_network_element_type_t)
49 routing_get_network_element_type(const char* name);
51 /** @Brief Specify that we use that action */
52 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
54 /** @brief Creates a new action.
56 * @param size The size is the one of the subtype you want to create
57 * @param cost initial value
58 * @param model to which model we should attach this action
59 * @param failed whether we should start this action in failed mode
61 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
62 surf_model_t model, int failed);
64 /** \brief Resource model description
66 typedef struct surf_model_description {
68 const char *description;
69 void_f_void_t model_init_preparse;
70 } s_surf_model_description_t, *surf_model_description_t;
72 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
74 XBT_PUBLIC(void) model_help(const char *category,
75 s_surf_model_description_t * table);
77 enum heap_action_type{
85 typedef struct surf_resource {
88 xbt_dict_t properties;
89 } s_surf_resource_t, *surf_resource_t;
91 /** \ingroup SURF_actions
92 * \brief Action structure
94 * Never create s_surf_action_t by yourself ! The actions are created
95 * on the fly when you call execute or communicate on a model.
97 * \see e_surf_action_state_t
99 typedef struct surf_action {
100 s_xbt_swag_hookup_t state_hookup;
101 xbt_swag_t state_set;
102 double cost; /**< cost */
103 double priority; /**< priority (1.0 by default) */
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 } s_surf_model_extension_workstation_t;
294 typedef struct surf_vm_workstation_model_extension_public {
295 /* The vm workstation model object has all members of the physical machine
296 * workstation model object. If these members are correctly initialized also
297 * in the vm workstation model object, we can access the vm workstation model
298 * object as if it is the pm workstatoin model object.
300 * But, it's not so clean. Think it again later.
302 s_surf_model_extension_workstation_t basic;
304 void (*create) (const char *name, void *ind_phys_workstation); // First operation of the VM model
305 // start does not appear here as it corresponds to turn the state from created to running (see smx_vm.c)
306 int (*get_state) (void *ind_vm_workstation);
307 void (*set_state) (void *ind_vms_workstation, int state);
308 void (*migrate) (void *ind_vm_workstation, void *ind_dest_phys_workstation); // will be vm_ws_migrate()
309 const char * (*get_phys_host) (void *ind_vm_workstation); // will be vm_ws_get_phys_host()
310 void (*destroy) (void *ind_vm_workstation); // will be vm_ws_destroy(), which destroies the vm-workstation-specific data
311 } s_surf_model_extension_vm_workstation_t;
313 /** \ingroup SURF_models
316 * The type of the model object. For example, we will have two model objects
317 * of the surf cpu model. One is for physical machines, and the other is for
322 SURF_MODEL_TYPE_CPU = 0,
323 SURF_MODEL_TYPE_NETWORK,
324 SURF_MODEL_TYPE_STORAGE,
325 SURF_MODEL_TYPE_WORKSTATION,
326 SURF_MODEL_TYPE_VM_WORKSTATION,
327 SURF_MODEL_TYPE_NEW_MODEL
328 } e_surf_model_type_t;
330 /** \ingroup SURF_models
331 * \brief Model datatype
333 * Generic data structure for a model. The workstations,
334 * the CPUs and the network links are examples of models.
336 typedef struct surf_model {
337 const char *name; /**< Name of this model */
338 s_surf_action_state_t states; /**< Any living action on this model */
340 e_surf_model_type_t type; /**< See e_surf_model_type_t */
342 e_surf_action_state_t(*action_state_get) (surf_action_t action);
343 /**< Return the state of an action */
344 void (*action_state_set) (surf_action_t action,
345 e_surf_action_state_t state);
346 /**< Change an action state*/
348 double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
349 double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
350 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. */
351 void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
352 void (*action_recycle) (surf_action_t action); /**< Recycle an action */
353 void (*action_data_set) (surf_action_t action, void *data); /**< Set the user data of an action */
354 void (*suspend) (surf_action_t action); /**< Suspend an action */
355 void (*resume) (surf_action_t action); /**< Resume a suspended action */
356 int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
357 void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
358 void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
360 void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
362 double (*get_remains) (surf_action_t action); /**< Get the remains of an action */
363 #ifdef HAVE_LATENCY_BOUND_TRACKING
364 int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */
367 void (*gap_remove) (surf_action_lmm_t action);
369 surf_model_private_t model_private;
372 s_surf_model_extension_cpu_t cpu;
373 s_surf_model_extension_network_t network;
374 s_surf_model_extension_storage_t storage;
375 s_surf_model_extension_workstation_t workstation;
376 // TODO Implement the corresponding model
377 s_surf_model_extension_vm_workstation_t vm_workstation;
378 /*******************************************/
379 /* TUTORIAL: New model */
380 s_surf_model_extension_new_model_t new_model;
381 /*******************************************/
385 surf_model_t surf_model_init(void);
386 void surf_model_exit(surf_model_t model);
388 static inline void *surf_cpu_resource_priv(const void *host) {
389 return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
391 static inline void *surf_workstation_resource_priv(const void *host){
392 return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
394 static inline void *surf_storage_resource_priv(const void *host){
395 return xbt_lib_get_level((void *)host, SURF_STORAGE_LEVEL);
398 static inline void *surf_cpu_resource_by_name(const char *name) {
399 return xbt_lib_get_elm_or_null(host_lib, name);
401 static inline void *surf_workstation_resource_by_name(const char *name){
402 return xbt_lib_get_elm_or_null(host_lib, name);
404 static inline void *surf_storage_resource_by_name(const char *name){
405 return xbt_lib_get_elm_or_null(storage_lib, name);
408 static inline surf_model_t surf_resource_model(const void *host, int level) {
409 /* If level is SURF_WKS_LEVEL, ws is a workstation_CLM03 object. It has
410 * surf_resource at the generic_resource field. */
411 surf_resource_t ws = xbt_lib_get_level((void *) host, level);
418 * Resource which have a metric handled by a maxmin system
423 tmgr_trace_event_t event;
426 typedef struct surf_resource_lmm {
427 s_surf_resource_t generic_resource;
428 lmm_constraint_t constraint;
429 e_surf_resource_state_t state_current;
430 tmgr_trace_event_t state_event;
431 s_surf_metric_t power;
432 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
434 /**************************************/
435 /* Implementations of model object */
436 /**************************************/
439 /** \ingroup SURF_models
440 * \brief The CPU model object for the physical machine layer
442 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_pm;
444 /** \ingroup SURF_models
445 * \brief The CPU model object for the virtual machine layer
447 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_vm;
449 /** \ingroup SURF_models
450 * \brief Initializes the CPU model with the model Cas01
452 * By default, this model uses the lazy optimization mechanism that
453 * relies on partial invalidation in LMM and a heap for lazy action update.
454 * You can change this behavior by setting the cpu/optim configuration
455 * variable to a different value.
457 * This function is called by surf_workstation_model_init_CLM03
458 * so you shouldn't have to call it by yourself.
460 * \see surf_workstation_model_init_CLM03()
462 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
464 /** \ingroup SURF_models
465 * \brief Initializes the CPU model with trace integration [Deprecated]
467 * You shouldn't have to call it by yourself.
468 * \see surf_workstation_model_init_CLM03()
470 XBT_PUBLIC(surf_model_t) surf_cpu_model_init_ti(void);
472 /** \brief This function call the share resources function needed
475 XBT_PUBLIC(double) generic_share_resources(double now);
477 /** \brief This function call the update action state function needed
480 XBT_PUBLIC(void) generic_update_actions_state(double now, double delta);
482 /** \ingroup SURF_models
483 * \brief The list of all available optimization modes (both for cpu and networks).
484 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
486 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
488 /** \ingroup SURF_models
489 * \brief The list of all available cpu model models
491 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
493 XBT_PUBLIC(void) create_workstations(void);
495 /**\brief create new host bypass the parser
500 /** \ingroup SURF_models
501 * \brief The network model
503 * When creating a new API on top on SURF, you shouldn't use the
504 * network model unless you know what you are doing. Only the workstation
505 * model should be accessed because depending on the platform model,
506 * the network model can be NULL.
508 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
510 /** \ingroup SURF_models
511 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
513 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
514 * based on the model 'LV08' and different correction factors depending on the communication
515 * size (< 1KiB, < 64KiB, >= 64KiB).
516 * See comments in the code for more information.
518 * \see surf_workstation_model_init_SMPI()
520 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
522 /** \ingroup SURF_models
523 * \brief Initializes the platform with the network model 'LegrandVelho'
525 * This model is proposed by Arnaud Legrand and Pedro Velho based on
526 * the results obtained with the GTNets simulator for onelink and
527 * dogbone sharing scenarios. See comments in the code for more information.
529 * \see surf_workstation_model_init_LegrandVelho()
531 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
533 /** \ingroup SURF_models
534 * \brief Initializes the platform with the network model 'Constant'
536 * In this model, the communication time between two network cards is
537 * constant, hence no need for a routing table. This is particularly
538 * usefull when simulating huge distributed algorithms where
539 * scalability is really an issue. This function is called in
540 * conjunction with surf_workstation_model_init_compound.
542 * \see surf_workstation_model_init_compound()
544 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
546 /** \ingroup SURF_models
547 * \brief Initializes the platform with the network model CM02
549 * This function is called by surf_workstation_model_init_CLM03
550 * or by yourself only if you plan using surf_workstation_model_init_compound
551 * See comments in the code for more information.
553 * \see surf_workstation_model_init_CLM03()
555 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
558 * brief initialize the the network model bypassing the XML parser
560 XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
565 /** \ingroup SURF_models
566 * \brief Initializes the platform with the network model GTNETS
567 * \param filename XML platform file name
569 * This function is called by surf_workstation_model_init_GTNETS
570 * or by yourself only if you plan using surf_workstation_model_init_compound
572 * \see surf_workstation_model_init_GTNETS()
574 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
578 /** \ingroup SURF_models
579 * \brief Initializes the platform with the network model NS3
580 * \param filename XML platform file name
582 * This function is called by surf_workstation_model_init_NS3
583 * or by yourself only if you plan using surf_workstation_model_init_compound
585 * \see surf_workstation_model_init_NS3()
587 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
590 /** \ingroup SURF_models
591 * \brief Initializes the platform with the network model Reno
592 * \param filename XML platform file name
594 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
597 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
598 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
600 * Call this function only if you plan using surf_workstation_model_init_compound.
603 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
605 /** \ingroup SURF_models
606 * \brief Initializes the platform with the network model Reno2
607 * \param filename XML platform file name
609 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
612 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
613 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
615 * Call this function only if you plan using surf_workstation_model_init_compound.
618 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
620 /** \ingroup SURF_models
621 * \brief Initializes the platform with the network model Vegas
622 * \param filename XML platform file name
624 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
625 * to the proportional fairness.
628 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
629 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
631 * Call this function only if you plan using surf_workstation_model_init_compound.
634 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
636 /** \ingroup SURF_models
637 * \brief The list of all available network model models
639 XBT_PUBLIC_DATA(s_surf_model_description_t)
640 surf_network_model_description[];
642 /** \ingroup SURF_models
643 * \brief The storage model
645 XBT_PUBLIC(void) surf_storage_model_init_default(void);
647 /** \ingroup SURF_models
648 * \brief The list of all available storage modes.
649 * This storage mode can be set using --cfg=storage/model:...
651 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
653 /** \ingroup SURF_models
654 * \brief The workstation model
656 * Note that when you create an API on top of SURF,
657 * the workstation model should be the only one you use
658 * because depending on the platform model, the network model and the CPU model
661 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
663 /** \ingroup SURF_models
664 * \brief The vm_workstation model
666 * Note that when you create an API on top of SURF,
667 * the vm_workstation model should be the only one you use
668 * because depending on the platform model, the network model and the CPU model
671 XBT_PUBLIC_DATA(surf_model_t) surf_vm_workstation_model;
673 /** \ingroup SURF_models
674 * \brief Initializes the platform with a compound workstation model
676 * This function should be called after a cpu_model and a
677 * network_model have been set up.
680 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
682 /** \ingroup SURF_models
683 * \brief Initializes the platform with the current best network and cpu models at hand
685 * This platform model seperates the workstation model and the network model.
686 * The workstation model will be initialized with the model compound, the network
687 * model with the model LV08 (with cross traffic support) and the CPU model with
689 * Such model is subject to modification with warning in the ChangeLog so monitor it!
692 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
694 /** \ingroup SURF_models
695 * \brief Initializes the platform with the workstation model CLM03
697 * This platform model seperates the workstation model and the network model.
698 * The workstation model will be initialized with the model CLM03, the network
699 * model with the model CM02 and the CPU model with the model Cas01.
700 * In future releases, some other network models will be implemented and will be
701 * combined with the workstation model CLM03.
704 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
706 /** \ingroup SURF_models
707 * \brief Initializes the platform with the model KCCFLN05
709 * With this model, only parallel tasks can be used. Resource sharing
710 * is done by identifying bottlenecks and giving an equal share of
711 * the model to each action.
714 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
716 /** \ingroup SURF_models
717 * \brief The list of all available workstation model models
719 XBT_PUBLIC_DATA(s_surf_model_description_t)
720 surf_workstation_model_description[];
722 /*******************************************
723 * TUTORIAL: New model
725 XBT_PUBLIC(void) surf_new_model_init_default(void);
726 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
727 /*******************************************/
729 /** \ingroup SURF_models
730 * \brief List of initialized models
732 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
733 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
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_CLM03()
749 * \see surf_workstation_model_init_CLM03(), 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) */
791 XBT_PUBLIC(void) parse_properties(void);
793 /* surf parse file related (public because called from a test suite) */
794 XBT_PUBLIC(void) parse_platform_file(const char *file);
796 /* Stores the sets */
797 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
799 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
800 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
801 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
802 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
803 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
804 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
805 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
808 XBT_PUBLIC(double) get_cpu_power(const char *power);
810 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
812 int surf_get_nthreads(void);
813 void surf_set_nthreads(int nthreads);
815 void surf_watched_hosts(void);
818 * Returns the initial path. On Windows the initial path is
819 * the current directory for the current process in the other
820 * case the function returns "./" that represents the current
821 * directory on Unix/Linux platforms.
823 const char *__surf_get_initial_path(void);
825 /********** Tracing **********/
826 /* from surf_instr.c */
827 void TRACE_surf_action(surf_action_t surf_action, const char *category);
828 void TRACE_surf_alloc(void);
829 void TRACE_surf_release(void);
831 /* instr_routing.c */
832 void instr_routing_define_callbacks (void);
833 void instr_new_variable_type (const char *new_typename, const char *color);
834 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
835 void instr_new_user_state_type (const char *father_type, const char *new_typename);
836 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
837 int instr_platform_traced (void);
838 xbt_graph_t instr_routing_platform_graph (void);
839 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
842 #endif /* _SURF_SURF_H */