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) {
78 typedef xbt_dictelm_t sg_storage_t;
79 static inline char* sg_storage_name(sg_storage_t storage) {
84 * Platform creation functions. Instead of passing 123 arguments to the creation functions
85 * (one for each possible XML attribute), we pass structures containing them all. It removes the
86 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
87 * old models can just continue to ignore it without having to update their headers.
89 * It shouldn't be too costly at runtime, provided that structures living on the stack are
90 * used, instead of malloced structures.
95 xbt_dynar_t power_peak;
99 tmgr_trace_t power_trace;
100 e_surf_resource_state_t initial_state;
101 tmgr_trace_t state_trace;
103 xbt_dict_t properties;
104 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
106 #define SG_PLATF_HOST_INITIALIZER { \
111 .initial_state = SURF_RESOURCE_ON,\
112 .power_trace = NULL,\
113 .state_trace = NULL,\
121 const char* link_down;
122 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
124 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
129 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
131 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
136 tmgr_trace_t bandwidth_trace;
138 tmgr_trace_t latency_trace;
139 e_surf_resource_state_t state;
140 tmgr_trace_t state_trace;
141 e_surf_link_sharing_policy_t policy;
142 xbt_dict_t properties;
143 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
145 #define SG_PLATF_LINK_INITIALIZER {\
148 .bandwidth_trace = NULL,\
150 .latency_trace = NULL,\
151 .state = SURF_RESOURCE_ON,\
152 .state_trace = NULL,\
153 .policy = SURF_LINK_SHARED,\
157 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
158 typedef struct s_sg_platf_peer_cbarg {
165 tmgr_trace_t availability_trace;
166 tmgr_trace_t state_trace;
167 } s_sg_platf_peer_cbarg_t;
169 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
171 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
172 typedef struct s_sg_platf_route_cbarg {
176 sg_routing_edge_t gw_src;
177 sg_routing_edge_t gw_dst;
178 xbt_dynar_t link_list;
179 } s_sg_platf_route_cbarg_t;
181 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
183 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
184 typedef struct s_sg_platf_cluster_cbarg {
198 xbt_dict_t properties;
199 const char* router_id;
200 e_surf_link_sharing_policy_t sharing_policy;
201 e_surf_link_sharing_policy_t bb_sharing_policy;
202 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
203 const char* state_trace;
204 } s_sg_platf_cluster_cbarg_t;
206 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
207 ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
209 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
210 typedef struct s_sg_platf_cabinet_cbarg {
218 } s_sg_platf_cabinet_cbarg_t;
220 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
226 const char* content_type;
227 xbt_dict_t properties;
228 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
230 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
236 const char* content_type;
237 xbt_dict_t properties;
238 unsigned long size; /* size in Gbytes */
239 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
241 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
246 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
248 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
251 const char* storageId;
253 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
255 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
257 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
258 typedef struct s_sg_platf_prop_cbarg {
261 } s_sg_platf_prop_cbarg_t;
263 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
265 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
266 typedef struct s_sg_platf_trace_cbarg {
271 } s_sg_platf_trace_cbarg_t;
273 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
275 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
276 typedef struct s_sg_platf_trace_connect_cbarg {
277 e_surf_trace_connect_kind_t kind;
280 } s_sg_platf_trace_connect_cbarg_t;
282 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
284 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
285 typedef struct s_sg_platf_process_cbarg {
288 xbt_dict_t properties;
290 const char *function;
293 e_surf_process_on_failure_t on_failure;
294 } s_sg_platf_process_cbarg_t;
296 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
298 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
299 typedef struct s_sg_platf_AS_cbarg {
302 } s_sg_platf_AS_cbarg_t;
304 #define SG_PLATF_AS_INITIALIZER {NULL,0}
306 /* ***************************************** */
307 /* TUTORIAL: New TAG */
309 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
310 typedef struct s_sg_platf_gpu_cbarg {
312 } s_sg_platf_gpu_cbarg_t;
314 #define SG_PLATF_GPU_INITIALIZER {NULL}
316 /* ***************************************** */
318 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
319 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
321 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
322 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
324 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
325 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
326 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
327 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
328 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
329 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
330 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
332 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
333 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
334 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
335 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
336 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
338 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
339 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
341 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
342 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
343 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
344 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
345 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
347 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
349 /* ***************************************** */
350 /* TUTORIAL: New TAG */
351 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
352 /* ***************************************** */
354 // Add route and Asroute without xml file with those functions
355 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
356 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
358 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
359 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
361 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
362 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
364 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
365 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
368 #endif /* SG_PLATF_H */