Logo AND Algorithmique Numérique Distribuée

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