Logo AND Algorithmique Numérique Distribuée

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