Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Adding the prototype for the callback on startup mechanism.
[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   void (*set_callback) (void *resource, void value, void *function, void *arg);
144   int (*get_callback)  (void **resource, void *value, void **function, void **arg);
145   const char *name; /**< Name of this model */
146 } s_surf_model_public_t, *surf_model_public_t;
147
148 /** \brief Private data available on all models
149  *  \ingroup SURF_models
150  */
151 typedef struct surf_model_private *surf_model_private_t;
152
153 /** \brief Resource datatype
154  *  \ingroup SURF_models
155  *  
156  *  Generic data structure for a model. The workstations,
157  *  the CPUs and the network links are examples of models.
158  */
159 typedef struct surf_model {
160   surf_model_private_t common_private;
161   surf_model_public_t common_public;
162 } s_surf_model_t;
163
164 /**************************************/
165 /* Implementations of model object */
166 /**************************************/
167
168 /** \brief Timer model extension public
169  * \ingroup SURF_model
170  *
171  * Additionnal functions specific to the timer model
172  */
173 typedef struct surf_timer_model_extension_public {
174   void (*set) (double date, void *function, void *arg);
175   int (*get)  (void **function, void **arg);
176 } s_surf_timer_model_extension_public_t,
177   *surf_timer_model_extension_public_t;
178
179 /** \brief Timer model
180  *  \ingroup SURF_models
181  */
182 typedef struct surf_timer_model {
183   surf_model_private_t common_private;
184   surf_model_public_t common_public;
185   surf_timer_model_extension_public_t extension_public;
186 } s_surf_timer_model_t, *surf_timer_model_t;
187
188 /** \brief The timer model
189  *  \ingroup SURF_models
190  */
191 XBT_PUBLIC_DATA(surf_timer_model_t) surf_timer_model;
192
193 /** \brief Initializes the timer model
194  *  \ingroup SURF_models
195  */
196 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
197
198 /* Cpu model */
199
200 /** \brief CPU state
201  *  \ingroup SURF_models
202  */
203 typedef enum {
204   SURF_CPU_ON = 1,              /**< Ready        */
205   SURF_CPU_OFF = 0              /**< Running      */
206 } e_surf_cpu_state_t;
207
208 /** \brief CPU model extension public
209  *  \ingroup SURF_models
210  *  
211  *  Public functions specific to the CPU model.
212  */
213 typedef struct surf_cpu_model_extension_public {
214   surf_action_t(*execute) (void *cpu, double size);
215   surf_action_t(*sleep) (void *cpu, double duration);
216   e_surf_cpu_state_t(*get_state) (void *cpu);
217   double (*get_speed) (void *cpu, double load);
218   double (*get_available_speed) (void *cpu);
219 } s_surf_cpu_model_extension_public_t,
220     *surf_cpu_model_extension_public_t;
221
222 /** \brief CPU model datatype
223  *  \ingroup SURF_models
224  */
225 typedef struct surf_cpu_model {
226   surf_model_private_t common_private;
227   surf_model_public_t common_public;
228   surf_cpu_model_extension_public_t extension_public;
229 } s_surf_cpu_model_t, *surf_cpu_model_t;
230
231 /** \brief The CPU model
232  *  \ingroup SURF_models
233  */
234 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
235
236 /** \brief Initializes the CPU model with the model Cas01
237  *  \ingroup SURF_models
238  *
239  *  This function is called by surf_workstation_model_init_CLM03
240  *  so you shouldn't have to call it by yourself.
241  *
242  *  \see surf_workstation_model_init_CLM03()
243  */
244 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
245
246 extern XBT_PUBLIC_DATA(int) surf_cpu_model_description_size;
247 /** \brief The list of all available cpu model models
248  *  \ingroup SURF_models
249  */
250 extern XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
251
252 /* Network model */
253
254 /** \brief Network model extension public
255  *  \ingroup SURF_models
256  *
257  *  Public functions specific to the network model
258  */
259 typedef struct surf_network_model_extension_public {
260   surf_action_t(*communicate) (void *src, void *dst, double size,
261                                double max_rate);
262   const void** (*get_route) (void *src, void *dst);
263   int (*get_route_size) (void *src, void *dst);
264   const char* (*get_link_name) (const void *link);
265   double (*get_link_bandwidth) (const void *link);
266   double (*get_link_latency) (const void *link);
267 } s_surf_network_model_extension_public_t,
268     *surf_network_model_extension_public_t;
269
270 /** \brief Network model datatype
271  *  \ingroup SURF_models
272  */
273 typedef struct surf_network_model {
274   surf_model_private_t common_private;
275   surf_model_public_t common_public;
276   surf_network_model_extension_public_t extension_public;
277 } s_surf_network_model_t, *surf_network_model_t;
278
279 /** \brief The network model
280  *  \ingroup SURF_models
281  *
282  *  When creating a new API on top on SURF, you shouldn't use the
283  *  network model unless you know what you are doing. Only the workstation
284  *  model should be accessed because depending on the platform model,
285  *  the network model can be NULL.
286  */
287 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
288
289 /** \brief Initializes the platform with the network model CM02
290  *  \ingroup SURF_models
291  *  \param filename XML platform file name
292  *
293  *  This function is called by surf_workstation_model_init_CLM03
294  *  or by yourself only if you plan using surf_workstation_model_init_compound
295  *
296  *  \see surf_workstation_model_init_CLM03()
297  */
298 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
299
300 #ifdef HAVE_GTNETS
301 /** \brief Initializes the platform with the network model GTNETS
302  *  \ingroup SURF_models
303  *  \param filename XML platform file name
304  *
305  *  This function is called by surf_workstation_model_init_GTNETS
306  *  or by yourself only if you plan using surf_workstation_model_init_compound
307  *
308  *  \see surf_workstation_model_init_GTNETS()
309  */
310 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
311 #endif
312
313 /** \brief Initializes the platform with the network model Reno
314  *  \ingroup SURF_models
315  *  \param filename XML platform file name
316  *
317  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
318  *
319  *  Reference:
320  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
321  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
322  *
323  *  Call this function only if you plan using surf_workstation_model_init_compound.
324  *
325  */
326 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
327
328 /** \brief Initializes the platform with the network model Vegas
329  *  \ingroup SURF_models
330  *  \param filename XML platform file name
331  *
332  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent 
333  *  to the proportional fairness.
334  *
335  *  Reference:
336  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
337  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
338  *
339  *  Call this function only if you plan using surf_workstation_model_init_compound.
340  *
341  */
342 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
343
344 #ifdef HAVE_SDP
345 /** \brief Initializes the platform with the network model based on SDP
346  *  \ingroup SURF_models
347  *  \param filename XML platform file name
348  *
349  *  This function implements the proportional fairness known as the maximization
350  *  of x1*x2*...*xn .
351  *
352  *  Reference:
353  *
354  *  [TAG03]. Corinne Touati, Eitan Altman, and Jérôme Galtier.  
355  *  Semi-definite programming approach for bandwidth allocation and routing in networks.
356  *  Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
357  *
358  *  Call this function only if you plan using surf_workstation_model_init_compound.
359  */
360 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
361 #endif
362
363
364
365 extern XBT_PUBLIC_DATA(int) surf_network_model_description_size;
366 /** \brief The list of all available network model models
367  *  \ingroup SURF_models
368  */
369 extern XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
370
371 /** \brief Workstation model extension public
372  *  \ingroup SURF_models
373  *
374  *  Public functions specific to the workstation model.
375  */
376 typedef struct surf_workstation_model_extension_public {
377   surf_action_t(*execute) (void *workstation, double size);            /**< Execute a computation amount on a workstation
378                                                                         and create the corresponding action */
379   surf_action_t(*sleep) (void *workstation, double duration);          /**< Make a workstation sleep during a given duration */
380   e_surf_cpu_state_t(*get_state) (void *workstation);                  /**< Return the CPU state of a workstation */
381   double (*get_speed) (void *workstation, double load);                /**< Return the speed of a workstation */
382   double (*get_available_speed) (void *workstation);                   /**< Return tha available speed of a workstation */
383   surf_action_t(*communicate) (void *workstation_src,                  /**< Execute a communication amount between two workstations */
384                                void *workstation_dst, double size,
385                                double max_rate);
386   surf_action_t(*execute_parallel_task) (int workstation_nb,           /**< Execute a parallel task on several workstations */
387                                          void **workstation_list,
388                                          double *computation_amount,
389                                          double *communication_amount,
390                                          double amount,
391                                          double rate);
392   const void** (*get_route) (void *src, void *dst);                    /**< Return the network link list between two workstations */
393   int (*get_route_size) (void *src, void *dst);                        /**< Return the route size between two workstations */
394   const char* (*get_link_name) (const void *link);                     /**< Return the name of a network link */
395   double (*get_link_bandwidth) (const void *link);                     /**< Return the current bandwidth of a network link */
396   double (*get_link_latency) (const void *link);                       /**< Return the current latency of a network link */
397 } s_surf_workstation_model_extension_public_t,
398     *surf_workstation_model_extension_public_t;
399
400 /** \brief Workstation model datatype.
401  *  \ingroup SURF_models
402  *
403  */
404 typedef struct surf_workstation_model {
405   surf_model_private_t common_private;
406   surf_model_public_t common_public;
407   surf_workstation_model_extension_public_t extension_public;
408 } s_surf_workstation_model_t, *surf_workstation_model_t;
409
410 /** \brief The workstation model
411  *  \ingroup SURF_models
412  *
413  *  Note that when you create an API on top of SURF,
414  *  the workstation model should be the only one you use
415  *  because depending on the platform model, the network model and the CPU model
416  *  may not exist.
417  */
418 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
419
420 /** \brief Initializes the platform with a compound workstation model
421  *  \ingroup SURF_models
422  *  \param filename XML platform file name
423  *
424  *  This function should be called after a cpu_model and a
425  *  network_model have been set up.
426  *
427  */
428 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
429
430 /** \brief Initializes the platform with the workstation model CLM03
431  *  \ingroup SURF_models
432  *  \param filename XML platform file name
433  *
434  *  This platform model seperates the workstation model and the network model.
435  *  The workstation model will be initialized with the model CLM03, the network
436  *  model with the model CM02 and the CPU model with the model Cas01.
437  *  In future releases, some other network models will be implemented and will be
438  *  combined with the workstation model CLM03.
439  *
440  *  \see surf_workstation_model_init_KCCFLN05()
441  */
442 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
443
444 /** \brief Initializes the platform with the model KCCFLN05
445  *  \ingroup SURF_models
446  *  \param filename XML platform file name
447  *
448  *  With this model, the workstations and the network are handled
449  *  together. The network model is roughly the same as in CM02 but
450  *  interference between computations and communications can be taken
451  *  into account. This platform model is the default one for MSG and
452  *  SimDag.
453  *
454  */
455 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
456
457 /** \brief Initializes the platform with the model KCCFLN05
458  *  \ingroup SURF_models
459  *  \param filename XML platform file name
460  *
461  *  With this model, only parallel tasks can be used. Resource sharing
462  *  is done by identifying bottlenecks and giving an equal share of
463  *  the model to each action.
464  *
465  */
466 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
467
468 extern XBT_PUBLIC_DATA(int) surf_workstation_model_description_size;
469 /** \brief The list of all available workstation model models
470  *  \ingroup SURF_models
471  */
472 extern XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[];
473
474 /** \brief The network links
475  *  \ingroup SURF_models
476  *
477  *  This dict contains all network links.
478  *
479  *  \see workstation_set
480  */
481 XBT_PUBLIC_DATA(xbt_dict_t) network_link_set;
482
483 /** \brief The workstations
484  *  \ingroup SURF_models
485  *
486  *  This dict contains all workstations.
487  *
488  *  \see network_link_set
489  */
490 XBT_PUBLIC_DATA(xbt_dict_t)  workstation_set;
491
492 /** \brief List of initialized models
493  *  \ingroup SURF_models
494  */
495 XBT_PUBLIC_DATA(xbt_dynar_t)  model_list;
496
497 /*******************************************/
498 /*** SURF Globals **************************/
499 /*******************************************/
500
501 /** \brief Initialize SURF
502  *  \ingroup SURF_simulation
503  *  \param argc argument number
504  *  \param argv arguments
505  *
506  *  This function has to be called to initialize the common
507  *  structures.  Then you will have to create the environment by
508  *  calling surf_timer_model_init() and
509  *  e.g. surf_workstation_model_init_CLM03() or
510  *  surf_workstation_model_init_KCCFLN05().
511  *
512  *  \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
513  *  surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
514  */
515 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
516
517 /** \brief Performs a part of the simulation
518  *  \ingroup SURF_simulation
519  *  \return the elapsed time, or -1.0 if no event could be executed
520  *
521  *  This function execute all possible events, update the action states
522  *  and returns the time elapsed.
523  *  When you call execute or communicate on a model, the corresponding actions
524  *  are not executed immediately but only when you call surf_solve.
525  *  Note that the returned elapsed time can be zero.
526  */
527 XBT_PUBLIC(double) surf_solve(void);
528
529 /** \brief Return the current time
530  *  \ingroup SURF_simulation
531  *
532  *  Return the current time in millisecond.
533  */
534 XBT_PUBLIC(double)surf_get_clock(void);
535
536 /** \brief Exit SURF
537  *  \ingroup SURF_simulation
538  *
539  *  Clean everything.
540  *
541  *  \see surf_init()
542  */
543 XBT_PUBLIC(void) surf_exit(void);
544
545
546 SG_END_DECL()
547
548 #endif                          /* _SURF_SURF_H */