Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
9566b4c81e065c144381bdac7a8fd891c14cb255
[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 /** \brief Action structure
67  * \ingroup SURF_actions
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 /** \brief Action states
111  *  \ingroup SURF_actions
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 /** \brief Action state sets
128  *  \ingroup SURF_actions
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 /** \brief Private data available on all models
154  *  \ingroup SURF_models
155  */
156 typedef struct surf_model_private *surf_model_private_t;
157
158      /* Cpu model */
159
160      /** \brief CPU model extension public
161       *  \ingroup SURF_models
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      /** \brief Network model extension public
186       *  \ingroup SURF_models
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 /** \brief Storage model extension public
214  *  \ingroup SURF_models
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      /** \brief Workstation model extension public
229       *  \ingroup SURF_models
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 /** \brief Model datatype
284  *  \ingroup SURF_models
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         return xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL);
339 }
340 static inline void *surf_storage_resource_by_name(const char *name){
341     return xbt_lib_get_or_null(storage_lib, name, SURF_STORAGE_LEVEL);
342 }
343
344 typedef struct surf_resource {
345   surf_model_t model;
346   char *name;
347   xbt_dict_t properties;
348 } s_surf_resource_t, *surf_resource_t;
349
350 /**
351  * Storage struct
352  */
353 typedef struct s_storage_type {
354   char *model;
355   xbt_dict_t content;
356   char *type_id;
357   xbt_dict_t properties;
358 } s_storage_type_t, *storage_type_t;
359
360 typedef struct s_mount {
361   void *id;
362   char *name;
363 } s_mount_t, *mount_t;
364
365 typedef struct s_content {
366   char *user_rights;
367   char *user;
368   char *group;
369   char *date;
370   char *time;
371   size_t size;
372 } s_content_t, *content_t;
373
374 /**
375  * Resource which have a metric handled by a maxmin system
376  */
377 typedef struct {
378   double scale;
379   double peak;
380   tmgr_trace_event_t event;
381 } s_surf_metric_t;
382
383 typedef struct surf_resource_lmm {
384   s_surf_resource_t generic_resource;
385   lmm_constraint_t constraint;
386   e_surf_resource_state_t state_current;
387   tmgr_trace_event_t state_event;
388   s_surf_metric_t power;
389 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
390
391 /**************************************/
392 /* Implementations of model object */
393 /**************************************/
394
395
396 /** \brief The CPU model
397  *  \ingroup SURF_models
398  */
399 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
400
401 /** \brief Initializes the CPU model with the model Cas01
402  *  \ingroup SURF_models
403  *
404  *  By default, this model uses the lazy optimization mechanism that
405  *  relies on partial invalidation in LMM and a heap for lazy action update.
406  *  You can change this behavior by setting the cpu/optim configuration
407  *  variable to a different value.
408  *
409  *  This function is called by surf_workstation_model_init_CLM03
410  *  so you shouldn't have to call it by yourself.
411  *
412  *  \see surf_workstation_model_init_CLM03()
413  */
414 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
415
416 /** \brief Initializes the CPU model with trace integration [Deprecated]
417  *  \ingroup SURF_models
418  *
419  *  You shouldn't have to call it by yourself.
420  *  \see surf_workstation_model_init_CLM03()
421  */
422 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
423
424 /** \brief This function call the share resources function needed
425  *
426  */
427 XBT_PUBLIC(double) generic_share_resources(double now);
428
429 /** \brief This function call the update action state function needed
430  *
431  */
432 XBT_PUBLIC(void)   generic_update_actions_state(double now, double delta);
433
434 /** \brief The list of all available optimization modes (both for cpu and networks).
435  *  \ingroup SURF_models
436  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
437  */
438 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
439
440 /** \brief The list of all available cpu model models
441  *  \ingroup SURF_models
442  */
443 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
444
445 XBT_PUBLIC(void) create_workstations(void);
446
447 /**\brief create new host bypass the parser
448  *
449  */
450
451
452 /** \brief The network model
453  *  \ingroup SURF_models
454  *
455  *  When creating a new API on top on SURF, you shouldn't use the
456  *  network model unless you know what you are doing. Only the workstation
457  *  model should be accessed because depending on the platform model,
458  *  the network model can be NULL.
459  */
460 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
461
462 /** \brief Same as network model 'LagrangeVelho', only with different correction factors.
463  *  \ingroup SURF_models
464  *
465  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
466  * based on the model 'LV08' and different correction factors depending on the communication
467  * size (< 1KiB, < 64KiB, >= 64KiB).
468  * See comments in the code for more information.
469  *
470  *  \see surf_workstation_model_init_SMPI()
471  */
472 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
473
474 /** \brief Initializes the platform with the network model 'LegrandVelho'
475  *  \ingroup SURF_models
476  *
477  * This model is proposed by Arnaud Legrand and Pedro Velho based on
478  * the results obtained with the GTNets simulator for onelink and
479  * dogbone sharing scenarios. See comments in the code for more information.
480  *
481  *  \see surf_workstation_model_init_LegrandVelho()
482  */
483 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
484
485 /** \brief Initializes the platform with the network model 'Constant'
486  *  \ingroup SURF_models
487  *
488  *  In this model, the communication time between two network cards is
489  *  constant, hence no need for a routing table. This is particularly
490  *  usefull when simulating huge distributed algorithms where
491  *  scalability is really an issue. This function is called in
492  *  conjunction with surf_workstation_model_init_compound.
493  *
494  *  \see surf_workstation_model_init_compound()
495  */
496 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
497
498 /** \brief Initializes the platform with the network model CM02
499  *  \ingroup SURF_models
500  *
501  *  This function is called by surf_workstation_model_init_CLM03
502  *  or by yourself only if you plan using surf_workstation_model_init_compound
503  *  See comments in the code for more information.
504  *
505  *  \see surf_workstation_model_init_CLM03()
506  */
507 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
508
509 /**
510  * brief initialize the the network model bypassing the XML parser
511  */
512 XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
513                                                 double initial_bw,
514                                                 double initial_lat);
515
516 #ifdef HAVE_GTNETS
517 /** \brief Initializes the platform with the network model GTNETS
518  *  \ingroup SURF_models
519  *  \param filename XML platform file name
520  *
521  *  This function is called by surf_workstation_model_init_GTNETS
522  *  or by yourself only if you plan using surf_workstation_model_init_compound
523  *
524  *  \see surf_workstation_model_init_GTNETS()
525  */
526 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
527 #endif
528
529 #ifdef HAVE_NS3
530 /** \brief Initializes the platform with the network model NS3
531  *  \ingroup SURF_models
532  *  \param filename XML platform file name
533  *
534  *  This function is called by surf_workstation_model_init_NS3
535  *  or by yourself only if you plan using surf_workstation_model_init_compound
536  *
537  *  \see surf_workstation_model_init_NS3()
538  */
539 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
540 #endif
541
542 /** \brief Initializes the platform with the network model Reno
543  *  \ingroup SURF_models
544  *  \param filename XML platform file name
545  *
546  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
547  *
548  *  Reference:
549  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
550  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
551  *
552  *  Call this function only if you plan using surf_workstation_model_init_compound.
553  *
554  */
555 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
556
557 /** \brief Initializes the platform with the network model Reno2
558  *  \ingroup SURF_models
559  *  \param filename XML platform file name
560  *
561  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
562  *
563  *  Reference:
564  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
565  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
566  *
567  *  Call this function only if you plan using surf_workstation_model_init_compound.
568  *
569  */
570 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
571
572 /** \brief Initializes the platform with the network model Vegas
573  *  \ingroup SURF_models
574  *  \param filename XML platform file name
575  *
576  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
577  *  to the proportional fairness.
578  *
579  *  Reference:
580  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
581  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
582  *
583  *  Call this function only if you plan using surf_workstation_model_init_compound.
584  *
585  */
586 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
587
588 /** \brief The list of all available network model models
589  *  \ingroup SURF_models
590  */
591 XBT_PUBLIC_DATA(s_surf_model_description_t)
592     surf_network_model_description[];
593
594
595
596
597
598
599 /** \brief The storage model
600  *  \ingroup SURF_models
601  */
602 XBT_PUBLIC(void) surf_storage_model_init_default(void);
603
604 /** \brief The list of all available storage modes.
605  *  \ingroup SURF_models
606  *  This storage mode can be set using --cfg=storage/model:...
607  */
608 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
609
610
611
612
613
614
615
616 /** \brief The workstation model
617  *  \ingroup SURF_models
618  *
619  *  Note that when you create an API on top of SURF,
620  *  the workstation model should be the only one you use
621  *  because depending on the platform model, the network model and the CPU model
622  *  may not exist.
623  */
624 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
625
626 /** \brief Initializes the platform with a compound workstation model
627  *  \ingroup SURF_models
628  *
629  *  This function should be called after a cpu_model and a
630  *  network_model have been set up.
631  *
632  */
633 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
634
635 /** \brief Initializes the platform with the current best network and cpu models at hand
636  *  \ingroup SURF_models
637  *
638  *  This platform model seperates the workstation model and the network model.
639  *  The workstation model will be initialized with the model compound, the network
640  *  model with the model LV08 (with cross traffic support) and the CPU model with
641  *  the model Cas01.
642  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
643  *
644  */
645 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
646
647 /** \brief Initializes the platform with the workstation model CLM03
648  *  \ingroup SURF_models
649  *
650  *  This platform model seperates the workstation model and the network model.
651  *  The workstation model will be initialized with the model CLM03, the network
652  *  model with the model CM02 and the CPU model with the model Cas01.
653  *  In future releases, some other network models will be implemented and will be
654  *  combined with the workstation model CLM03.
655  *
656  */
657 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
658
659 /** \brief Initializes the platform with the model KCCFLN05
660  *  \ingroup SURF_models
661  *
662  *  With this model, only parallel tasks can be used. Resource sharing
663  *  is done by identifying bottlenecks and giving an equal share of
664  *  the model to each action.
665  *
666  */
667 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
668
669 /** \brief The list of all available workstation model models
670  *  \ingroup SURF_models
671  */
672 XBT_PUBLIC_DATA(s_surf_model_description_t)
673     surf_workstation_model_description[];
674
675 /** \brief List of initialized models
676  *  \ingroup SURF_models
677  */
678 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
679
680 /*******************************************/
681 /*** SURF Globals **************************/
682 /*******************************************/
683 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
684
685 /** \brief Initialize SURF
686  *  \ingroup SURF_simulation
687  *  \param argc argument number
688  *  \param argv arguments
689  *
690  *  This function has to be called to initialize the common
691  *  structures.  Then you will have to create the environment by
692  *  calling 
693  *  e.g. surf_workstation_model_init_CLM03()
694  *
695  *  \see surf_workstation_model_init_CLM03(), surf_workstation_model_init_compound(), surf_exit()
696  */
697 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
698
699 /** \brief Finish simulation initialization
700  *  \ingroup SURF_simulation
701  *
702  *  This function must be called before the first call to surf_solve()
703  */
704 XBT_PUBLIC(void) surf_presolve(void);
705
706 /** \brief Performs a part of the simulation
707  *  \ingroup SURF_simulation
708  *  \param max_date Maximum date to update the simulation to, or -1
709  *  \return the elapsed time, or -1.0 if no event could be executed
710  *
711  *  This function execute all possible events, update the action states
712  *  and returns the time elapsed.
713  *  When you call execute or communicate on a model, the corresponding actions
714  *  are not executed immediately but only when you call surf_solve.
715  *  Note that the returned elapsed time can be zero.
716  */
717 XBT_PUBLIC(double) surf_solve(double max_date);
718
719 /** \brief Return the current time
720  *  \ingroup SURF_simulation
721  *
722  *  Return the current time in millisecond.
723  */
724 XBT_PUBLIC(double) surf_get_clock(void);
725
726 /** \brief Exit SURF
727  *  \ingroup SURF_simulation
728  *
729  *  Clean everything.
730  *
731  *  \see surf_init()
732  */
733 XBT_PUBLIC(void) surf_exit(void);
734
735 /* Prototypes of the functions that handle the properties */
736 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
737 XBT_PUBLIC(void) parse_properties(void);
738
739 /* surf parse file related (public because called from a test suite) */
740 XBT_PUBLIC(void) parse_platform_file(const char *file);
741
742 /* Stores the sets */
743 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
744
745 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
746 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
747 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
748 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
749 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
750 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
751 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
752
753
754 XBT_PUBLIC(double) get_cpu_power(const char *power);
755
756 int surf_get_nthreads(void);
757 void surf_set_nthreads(int nthreads);
758
759 SG_END_DECL()
760 #endif                          /* _SURF_SURF_H */