Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
851f33daf7ed234133b43e78fdb20ef77a3f22ce
[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
17 SG_BEGIN_DECL()
18
19
20
21 /* Actions and models are higly connected structures... */
22
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 Resource 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) (const char *filename);
47 } s_surf_model_description_t, *surf_model_description_t;
48
49 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t *table,
50                                              int table_size,
51                                              const char* name, 
52                                              surf_model_t model
53                                              );
54 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t *table,
55                                           int table_size,
56                                           const char* name);
57
58 /** \brief Action structure
59  * \ingroup SURF_actions
60  *
61  *  Never create s_surf_action_t by yourself ! The actions are created
62  *  on the fly when you call execute or communicate on a model.
63  *  
64  *  \see e_surf_action_state_t
65  */
66 typedef struct surf_action {
67   s_xbt_swag_hookup_t state_hookup;
68   xbt_swag_t state_set;
69   double cost;                  /**< cost        */
70   double priority;              /**< priority (1.0 by default) */
71   double max_duration;          /**< max_duration (may fluctuate until
72                                    the task is completed) */
73   double remains;               /**< How much of that cost remains to
74                                  * be done in the currently running task */
75   double start;                 /**< start time  */
76   double finish;                /**< finish time : this is modified during the run
77                                  * and fluctuates until the task is completed */
78   void *data;                   /**< for your convenience */
79   int using;
80   surf_model_t model_type;
81 } s_surf_action_t;
82
83 /** \brief Action states
84  *  \ingroup SURF_actions
85  *
86  *  Action states.
87  *
88  *  \see surf_action_t, surf_action_state_t
89  */
90 typedef enum {
91   SURF_ACTION_READY = 0,        /**< Ready        */
92   SURF_ACTION_RUNNING,          /**< Running      */
93   SURF_ACTION_FAILED,           /**< Task Failure */
94   SURF_ACTION_DONE,             /**< Completed    */
95   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
96   SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
97 } e_surf_action_state_t;
98
99 /** \brief Action state sets
100  *  \ingroup SURF_actions
101  *
102  *  This structure contains some sets of actions.
103  *  It provides a fast access to the actions in each state.
104  *
105  *  \see surf_action_t, e_surf_action_state_t
106  */
107 typedef struct surf_action_state {
108   xbt_swag_t ready_action_set;   /**< Actions in state SURF_ACTION_READY */
109   xbt_swag_t running_action_set; /**< Actions in state SURF_ACTION_RUNNING */
110   xbt_swag_t failed_action_set;  /**< Actions in state SURF_ACTION_FAILED */
111   xbt_swag_t done_action_set;    /**< Actions in state SURF_ACTION_DONE */
112 } s_surf_action_state_t, *surf_action_state_t;
113
114 /***************************/
115 /* Generic model object */
116 /***************************/
117
118 /** \brief Public data available on all models
119  *  \ingroup SURF_models
120  *
121  *  These functions are implemented by all models.
122  */
123 typedef struct surf_model_public {
124   s_surf_action_state_t states; /**< Any living action on this model */
125   void *(*name_service) (const char *name); /**< Return a model given its name */
126   const char *(*get_resource_name) (void *resource_id); /**< Return the name of a resource */
127
128   e_surf_action_state_t(*action_get_state) (surf_action_t action); /**< Return the state of an action */
129   double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
130   double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
131   void (*action_use) (surf_action_t action); /**< Set an action used */
132   int  (*action_free) (surf_action_t action); /**< Free an action */
133   void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
134   void (*action_recycle) (surf_action_t action); /**< Recycle an action */
135   void (*action_change_state) (surf_action_t action, /**< Change an action state*/
136                                e_surf_action_state_t state);
137   void (*action_set_data) (surf_action_t action, void *data); /**< Set the user data of an action */
138   void (*suspend) (surf_action_t action); /**< Suspend an action */
139   void (*resume) (surf_action_t action); /**< Resume a suspended action */
140   int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
141   void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
142   void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
143   const char *name; /**< Name of this model */
144
145   xbt_dict_t (*get_properties) (void* link); /**< Return the properties dictionary */
146
147 } s_surf_model_public_t, *surf_model_public_t;
148
149 /** \brief Private data available on all models
150  *  \ingroup SURF_models
151  */
152 typedef struct surf_model_private *surf_model_private_t;
153
154 /** \brief Resource datatype
155  *  \ingroup SURF_models
156  *  
157  *  Generic data structure for a model. The workstations,
158  *  the CPUs and the network links are examples of models.
159  */
160 typedef struct surf_model {
161   surf_model_private_t common_private;
162   surf_model_public_t common_public;
163 } s_surf_model_t;
164
165 /**************************************/
166 /* Implementations of model object */
167 /**************************************/
168
169 /** \brief Timer model extension public
170  * \ingroup SURF_model
171  *
172  * Additionnal functions specific to the timer model
173  */
174 typedef struct surf_timer_model_extension_public {
175   void (*set) (double date, void *function, void *arg);
176   int (*get)  (void **function, void **arg);
177 } s_surf_timer_model_extension_public_t,
178   *surf_timer_model_extension_public_t;
179
180 /** \brief Timer model
181  *  \ingroup SURF_models
182  */
183 typedef struct surf_timer_model {
184   surf_model_private_t common_private;
185   surf_model_public_t common_public;
186   surf_timer_model_extension_public_t extension_public;
187 } s_surf_timer_model_t, *surf_timer_model_t;
188
189 /** \brief The timer model
190  *  \ingroup SURF_models
191  */
192 XBT_PUBLIC_DATA(surf_timer_model_t) surf_timer_model;
193
194 /** \brief Initializes the timer model
195  *  \ingroup SURF_models
196  */
197 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
198
199 /* Cpu model */
200
201 /** \brief CPU state
202  *  \ingroup SURF_models
203  */
204 typedef enum {
205   SURF_CPU_ON = 1,              /**< Ready        */
206   SURF_CPU_OFF = 0              /**< Running      */
207 } e_surf_cpu_state_t;
208
209 /** \brief CPU model extension public
210  *  \ingroup SURF_models
211  *  
212  *  Public functions specific to the CPU model.
213  */
214 typedef struct surf_cpu_model_extension_public {
215   surf_action_t(*execute) (void *cpu, double size);
216   surf_action_t(*sleep) (void *cpu, double duration);
217   e_surf_cpu_state_t(*get_state) (void *cpu);
218   double (*get_speed) (void *cpu, double load);
219   double (*get_available_speed) (void *cpu);
220 } s_surf_cpu_model_extension_public_t,
221     *surf_cpu_model_extension_public_t;
222
223 /** \brief CPU model datatype
224  *  \ingroup SURF_models
225  */
226 typedef struct surf_cpu_model {
227   surf_model_private_t common_private;
228   surf_model_public_t common_public;
229   surf_cpu_model_extension_public_t extension_public;
230 } s_surf_cpu_model_t, *surf_cpu_model_t;
231
232 /** \brief The CPU model
233  *  \ingroup SURF_models
234  */
235 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
236
237 /** \brief Initializes the CPU model with the model Cas01
238  *  \ingroup SURF_models
239  *
240  *  This function is called by surf_workstation_model_init_CLM03
241  *  so you shouldn't have to call it by yourself.
242  *
243  *  \see surf_workstation_model_init_CLM03()
244  */
245 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
246
247 XBT_PUBLIC_DATA(int) surf_cpu_model_description_size;
248 /** \brief The list of all available cpu model models
249  *  \ingroup SURF_models
250  */
251 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
252
253 /* Network model */
254
255 /** \brief Network model extension public
256  *  \ingroup SURF_models
257  *
258  *  Public functions specific to the network model
259  */
260 typedef struct surf_network_model_extension_public {
261   surf_action_t(*communicate) (void *src, void *dst, double size,
262                                double max_rate);
263   const void** (*get_route) (void *src, void *dst);
264   int (*get_route_size) (void *src, void *dst);
265   const char* (*get_link_name) (const void *link);
266   double (*get_link_bandwidth) (const void *link);
267   double (*get_link_latency) (const void *link);
268 } s_surf_network_model_extension_public_t,
269     *surf_network_model_extension_public_t;
270
271 /** \brief Network model datatype
272  *  \ingroup SURF_models
273  */
274 typedef struct surf_network_model {
275   surf_model_private_t common_private;
276   surf_model_public_t common_public;
277   surf_network_model_extension_public_t extension_public;
278 } s_surf_network_model_t, *surf_network_model_t;
279
280 /** \brief The network model
281  *  \ingroup SURF_models
282  *
283  *  When creating a new API on top on SURF, you shouldn't use the
284  *  network model unless you know what you are doing. Only the workstation
285  *  model should be accessed because depending on the platform model,
286  *  the network model can be NULL.
287  */
288 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
289
290 /** \brief Initializes the platform with the network model CM02
291  *  \ingroup SURF_models
292  *  \param filename XML platform file name
293  *
294  *  This function is called by surf_workstation_model_init_CLM03
295  *  or by yourself only if you plan using surf_workstation_model_init_compound
296  *
297  *  \see surf_workstation_model_init_CLM03()
298  */
299 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
300
301 #ifdef HAVE_GTNETS
302 /** \brief Initializes the platform with the network model GTNETS
303  *  \ingroup SURF_models
304  *  \param filename XML platform file name
305  *
306  *  This function is called by surf_workstation_model_init_GTNETS
307  *  or by yourself only if you plan using surf_workstation_model_init_compound
308  *
309  *  \see surf_workstation_model_init_GTNETS()
310  */
311 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
312 #endif
313
314 /** \brief Initializes the platform with the network model Reno
315  *  \ingroup SURF_models
316  *  \param filename XML platform file name
317  *
318  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
319  *
320  *  Reference:
321  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
322  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
323  *
324  *  Call this function only if you plan using surf_workstation_model_init_compound.
325  *
326  */
327 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
328
329 /** \brief Initializes the platform with the network model Vegas
330  *  \ingroup SURF_models
331  *  \param filename XML platform file name
332  *
333  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent 
334  *  to the proportional fairness.
335  *
336  *  Reference:
337  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
338  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
339  *
340  *  Call this function only if you plan using surf_workstation_model_init_compound.
341  *
342  */
343 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
344
345 #ifdef HAVE_SDP
346 /** \brief Initializes the platform with the network model based on SDP
347  *  \ingroup SURF_models
348  *  \param filename XML platform file name
349  *
350  *  This function implements the proportional fairness known as the maximization
351  *  of x1*x2*...*xn .
352  *
353  *  Reference:
354  *
355  *  [TAG03]. Corinne Touati, Eitan Altman, and Jérôme Galtier.  
356  *  Semi-definite programming approach for bandwidth allocation and routing in networks.
357  *  Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
358  *
359  *  Call this function only if you plan using surf_workstation_model_init_compound.
360  */
361 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
362 #endif
363
364
365
366 XBT_PUBLIC_DATA(int) surf_network_model_description_size;
367 /** \brief The list of all available network model models
368  *  \ingroup SURF_models
369  */
370 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
371
372 /** \brief Workstation model extension public
373  *  \ingroup SURF_models
374  *
375  *  Public functions specific to the workstation model.
376  */
377 typedef struct surf_workstation_model_extension_public {
378   surf_action_t(*execute) (void *workstation, double size);            /**< Execute a computation amount on a workstation
379                                                                         and create the corresponding action */
380   surf_action_t(*sleep) (void *workstation, double duration);          /**< Make a workstation sleep during a given duration */
381   e_surf_cpu_state_t(*get_state) (void *workstation);                  /**< Return the CPU state of a workstation */
382   double (*get_speed) (void *workstation, double load);                /**< Return the speed of a workstation */
383   double (*get_available_speed) (void *workstation);                   /**< Return tha available speed of a workstation */
384   surf_action_t(*communicate) (void *workstation_src,                  /**< Execute a communication amount between two workstations */
385                                void *workstation_dst, double size,
386                                double max_rate);
387
388   surf_action_t(*execute_parallel_task) (int workstation_nb,           /**< Execute a parallel task on several workstations */
389                                          void **workstation_list,
390                                          double *computation_amount,
391                                          double *communication_amount,
392                                          double amount,
393                                          double rate);
394   const void** (*get_route) (void *src, void *dst);                    /**< Return the network link list between two workstations */
395   int (*get_route_size) (void *src, void *dst);                        /**< Return the route size between two workstations */
396   const char* (*get_link_name) (const void *link);                     /**< Return the name of a network link */
397   double (*get_link_bandwidth) (const void *link);                     /**< Return the current bandwidth of a network link */
398   double (*get_link_latency) (const void *link);                       /**< Return the current latency of a network link */
399 } s_surf_workstation_model_extension_public_t,
400     *surf_workstation_model_extension_public_t;
401
402 /** \brief Workstation model datatype.
403  *  \ingroup SURF_models
404  *
405  */
406 typedef struct surf_workstation_model {
407   surf_model_private_t common_private;
408   surf_model_public_t common_public;
409   surf_workstation_model_extension_public_t extension_public;
410 } s_surf_workstation_model_t, *surf_workstation_model_t;
411
412 /** \brief The workstation model
413  *  \ingroup SURF_models
414  *
415  *  Note that when you create an API on top of SURF,
416  *  the workstation model should be the only one you use
417  *  because depending on the platform model, the network model and the CPU model
418  *  may not exist.
419  */
420 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
421
422 /** \brief Initializes the platform with a compound workstation model
423  *  \ingroup SURF_models
424  *  \param filename XML platform file name
425  *
426  *  This function should be called after a cpu_model and a
427  *  network_model have been set up.
428  *
429  */
430 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
431
432 /** \brief Initializes the platform with the workstation model CLM03
433  *  \ingroup SURF_models
434  *  \param filename XML platform file name
435  *
436  *  This platform model seperates the workstation model and the network model.
437  *  The workstation model will be initialized with the model CLM03, the network
438  *  model with the model CM02 and the CPU model with the model Cas01.
439  *  In future releases, some other network models will be implemented and will be
440  *  combined with the workstation model CLM03.
441  *
442  *  \see surf_workstation_model_init_KCCFLN05()
443  */
444 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
445
446 /** \brief Initializes the platform with the model KCCFLN05
447  *  \ingroup SURF_models
448  *  \param filename XML platform file name
449  *
450  *  With this model, the workstations and the network are handled
451  *  together. The network model is roughly the same as in CM02 but
452  *  interference between computations and communications can be taken
453  *  into account. This platform model is the default one for MSG and
454  *  SimDag.
455  *
456  */
457 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
458
459 /** \brief Initializes the platform with the model KCCFLN05
460  *  \ingroup SURF_models
461  *  \param filename XML platform file name
462  *
463  *  With this model, only parallel tasks can be used. Resource sharing
464  *  is done by identifying bottlenecks and giving an equal share of
465  *  the model to each action.
466  *
467  */
468 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
469
470 XBT_PUBLIC_DATA(int) surf_workstation_model_description_size;
471 /** \brief The list of all available workstation model models
472  *  \ingroup SURF_models
473  */
474 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[];
475
476 /** \brief The network links
477  *  \ingroup SURF_models
478  *
479  *  This dict contains all network links.
480  *
481  *  \see workstation_set
482  */
483 XBT_PUBLIC_DATA(xbt_dict_t) link_set;
484
485 /** \brief The workstations
486  *  \ingroup SURF_models
487  *
488  *  This dict contains all workstations.
489  *
490  *  \see link_set
491  */
492 XBT_PUBLIC_DATA(xbt_dict_t)  workstation_set;
493
494 /** \brief List of initialized models
495  *  \ingroup SURF_models
496  */
497 XBT_PUBLIC_DATA(xbt_dynar_t)  model_list;
498
499 /*******************************************/
500 /*** SURF Globals **************************/
501 /*******************************************/
502
503 /** \brief Initialize SURF
504  *  \ingroup SURF_simulation
505  *  \param argc argument number
506  *  \param argv arguments
507  *
508  *  This function has to be called to initialize the common
509  *  structures.  Then you will have to create the environment by
510  *  calling surf_timer_model_init() and
511  *  e.g. surf_workstation_model_init_CLM03() or
512  *  surf_workstation_model_init_KCCFLN05().
513  *
514  *  \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
515  *  surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
516  */
517 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
518
519 /** \brief Performs a part of the simulation
520  *  \ingroup SURF_simulation
521  *  \return the elapsed time, or -1.0 if no event could be executed
522  *
523  *  This function execute all possible events, update the action states
524  *  and returns the time elapsed.
525  *  When you call execute or communicate on a model, the corresponding actions
526  *  are not executed immediately but only when you call surf_solve.
527  *  Note that the returned elapsed time can be zero.
528  */
529 XBT_PUBLIC(double) surf_solve(void);
530
531 /** \brief Return the current time
532  *  \ingroup SURF_simulation
533  *
534  *  Return the current time in millisecond.
535  */
536 XBT_PUBLIC(double)surf_get_clock(void);
537
538 /** \brief Exit SURF
539  *  \ingroup SURF_simulation
540  *
541  *  Clean everything.
542  *
543  *  \see surf_init()
544  */
545 XBT_PUBLIC(void) surf_exit(void);
546
547 /* Prototypes of the functions that handle the properties */
548 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
549 void parse_properties(void);
550 void free_string(void*);
551
552 XBT_PUBLIC(void) surfxml_add_callback(xbt_dynar_t cb_list, void_f_void_t function);
553
554 SG_END_DECL()
555
556 #endif                          /* _SURF_SURF_H */