1 /* platf.h - Public interface to the SimGrid platforms */
3 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved. */
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. */
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;
16 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
18 /** Defines whether a given resource is working or not */
20 SURF_RESOURCE_ON = 1, /**< Up & ready */
21 SURF_RESOURCE_OFF = 0 /**< Down & broken */
22 } e_surf_resource_state_t;
25 SURF_LINK_FULLDUPLEX = 2,
28 } e_surf_link_sharing_policy_t;
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;
39 SURF_PROCESS_ON_FAILURE_DIE = 1,
40 SURF_PROCESS_ON_FAILURE_RESTART = 0
41 } e_surf_process_on_failure_t;
44 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
46 /** opaque structure defining a event generator for availability based on a probability distribution */
47 typedef struct probabilist_event_generator *probabilist_event_generator_t;
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,
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);
65 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
68 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
70 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
73 typedef xbt_dictelm_t sg_host_t;
74 static inline char* sg_host_name(sg_host_t host) {
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.
85 * It shouldn't be too costly at runtime, provided that structures living on the stack are
86 * used, instead of malloced structures.
94 tmgr_trace_t power_trace;
95 e_surf_resource_state_t initial_state;
96 tmgr_trace_t state_trace;
98 xbt_dict_t properties;
99 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
101 #define SG_PLATF_HOST_INITIALIZER { \
106 .initial_state = SURF_RESOURCE_ON,\
107 .power_trace = NULL,\
108 .state_trace = NULL,\
116 const char* link_down;
117 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
119 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
124 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
126 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
131 tmgr_trace_t bandwidth_trace;
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;
140 #define SG_PLATF_LINK_INITIALIZER {\
143 .bandwidth_trace = NULL,\
145 .latency_trace = NULL,\
146 .state = SURF_RESOURCE_ON,\
147 .state_trace = NULL,\
148 .policy = SURF_LINK_SHARED,\
152 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
153 typedef struct s_sg_platf_peer_cbarg {
160 tmgr_trace_t availability_trace;
161 tmgr_trace_t state_trace;
162 } s_sg_platf_peer_cbarg_t;
164 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
166 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
167 typedef struct s_sg_platf_route_cbarg {
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;
176 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
178 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
179 typedef struct s_sg_platf_cluster_cbarg {
193 const char* router_id;
194 e_surf_link_sharing_policy_t sharing_policy;
195 e_surf_link_sharing_policy_t bb_sharing_policy;
196 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
197 const char* state_trace;
198 } s_sg_platf_cluster_cbarg_t;
200 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
201 ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
203 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
204 typedef struct s_sg_platf_cabinet_cbarg {
212 } s_sg_platf_cabinet_cbarg_t;
214 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
220 xbt_dict_t properties;
221 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
223 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
229 xbt_dict_t properties;
230 unsigned long size; /* size in Gbytes */
231 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
233 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
238 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
240 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
245 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
247 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
249 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
250 typedef struct s_sg_platf_prop_cbarg {
253 } s_sg_platf_prop_cbarg_t;
255 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
257 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
258 typedef struct s_sg_platf_trace_cbarg {
263 } s_sg_platf_trace_cbarg_t;
265 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
267 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
268 typedef struct s_sg_platf_trace_connect_cbarg {
269 e_surf_trace_connect_kind_t kind;
272 } s_sg_platf_trace_connect_cbarg_t;
274 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
276 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
277 typedef struct s_sg_platf_process_cbarg {
280 xbt_dict_t properties;
282 const char *function;
285 e_surf_process_on_failure_t on_failure;
286 } s_sg_platf_process_cbarg_t;
288 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
290 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
291 typedef struct s_sg_platf_AS_cbarg {
294 } s_sg_platf_AS_cbarg_t;
296 #define SG_PLATF_AS_INITIALIZER {NULL,0}
298 /* ***************************************** */
299 /* TUTORIAL: New TAG */
301 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
302 typedef struct s_sg_platf_gpu_cbarg {
304 } s_sg_platf_gpu_cbarg_t;
306 #define SG_PLATF_GPU_INITIALIZER {NULL}
308 /* ***************************************** */
310 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
311 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
313 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
314 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
316 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
317 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
318 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
319 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
320 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
321 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
322 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
324 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
325 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
326 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
327 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
328 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
330 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
331 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
333 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
334 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
335 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
336 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
337 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
339 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
341 /* ***************************************** */
342 /* TUTORIAL: New TAG */
343 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
344 /* ***************************************** */
346 // Add route and Asroute without xml file with those functions
347 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
348 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
350 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
351 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
353 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
354 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
356 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
357 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
360 #endif /* SG_PLATF_H */