Logo AND Algorithmique Numérique Distribuée

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