Logo AND Algorithmique Numérique Distribuée

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