Logo AND Algorithmique Numérique Distribuée

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