Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
12bcb4177c58bde1ce51f316dfe1774b0c8f90b4
[simgrid.git] / src / include / surf / surf.h
1 /*      $Id$     */
2
3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #ifndef _SURF_SURF_H
9 #define _SURF_SURF_H
10
11 #include "xbt/swag.h"
12 #include "xbt/dynar.h"
13 #include "xbt/dict.h"
14 #include "xbt/misc.h"
15 #include "portable.h"
16 #include "xbt/config.h"
17
18 SG_BEGIN_DECL()
19
20
21
22 /* Actions and models are higly connected structures... */
23 /** \brief Action datatype
24  *  \ingroup SURF_actions
25  *
26  * An action is some working amount on a model.
27  * It is represented as a cost, a priority, a duration and a state.
28  *
29  * \see e_surf_action_state_t
30  */
31      typedef struct surf_action *surf_action_t;
32
33 /** \brief Model datatype
34  *  \ingroup SURF_models
35  *
36  *  Generic data structure for a model. The workstations,
37  *  the CPUs and the network links are examples of models.
38  */
39      typedef struct surf_model *surf_model_t;
40
41 /** \brief Resource model description
42  */
43      typedef struct surf_model_description {
44        const char *name;
45        surf_model_t model;
46        void (*model_init_preparse) (const char *filename);
47        void (*model_init_postparse) (void);
48      } s_surf_model_description_t, *surf_model_description_t;
49
50 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
51                                           const char *name,
52                                           surf_model_t model);
53 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
54                                        const char *name);
55
56 /** \brief Action structure
57  * \ingroup SURF_actions
58  *
59  *  Never create s_surf_action_t by yourself ! The actions are created
60  *  on the fly when you call execute or communicate on a model.
61  *
62  *  \see e_surf_action_state_t
63  */
64      typedef struct surf_action {
65        s_xbt_swag_hookup_t state_hookup;
66        xbt_swag_t state_set;
67        double cost;             /**< cost        */
68        double priority;         /**< priority (1.0 by default) */
69        double max_duration;     /**< max_duration (may fluctuate until
70                                    the task is completed) */
71        double remains;          /**< How much of that cost remains to
72                                  * be done in the currently running task */
73        double start;            /**< start time  */
74        double finish;           /**< finish time : this is modified during the run
75                                  * and fluctuates until the task is completed */
76        void *data;              /**< for your convenience */
77        int refcount;
78        surf_model_t model_type;
79      } s_surf_action_t;
80
81 /** \brief Action states
82  *  \ingroup SURF_actions
83  *
84  *  Action states.
85  *
86  *  \see surf_action_t, surf_action_state_t
87  */
88      typedef enum {
89        SURF_ACTION_READY = 0,   /**< Ready        */
90        SURF_ACTION_RUNNING,     /**< Running      */
91        SURF_ACTION_FAILED,      /**< Task Failure */
92        SURF_ACTION_DONE,        /**< Completed    */
93        SURF_ACTION_TO_FREE,     /**< Action to free in next cleanup */
94        SURF_ACTION_NOT_IN_THE_SYSTEM
95                                 /**< Not in the system anymore. Why did you ask ? */
96      } e_surf_action_state_t;
97
98 /** \brief Action state sets
99  *  \ingroup SURF_actions
100  *
101  *  This structure contains some sets of actions.
102  *  It provides a fast access to the actions in each state.
103  *
104  *  \see surf_action_t, e_surf_action_state_t
105  */
106      typedef struct surf_action_state {
107        xbt_swag_t ready_action_set;
108                                  /**< Actions in state SURF_ACTION_READY */
109        xbt_swag_t running_action_set;
110                                  /**< Actions in state SURF_ACTION_RUNNING */
111        xbt_swag_t failed_action_set;
112                                  /**< Actions in state SURF_ACTION_FAILED */
113        xbt_swag_t done_action_set;
114                                  /**< Actions in state SURF_ACTION_DONE */
115      } s_surf_action_state_t, *surf_action_state_t;
116
117 /***************************/
118 /* Generic model object */
119 /***************************/
120
121 /** \brief Private data available on all models
122  *  \ingroup SURF_models
123  */
124      typedef struct surf_model_private *surf_model_private_t;
125
126      /** \brief Timer model extension public
127       * \ingroup SURF_model
128       *
129       * Additionnal functions specific to the timer model
130       */
131      typedef struct surf_timer_model_extension_public {
132        void (*set) (double date, void *function, void *arg);
133        int (*get) (void **function, void **arg);
134      } s_surf_model_extension_timer_t;
135
136      /* Cpu model */
137
138      /** \brief CPU state
139       *  \ingroup SURF_models
140       */
141      typedef enum {
142        SURF_CPU_ON = 1,                   /**< Up & ready        */
143        SURF_CPU_OFF = 0                   /**< Down & broken     */
144      } e_surf_cpu_state_t;
145
146      /** \brief CPU model extension public
147       *  \ingroup SURF_models
148       *
149       *  Public functions specific to the CPU model.
150       */
151      typedef struct surf_cpu_model_extension_public {
152        surf_action_t(*execute) (void *cpu, double size);
153        surf_action_t(*sleep) (void *cpu, double duration);
154        e_surf_cpu_state_t(*get_state) (void *cpu);
155        double (*get_speed) (void *cpu, double load);
156        double (*get_available_speed) (void *cpu);
157      } s_surf_model_extension_cpu_t;
158
159      /* Network model */
160
161      /** \brief Network model extension public
162       *  \ingroup SURF_models
163       *
164       *  Public functions specific to the network model
165       */
166      typedef struct surf_network_model_extension_public {
167        surf_action_t(*communicate) (void *src, void *dst, double size,
168                                     double max_rate);
169        const void **(*get_route) (void *src, void *dst);
170        int (*get_route_size) (void *src, void *dst);
171        double (*get_link_bandwidth) (const void *link);
172        double (*get_link_latency) (const void *link);
173        int (*link_shared) (const void *link);
174      } s_surf_model_extension_network_t;
175
176      /** \brief Workstation model extension public
177       *  \ingroup SURF_models
178       *
179       *  Public functions specific to the workstation model.
180       */
181      typedef struct surf_workstation_model_extension_public {
182        surf_action_t(*execute) (void *workstation, double size);                           /**< Execute a computation amount on a workstation
183                                                                                         and create the corresponding action */
184        surf_action_t(*sleep) (void *workstation, double duration);                         /**< Make a workstation sleep during a given duration */
185        e_surf_cpu_state_t(*get_state) (void *workstation);                                 /**< Return the CPU state of a workstation */
186        double (*get_speed) (void *workstation, double load);                               /**< Return the speed of a workstation */
187        double (*get_available_speed) (void *workstation);                                  /**< Return tha available speed of a workstation */
188        surf_action_t(*communicate) (void *workstation_src,                                 /**< Execute a communication amount between two workstations */
189                                     void *workstation_dst, double size,
190                                     double max_rate);
191
192        surf_action_t(*execute_parallel_task) (int workstation_nb,                          /**< Execute a parallel task on several workstations */
193                                               void **workstation_list,
194                                               double *computation_amount,
195                                               double *communication_amount,
196                                               double amount, double rate);
197        const void **(*get_route) (void *src, void *dst);                                   /**< Return the network link list between two workstations */
198        int (*get_route_size) (void *src, void *dst);                                       /**< Return the route size between two workstations */
199        double (*get_link_bandwidth) (const void *link);                                    /**< Return the current bandwidth of a network link */
200        double (*get_link_latency) (const void *link);                                      /**< Return the current latency of a network link */
201        int (*link_shared) (const void *link);
202      } s_surf_model_extension_workstation_t;
203
204 /** \brief Model datatype
205  *  \ingroup SURF_models
206  *
207  *  Generic data structure for a model. The workstations,
208  *  the CPUs and the network links are examples of models.
209  */
210      typedef struct surf_model {
211        const char *name;/**< Name of this model */
212        s_surf_action_state_t states; /**< Any living action on this model */
213
214        e_surf_action_state_t(*action_state_get) (surf_action_t action);/**< Return the state of an action */
215        void (*action_state_set) (surf_action_t action,
216                                     e_surf_action_state_t state); /**< Change an action state*/
217
218        double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
219        double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
220        void (*action_ref) (surf_action_t action);/**< Specify that we use that action */
221        int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
222        void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
223        void (*action_recycle) (surf_action_t action);/**< Recycle an action */
224        void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
225        void (*suspend) (surf_action_t action);/**< Suspend an action */
226        void (*resume) (surf_action_t action);/**< Resume a suspended action */
227        int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
228        void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
229        void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
230
231        xbt_dict_t(*get_properties) (void *resource_id);/**< Return the properties dictionary */
232        xbt_dict_t resource_set;
233
234
235
236        surf_model_private_t model_private;
237
238
239
240        union extension {
241          s_surf_model_extension_timer_t timer;
242          s_surf_model_extension_cpu_t cpu;
243          s_surf_model_extension_network_t network;
244          s_surf_model_extension_workstation_t workstation;
245        } extension;
246      } s_surf_model_t;
247
248      surf_model_t surf_model_init(void);
249      void surf_model_exit(surf_model_t model);
250
251      void *surf_model_resource_by_name(surf_model_t model, const char *name);
252 #define surf_model_resource_set(model) (model)->resource_set
253
254      typedef struct surf_resource {
255        surf_model_t model;
256        char *name;
257      } s_surf_resource_t, *surf_resource_t;
258
259 XBT_PUBLIC(const char*) surf_resource_name(const void *resource);
260 XBT_PUBLIC(void) surf_resource_free(void* resource);
261 /**************************************/
262 /* Implementations of model object */
263 /**************************************/
264
265
266 /** \brief The timer model
267  *  \ingroup SURF_models
268  */
269 XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
270
271 /** \brief Initializes the timer model
272  *  \ingroup SURF_models
273  */
274 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
275
276 /** \brief The CPU model
277  *  \ingroup SURF_models
278  */
279 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
280
281 /** \brief Initializes the CPU model with the model Cas01
282  *  \ingroup SURF_models
283  *
284  *  This function is called by surf_workstation_model_init_CLM03
285  *  so you shouldn't have to call it by yourself.
286  *
287  *  \see surf_workstation_model_init_CLM03()
288  */
289 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
290
291 /** \brief The list of all available cpu model models
292  *  \ingroup SURF_models
293  */
294 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
295
296 XBT_PUBLIC(void) create_workstations(void);
297
298 /** \brief The network model
299  *  \ingroup SURF_models
300  *
301  *  When creating a new API on top on SURF, you shouldn't use the
302  *  network model unless you know what you are doing. Only the workstation
303  *  model should be accessed because depending on the platform model,
304  *  the network model can be NULL.
305  */
306 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
307
308 /** \brief Initializes the platform with the network model 'LagrangeVelho'
309  *  \ingroup SURF_models
310  *  \param filename XML platform file name
311  *
312  * This model is proposed by Arnaud Legrand and Pedro Velho based on
313  * the results obtained with the GTNets simulator for onelink and
314  * dogbone sharing scenarios.
315  *
316  *  \see surf_workstation_model_init_LegrandVelho()
317  */
318 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
319
320 /** \brief Initializes the platform with the network model 'Constant'
321  *  \ingroup SURF_models
322  *  \param filename XML platform file name
323  *
324  *  In this model, the communication time between two network cards is
325  *  constant, hence no need for a routing table. This is particularly
326  *  usefull when simulating huge distributed algorithms where
327  *  scalability is really an issue. This function is called in
328  *  conjunction with surf_workstation_model_init_compound.
329  *
330  *  \see surf_workstation_model_init_compound()
331  */
332 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
333
334 /** \brief Initializes the platform with the network model CM02
335  *  \ingroup SURF_models
336  *  \param filename XML platform file name
337  *
338  *  This function is called by surf_workstation_model_init_CLM03
339  *  or by yourself only if you plan using surf_workstation_model_init_compound
340  *
341  *  \see surf_workstation_model_init_CLM03()
342  */
343 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
344
345 #ifdef HAVE_GTNETS
346 /** \brief Initializes the platform with the network model GTNETS
347  *  \ingroup SURF_models
348  *  \param filename XML platform file name
349  *
350  *  This function is called by surf_workstation_model_init_GTNETS
351  *  or by yourself only if you plan using surf_workstation_model_init_compound
352  *
353  *  \see surf_workstation_model_init_GTNETS()
354  */
355 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
356 #endif
357
358 /** \brief Initializes the platform with the network model Reno
359  *  \ingroup SURF_models
360  *  \param filename XML platform file name
361  *
362  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
363  *
364  *  Reference:
365  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
366  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
367  *
368  *  Call this function only if you plan using surf_workstation_model_init_compound.
369  *
370  */
371 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
372
373 /** \brief Initializes the platform with the network model Reno2
374  *  \ingroup SURF_models
375  *  \param filename XML platform file name
376  *
377  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
378  *
379  *  Reference:
380  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
381  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
382  *
383  *  Call this function only if you plan using surf_workstation_model_init_compound.
384  *
385  */
386 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
387
388 /** \brief Initializes the platform with the network model Vegas
389  *  \ingroup SURF_models
390  *  \param filename XML platform file name
391  *
392  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
393  *  to the proportional fairness.
394  *
395  *  Reference:
396  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
397  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
398  *
399  *  Call this function only if you plan using surf_workstation_model_init_compound.
400  *
401  */
402 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
403
404 #ifdef HAVE_SDP
405 /** \brief Initializes the platform with the network model based on SDP
406  *  \ingroup SURF_models
407  *  \param filename XML platform file name
408  *
409  *  This function implements the proportional fairness known as the maximization
410  *  of x1*x2*...*xn .
411  *
412  *  Reference:
413  *
414  *  [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
415  *  Semi-definite programming approach for bandwidth allocation and routing in networks.
416  *  Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
417  *
418  *  Call this function only if you plan using surf_workstation_model_init_compound.
419  */
420 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
421 #endif
422
423 /** \brief The list of all available network model models
424  *  \ingroup SURF_models
425  */
426 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
427
428
429 /** \brief The workstation model
430  *  \ingroup SURF_models
431  *
432  *  Note that when you create an API on top of SURF,
433  *  the workstation model should be the only one you use
434  *  because depending on the platform model, the network model and the CPU model
435  *  may not exist.
436  */
437 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
438
439 /** \brief Initializes the platform with a compound workstation model
440  *  \ingroup SURF_models
441  *  \param filename XML platform file name
442  *
443  *  This function should be called after a cpu_model and a
444  *  network_model have been set up.
445  *
446  */
447 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
448
449 /** \brief Initializes the platform with the workstation model CLM03
450  *  \ingroup SURF_models
451  *  \param filename XML platform file name
452  *
453  *  This platform model seperates the workstation model and the network model.
454  *  The workstation model will be initialized with the model CLM03, the network
455  *  model with the model CM02 and the CPU model with the model Cas01.
456  *  In future releases, some other network models will be implemented and will be
457  *  combined with the workstation model CLM03.
458  *
459  *  \see surf_workstation_model_init_KCCFLN05()
460  */
461 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
462
463 /** \brief Initializes the platform with the model KCCFLN05
464  *  \ingroup SURF_models
465  *  \param filename XML platform file name
466  *
467  *  With this model, the workstations and the network are handled
468  *  together. The network model is roughly the same as in CM02 but
469  *  interference between computations and communications can be taken
470  *  into account. This platform model is the default one for MSG and
471  *  SimDag.
472  *
473  */
474 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
475
476 /** \brief Initializes the platform with the model KCCFLN05
477  *  \ingroup SURF_models
478  *  \param filename XML platform file name
479  *
480  *  With this model, only parallel tasks can be used. Resource sharing
481  *  is done by identifying bottlenecks and giving an equal share of
482  *  the model to each action.
483  *
484  */
485 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
486
487 /** \brief The list of all available workstation model models
488  *  \ingroup SURF_models
489  */
490 XBT_PUBLIC_DATA(s_surf_model_description_t)
491   surf_workstation_model_description[];
492
493 /** \brief The network links
494  *  \ingroup SURF_models
495  *
496  *  This dict contains all network links.
497  *
498  *  \see workstation_set
499  */
500 XBT_PUBLIC_DATA(xbt_dict_t) link_set;
501
502 /** \brief The workstations
503  *  \ingroup SURF_models
504  *
505  *  This dict contains all workstations.
506  *
507  *  \see link_set
508  */
509 /** \brief List of initialized models
510  *  \ingroup SURF_models
511  */
512 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
513
514 /*******************************************/
515 /*** SURF Globals **************************/
516 /*******************************************/
517 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
518
519 /** \brief Initialize SURF
520  *  \ingroup SURF_simulation
521  *  \param argc argument number
522  *  \param argv arguments
523  *
524  *  This function has to be called to initialize the common
525  *  structures.  Then you will have to create the environment by
526  *  calling surf_timer_model_init() and
527  *  e.g. surf_workstation_model_init_CLM03() or
528  *  surf_workstation_model_init_KCCFLN05().
529  *
530  *  \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
531  *  surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
532  */
533 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
534
535 /** \brief Initialize the used models.
536  *
537  * Must be called after the surf_init so that configuration infrastructure is created
538  * Must be called before parsing/creating the environment
539  * Must not be called within the initialization process so that the use get a chance to change the settings from
540  * its code between, say, MSG_init and MSG_create_environment using MSG_config
541  */
542 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
543
544 /** \brief create the elements of the models
545  *
546  * Must be called after parsing the platform file and before using any elements
547  */
548 XBT_PUBLIC(void) surf_config_models_create_elms(void);
549
550 /** \brief Finish simulation initialization
551  *  \ingroup SURF_simulation
552  *
553  *  This function must be called before the first call to surf_solve()
554  */
555 XBT_PUBLIC(void) surf_presolve(void);
556
557 /** \brief Performs a part of the simulation
558  *  \ingroup SURF_simulation
559  *  \return the elapsed time, or -1.0 if no event could be executed
560  *
561  *  This function execute all possible events, update the action states
562  *  and returns the time elapsed.
563  *  When you call execute or communicate on a model, the corresponding actions
564  *  are not executed immediately but only when you call surf_solve.
565  *  Note that the returned elapsed time can be zero.
566  */
567 XBT_PUBLIC(double) surf_solve(void);
568
569 /** \brief Return the current time
570  *  \ingroup SURF_simulation
571  *
572  *  Return the current time in millisecond.
573  */
574 XBT_PUBLIC(double) surf_get_clock(void);
575
576 /** \brief Exit SURF
577  *  \ingroup SURF_simulation
578  *
579  *  Clean everything.
580  *
581  *  \see surf_init()
582  */
583 XBT_PUBLIC(void) surf_exit(void);
584
585 /* Prototypes of the functions that handle the properties */
586 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
587 XBT_PUBLIC_DATA(void) parse_properties(void);
588
589 /* surf parse file related (public because called from a test suite) */
590 XBT_PUBLIC(void) parse_platform_file(const char *file);
591
592 /* Stores the sets */
593 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
594
595 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
596                                    const char *route_name, int action,
597                                    int isMultiRoute);
598 XBT_PUBLIC_DATA(int) route_action;
599
600 /* This is used by all models when creating the routing table while parsing */
601 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
602 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
603
604
605 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
606 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
607 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
608 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
609 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
610 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
611 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
612
613
614 XBT_PUBLIC_DATA(double) get_cpu_power(const char *power);
615
616
617 SG_END_DECL()
618 #endif /* _SURF_SURF_H */