Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
forgot some functions in last commit ...
[simgrid.git] / src / include / surf / surf.h
1 /* Copyright (c) 2004-2013. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef _SURF_SURF_H
8 #define _SURF_SURF_H
9
10 #include "xbt/swag.h"
11 #include "xbt/dynar.h"
12 #include "xbt/dict.h"
13 #include "xbt/graph.h"
14 #include "xbt/misc.h"
15 #include "portable.h"
16 #include "xbt/config.h"
17 #include "surf/datatypes.h"
18 #include "xbt/lib.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/platf_interface.h"
21 #include "simgrid/datatypes.h"
22
23 SG_BEGIN_DECL()
24 /* Actions and models are highly connected structures... */
25
26 /* user-visible parameters */
27 extern double sg_tcp_gamma;
28 extern double sg_sender_gap;
29 extern double sg_latency_factor;
30 extern double sg_bandwidth_factor;
31 extern double sg_weight_S_parameter;
32 extern int sg_network_crosstraffic;
33 #ifdef HAVE_GTNETS
34 extern double sg_gtnets_jitter;
35 extern int sg_gtnets_jitter_seed;
36 #endif
37 extern xbt_dynar_t surf_path;
38
39 typedef enum {
40   SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
41   SURF_NETWORK_ELEMENT_HOST,    /* host type */
42   SURF_NETWORK_ELEMENT_ROUTER,  /* router type */
43   SURF_NETWORK_ELEMENT_AS       /* AS type */
44 } e_surf_network_element_type_t;
45
46 #ifdef __cplusplus
47 class Model;
48 class CpuModel;
49 class WorkstationModel;
50 class WorkstationVMModel;
51 class NetworkModel;
52 class StorageModel;
53 class Resource;
54 class ResourceLmm;
55 class WorkstationCLM03;
56 class NetworkCm02Link;
57 class Cpu;
58 class Action;
59 class ActionLmm;
60 class StorageActionLmm;
61 struct As;
62 struct RoutingEdge;
63 class RoutingPlatf;
64 #else
65 typedef struct Model Model;
66 typedef struct CpuModel CpuModel;
67 typedef struct WorkstationModel WorkstationModel;
68 typedef struct WorkstationVMModel WorkstationVMModel;
69 typedef struct NetworkModel NetworkModel;
70 typedef struct StorageModel StorageModel;
71 typedef struct Resource Resource;
72 typedef struct ResourceLmm ResourceLmm;
73 typedef struct WorkstationCLM03 WorkstationCLM03;
74 typedef struct NetworkCm02Link NetworkCm02Link;
75 typedef struct Cpu Cpu;
76 typedef struct Action Action;
77 typedef struct ActionLmm ActionLmm;
78 typedef struct StorageActionLmm StorageActionLmm;
79 typedef struct As As;
80 typedef struct RoutingEdge RoutingEdge;
81 typedef struct RoutingPlatf RoutingPlatf;
82 #endif
83
84 /** \ingroup SURF_models
85  *  \brief Model datatype
86  *
87  *  Generic data structure for a model. The workstations,
88  *  the CPUs and the network links are examples of models.
89  */
90 typedef Model *surf_model_t;
91 typedef CpuModel *surf_cpu_model_t;
92 typedef WorkstationModel *surf_workstation_model_t;
93 typedef WorkstationVMModel *surf_vm_workstation_model_t;
94
95 typedef NetworkModel *surf_network_model_t;
96 typedef StorageModel *surf_storage_model_t;
97
98 typedef xbt_dictelm_t surf_resource_t;
99 typedef Resource *surf_cpp_resource_t;
100 typedef WorkstationCLM03 *surf_workstation_CLM03_t;
101 typedef NetworkCm02Link *surf_network_link_t;
102 typedef Cpu *surf_cpu_t;
103
104 /** \ingroup SURF_actions
105  *  \brief Action structure
106  *
107  *  Never create s_surf_action_t by yourself ! The actions are created
108  *  on the fly when you call execute or communicate on a model.
109  *
110  *  \see e_surf_action_state_t
111  */
112 typedef Action *surf_action_t;
113 typedef ActionLmm *surf_action_lmm_t;
114 typedef StorageActionLmm *surf_storage_action_lmm_t;
115
116 typedef As *AS_t;
117 typedef RoutingEdge *routing_edge_t;
118 typedef RoutingPlatf *routing_platf_t;
119
120 typedef struct surf_file *surf_file_t;
121
122 XBT_PUBLIC(e_surf_network_element_type_t)
123   routing_get_network_element_type(const char* name);
124
125 /** @Brief Specify that we use that action */
126 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
127
128 /** @brief Creates a new action.
129  *
130  * @param size The size is the one of the subtype you want to create
131  * @param cost initial value
132  * @param model to which model we should attach this action
133  * @param failed whether we should start this action in failed mode
134  */
135 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
136                                    surf_model_t model, int failed);
137
138 /** \brief Resource model description
139  */
140 typedef struct surf_model_description {
141   const char *name;
142   const char *description;
143   void_f_void_t model_init_preparse;
144 } s_surf_model_description_t, *surf_model_description_t;
145
146 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
147                                        const char *name);
148 XBT_PUBLIC(void) model_help(const char *category,
149                             s_surf_model_description_t * table);
150
151 /** \ingroup SURF_actions
152  *  \brief Action states
153  *
154  *  Action states.
155  *
156  *  \see surf_action_t, surf_action_state_t
157  */
158
159 typedef enum {
160   SURF_ACTION_READY = 0,        /**< Ready        */
161   SURF_ACTION_RUNNING,          /**< Running      */
162   SURF_ACTION_FAILED,           /**< Task Failure */
163   SURF_ACTION_DONE,             /**< Completed    */
164   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
165   SURF_ACTION_NOT_IN_THE_SYSTEM
166                                 /**< Not in the system anymore. Why did you ask ? */
167 } e_surf_action_state_t;
168
169 /* FIXME: Where should the VM state be defined? */
170 typedef enum {
171   /* created, but not yet started */
172   SURF_VM_STATE_CREATED,
173
174   SURF_VM_STATE_RUNNING,
175   SURF_VM_STATE_MIGRATING,
176
177   /* Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
178   SURF_VM_STATE_SUSPENDED,
179
180   /* Save/restore involves disk I/O, so there should be transition states. */
181   SURF_VM_STATE_SAVING,
182   SURF_VM_STATE_SAVED,
183   SURF_VM_STATE_RESTORING,
184
185 } e_surf_vm_state_t;
186
187 /***************************/
188 /* Generic model object */
189 /***************************/
190 //FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
191 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
192
193 static inline void *surf_cpu_resource_priv(const void *host) {
194   return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
195 }
196 static inline void *surf_workstation_resource_priv(const void *host){
197   return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
198 }
199 static inline void *surf_storage_resource_priv(const void *storage){
200   return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
201 }
202
203 static inline void *surf_cpu_resource_by_name(const char *name) {
204   return xbt_lib_get_elm_or_null(host_lib, name);
205 }
206 static inline void *surf_workstation_resource_by_name(const char *name){
207   return xbt_lib_get_elm_or_null(host_lib, name);
208 }
209 static inline void *surf_storage_resource_by_name(const char *name){
210   return xbt_lib_get_elm_or_null(storage_lib, name);
211 }
212
213 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
214 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
215 XBT_PUBLIC(void)  surf_as_cluster_set_backbone(AS_t as, void* backbone);
216 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
217 XBT_PUBLIC(xbt_swag_t) surf_model_done_action_set(surf_model_t model);
218 XBT_PUBLIC(xbt_swag_t) surf_model_failed_action_set(surf_model_t model);
219 XBT_PUBLIC(xbt_swag_t) surf_model_ready_action_set(surf_model_t model);
220 XBT_PUBLIC(xbt_swag_t) surf_model_running_action_set(surf_model_t model);
221 XBT_PUBLIC(surf_action_t) surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
222                                                     int workstation_nb,
223                                             void **workstation_list,
224                                             double *computation_amount,
225                                             double *communication_amount,
226                                             double rate);
227 XBT_PUBLIC(surf_action_t) surf_workstation_model_communicate(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
228 XBT_PUBLIC(xbt_dynar_t) surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst);
229 XBT_PUBLIC(void) surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host);
230 XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate);
231 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
232 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
233 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
234 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
235 XBT_PUBLIC(double) surf_workstation_get_speed(surf_resource_t resource, double load);
236 XBT_PUBLIC(double) surf_workstation_get_available_speed(surf_resource_t resource);
237 XBT_PUBLIC(int) surf_workstation_get_core(surf_resource_t resource);
238 XBT_PUBLIC(surf_action_t) surf_workstation_execute(surf_resource_t resource, double size);
239 XBT_PUBLIC(surf_action_t) surf_workstation_sleep(surf_resource_t resource, double duration);
240 XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, const char* mount, const char* path);
241 XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
242 XBT_PUBLIC(surf_action_t) surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size);
243 XBT_PUBLIC(surf_action_t) surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size);
244 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf_file_t fd);
245 XBT_PUBLIC(sg_size_t) surf_workstation_get_free_size(surf_resource_t resource, const char* name);
246 XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, const char* name);
247 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_vms(surf_resource_t resource);
248 XBT_PUBLIC(void) surf_workstation_get_params(surf_resource_t resource, ws_params_t params);
249 XBT_PUBLIC(void) surf_workstation_set_params(surf_resource_t resource, ws_params_t params);
250 XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource);
251 XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource);
252 XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource);
253 XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource);
254 XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource);
255 XBT_PUBLIC(void) surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
256 XBT_PUBLIC(surf_resource_t) surf_vm_workstation_get_pm(surf_resource_t resource);
257 XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double bound);
258 XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
259 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
260 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
261 XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
262 XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index);
263 XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
264 XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
265 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
266 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_storage_list(surf_resource_t workstation);
267 XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
268 XBT_PUBLIC(surf_action_t) surf_workstation_ls(surf_resource_t workstation, const char* mount, const char *path);
269 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
270 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
271 XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation, surf_file_t fd, sg_size_t offset, int origin);
272 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
273 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
274 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
275 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
276 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
277 XBT_PUBLIC(void) surf_storage_rename(surf_resource_t resource, const char* src, const char* dest);
278 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
279 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
280 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
281 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
282 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
283 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
284 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
285 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
286 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
287 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
288 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
289 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
290 XBT_PUBLIC(int) surf_action_get_cost(surf_action_t action);
291 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
292 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
293 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
294 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
295 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
296
297 /**************************************/
298 /* Implementations of model object */
299 /**************************************/
300
301
302 /** \ingroup SURF_models
303  *  \brief The CPU model object for the physical machine layer
304  */
305 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
306
307 /** \ingroup SURF_models
308  *  \brief The CPU model object for the virtual machine layer
309  */
310 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
311
312
313 /** \ingroup SURF_models
314  *  \brief Initializes the CPU model with the model Cas01
315  *
316  *  By default, this model uses the lazy optimization mechanism that
317  *  relies on partial invalidation in LMM and a heap for lazy action update.
318  *  You can change this behavior by setting the cpu/optim configuration
319  *  variable to a different value.
320  *
321  *  You shouldn't have to call it by yourself.
322  */
323 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
324
325 /** \ingroup SURF_models
326  *  \brief Initializes the CPU model with trace integration [Deprecated]
327  *
328  *  You shouldn't have to call it by yourself.
329  */
330 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
331
332 /** \ingroup SURF_models
333  *  \brief The list of all available optimization modes (both for cpu and networks).
334  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
335  */
336 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
337
338 /** \ingroup SURF_models
339  *  \brief The list of all available cpu model models
340  */
341 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
342
343 /**\brief create new host bypass the parser
344  *
345  */
346
347
348 /** \ingroup SURF_models
349  *  \brief The network model
350  *
351  *  When creating a new API on top on SURF, you shouldn't use the
352  *  network model unless you know what you are doing. Only the workstation
353  *  model should be accessed because depending on the platform model,
354  *  the network model can be NULL.
355  */
356 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
357
358 /** \ingroup SURF_models
359  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
360  *
361  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
362  * based on the model 'LV08' and different correction factors depending on the communication
363  * size (< 1KiB, < 64KiB, >= 64KiB).
364  * See comments in the code for more information.
365  *
366  *  \see surf_workstation_model_init_SMPI()
367  */
368 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
369
370 /** \ingroup SURF_models
371  *  \brief Initializes the platform with the network model 'LegrandVelho'
372  *
373  * This model is proposed by Arnaud Legrand and Pedro Velho based on
374  * the results obtained with the GTNets simulator for onelink and
375  * dogbone sharing scenarios. See comments in the code for more information.
376  *
377  *  \see surf_workstation_model_init_LegrandVelho()
378  */
379 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
380
381 /** \ingroup SURF_models
382  *  \brief Initializes the platform with the network model 'Constant'
383  *
384  *  In this model, the communication time between two network cards is
385  *  constant, hence no need for a routing table. This is particularly
386  *  usefull when simulating huge distributed algorithms where
387  *  scalability is really an issue. This function is called in
388  *  conjunction with surf_workstation_model_init_compound.
389  *
390  *  \see surf_workstation_model_init_compound()
391  */
392 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
393
394 /** \ingroup SURF_models
395  *  \brief Initializes the platform with the network model CM02
396  *
397  *  You sould call this function by yourself only if you plan using
398  *  surf_workstation_model_init_compound.
399  *  See comments in the code for more information.
400  */
401 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
402
403 #ifdef HAVE_GTNETS
404 /** \ingroup SURF_models
405  *  \brief Initializes the platform with the network model GTNETS
406  *  \param filename XML platform file name
407  *
408  *  This function is called by surf_workstation_model_init_GTNETS
409  *  or by yourself only if you plan using surf_workstation_model_init_compound
410  *
411  *  \see surf_workstation_model_init_GTNETS()
412  */
413 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
414 #endif
415
416 #ifdef HAVE_NS3
417 /** \ingroup SURF_models
418  *  \brief Initializes the platform with the network model NS3
419  *  \param filename XML platform file name
420  *
421  *  This function is called by surf_workstation_model_init_NS3
422  *  or by yourself only if you plan using surf_workstation_model_init_compound
423  *
424  *  \see surf_workstation_model_init_NS3()
425  */
426 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
427 #endif
428
429 /** \ingroup SURF_models
430  *  \brief Initializes the platform with the network model Reno
431  *  \param filename XML platform file name
432  *
433  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
434  *
435  *  Reference:
436  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
437  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
438  *
439  *  Call this function only if you plan using surf_workstation_model_init_compound.
440  *
441  */
442 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
443
444 /** \ingroup SURF_models
445  *  \brief Initializes the platform with the network model Reno2
446  *  \param filename XML platform file name
447  *
448  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
449  *
450  *  Reference:
451  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
452  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
453  *
454  *  Call this function only if you plan using surf_workstation_model_init_compound.
455  *
456  */
457 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
458
459 /** \ingroup SURF_models
460  *  \brief Initializes the platform with the network model Vegas
461  *  \param filename XML platform file name
462  *
463  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
464  *  to the proportional fairness.
465  *
466  *  Reference:
467  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
468  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
469  *
470  *  Call this function only if you plan using surf_workstation_model_init_compound.
471  *
472  */
473 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
474
475 /** \ingroup SURF_models
476  *  \brief The list of all available network model models
477  */
478 XBT_PUBLIC_DATA(s_surf_model_description_t)
479     surf_network_model_description[];
480
481 /** \ingroup SURF_models
482  *  \brief The storage model
483  */
484 XBT_PUBLIC(void) surf_storage_model_init_default(void);
485
486 /** \ingroup SURF_models
487  *  \brief The list of all available storage modes.
488  *  This storage mode can be set using --cfg=storage/model:...
489  */
490 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
491
492 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
493
494 /** \ingroup SURF_models
495  *  \brief The workstation model
496  *
497  *  Note that when you create an API on top of SURF,
498  *  the workstation model should be the only one you use
499  *  because depending on the platform model, the network model and the CPU model
500  *  may not exist.
501  */
502 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
503
504 /** \ingroup SURF_models
505  *  \brief The vm_workstation model
506  *
507  *  Note that when you create an API on top of SURF,
508  *  the vm_workstation model should be the only one you use
509  *  because depending on the platform model, the network model and the CPU model
510  *  may not exist.
511  */
512 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
513
514 /** \ingroup SURF_models
515  *  \brief Initializes the platform with a compound workstation model
516  *
517  *  This function should be called after a cpu_model and a
518  *  network_model have been set up.
519  *
520  */
521 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
522
523 /** \ingroup SURF_models
524  *  \brief Initializes the platform with the current best network and cpu models at hand
525  *
526  *  This platform model seperates the workstation model and the network model.
527  *  The workstation model will be initialized with the model compound, the network
528  *  model with the model LV08 (with cross traffic support) and the CPU model with
529  *  the model Cas01.
530  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
531  *
532  */
533 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
534
535 /** \ingroup SURF_models
536  *  \brief Initializes the platform with the model KCCFLN05
537  *
538  *  With this model, only parallel tasks can be used. Resource sharing
539  *  is done by identifying bottlenecks and giving an equal share of
540  *  the model to each action.
541  *
542  */
543 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
544
545 /** \ingroup SURF_models
546  *  \brief The list of all available workstation model models
547  */
548 XBT_PUBLIC_DATA(s_surf_model_description_t)
549     surf_workstation_model_description[];
550
551 /** \ingroup SURF_models
552  *  \brief Initializes the platform with the current best network and cpu models at hand
553  *
554  *  This platform model seperates the workstation model and the network model.
555  *  The workstation model will be initialized with the model compound, the network
556  *  model with the model LV08 (with cross traffic support) and the CPU model with
557  *  the model Cas01.
558  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
559  *
560  */
561 XBT_PUBLIC(void) surf_vm_workstation_model_init_current_default(void);
562
563 /** \ingroup SURF_models
564  *  \brief The list of all available vm workstation model models
565  */
566 XBT_PUBLIC_DATA(s_surf_model_description_t)
567     surf_vm_workstation_model_description[];
568
569 /*******************************************/
570
571 /** \ingroup SURF_models
572  *  \brief List of initialized models
573  */
574 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
575 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
576
577 /** \ingroup SURF_simulation
578  *  \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
579  */
580 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
581
582 /** \ingroup SURF_simulation
583  *  \brief List of hosts for which one want to be notified if they ever restart.
584  */
585 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
586
587 /*******************************************/
588 /*** SURF Platform *************************/
589 /*******************************************/
590 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void); 
591 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
592 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
593 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
594 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
595 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
596 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
597 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
598
599 /*******************************************/
600 /*** SURF Globals **************************/
601 /*******************************************/
602
603 /** \ingroup SURF_simulation
604  *  \brief Initialize SURF
605  *  \param argc argument number
606  *  \param argv arguments
607  *
608  *  This function has to be called to initialize the common
609  *  structures.  Then you will have to create the environment by
610  *  calling 
611  *  e.g. surf_workstation_model_init_CM02()
612  *
613  *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
614  */
615 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
616
617 /** \ingroup SURF_simulation
618  *  \brief Finish simulation initialization
619  *
620  *  This function must be called before the first call to surf_solve()
621  */
622 XBT_PUBLIC(void) surf_presolve(void);
623
624 /** \ingroup SURF_simulation
625  *  \brief Performs a part of the simulation
626  *  \param max_date Maximum date to update the simulation to, or -1
627  *  \return the elapsed time, or -1.0 if no event could be executed
628  *
629  *  This function execute all possible events, update the action states
630  *  and returns the time elapsed.
631  *  When you call execute or communicate on a model, the corresponding actions
632  *  are not executed immediately but only when you call surf_solve.
633  *  Note that the returned elapsed time can be zero.
634  */
635 XBT_PUBLIC(double) surf_solve(double max_date);
636
637 /** \ingroup SURF_simulation
638  *  \brief Return the current time
639  *
640  *  Return the current time in millisecond.
641  */
642 XBT_PUBLIC(double) surf_get_clock(void);
643
644 /** \ingroup SURF_simulation
645  *  \brief Exit SURF
646  *
647  *  Clean everything.
648  *
649  *  \see surf_init()
650  */
651 XBT_PUBLIC(void) surf_exit(void);
652
653 /* Prototypes of the functions that handle the properties */
654 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
655
656 /* surf parse file related (public because called from a test suite) */
657 XBT_PUBLIC(void) parse_platform_file(const char *file);
658
659 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
660 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
661 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
662 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
663 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
664 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
665 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
666
667
668 XBT_PUBLIC(double) get_cpu_power(const char *power);
669
670 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
671
672 int surf_get_nthreads(void);
673 void surf_set_nthreads(int nthreads);
674
675 /*
676  * Returns the initial path. On Windows the initial path is
677  * the current directory for the current process in the other
678  * case the function returns "./" that represents the current
679  * directory on Unix/Linux platforms.
680  */
681 const char *__surf_get_initial_path(void);
682
683 /********** Tracing **********/
684 /* from surf_instr.c */
685 void TRACE_surf_action(surf_action_t surf_action, const char *category);
686 void TRACE_surf_alloc(void);
687 void TRACE_surf_release(void);
688
689 /* instr_routing.c */
690 void instr_routing_define_callbacks (void);
691 void instr_new_variable_type (const char *new_typename, const char *color);
692 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
693 void instr_new_user_state_type (const char *father_type, const char *new_typename);
694 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
695 int instr_platform_traced (void);
696 xbt_graph_t instr_routing_platform_graph (void);
697 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
698
699 SG_END_DECL()
700 #endif                          /* _SURF_SURF_H */