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
75 } s_ws_params_t, *ws_params_t;
77 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
79 /** opaque structure defining a event generator for availability based on a probability distribution */
80 typedef struct probabilist_event_generator *probabilist_event_generator_t;
82 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
83 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
87 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
88 probabilist_event_generator_t date_generator,
89 probabilist_event_generator_t value_generator);
90 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
91 probabilist_event_generator_t date_generator,
92 e_surf_resource_state_t first_event_value);
93 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
94 probabilist_event_generator_t avail_duration_generator,
95 probabilist_event_generator_t unavail_duration_generator,
96 e_surf_resource_state_t first_event_value);
98 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
101 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
103 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
106 typedef xbt_dictelm_t sg_host_t;
107 static inline char* sg_host_name(sg_host_t host) {
113 * Platform creation functions. Instead of passing 123 arguments to the creation functions
114 * (one for each possible XML attribute), we pass structures containing them all. It removes the
115 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
116 * old models can just continue to ignore it without having to update their headers.
118 * It shouldn't be too costly at runtime, provided that structures living on the stack are
119 * used, instead of malloced structures.
127 tmgr_trace_t power_trace;
128 e_surf_resource_state_t initial_state;
129 tmgr_trace_t state_trace;
131 xbt_dict_t properties;
132 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
134 #define SG_PLATF_HOST_INITIALIZER { \
139 .initial_state = SURF_RESOURCE_ON,\
140 .power_trace = NULL,\
141 .state_trace = NULL,\
149 const char* link_down;
150 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
152 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
157 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
159 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
164 tmgr_trace_t bandwidth_trace;
166 tmgr_trace_t latency_trace;
167 e_surf_resource_state_t state;
168 tmgr_trace_t state_trace;
169 e_surf_link_sharing_policy_t policy;
170 xbt_dict_t properties;
171 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
173 #define SG_PLATF_LINK_INITIALIZER {\
176 .bandwidth_trace = NULL,\
178 .latency_trace = NULL,\
179 .state = SURF_RESOURCE_ON,\
180 .state_trace = NULL,\
181 .policy = SURF_LINK_SHARED,\
185 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
186 typedef struct s_sg_platf_peer_cbarg {
193 tmgr_trace_t availability_trace;
194 tmgr_trace_t state_trace;
195 } s_sg_platf_peer_cbarg_t;
197 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
199 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
200 typedef struct s_sg_platf_route_cbarg {
204 sg_routing_edge_t gw_src;
205 sg_routing_edge_t gw_dst;
206 xbt_dynar_t link_list;
207 } s_sg_platf_route_cbarg_t;
209 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
211 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
212 typedef struct s_sg_platf_cluster_cbarg {
226 const char* router_id;
227 e_surf_link_sharing_policy_t sharing_policy;
228 e_surf_link_sharing_policy_t bb_sharing_policy;
229 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
230 const char* state_trace;
231 } s_sg_platf_cluster_cbarg_t;
233 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
234 ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
236 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
237 typedef struct s_sg_platf_cabinet_cbarg {
245 } s_sg_platf_cabinet_cbarg_t;
247 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
253 xbt_dict_t properties;
254 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
256 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
262 xbt_dict_t properties;
263 unsigned long size; /* size in Gbytes */
264 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
266 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
271 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
273 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
278 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
280 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
282 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
283 typedef struct s_sg_platf_prop_cbarg {
286 } s_sg_platf_prop_cbarg_t;
288 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
290 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
291 typedef struct s_sg_platf_trace_cbarg {
296 } s_sg_platf_trace_cbarg_t;
298 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
300 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
301 typedef struct s_sg_platf_trace_connect_cbarg {
302 e_surf_trace_connect_kind_t kind;
305 } s_sg_platf_trace_connect_cbarg_t;
307 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
309 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
310 typedef struct s_sg_platf_process_cbarg {
313 xbt_dict_t properties;
315 const char *function;
318 e_surf_process_on_failure_t on_failure;
319 } s_sg_platf_process_cbarg_t;
321 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
323 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
324 typedef struct s_sg_platf_AS_cbarg {
327 } s_sg_platf_AS_cbarg_t;
329 #define SG_PLATF_AS_INITIALIZER {NULL,0}
331 /* ***************************************** */
332 /* TUTORIAL: New TAG */
334 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
335 typedef struct s_sg_platf_gpu_cbarg {
337 } s_sg_platf_gpu_cbarg_t;
339 #define SG_PLATF_GPU_INITIALIZER {NULL}
341 /* ***************************************** */
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
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
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
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
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);
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_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
368 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
369 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
370 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
372 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
374 /* ***************************************** */
375 /* TUTORIAL: New TAG */
376 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
377 /* ***************************************** */
379 // Add route and Asroute without xml file with those functions
380 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
381 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
383 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
384 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
386 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
387 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
389 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
390 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
393 #endif /* SG_PLATF_H */