Logo AND Algorithmique Numérique Distribuée

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