Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'torus'
[simgrid.git] / include / simgrid / platf.h
1 /* platf.h - Public interface to the SimGrid platforms                      */
2
3 /* Copyright (c) 2004-2013. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef SG_PLATF_H
10 #define SG_PLATF_H
11
12 #include <xbt.h>
13
14 SG_BEGIN_DECL()
15
16 typedef void *sg_routing_link_t; /* FIXME:The actual type is model-dependent so use void* instead*/
17 typedef struct RoutingEdge *sg_routing_edge_t;
18
19 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
20
21 /** @ingroup SURF_interface
22 * @brief Defines whether a given resource is working or not */
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 typedef enum {
29   SURF_LINK_FULLDUPLEX = 2,
30   SURF_LINK_SHARED = 1,
31   SURF_LINK_FATPIPE = 0
32 } e_surf_link_sharing_policy_t;
33
34 typedef enum {
35   SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4,
36   SURF_TRACE_CONNECT_KIND_POWER = 3,
37   SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
38   SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
39   SURF_TRACE_CONNECT_KIND_LATENCY = 0
40 } e_surf_trace_connect_kind_t;
41
42 typedef enum {
43   SURF_PROCESS_ON_FAILURE_DIE = 1,
44   SURF_PROCESS_ON_FAILURE_RESTART = 0
45 } e_surf_process_on_failure_t;
46
47 typedef enum {
48   SURF_CLUSTER_FLAT = 1,
49   SURF_CLUSTER_TORUS = 0
50 } e_surf_cluster_topology_t;
51
52
53 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
54
55 /** opaque structure defining a event generator for availability based on a probability distribution */
56 typedef struct probabilist_event_generator *probabilist_event_generator_t;
57
58 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
59 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
60                                                     const char *input,
61                                                     double periodicity);
62
63 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
64                                               probabilist_event_generator_t date_generator,
65                                               probabilist_event_generator_t value_generator);
66 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
67                                               probabilist_event_generator_t date_generator,
68                                               e_surf_resource_state_t first_event_value);
69 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
70                                               probabilist_event_generator_t avail_duration_generator,
71                                               probabilist_event_generator_t unavail_duration_generator,
72                                               e_surf_resource_state_t first_event_value);
73
74 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
75                                                                            double min,
76                                                                            double max);
77 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
78                                                                            double rate);
79 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
80                                                                            double scale,
81                                                                            double shape);
82
83 typedef xbt_dictelm_t sg_host_t;
84 static inline char* sg_host_name(sg_host_t host) {
85   return host->key;
86 }
87
88 typedef xbt_dictelm_t sg_storage_t;
89 static inline char* sg_storage_name(sg_storage_t storage) {
90   return storage->key;
91 }
92 /* Type for any simgrid size */
93 typedef unsigned long long sg_size_t;
94
95 /*
96  * Platform creation functions. Instead of passing 123 arguments to the creation functions
97  * (one for each possible XML attribute), we pass structures containing them all. It removes the
98  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
99  * old models can just continue to ignore it without having to update their headers.
100  *
101  * It shouldn't be too costly at runtime, provided that structures living on the stack are
102  * used, instead of malloced structures.
103  */
104
105 typedef struct {
106   const char* id;
107   xbt_dynar_t power_peak;
108   int pstate;
109   int core_amount;
110   double power_scale;
111   tmgr_trace_t power_trace;
112   e_surf_resource_state_t initial_state;
113   tmgr_trace_t state_trace;
114   const char* coord;
115   xbt_dict_t properties;
116 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
117
118 #define SG_PLATF_HOST_INITIALIZER { \
119     .id = NULL,\
120     .power_peak = 0,\
121     .core_amount = 1.,\
122     .power_scale = 1,\
123     .initial_state = SURF_RESOURCE_ON,\
124     .power_trace = NULL,\
125     .state_trace = NULL,\
126     .coord = NULL,\
127     .properties = NULL\
128     }
129
130 typedef struct {
131   const char* id;
132   const char* link_up;
133   const char* link_down;
134 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
135
136 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
137
138 typedef struct {
139   const char* id;
140   const char* coord;
141 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
142
143 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
144
145 typedef struct {
146   const char* id;
147   double bandwidth;
148   tmgr_trace_t bandwidth_trace;
149   double latency;
150   tmgr_trace_t latency_trace;
151   e_surf_resource_state_t state;
152   tmgr_trace_t state_trace;
153   e_surf_link_sharing_policy_t policy;
154   xbt_dict_t properties;
155 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
156
157 #define SG_PLATF_LINK_INITIALIZER {\
158   .id = NULL,\
159   .bandwidth = 0.,\
160   .bandwidth_trace = NULL,\
161   .latency = 0.,\
162   .latency_trace = NULL,\
163   .state = SURF_RESOURCE_ON,\
164   .state_trace = NULL,\
165   .policy = SURF_LINK_SHARED,\
166   .properties = NULL\
167 }
168
169 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
170 typedef struct s_sg_platf_peer_cbarg {
171   const char* id;
172   double power;
173   double bw_in;
174   double bw_out;
175   double lat;
176   const char* coord;
177   tmgr_trace_t availability_trace;
178   tmgr_trace_t state_trace;
179 } s_sg_platf_peer_cbarg_t;
180
181 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
182
183 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
184 typedef struct s_sg_platf_route_cbarg {
185   int symmetrical;
186   const char *src;
187   const char *dst;
188   sg_routing_edge_t gw_src;
189   sg_routing_edge_t gw_dst;
190   xbt_dynar_t link_list;
191 } s_sg_platf_route_cbarg_t;
192
193 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
194
195 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
196 typedef struct s_sg_platf_cluster_cbarg {
197   const char* id;
198   const char* prefix;
199   const char* suffix;
200   const char* radical;
201   double power;
202   int core_amount;
203   double bw;
204   double lat;
205   double bb_bw;
206   double bb_lat;
207   double loopback_bw;
208   double loopback_lat;
209   double limiter_link;
210   e_surf_cluster_topology_t topology;
211   const char* topo_parameters;
212   xbt_dict_t properties;
213   const char* router_id;
214   e_surf_link_sharing_policy_t sharing_policy;
215   e_surf_link_sharing_policy_t bb_sharing_policy;
216   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
217   const char* state_trace;
218 } s_sg_platf_cluster_cbarg_t;
219
220 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
221   ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
222
223 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
224 typedef struct s_sg_platf_cabinet_cbarg {
225   const char* id;
226   const char* prefix;
227   const char* suffix;
228   const char* radical;
229   double power;
230   double bw;
231   double lat;
232 } s_sg_platf_cabinet_cbarg_t;
233
234 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
235
236 typedef struct {
237   const char* id;
238   const char* type_id;
239   const char* content;
240   const char* content_type;
241   xbt_dict_t properties;
242 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
243
244 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
245
246 typedef struct {
247   const char* id;
248   const char* model;
249   const char* content;
250   const char* content_type;
251   xbt_dict_t properties;
252   sg_size_t size;
253 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
254
255 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
256
257 typedef struct {
258   const char* type_id;
259   const char* name;
260 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
261
262 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
263
264 typedef struct {
265   const char* storageId;
266   const char* name;
267 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
268
269 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
270
271 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
272 typedef struct s_sg_platf_prop_cbarg {
273   const char *id;
274   const char *value;
275 } s_sg_platf_prop_cbarg_t;
276
277 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
278
279 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
280 typedef struct s_sg_platf_trace_cbarg {
281   const char *id;
282   const char *file;
283   double periodicity;
284   const char *pc_data;
285 } s_sg_platf_trace_cbarg_t;
286
287 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
288
289 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
290 typedef struct s_sg_platf_trace_connect_cbarg {
291   e_surf_trace_connect_kind_t kind;
292   const char *trace;
293   const char *element;
294 } s_sg_platf_trace_connect_cbarg_t;
295
296 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
297
298 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
299 typedef struct s_sg_platf_process_cbarg {
300   const char **argv;
301   int argc;
302   xbt_dict_t properties;
303   const char *host;
304   const char *function;
305   double start_time;
306   double kill_time;
307   e_surf_process_on_failure_t on_failure;
308 } s_sg_platf_process_cbarg_t;
309
310 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
311
312 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
313 typedef struct s_sg_platf_AS_cbarg {
314   const char *id;
315   int routing;
316 } s_sg_platf_AS_cbarg_t;
317
318 #define SG_PLATF_AS_INITIALIZER {NULL,0}
319
320 /* ***************************************** */
321 /* TUTORIAL: New TAG                         */
322
323 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
324 typedef struct s_sg_platf_gpu_cbarg {
325   const char *name;
326 } s_sg_platf_gpu_cbarg_t;
327
328 #define SG_PLATF_GPU_INITIALIZER {NULL}
329
330 /* ***************************************** */
331
332 XBT_PUBLIC(void) sg_platf_begin(void);  // Start a new platform
333 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
334
335 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
336 XBT_PUBLIC(void) sg_platf_new_AS_end(void);                            // That AS is fully described
337
338 XBT_PUBLIC(void) sg_platf_new_host   (sg_platf_host_cbarg_t   host);   // Add an host   to the currently described AS
339 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
340 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router  to the currently described AS
341 XBT_PUBLIC(void) sg_platf_new_link   (sg_platf_link_cbarg_t link);     // Add a link    to the currently described AS
342 XBT_PUBLIC(void) sg_platf_new_peer   (sg_platf_peer_cbarg_t peer);     // Add a peer    to the currently described AS
343 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
344 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
345
346 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
347 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
348 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
349 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
350 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
351
352 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
353 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
354
355 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
356 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
357 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
358 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
359 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
360
361 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
362
363 /* ***************************************** */
364 /* TUTORIAL: New TAG                         */
365 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
366 /* ***************************************** */
367
368 // Add route and Asroute without xml file with those functions
369 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
370 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
371
372 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
373 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
374
375 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
376 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
377
378 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
379 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
380
381 SG_END_DECL()
382
383 #endif                          /* SG_PLATF_H */