Logo AND Algorithmique Numérique Distribuée

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