Logo AND Algorithmique Numérique Distribuée

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