Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Change parameters order for msg_file_read, msg_file_write and in all their internal...
[simgrid.git] / src / include / surf / surf.h
1 /* Copyright (c) 2004-2013. 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   int (*get_core) (void *cpu);
197   double (*get_speed) (void *cpu, double load);
198   double (*get_available_speed) (void *cpu);
199   double (*get_current_power_peak) (void *cpu);
200   double (*get_power_peak_at) (void *cpu, int pstate_index);
201   int (*get_nb_pstates) (void *cpu);
202   void (*set_power_peak_at) (void *cpu, int pstate_index);
203   double (*get_consumed_energy) (void *cpu);
204   void (*add_traces) (void);
205 } s_surf_model_extension_cpu_t;
206
207      /* Network model */
208
209      /** \ingroup SURF_models
210       *  \brief Network model extension public
211       *
212       *  Public functions specific to the network model
213       */
214 typedef struct surf_network_model_extension_public {
215   surf_action_t (*communicate) (sg_routing_edge_t src,
216                                 sg_routing_edge_t dst,
217                                 double size, double rate);
218   xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
219   double (*get_link_bandwidth) (const void *link);
220   double (*get_link_latency) (const void *link);
221   int (*link_shared) (const void *link);
222   void (*add_traces) (void);
223 } s_surf_model_extension_network_t;
224
225 /* Storage model */
226
227 /** \ingroup SURF_models
228  *  \brief Storage model extension public
229  *
230  *  Public functions specific to the Storage model.
231  */
232
233 typedef struct surf_storage_model_extension_public {
234   surf_action_t(*open) (void *storage, const char* mount, const char* path);
235   surf_action_t(*close) (void *storage, surf_file_t fd);
236   surf_action_t(*read) (void *storage, surf_file_t fd, sg_storage_size_t size);
237   surf_action_t(*write) (void *storage, surf_file_t fd, sg_storage_size_t size);
238   surf_action_t(*stat) (void *storage, surf_file_t fd);
239   surf_action_t(*ls) (void *storage, const char *path);
240   xbt_dict_t(*get_properties) (const void *storage);
241   xbt_dict_t(*get_content) (void *storage);
242 } s_surf_model_extension_storage_t;
243
244      /** \ingroup SURF_models
245       *  \brief Workstation model extension public
246       *
247       *  Public functions specific to the workstation model.
248       */
249 typedef struct surf_workstation_model_extension_public {
250   surf_action_t(*execute) (void *workstation, double size);                                /**< Execute a computation amount on a workstation
251                                       and create the corresponding action */
252   surf_action_t(*sleep) (void *workstation, double duration);                              /**< Make a workstation sleep during a given duration */
253   e_surf_resource_state_t(*get_state) (void *workstation);                                      /**< Return the CPU state of a workstation */
254
255   int (*get_core) (void *workstation); 
256   double (*get_speed) (void *workstation, double load);                                    /**< Return the speed of a workstation */
257   double (*get_available_speed) (void *workstation);                                       /**< Return tha available speed of a workstation */
258
259   double (*get_current_power_peak) (void *workstation);                                   /**< Return the current CPU speed of a workstation */
260   double (*get_power_peak_at) (void *workstation, int pstate_index);                      /**< Return the speed of a workstation for a specific pstate,
261                                                                                                  (where higher pstate values represent lower processor speeds) */
262   int (*get_nb_pstates) (void *workstation);                                              /**< Return the number of pstates defined for a workstation (default is 1) */
263   void (*set_power_peak_at) (void *workstation, int pstate_index);                        /**< Set the processor speed of a workstation to the speed associated with the pstate_index pstate */
264   double (*get_consumed_energy) (void *workstation);                                      /**< Return the total energy consumed by a workstation */
265
266    surf_action_t(*communicate) (void *workstation_src,                                     /**< Execute a communication amount between two workstations */
267                                 void *workstation_dst, double size,
268                                 double max_rate);
269    // FIXME: kill next field, which duplicates the routing
270    xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst);                 /**< Get the list of links between two ws */
271
272    surf_action_t(*execute_parallel_task) (int workstation_nb,                              /**< Execute a parallel task on several workstations */
273                                           void **workstation_list,
274                                           double *computation_amount,
275                                           double *communication_amount,
276                                           double rate);
277   double (*get_link_bandwidth) (const void *link);                                         /**< Return the current bandwidth of a network link */
278   double (*get_link_latency) (const void *link);                                           /**< Return the current latency of a network link */
279   surf_action_t(*open) (void *workstation, const char* storage,
280                         const char* path);
281   surf_action_t(*close) (void *workstation, surf_file_t fd);
282   surf_action_t(*read) (void *workstation, surf_file_t fd, sg_storage_size_t size);
283   surf_action_t(*write) (void *workstation, surf_file_t fd, sg_storage_size_t size);
284   surf_action_t(*stat) (void *workstation, surf_file_t fd);
285   int(*unlink) (void *workstation, surf_file_t fd);
286   surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
287   sg_storage_size_t (*get_size) (void *workstation, surf_file_t fd);
288   xbt_dynar_t (*get_info) (void *workstation, surf_file_t fd);
289
290   int (*link_shared) (const void *link);
291   xbt_dict_t(*get_properties) (const void *resource);
292   void (*add_traces) (void);
293
294   sg_storage_size_t (*get_free_size) (void *workstation,const char* name);
295   sg_storage_size_t (*get_used_size) (void *workstation,const char* name);
296   xbt_dict_t (*get_storage_list) (void *workstation);
297
298 } s_surf_model_extension_workstation_t;
299
300
301
302
303 /** \ingroup SURF_models
304  *  \brief Model datatype
305  *
306  *  Generic data structure for a model. The workstations,
307  *  the CPUs and the network links are examples of models.
308  */
309 typedef struct surf_model {
310   const char *name;     /**< Name of this model */
311   s_surf_action_state_t states;      /**< Any living action on this model */
312
313    e_surf_action_state_t(*action_state_get) (surf_action_t action);
314                                                                        /**< Return the state of an action */
315   void (*action_state_set) (surf_action_t action,
316                             e_surf_action_state_t state);
317                                                                   /**< Change an action state*/
318
319   double (*action_get_start_time) (surf_action_t action);     /**< Return the start time of an action */
320   double (*action_get_finish_time) (surf_action_t action);     /**< Return the finish time of an action */
321   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. */
322   void (*action_cancel) (surf_action_t action);     /**< Cancel a running action */
323   void (*action_recycle) (surf_action_t action);     /**< Recycle an action */
324   void (*action_data_set) (surf_action_t action, void *data);     /**< Set the user data of an action */
325   void (*suspend) (surf_action_t action);     /**< Suspend an action */
326   void (*resume) (surf_action_t action);     /**< Resume a suspended action */
327   int (*is_suspended) (surf_action_t action);     /**< Return whether an action is suspended */
328   void (*set_max_duration) (surf_action_t action, double duration);     /**< Set the max duration of an action*/
329   void (*set_priority) (surf_action_t action, double priority);     /**< Set the priority of an action */
330 #ifdef HAVE_TRACING
331   void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
332 #endif
333   double (*get_remains) (surf_action_t action);     /**< Get the remains of an action */
334 #ifdef HAVE_LATENCY_BOUND_TRACKING
335   int (*get_latency_limited) (surf_action_t action);     /**< Return 1 if action is limited by latency, 0 otherwise */
336 #endif
337
338   void (*gap_remove) (surf_action_lmm_t action);
339
340   surf_model_private_t model_private;
341
342   union extension {
343     s_surf_model_extension_cpu_t cpu;
344     s_surf_model_extension_network_t network;
345     s_surf_model_extension_storage_t storage;
346     s_surf_model_extension_workstation_t workstation;
347     /*******************************************/
348     /* TUTORIAL: New model                     */
349     s_surf_model_extension_new_model_t new_model;
350     /*******************************************/
351   } extension;
352 } s_surf_model_t;
353
354 surf_model_t surf_model_init(void);
355 void surf_model_exit(surf_model_t model);
356
357 static inline void *surf_cpu_resource_priv(const void *host) {
358   return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
359 }
360 static inline void *surf_workstation_resource_priv(const void *host){
361   return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
362 }
363 static inline void *surf_storage_resource_priv(const void *storage){
364   return xbt_lib_get_level((void *)storage, SURF_STORAGE_LEVEL);
365 }
366
367 static inline void *surf_cpu_resource_by_name(const char *name) {
368   return xbt_lib_get_elm_or_null(host_lib, name);
369 }
370 static inline void *surf_workstation_resource_by_name(const char *name){
371   return xbt_lib_get_elm_or_null(host_lib, name);
372 }
373 static inline void *surf_storage_resource_by_name(const char *name){
374   return xbt_lib_get_elm_or_null(storage_lib, name);
375 }
376
377 typedef struct surf_resource {
378   surf_model_t model;
379   char *name;
380   xbt_dict_t properties;
381   void_f_pvoid_t free_f;
382 } s_surf_resource_t, *surf_resource_t;
383
384 /**
385  * Resource which have a metric handled by a maxmin system
386  */
387 typedef struct {
388   double scale;
389   double peak;
390   tmgr_trace_event_t event;
391 } s_surf_metric_t;
392
393 typedef struct surf_resource_lmm {
394   s_surf_resource_t generic_resource;
395   lmm_constraint_t constraint;
396   e_surf_resource_state_t state_current;
397   tmgr_trace_event_t state_event;
398   s_surf_metric_t power;
399 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
400
401 /**************************************/
402 /* Implementations of model object */
403 /**************************************/
404
405
406 /** \ingroup SURF_models
407  *  \brief The CPU model
408  */
409 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
410
411 /** \ingroup SURF_models
412  *  \brief Initializes the CPU model with the model Cas01
413  *
414  *  By default, this model uses the lazy optimization mechanism that
415  *  relies on partial invalidation in LMM and a heap for lazy action update.
416  *  You can change this behavior by setting the cpu/optim configuration
417  *  variable to a different value.
418  *
419  *  You shouldn't have to call it by yourself.
420  */
421 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
422
423 /** \ingroup SURF_models
424  *  \brief Initializes the CPU model with trace integration [Deprecated]
425  *
426  *  You shouldn't have to call it by yourself.
427  */
428 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
429
430 /** \ingroup SURF_models
431  *  \brief The list of all available optimization modes (both for cpu and networks).
432  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
433  */
434 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
435
436 /** \ingroup SURF_models
437  *  \brief The list of all available cpu model models
438  */
439 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
440
441 /**\brief create new host bypass the parser
442  *
443  */
444
445
446 /** \ingroup SURF_models
447  *  \brief The network model
448  *
449  *  When creating a new API on top on SURF, you shouldn't use the
450  *  network model unless you know what you are doing. Only the workstation
451  *  model should be accessed because depending on the platform model,
452  *  the network model can be NULL.
453  */
454 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
455
456 /** \ingroup SURF_models
457  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
458  *
459  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
460  * based on the model 'LV08' and different correction factors depending on the communication
461  * size (< 1KiB, < 64KiB, >= 64KiB).
462  * See comments in the code for more information.
463  *
464  *  \see surf_workstation_model_init_SMPI()
465  */
466 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
467
468 /** \ingroup SURF_models
469  *  \brief Initializes the platform with the network model 'LegrandVelho'
470  *
471  * This model is proposed by Arnaud Legrand and Pedro Velho based on
472  * the results obtained with the GTNets simulator for onelink and
473  * dogbone sharing scenarios. See comments in the code for more information.
474  *
475  *  \see surf_workstation_model_init_LegrandVelho()
476  */
477 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
478
479 /** \ingroup SURF_models
480  *  \brief Initializes the platform with the network model 'Constant'
481  *
482  *  In this model, the communication time between two network cards is
483  *  constant, hence no need for a routing table. This is particularly
484  *  usefull when simulating huge distributed algorithms where
485  *  scalability is really an issue. This function is called in
486  *  conjunction with surf_workstation_model_init_compound.
487  *
488  *  \see surf_workstation_model_init_compound()
489  */
490 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
491
492 /** \ingroup SURF_models
493  *  \brief Initializes the platform with the network model CM02
494  *
495  *  You sould call this function by yourself only if you plan using
496  *  surf_workstation_model_init_compound.
497  *  See comments in the code for more information.
498  */
499 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
500
501 #ifdef HAVE_GTNETS
502 /** \ingroup SURF_models
503  *  \brief Initializes the platform with the network model GTNETS
504  *  \param filename XML platform file name
505  *
506  *  This function is called by surf_workstation_model_init_GTNETS
507  *  or by yourself only if you plan using surf_workstation_model_init_compound
508  *
509  *  \see surf_workstation_model_init_GTNETS()
510  */
511 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
512 #endif
513
514 #ifdef HAVE_NS3
515 /** \ingroup SURF_models
516  *  \brief Initializes the platform with the network model NS3
517  *  \param filename XML platform file name
518  *
519  *  This function is called by surf_workstation_model_init_NS3
520  *  or by yourself only if you plan using surf_workstation_model_init_compound
521  *
522  *  \see surf_workstation_model_init_NS3()
523  */
524 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
525 #endif
526
527 /** \ingroup SURF_models
528  *  \brief Initializes the platform with the network model Reno
529  *  \param filename XML platform file name
530  *
531  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
532  *
533  *  Reference:
534  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
535  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
536  *
537  *  Call this function only if you plan using surf_workstation_model_init_compound.
538  *
539  */
540 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
541
542 /** \ingroup SURF_models
543  *  \brief Initializes the platform with the network model Reno2
544  *  \param filename XML platform file name
545  *
546  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
547  *
548  *  Reference:
549  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
550  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
551  *
552  *  Call this function only if you plan using surf_workstation_model_init_compound.
553  *
554  */
555 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
556
557 /** \ingroup SURF_models
558  *  \brief Initializes the platform with the network model Vegas
559  *  \param filename XML platform file name
560  *
561  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
562  *  to the proportional fairness.
563  *
564  *  Reference:
565  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
566  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
567  *
568  *  Call this function only if you plan using surf_workstation_model_init_compound.
569  *
570  */
571 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
572
573 /** \ingroup SURF_models
574  *  \brief The list of all available network model models
575  */
576 XBT_PUBLIC_DATA(s_surf_model_description_t)
577     surf_network_model_description[];
578
579 /** \ingroup SURF_models
580  *  \brief The storage model
581  */
582 XBT_PUBLIC(void) surf_storage_model_init_default(void);
583
584 /** \ingroup SURF_models
585  *  \brief The list of all available storage modes.
586  *  This storage mode can be set using --cfg=storage/model:...
587  */
588 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
589
590 XBT_PUBLIC_DATA(surf_model_t) surf_storage_model;
591
592 /** \ingroup SURF_models
593  *  \brief The workstation model
594  *
595  *  Note that when you create an API on top of SURF,
596  *  the workstation model should be the only one you use
597  *  because depending on the platform model, the network model and the CPU model
598  *  may not exist.
599  */
600 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
601
602 /** \ingroup SURF_models
603  *  \brief Initializes the platform with a compound workstation model
604  *
605  *  This function should be called after a cpu_model and a
606  *  network_model have been set up.
607  *
608  */
609 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
610
611 /** \ingroup SURF_models
612  *  \brief Initializes the platform with the current best network and cpu models at hand
613  *
614  *  This platform model seperates the workstation model and the network model.
615  *  The workstation model will be initialized with the model compound, the network
616  *  model with the model LV08 (with cross traffic support) and the CPU model with
617  *  the model Cas01.
618  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
619  *
620  */
621 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
622
623 /** \ingroup SURF_models
624  *  \brief Initializes the platform with the model KCCFLN05
625  *
626  *  With this model, only parallel tasks can be used. Resource sharing
627  *  is done by identifying bottlenecks and giving an equal share of
628  *  the model to each action.
629  *
630  */
631 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
632
633 /** \ingroup SURF_models
634  *  \brief The list of all available workstation model models
635  */
636 XBT_PUBLIC_DATA(s_surf_model_description_t)
637     surf_workstation_model_description[];
638
639 /*******************************************
640  *  TUTORIAL: New model
641  */
642 XBT_PUBLIC(void) surf_new_model_init_default(void);
643 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
644 /*******************************************/
645
646 /** \ingroup SURF_models
647  *  \brief List of initialized models
648  */
649 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
650
651 /** \ingroup SURF_simulation
652  *  \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
653  */
654 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
655
656 /** \ingroup SURF_simulation
657  *  \brief List of hosts for which one want to be notified if they ever restart.
658  */
659 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
660
661 /*******************************************/
662 /*** SURF Platform *************************/
663 /*******************************************/
664 typedef struct s_as *AS_t;
665
666 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void); 
667 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
668 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
669 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
670 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
671
672 /*******************************************/
673 /*** SURF Globals **************************/
674 /*******************************************/
675
676 /** \ingroup SURF_simulation
677  *  \brief Initialize SURF
678  *  \param argc argument number
679  *  \param argv arguments
680  *
681  *  This function has to be called to initialize the common
682  *  structures.  Then you will have to create the environment by
683  *  calling 
684  *  e.g. surf_workstation_model_init_CM02()
685  *
686  *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
687  */
688 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
689
690 /** \ingroup SURF_simulation
691  *  \brief Finish simulation initialization
692  *
693  *  This function must be called before the first call to surf_solve()
694  */
695 XBT_PUBLIC(void) surf_presolve(void);
696
697 /** \ingroup SURF_simulation
698  *  \brief Performs a part of the simulation
699  *  \param max_date Maximum date to update the simulation to, or -1
700  *  \return the elapsed time, or -1.0 if no event could be executed
701  *
702  *  This function execute all possible events, update the action states
703  *  and returns the time elapsed.
704  *  When you call execute or communicate on a model, the corresponding actions
705  *  are not executed immediately but only when you call surf_solve.
706  *  Note that the returned elapsed time can be zero.
707  */
708 XBT_PUBLIC(double) surf_solve(double max_date);
709
710 /** \ingroup SURF_simulation
711  *  \brief Return the current time
712  *
713  *  Return the current time in millisecond.
714  */
715 XBT_PUBLIC(double) surf_get_clock(void);
716
717 /** \ingroup SURF_simulation
718  *  \brief Exit SURF
719  *
720  *  Clean everything.
721  *
722  *  \see surf_init()
723  */
724 XBT_PUBLIC(void) surf_exit(void);
725
726 /* Prototypes of the functions that handle the properties */
727 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
728
729 /* surf parse file related (public because called from a test suite) */
730 XBT_PUBLIC(void) parse_platform_file(const char *file);
731
732 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
733 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
734 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
735 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
736 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
737 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
738 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
739
740
741 XBT_PUBLIC(double) get_cpu_power(const char *power);
742
743 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
744
745 int surf_get_nthreads(void);
746 void surf_set_nthreads(int nthreads);
747
748 /*
749  * Returns the initial path. On Windows the initial path is
750  * the current directory for the current process in the other
751  * case the function returns "./" that represents the current
752  * directory on Unix/Linux platforms.
753  */
754 const char *__surf_get_initial_path(void);
755
756 /********** Tracing **********/
757 /* from surf_instr.c */
758 void TRACE_surf_action(surf_action_t surf_action, const char *category);
759 void TRACE_surf_alloc(void);
760 void TRACE_surf_release(void);
761
762 /* instr_routing.c */
763 void instr_routing_define_callbacks (void);
764 void instr_new_variable_type (const char *new_typename, const char *color);
765 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
766 void instr_new_user_state_type (const char *father_type, const char *new_typename);
767 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
768 int instr_platform_traced (void);
769 xbt_graph_t instr_routing_platform_graph (void);
770 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
771
772 SG_END_DECL()
773 #endif                          /* _SURF_SURF_H */