Logo AND Algorithmique Numérique Distribuée

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