Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
inline the accessors of surf_resource_t
[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
22
23 typedef enum {
24   SURF_RESOURCE_ON = 1,                   /**< Up & ready        */
25   SURF_RESOURCE_OFF = 0                   /**< Down & broken     */
26 } e_surf_resource_state_t;
27
28 /** @Brief Specify that we use that action */
29 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
30 /** @brief Creates a new action.
31  *
32  * @param size The size is the one of the subtype you want to create
33  * @param cost initial value
34  * @param model to which model we should attach this action
35  * @param failed whether we should start this action in failed mode
36  */
37 XBT_PUBLIC(void*) surf_action_new(size_t size,double cost,surf_model_t model, int failed);
38
39
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      typedef struct {
82        s_surf_action_t generic_action;
83        lmm_variable_t variable;
84        int suspended;
85      } s_surf_action_lmm_t,*surf_action_lmm_t;
86 /** \brief Action states
87  *  \ingroup SURF_actions
88  *
89  *  Action states.
90  *
91  *  \see surf_action_t, surf_action_state_t
92  */
93      typedef enum {
94        SURF_ACTION_READY = 0,   /**< Ready        */
95        SURF_ACTION_RUNNING,     /**< Running      */
96        SURF_ACTION_FAILED,      /**< Task Failure */
97        SURF_ACTION_DONE,        /**< Completed    */
98        SURF_ACTION_TO_FREE,     /**< Action to free in next cleanup */
99        SURF_ACTION_NOT_IN_THE_SYSTEM
100                                 /**< Not in the system anymore. Why did you ask ? */
101      } e_surf_action_state_t;
102
103 /** \brief Action state sets
104  *  \ingroup SURF_actions
105  *
106  *  This structure contains some sets of actions.
107  *  It provides a fast access to the actions in each state.
108  *
109  *  \see surf_action_t, e_surf_action_state_t
110  */
111      typedef struct surf_action_state {
112        xbt_swag_t ready_action_set;
113                                  /**< Actions in state SURF_ACTION_READY */
114        xbt_swag_t running_action_set;
115                                  /**< Actions in state SURF_ACTION_RUNNING */
116        xbt_swag_t failed_action_set;
117                                  /**< Actions in state SURF_ACTION_FAILED */
118        xbt_swag_t done_action_set;
119                                  /**< Actions in state SURF_ACTION_DONE */
120      } s_surf_action_state_t, *surf_action_state_t;
121
122 /***************************/
123 /* Generic model object */
124 /***************************/
125      typedef struct s_routing s_routing_t, *routing_t;
126      XBT_PUBLIC_DATA(routing_t) used_routing;
127
128 /** \brief Private data available on all models
129  *  \ingroup SURF_models
130  */
131      typedef struct surf_model_private *surf_model_private_t;
132
133      /** \brief Timer model extension public
134       * \ingroup SURF_model
135       *
136       * Additionnal functions specific to the timer model
137       */
138      typedef struct surf_timer_model_extension_public {
139        void (*set) (double date, void *function, void *arg);
140        int (*get) (void **function, void **arg);
141      } s_surf_model_extension_timer_t;
142
143      /* Cpu model */
144
145      /** \brief CPU model extension public
146       *  \ingroup SURF_models
147       *
148       *  Public functions specific to the CPU model.
149       */
150      typedef struct surf_cpu_model_extension_public {
151        surf_action_t(*execute) (void *cpu, double size);
152        surf_action_t(*sleep) (void *cpu, double duration);
153        e_surf_resource_state_t (*get_state) (void *cpu);
154        double (*get_speed) (void *cpu, double load);
155        double (*get_available_speed) (void *cpu);
156      } s_surf_model_extension_cpu_t;
157
158      /* Network model */
159
160      /** \brief Network model extension public
161       *  \ingroup SURF_models
162       *
163       *  Public functions specific to the network model
164       */
165      typedef struct surf_network_model_extension_public {
166        surf_action_t(*communicate) (const char *src_name,const char *dst_name,int src, int dst, double size,
167            double rate);
168        xbt_dynar_t (*get_route) (int src, int dst);
169        double (*get_link_bandwidth) (const void *link);
170        double (*get_link_latency) (const void *link);
171        int (*link_shared) (const void *link);
172      } s_surf_model_extension_network_t;
173
174      /** \brief Workstation model extension public
175       *  \ingroup SURF_models
176       *
177       *  Public functions specific to the workstation model.
178       */
179      typedef struct surf_workstation_model_extension_public {
180        surf_action_t(*execute) (void *workstation, double size);                           /**< Execute a computation amount on a workstation
181                                                                                         and create the corresponding action */
182        surf_action_t(*sleep) (void *workstation, double duration);                         /**< Make a workstation sleep during a given duration */
183        e_surf_resource_state_t(*get_state) (void *workstation);                                 /**< Return the CPU state of a workstation */
184        double (*get_speed) (void *workstation, double load);                               /**< Return the speed of a workstation */
185        double (*get_available_speed) (void *workstation);                                  /**< Return tha available speed of a workstation */
186        surf_action_t(*communicate) (void *workstation_src,                                 /**< Execute a communication amount between two workstations */
187                                     void *workstation_dst, double size,
188                                     double max_rate);
189        xbt_dynar_t(*get_route)(void *workstation_src,void *workstation_dst);               /**< Get the list of links between two ws */
190
191        surf_action_t(*execute_parallel_task) (int workstation_nb,                          /**< Execute a parallel task on several workstations */
192                                               void **workstation_list,
193                                               double *computation_amount,
194                                               double *communication_amount,
195                                               double amount, double rate);
196        double (*get_link_bandwidth) (const void *link);                                    /**< Return the current bandwidth of a network link */
197        double (*get_link_latency) (const void *link);                                      /**< Return the current latency of a network link */
198        int (*link_shared) (const void *link);
199        xbt_dict_t (*get_properties)(const void*resource);
200      } s_surf_model_extension_workstation_t;
201
202 /** \brief Model datatype
203  *  \ingroup SURF_models
204  *
205  *  Generic data structure for a model. The workstations,
206  *  the CPUs and the network links are examples of models.
207  */
208      typedef struct surf_model {
209        const char *name;/**< Name of this model */
210        s_surf_action_state_t states; /**< Any living action on this model */
211
212        e_surf_action_state_t(*action_state_get) (surf_action_t action);/**< Return the state of an action */
213        void (*action_state_set) (surf_action_t action,
214                                     e_surf_action_state_t state); /**< Change an action state*/
215
216        double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
217        double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
218        int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */
219        void (*action_cancel) (surf_action_t action);/**< Cancel a running action */
220        void (*action_recycle) (surf_action_t action);/**< Recycle an action */
221        void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */
222        void (*suspend) (surf_action_t action);/**< Suspend an action */
223        void (*resume) (surf_action_t action);/**< Resume a suspended action */
224        int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
225        void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
226        void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
227
228        xbt_dict_t resource_set;
229
230
231
232        surf_model_private_t model_private;
233
234
235
236        union extension {
237          s_surf_model_extension_timer_t timer;
238          s_surf_model_extension_cpu_t cpu;
239          s_surf_model_extension_network_t network;
240          s_surf_model_extension_workstation_t workstation;
241        } extension;
242      } s_surf_model_t;
243
244      surf_model_t surf_model_init(void);
245      void surf_model_exit(surf_model_t model);
246
247      void *surf_model_resource_by_name(surf_model_t model, const char *name);
248 #define surf_model_resource_set(model) (model)->resource_set
249
250      typedef struct surf_resource {
251        surf_model_t model;
252        char *name;
253        xbt_dict_t properties;
254      } s_surf_resource_t, *surf_resource_t;
255
256 /**
257  * Resource which have a metric handled by a maxmin system
258  */
259 typedef struct surf_resource_lmm {
260   s_surf_resource_t generic_resource;
261   lmm_constraint_t constraint;
262   e_surf_resource_state_t state_current;
263   tmgr_trace_event_t state_event;
264   double metric_current;
265   tmgr_trace_event_t metric_event;
266 }s_surf_resource_lmm_t, *surf_resource_lmm_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 List of initialized models
501  *  \ingroup SURF_models
502  */
503 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
504
505 /*******************************************/
506 /*** SURF Globals **************************/
507 /*******************************************/
508 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
509
510 /** \brief Initialize SURF
511  *  \ingroup SURF_simulation
512  *  \param argc argument number
513  *  \param argv arguments
514  *
515  *  This function has to be called to initialize the common
516  *  structures.  Then you will have to create the environment by
517  *  calling surf_timer_model_init() and
518  *  e.g. surf_workstation_model_init_CLM03() or
519  *  surf_workstation_model_init_KCCFLN05().
520  *
521  *  \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
522  *  surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
523  */
524 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
525
526 /** \brief Initialize the used models.
527  *
528  * Must be called after the surf_init so that configuration infrastructure is created
529  * Must be called before parsing/creating the environment
530  * Must not be called within the initialization process so that the use get a chance to change the settings from
531  * its code between, say, MSG_init and MSG_create_environment using MSG_config
532  */
533 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
534
535 /** \brief create the elements of the models
536  *
537  * Must be called after parsing the platform file and before using any elements
538  */
539 XBT_PUBLIC(void) surf_config_models_create_elms(void);
540
541 /** \brief Finish simulation initialization
542  *  \ingroup SURF_simulation
543  *
544  *  This function must be called before the first call to surf_solve()
545  */
546 XBT_PUBLIC(void) surf_presolve(void);
547
548 /** \brief Performs a part of the simulation
549  *  \ingroup SURF_simulation
550  *  \return the elapsed time, or -1.0 if no event could be executed
551  *
552  *  This function execute all possible events, update the action states
553  *  and returns the time elapsed.
554  *  When you call execute or communicate on a model, the corresponding actions
555  *  are not executed immediately but only when you call surf_solve.
556  *  Note that the returned elapsed time can be zero.
557  */
558 XBT_PUBLIC(double) surf_solve(void);
559
560 /** \brief Return the current time
561  *  \ingroup SURF_simulation
562  *
563  *  Return the current time in millisecond.
564  */
565 XBT_PUBLIC(double) surf_get_clock(void);
566
567 /** \brief Exit SURF
568  *  \ingroup SURF_simulation
569  *
570  *  Clean everything.
571  *
572  *  \see surf_init()
573  */
574 XBT_PUBLIC(void) surf_exit(void);
575
576 /* Prototypes of the functions that handle the properties */
577 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
578 XBT_PUBLIC_DATA(void) parse_properties(void);
579
580 /* surf parse file related (public because called from a test suite) */
581 XBT_PUBLIC(void) parse_platform_file(const char *file);
582
583 /* Stores the sets */
584 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
585
586 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
587                                    const char *route_name, int action,
588                                    int isMultiRoute);
589 XBT_PUBLIC_DATA(int) route_action;
590
591 /* This is used by all models when creating the routing table while parsing */
592 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
593 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
594
595
596 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
597 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
598 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
599 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
600 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
601 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
602 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
603
604
605 XBT_PUBLIC(double) get_cpu_power(const char *power);
606
607 #include "surf/surf_resource.h"
608
609 SG_END_DECL()
610 #endif /* _SURF_SURF_H */