1 /* platf.h - Public interface to the SimGrid platforms */
3 /* Copyright (c) 2004-2013. The SimGrid Team.
4 * All rights reserved. */
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. */
14 typedef void *sg_routing_link_t; /* The actual type is model-dependent so use void* instead*/
15 typedef struct s_routing_edge *sg_routing_edge_t;
17 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
19 /** Defines whether a given resource is working or not */
21 SURF_RESOURCE_ON = 1, /**< Up & ready */
22 SURF_RESOURCE_OFF = 0 /**< Down & broken */
23 } e_surf_resource_state_t;
26 SURF_LINK_FULLDUPLEX = 2,
29 } e_surf_link_sharing_policy_t;
32 SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4,
33 SURF_TRACE_CONNECT_KIND_POWER = 3,
34 SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
35 SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
36 SURF_TRACE_CONNECT_KIND_LATENCY = 0
37 } e_surf_trace_connect_kind_t;
40 SURF_PROCESS_ON_FAILURE_DIE = 1,
41 SURF_PROCESS_ON_FAILURE_RESTART = 0
42 } e_surf_process_on_failure_t;
45 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
47 /** opaque structure defining a event generator for availability based on a probability distribution */
48 typedef struct probabilist_event_generator *probabilist_event_generator_t;
50 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
51 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
55 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
56 probabilist_event_generator_t date_generator,
57 probabilist_event_generator_t value_generator);
58 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
59 probabilist_event_generator_t date_generator,
60 e_surf_resource_state_t first_event_value);
61 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
62 probabilist_event_generator_t avail_duration_generator,
63 probabilist_event_generator_t unavail_duration_generator,
64 e_surf_resource_state_t first_event_value);
66 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
69 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
71 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
74 typedef xbt_dictelm_t sg_host_t;
75 static inline char* sg_host_name(sg_host_t host) {
79 typedef xbt_dictelm_t sg_storage_t;
80 static inline char* sg_storage_name(sg_storage_t storage) {
83 /* Type for any integer storage size */
84 typedef uint64_t sg_storage_size_t;
88 * Platform creation functions. Instead of passing 123 arguments to the creation functions
89 * (one for each possible XML attribute), we pass structures containing them all. It removes the
90 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
91 * old models can just continue to ignore it without having to update their headers.
93 * It shouldn't be too costly at runtime, provided that structures living on the stack are
94 * used, instead of malloced structures.
99 xbt_dynar_t power_peak;
103 tmgr_trace_t power_trace;
104 e_surf_resource_state_t initial_state;
105 tmgr_trace_t state_trace;
107 xbt_dict_t properties;
108 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
110 #define SG_PLATF_HOST_INITIALIZER { \
115 .initial_state = SURF_RESOURCE_ON,\
116 .power_trace = NULL,\
117 .state_trace = NULL,\
125 const char* link_down;
126 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
128 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
133 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
135 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
140 tmgr_trace_t bandwidth_trace;
142 tmgr_trace_t latency_trace;
143 e_surf_resource_state_t state;
144 tmgr_trace_t state_trace;
145 e_surf_link_sharing_policy_t policy;
146 xbt_dict_t properties;
147 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
149 #define SG_PLATF_LINK_INITIALIZER {\
152 .bandwidth_trace = NULL,\
154 .latency_trace = NULL,\
155 .state = SURF_RESOURCE_ON,\
156 .state_trace = NULL,\
157 .policy = SURF_LINK_SHARED,\
161 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
162 typedef struct s_sg_platf_peer_cbarg {
169 tmgr_trace_t availability_trace;
170 tmgr_trace_t state_trace;
171 } s_sg_platf_peer_cbarg_t;
173 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
175 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
176 typedef struct s_sg_platf_route_cbarg {
180 sg_routing_edge_t gw_src;
181 sg_routing_edge_t gw_dst;
182 xbt_dynar_t link_list;
183 } s_sg_platf_route_cbarg_t;
185 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
187 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
188 typedef struct s_sg_platf_cluster_cbarg {
202 xbt_dict_t properties;
203 const char* router_id;
204 e_surf_link_sharing_policy_t sharing_policy;
205 e_surf_link_sharing_policy_t bb_sharing_policy;
206 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
207 const char* state_trace;
208 } s_sg_platf_cluster_cbarg_t;
210 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
211 ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
213 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
214 typedef struct s_sg_platf_cabinet_cbarg {
222 } s_sg_platf_cabinet_cbarg_t;
224 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
230 const char* content_type;
231 xbt_dict_t properties;
232 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
234 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
240 const char* content_type;
241 xbt_dict_t properties;
242 sg_storage_size_t size;
243 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
245 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
250 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
252 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
255 const char* storageId;
257 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
259 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
261 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
262 typedef struct s_sg_platf_prop_cbarg {
265 } s_sg_platf_prop_cbarg_t;
267 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
269 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
270 typedef struct s_sg_platf_trace_cbarg {
275 } s_sg_platf_trace_cbarg_t;
277 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
279 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
280 typedef struct s_sg_platf_trace_connect_cbarg {
281 e_surf_trace_connect_kind_t kind;
284 } s_sg_platf_trace_connect_cbarg_t;
286 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
288 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
289 typedef struct s_sg_platf_process_cbarg {
292 xbt_dict_t properties;
294 const char *function;
297 e_surf_process_on_failure_t on_failure;
298 } s_sg_platf_process_cbarg_t;
300 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
302 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
303 typedef struct s_sg_platf_AS_cbarg {
306 } s_sg_platf_AS_cbarg_t;
308 #define SG_PLATF_AS_INITIALIZER {NULL,0}
310 /* ***************************************** */
311 /* TUTORIAL: New TAG */
313 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
314 typedef struct s_sg_platf_gpu_cbarg {
316 } s_sg_platf_gpu_cbarg_t;
318 #define SG_PLATF_GPU_INITIALIZER {NULL}
320 /* ***************************************** */
322 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
323 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
325 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
326 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
328 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
329 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
330 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
331 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
332 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
333 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
334 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
336 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
337 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
338 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
339 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
340 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
342 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
343 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
345 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
346 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
347 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
348 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
349 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
351 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
353 /* ***************************************** */
354 /* TUTORIAL: New TAG */
355 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
356 /* ***************************************** */
358 // Add route and Asroute without xml file with those functions
359 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
360 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
362 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
363 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
365 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
366 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
368 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
369 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
372 #endif /* SG_PLATF_H */