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 /* FIXME: Where should the VM state be defined? */
46 /* created, but not yet started */
47 SURF_VM_STATE_CREATED,
49 SURF_VM_STATE_RUNNING,
50 SURF_VM_STATE_MIGRATING,
52 /* Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
53 SURF_VM_STATE_SUSPENDED,
55 /* Save/restore involves disk I/O, so there should be transition states. */
58 SURF_VM_STATE_RESTORING,
62 typedef struct ws_params {
67 /* The size of other states than memory pages, which is out-of-scope of dirty
76 /* set migration speed */
78 } s_ws_params_t, *ws_params_t;
80 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
82 /** opaque structure defining a event generator for availability based on a probability distribution */
83 typedef struct probabilist_event_generator *probabilist_event_generator_t;
85 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
86 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
90 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
91 probabilist_event_generator_t date_generator,
92 probabilist_event_generator_t value_generator);
93 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
94 probabilist_event_generator_t date_generator,
95 e_surf_resource_state_t first_event_value);
96 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
97 probabilist_event_generator_t avail_duration_generator,
98 probabilist_event_generator_t unavail_duration_generator,
99 e_surf_resource_state_t first_event_value);
101 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
104 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
106 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
109 typedef xbt_dictelm_t sg_host_t;
110 static inline char* sg_host_name(sg_host_t host) {
116 * Platform creation functions. Instead of passing 123 arguments to the creation functions
117 * (one for each possible XML attribute), we pass structures containing them all. It removes the
118 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
119 * old models can just continue to ignore it without having to update their headers.
121 * It shouldn't be too costly at runtime, provided that structures living on the stack are
122 * used, instead of malloced structures.
130 tmgr_trace_t power_trace;
131 e_surf_resource_state_t initial_state;
132 tmgr_trace_t state_trace;
134 xbt_dict_t properties;
135 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
137 #define SG_PLATF_HOST_INITIALIZER { \
142 .initial_state = SURF_RESOURCE_ON,\
143 .power_trace = NULL,\
144 .state_trace = NULL,\
152 const char* link_down;
153 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
155 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
160 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
162 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
167 tmgr_trace_t bandwidth_trace;
169 tmgr_trace_t latency_trace;
170 e_surf_resource_state_t state;
171 tmgr_trace_t state_trace;
172 e_surf_link_sharing_policy_t policy;
173 xbt_dict_t properties;
174 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
176 #define SG_PLATF_LINK_INITIALIZER {\
179 .bandwidth_trace = NULL,\
181 .latency_trace = NULL,\
182 .state = SURF_RESOURCE_ON,\
183 .state_trace = NULL,\
184 .policy = SURF_LINK_SHARED,\
188 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
189 typedef struct s_sg_platf_peer_cbarg {
196 tmgr_trace_t availability_trace;
197 tmgr_trace_t state_trace;
198 } s_sg_platf_peer_cbarg_t;
200 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
202 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
203 typedef struct s_sg_platf_route_cbarg {
207 sg_routing_edge_t gw_src;
208 sg_routing_edge_t gw_dst;
209 xbt_dynar_t link_list;
210 } s_sg_platf_route_cbarg_t;
212 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
214 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
215 typedef struct s_sg_platf_cluster_cbarg {
229 const char* router_id;
230 e_surf_link_sharing_policy_t sharing_policy;
231 e_surf_link_sharing_policy_t bb_sharing_policy;
232 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
233 const char* state_trace;
234 } s_sg_platf_cluster_cbarg_t;
236 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
237 ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
239 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
240 typedef struct s_sg_platf_cabinet_cbarg {
248 } s_sg_platf_cabinet_cbarg_t;
250 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
256 xbt_dict_t properties;
257 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
259 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
265 xbt_dict_t properties;
266 unsigned long size; /* size in Gbytes */
267 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
269 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
274 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
276 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
281 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
283 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
285 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
286 typedef struct s_sg_platf_prop_cbarg {
289 } s_sg_platf_prop_cbarg_t;
291 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
293 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
294 typedef struct s_sg_platf_trace_cbarg {
299 } s_sg_platf_trace_cbarg_t;
301 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
303 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
304 typedef struct s_sg_platf_trace_connect_cbarg {
305 e_surf_trace_connect_kind_t kind;
308 } s_sg_platf_trace_connect_cbarg_t;
310 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
312 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
313 typedef struct s_sg_platf_process_cbarg {
316 xbt_dict_t properties;
318 const char *function;
321 e_surf_process_on_failure_t on_failure;
322 } s_sg_platf_process_cbarg_t;
324 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
326 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
327 typedef struct s_sg_platf_AS_cbarg {
330 } s_sg_platf_AS_cbarg_t;
332 #define SG_PLATF_AS_INITIALIZER {NULL,0}
334 /* ***************************************** */
335 /* TUTORIAL: New TAG */
337 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
338 typedef struct s_sg_platf_gpu_cbarg {
340 } s_sg_platf_gpu_cbarg_t;
342 #define SG_PLATF_GPU_INITIALIZER {NULL}
344 /* ***************************************** */
346 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
347 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
349 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
350 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
352 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
353 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
354 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
355 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
356 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
357 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
358 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
360 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
361 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
362 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
363 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
364 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
366 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
367 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
369 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
370 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
371 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
372 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
373 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
375 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
377 /* ***************************************** */
378 /* TUTORIAL: New TAG */
379 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
380 /* ***************************************** */
382 // Add route and Asroute without xml file with those functions
383 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
384 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
386 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
387 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
389 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
390 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
392 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
393 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
396 #endif /* SG_PLATF_H */