Logo AND Algorithmique Numérique Distribuée

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