Logo AND Algorithmique Numérique Distribuée

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