Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
025acee757da6e921b89b4051b301af7bc25fd4a
[simgrid.git] / src / include / surf / surf.h
1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef _SURF_SURF_H
8 #define _SURF_SURF_H
9
10 #include "xbt/swag.h"
11 #include "xbt/dynar.h"
12 #include "xbt/dict.h"
13 #include "xbt/graph.h"
14 #include "xbt/misc.h"
15 #include "portable.h"
16 #include "xbt/config.h"
17 #include "surf/datatypes.h"
18 #include "xbt/lib.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/platf_interface.h"
21
22 SG_BEGIN_DECL()
23 /* Actions and models are highly connected structures... */
24
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;
32 #ifdef HAVE_GTNETS
33 extern double sg_gtnets_jitter;
34 extern int sg_gtnets_jitter_seed;
35 #endif
36 extern xbt_dynar_t surf_path;
37
38
39 typedef enum {
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;
45
46 XBT_PUBLIC(e_surf_network_element_type_t)
47   routing_get_network_element_type(const char* name);
48
49 /** @Brief Specify that we use that action */
50 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
51
52 /** @brief Creates a new action.
53  *
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
58  */
59 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
60                                    surf_model_t model, int failed);
61
62 /** \brief Resource model description
63  */
64 typedef struct surf_model_description {
65   const char *name;
66   const char *description;
67   void_f_void_t model_init_preparse;
68 } s_surf_model_description_t, *surf_model_description_t;
69
70 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
71                                        const char *name);
72 XBT_PUBLIC(void) model_help(const char *category,
73                             s_surf_model_description_t * table);
74
75 enum heap_action_type{
76   LATENCY = 100,
77   MAX_DURATION,
78   NORMAL,
79   NOTSET
80 };
81
82 /** \ingroup SURF_actions
83  *  \brief Action structure
84  *
85  *  Never create s_surf_action_t by yourself ! The actions are created
86  *  on the fly when you call execute or communicate on a model.
87  *
88  *  \see e_surf_action_state_t
89  */
90 typedef struct surf_action {
91   s_xbt_swag_hookup_t state_hookup;
92   xbt_swag_t state_set;
93   double cost;                  /**< cost        */
94   double priority;              /**< priority (1.0 by default) */
95   double max_duration;          /**< max_duration (may fluctuate until
96            the task is completed) */
97   double remains;               /**< How much of that cost remains to
98          * be done in the currently running task */
99 #ifdef HAVE_LATENCY_BOUND_TRACKING
100   int latency_limited;               /**< Set to 1 if is limited by latency, 0 otherwise */
101 #endif
102
103   double start;                 /**< start time  */
104   double finish;                /**< finish time : this is modified during the run
105          * and fluctuates until the task is completed */
106   void *data;                   /**< for your convenience */
107   int refcount;
108   surf_model_t model_type;
109 #ifdef HAVE_TRACING
110   char *category;               /**< tracing category for categorized resource utilization monitoring */
111 #endif
112   surf_file_t file;        /**< surf_file_t for storage model */
113   xbt_dict_t ls_dict;
114 } s_surf_action_t;
115
116 typedef struct surf_action_lmm {
117   s_surf_action_t generic_action;
118   lmm_variable_t variable;
119   int suspended;
120   s_xbt_swag_hookup_t action_list_hookup;
121   int index_heap;
122   double last_update;
123   double last_value;
124   enum heap_action_type hat;
125 } s_surf_action_lmm_t, *surf_action_lmm_t;
126
127 /** \ingroup SURF_actions
128  *  \brief Action states
129  *
130  *  Action states.
131  *
132  *  \see surf_action_t, surf_action_state_t
133  */
134 typedef enum {
135   SURF_ACTION_READY = 0,        /**< Ready        */
136   SURF_ACTION_RUNNING,          /**< Running      */
137   SURF_ACTION_FAILED,           /**< Task Failure */
138   SURF_ACTION_DONE,             /**< Completed    */
139   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
140   SURF_ACTION_NOT_IN_THE_SYSTEM
141                                 /**< Not in the system anymore. Why did you ask ? */
142 } e_surf_action_state_t;
143
144 /** \ingroup SURF_actions
145  *  \brief Action state sets
146  *
147  *  This structure contains some sets of actions.
148  *  It provides a fast access to the actions in each state.
149  *
150  *  \see surf_action_t, e_surf_action_state_t
151  */
152 typedef struct surf_action_state {
153   xbt_swag_t ready_action_set;
154                                  /**< Actions in state SURF_ACTION_READY */
155   xbt_swag_t running_action_set;
156                                  /**< Actions in state SURF_ACTION_RUNNING */
157   xbt_swag_t failed_action_set;
158                                  /**< Actions in state SURF_ACTION_FAILED */
159   xbt_swag_t done_action_set;
160                                  /**< Actions in state SURF_ACTION_DONE */
161 } s_surf_action_state_t, *surf_action_state_t;
162
163 /***************************/
164 /* Generic model object */
165 /***************************/
166 typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
167 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
168
169 /*******************************************
170  *  TUTORIAL: New model
171  *  New model extension public
172  *  Public functions specific to a New model.
173  */
174 typedef struct surf_new_model_extension_public {
175   surf_action_t(*fct) ();
176   void* (*create_resource) ();
177 } s_surf_model_extension_new_model_t;
178 /*******************************************/
179
180 /** \ingroup SURF_models
181  *  \brief Private data available on all models
182  */
183 typedef struct surf_model_private *surf_model_private_t;
184
185      /* Cpu model */
186
187      /** \ingroup SURF_models
188       *  \brief CPU model extension public
189       *
190       *  Public functions specific to the CPU model.
191       */
192 typedef struct surf_cpu_model_extension_public {
193   surf_action_t(*execute) (void *cpu, double size);
194   surf_action_t(*sleep) (void *cpu, double duration);
195   e_surf_resource_state_t(*get_state) (void *cpu);
196   double (*get_speed) (void *cpu, double load);
197   double (*get_available_speed) (void *cpu);
198   void (*add_traces) (void);
199 } s_surf_model_extension_cpu_t;
200
201      /* Network model */
202
203      /** \ingroup SURF_models
204       *  \brief Network model extension public
205       *
206       *  Public functions specific to the network model
207       */
208 typedef struct surf_network_model_extension_public {
209   surf_action_t (*communicate) (sg_routing_edge_t src,
210                                 sg_routing_edge_t dst,
211                                 double size, double rate);
212   xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
213   double (*get_link_bandwidth) (const void *link);
214   double (*get_link_latency) (const void *link);
215   int (*link_shared) (const void *link);
216   void (*add_traces) (void);
217 } s_surf_model_extension_network_t;
218
219 /* Storage model */
220
221 /** \ingroup SURF_models
222  *  \brief Storage model extension public
223  *
224  *  Public functions specific to the Storage model.
225  */
226
227 typedef struct surf_storage_model_extension_public {
228   surf_action_t(*open) (void *storage, const char* mount, const char* path, const char* mode);
229   surf_action_t(*close) (void *storage, surf_file_t fd);
230   surf_action_t(*read) (void *storage, void* ptr, double size, size_t nmemb, surf_file_t stream);
231   surf_action_t(*write) (void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
232   surf_action_t(*stat) (void *storage, surf_file_t stream);
233   surf_action_t(*unlink) (void *storage, surf_file_t stream);
234   surf_action_t(*ls) (void *storage, const char *path);
235   surf_action_t(*get_size) (void *storage, surf_file_t stream);
236 } s_surf_model_extension_storage_t;
237
238      /** \ingroup SURF_models
239       *  \brief Workstation model extension public
240       *
241       *  Public functions specific to the workstation model.
242       */
243 typedef struct surf_workstation_model_extension_public {
244   surf_action_t(*execute) (void *workstation, double size);                                /**< Execute a computation amount on a workstation
245                                       and create the corresponding action */
246   surf_action_t(*sleep) (void *workstation, double duration);                              /**< Make a workstation sleep during a given duration */
247   e_surf_resource_state_t(*get_state) (void *workstation);                                      /**< Return the CPU state of a workstation */
248   double (*get_speed) (void *workstation, double load);                                    /**< Return the speed of a workstation */
249   double (*get_available_speed) (void *workstation);                                       /**< Return tha available speed of a workstation */
250    surf_action_t(*communicate) (void *workstation_src,                                     /**< Execute a communication amount between two workstations */
251                                 void *workstation_dst, double size,
252                                 double max_rate);
253    // FIXME: kill next field, which duplicates the routing
254    xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst);                 /**< Get the list of links between two ws */
255
256    surf_action_t(*execute_parallel_task) (int workstation_nb,                              /**< Execute a parallel task on several workstations */
257                                           void **workstation_list,
258                                           double *computation_amount,
259                                           double *communication_amount,
260                                           double rate);
261   double (*get_link_bandwidth) (const void *link);                                         /**< Return the current bandwidth of a network link */
262   double (*get_link_latency) (const void *link);                                           /**< Return the current latency of a network link */
263   surf_action_t(*open) (void *workstation, const char* storage, const char* path, const char* mode);
264   surf_action_t(*close) (void *workstation, surf_file_t fd);
265   surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
266   surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
267   surf_action_t(*stat) (void *workstation, surf_file_t stream);
268   surf_action_t(*unlink) (void *workstation, surf_file_t stream);
269   surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
270   surf_action_t(*get_size) (void *workstation, surf_file_t fd);
271
272   int (*link_shared) (const void *link);
273    xbt_dict_t(*get_properties) (const void *resource);
274   void (*add_traces) (void);
275
276 } s_surf_model_extension_workstation_t;
277
278
279
280
281 /** \ingroup SURF_models
282  *  \brief Model datatype
283  *
284  *  Generic data structure for a model. The workstations,
285  *  the CPUs and the network links are examples of models.
286  */
287 typedef struct surf_model {
288   const char *name;     /**< Name of this model */
289   s_surf_action_state_t states;      /**< Any living action on this model */
290
291    e_surf_action_state_t(*action_state_get) (surf_action_t action);
292                                                                        /**< Return the state of an action */
293   void (*action_state_set) (surf_action_t action,
294                             e_surf_action_state_t state);
295                                                                   /**< Change an action state*/
296
297   double (*action_get_start_time) (surf_action_t action);     /**< Return the start time of an action */
298   double (*action_get_finish_time) (surf_action_t action);     /**< Return the finish time of an action */
299   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. */
300   void (*action_cancel) (surf_action_t action);     /**< Cancel a running action */
301   void (*action_recycle) (surf_action_t action);     /**< Recycle an action */
302   void (*action_data_set) (surf_action_t action, void *data);     /**< Set the user data of an action */
303   void (*suspend) (surf_action_t action);     /**< Suspend an action */
304   void (*resume) (surf_action_t action);     /**< Resume a suspended action */
305   int (*is_suspended) (surf_action_t action);     /**< Return whether an action is suspended */
306   void (*set_max_duration) (surf_action_t action, double duration);     /**< Set the max duration of an action*/
307   void (*set_priority) (surf_action_t action, double priority);     /**< Set the priority of an action */
308 #ifdef HAVE_TRACING
309   void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
310 #endif
311   double (*get_remains) (surf_action_t action);     /**< Get the remains of an action */
312 #ifdef HAVE_LATENCY_BOUND_TRACKING
313   int (*get_latency_limited) (surf_action_t action);     /**< Return 1 if action is limited by latency, 0 otherwise */
314 #endif
315
316   void (*gap_remove) (surf_action_lmm_t action);
317
318   surf_model_private_t model_private;
319
320   union extension {
321     s_surf_model_extension_cpu_t cpu;
322     s_surf_model_extension_network_t network;
323     s_surf_model_extension_storage_t storage;
324     s_surf_model_extension_workstation_t workstation;
325     /*******************************************/
326     /* TUTORIAL: New model                     */
327     s_surf_model_extension_new_model_t new_model;
328     /*******************************************/
329   } extension;
330 } s_surf_model_t;
331
332 surf_model_t surf_model_init(void);
333 void surf_model_exit(surf_model_t model);
334
335 static inline void *surf_cpu_resource_priv(const void *host) {
336   return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
337 }
338 static inline void *surf_workstation_resource_priv(const void *host){
339   return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
340 }
341 static inline void *surf_storage_resource_priv(const void *host){
342   return xbt_lib_get_level((void *)host, SURF_STORAGE_LEVEL);
343 }
344
345 static inline void *surf_cpu_resource_by_name(const char *name) {
346   return xbt_lib_get_elm_or_null(host_lib, name);
347 }
348 static inline void *surf_workstation_resource_by_name(const char *name){
349   return xbt_lib_get_elm_or_null(host_lib, name);
350 }
351 static inline void *surf_storage_resource_by_name(const char *name){
352   return xbt_lib_get_elm_or_null(storage_lib, name);
353 }
354
355 typedef struct surf_resource {
356   surf_model_t model;
357   char *name;
358   xbt_dict_t properties;
359 } s_surf_resource_t, *surf_resource_t;
360
361 /**
362  * Resource which have a metric handled by a maxmin system
363  */
364 typedef struct {
365   double scale;
366   double peak;
367   tmgr_trace_event_t event;
368 } s_surf_metric_t;
369
370 typedef struct surf_resource_lmm {
371   s_surf_resource_t generic_resource;
372   lmm_constraint_t constraint;
373   e_surf_resource_state_t state_current;
374   tmgr_trace_event_t state_event;
375   s_surf_metric_t power;
376 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
377
378 /**************************************/
379 /* Implementations of model object */
380 /**************************************/
381
382
383 /** \ingroup SURF_models
384  *  \brief The CPU model
385  */
386 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
387
388 /** \ingroup SURF_models
389  *  \brief Initializes the CPU model with the model Cas01
390  *
391  *  By default, this model uses the lazy optimization mechanism that
392  *  relies on partial invalidation in LMM and a heap for lazy action update.
393  *  You can change this behavior by setting the cpu/optim configuration
394  *  variable to a different value.
395  *
396  *  You shouldn't have to call it by yourself.
397  */
398 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
399
400 /** \ingroup SURF_models
401  *  \brief Initializes the CPU model with trace integration [Deprecated]
402  *
403  *  You shouldn't have to call it by yourself.
404  */
405 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
406
407 /** \ingroup SURF_models
408  *  \brief The list of all available optimization modes (both for cpu and networks).
409  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
410  */
411 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
412
413 /** \ingroup SURF_models
414  *  \brief The list of all available cpu model models
415  */
416 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
417
418 /**\brief create new host bypass the parser
419  *
420  */
421
422
423 /** \ingroup SURF_models
424  *  \brief The network model
425  *
426  *  When creating a new API on top on SURF, you shouldn't use the
427  *  network model unless you know what you are doing. Only the workstation
428  *  model should be accessed because depending on the platform model,
429  *  the network model can be NULL.
430  */
431 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
432
433 /** \ingroup SURF_models
434  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
435  *
436  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
437  * based on the model 'LV08' and different correction factors depending on the communication
438  * size (< 1KiB, < 64KiB, >= 64KiB).
439  * See comments in the code for more information.
440  *
441  *  \see surf_workstation_model_init_SMPI()
442  */
443 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
444
445 /** \ingroup SURF_models
446  *  \brief Initializes the platform with the network model 'LegrandVelho'
447  *
448  * This model is proposed by Arnaud Legrand and Pedro Velho based on
449  * the results obtained with the GTNets simulator for onelink and
450  * dogbone sharing scenarios. See comments in the code for more information.
451  *
452  *  \see surf_workstation_model_init_LegrandVelho()
453  */
454 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
455
456 /** \ingroup SURF_models
457  *  \brief Initializes the platform with the network model 'Constant'
458  *
459  *  In this model, the communication time between two network cards is
460  *  constant, hence no need for a routing table. This is particularly
461  *  usefull when simulating huge distributed algorithms where
462  *  scalability is really an issue. This function is called in
463  *  conjunction with surf_workstation_model_init_compound.
464  *
465  *  \see surf_workstation_model_init_compound()
466  */
467 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
468
469 /** \ingroup SURF_models
470  *  \brief Initializes the platform with the network model CM02
471  *
472  *  You sould call this function by yourself only if you plan using
473  *  surf_workstation_model_init_compound.
474  *  See comments in the code for more information.
475  */
476 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
477
478 #ifdef HAVE_GTNETS
479 /** \ingroup SURF_models
480  *  \brief Initializes the platform with the network model GTNETS
481  *  \param filename XML platform file name
482  *
483  *  This function is called by surf_workstation_model_init_GTNETS
484  *  or by yourself only if you plan using surf_workstation_model_init_compound
485  *
486  *  \see surf_workstation_model_init_GTNETS()
487  */
488 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
489 #endif
490
491 #ifdef HAVE_NS3
492 /** \ingroup SURF_models
493  *  \brief Initializes the platform with the network model NS3
494  *  \param filename XML platform file name
495  *
496  *  This function is called by surf_workstation_model_init_NS3
497  *  or by yourself only if you plan using surf_workstation_model_init_compound
498  *
499  *  \see surf_workstation_model_init_NS3()
500  */
501 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
502 #endif
503
504 /** \ingroup SURF_models
505  *  \brief Initializes the platform with the network model Reno
506  *  \param filename XML platform file name
507  *
508  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
509  *
510  *  Reference:
511  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
512  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
513  *
514  *  Call this function only if you plan using surf_workstation_model_init_compound.
515  *
516  */
517 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
518
519 /** \ingroup SURF_models
520  *  \brief Initializes the platform with the network model Reno2
521  *  \param filename XML platform file name
522  *
523  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
524  *
525  *  Reference:
526  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
527  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
528  *
529  *  Call this function only if you plan using surf_workstation_model_init_compound.
530  *
531  */
532 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
533
534 /** \ingroup SURF_models
535  *  \brief Initializes the platform with the network model Vegas
536  *  \param filename XML platform file name
537  *
538  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
539  *  to the proportional fairness.
540  *
541  *  Reference:
542  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
543  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
544  *
545  *  Call this function only if you plan using surf_workstation_model_init_compound.
546  *
547  */
548 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
549
550 /** \ingroup SURF_models
551  *  \brief The list of all available network model models
552  */
553 XBT_PUBLIC_DATA(s_surf_model_description_t)
554     surf_network_model_description[];
555
556 /** \ingroup SURF_models
557  *  \brief The storage model
558  */
559 XBT_PUBLIC(void) surf_storage_model_init_default(void);
560
561 /** \ingroup SURF_models
562  *  \brief The list of all available storage modes.
563  *  This storage mode can be set using --cfg=storage/model:...
564  */
565 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
566
567 /** \ingroup SURF_models
568  *  \brief The workstation model
569  *
570  *  Note that when you create an API on top of SURF,
571  *  the workstation model should be the only one you use
572  *  because depending on the platform model, the network model and the CPU model
573  *  may not exist.
574  */
575 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
576
577 /** \ingroup SURF_models
578  *  \brief Initializes the platform with a compound workstation model
579  *
580  *  This function should be called after a cpu_model and a
581  *  network_model have been set up.
582  *
583  */
584 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
585
586 /** \ingroup SURF_models
587  *  \brief Initializes the platform with the current best network and cpu models at hand
588  *
589  *  This platform model seperates the workstation model and the network model.
590  *  The workstation model will be initialized with the model compound, the network
591  *  model with the model LV08 (with cross traffic support) and the CPU model with
592  *  the model Cas01.
593  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
594  *
595  */
596 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
597
598 /** \ingroup SURF_models
599  *  \brief Initializes the platform with the model KCCFLN05
600  *
601  *  With this model, only parallel tasks can be used. Resource sharing
602  *  is done by identifying bottlenecks and giving an equal share of
603  *  the model to each action.
604  *
605  */
606 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
607
608 /** \ingroup SURF_models
609  *  \brief The list of all available workstation model models
610  */
611 XBT_PUBLIC_DATA(s_surf_model_description_t)
612     surf_workstation_model_description[];
613
614 /*******************************************
615  *  TUTORIAL: New model
616  */
617 XBT_PUBLIC(void) surf_new_model_init_default(void);
618 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
619 /*******************************************/
620
621 /** \ingroup SURF_models
622  *  \brief List of initialized models
623  */
624 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
625
626 /*******************************************/
627 /*** SURF Globals **************************/
628 /*******************************************/
629
630 /** \ingroup SURF_simulation
631  *  \brief Initialize SURF
632  *  \param argc argument number
633  *  \param argv arguments
634  *
635  *  This function has to be called to initialize the common
636  *  structures.  Then you will have to create the environment by
637  *  calling 
638  *  e.g. surf_workstation_model_init_CM02()
639  *
640  *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
641  */
642 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
643
644 /** \ingroup SURF_simulation
645  *  \brief Finish simulation initialization
646  *
647  *  This function must be called before the first call to surf_solve()
648  */
649 XBT_PUBLIC(void) surf_presolve(void);
650
651 /** \ingroup SURF_simulation
652  *  \brief Performs a part of the simulation
653  *  \param max_date Maximum date to update the simulation to, or -1
654  *  \return the elapsed time, or -1.0 if no event could be executed
655  *
656  *  This function execute all possible events, update the action states
657  *  and returns the time elapsed.
658  *  When you call execute or communicate on a model, the corresponding actions
659  *  are not executed immediately but only when you call surf_solve.
660  *  Note that the returned elapsed time can be zero.
661  */
662 XBT_PUBLIC(double) surf_solve(double max_date);
663
664 /** \ingroup SURF_simulation
665  *  \brief Return the current time
666  *
667  *  Return the current time in millisecond.
668  */
669 XBT_PUBLIC(double) surf_get_clock(void);
670
671 /** \ingroup SURF_simulation
672  *  \brief Exit SURF
673  *
674  *  Clean everything.
675  *
676  *  \see surf_init()
677  */
678 XBT_PUBLIC(void) surf_exit(void);
679
680 /* Prototypes of the functions that handle the properties */
681 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
682
683 /* surf parse file related (public because called from a test suite) */
684 XBT_PUBLIC(void) parse_platform_file(const char *file);
685
686 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
687 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
688 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
689 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
690 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
691 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
692 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
693
694
695 XBT_PUBLIC(double) get_cpu_power(const char *power);
696
697 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
698
699 int surf_get_nthreads(void);
700 void surf_set_nthreads(int nthreads);
701
702 void surf_watched_hosts(void);
703
704 /*
705  * Returns the initial path. On Windows the initial path is
706  * the current directory for the current process in the other
707  * case the function returns "./" that represents the current
708  * directory on Unix/Linux platforms.
709  */
710 const char *__surf_get_initial_path(void);
711
712 /********** Tracing **********/
713 /* from surf_instr.c */
714 void TRACE_surf_action(surf_action_t surf_action, const char *category);
715 void TRACE_surf_alloc(void);
716 void TRACE_surf_release(void);
717
718 /* instr_routing.c */
719 void instr_routing_define_callbacks (void);
720 void instr_new_variable_type (const char *new_typename, const char *color);
721 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
722 void instr_new_user_state_type (const char *father_type, const char *new_typename);
723 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
724 int instr_platform_traced (void);
725 xbt_graph_t instr_routing_platform_graph (void);
726 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
727
728 SG_END_DECL()
729 #endif                          /* _SURF_SURF_H */