1 /* platf.h - Public interface to the SimGrid platforms */
3 /* Copyright (c) 2004-2014. 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. */
16 typedef void *sg_routing_link_t; /* FIXME:The actual type is model-dependent so use void* instead*/
17 typedef struct RoutingEdge *sg_routing_edge_t;
19 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
21 /** @ingroup SURF_interface
22 * @brief Defines whether a given resource is working or not */
24 SURF_RESOURCE_ON = 1, /**< Up & ready */
25 SURF_RESOURCE_OFF = 0 /**< Down & broken */
26 } e_surf_resource_state_t;
29 SURF_LINK_FULLDUPLEX = 2,
32 } e_surf_link_sharing_policy_t;
35 SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4,
36 SURF_TRACE_CONNECT_KIND_POWER = 3,
37 SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
38 SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
39 SURF_TRACE_CONNECT_KIND_LATENCY = 0
40 } e_surf_trace_connect_kind_t;
43 SURF_PROCESS_ON_FAILURE_DIE = 1,
44 SURF_PROCESS_ON_FAILURE_RESTART = 0
45 } e_surf_process_on_failure_t;
48 SURF_CLUSTER_FAT_TREE=2,
49 SURF_CLUSTER_FLAT = 1,
50 SURF_CLUSTER_TORUS = 0
51 } e_surf_cluster_topology_t;
54 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
56 /** opaque structure defining a event generator for availability based on a probability distribution */
57 typedef struct probabilist_event_generator *probabilist_event_generator_t;
59 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
60 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
64 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
65 probabilist_event_generator_t date_generator,
66 probabilist_event_generator_t value_generator);
67 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
68 probabilist_event_generator_t date_generator,
69 e_surf_resource_state_t first_event_value);
70 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
71 probabilist_event_generator_t avail_duration_generator,
72 probabilist_event_generator_t unavail_duration_generator,
73 e_surf_resource_state_t first_event_value);
75 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
78 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
80 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
84 typedef xbt_dictelm_t sg_host_t;
85 static inline char* sg_host_name(sg_host_t host) {
89 typedef xbt_dictelm_t sg_storage_t;
90 static inline char* sg_storage_name(sg_storage_t storage) {
93 /** @ingroup m_datatypes_management_details
94 * @brief Type for any simgrid size
96 typedef unsigned long long sg_size_t;
99 * Platform creation functions. Instead of passing 123 arguments to the creation functions
100 * (one for each possible XML attribute), we pass structures containing them all. It removes the
101 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
102 * old models can just continue to ignore it without having to update their headers.
104 * It shouldn't be too costly at runtime, provided that structures living on the stack are
105 * used, instead of malloced structures.
110 xbt_dynar_t power_peak;
114 tmgr_trace_t power_trace;
115 e_surf_resource_state_t initial_state;
116 tmgr_trace_t state_trace;
118 xbt_dict_t properties;
119 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
121 #define SG_PLATF_HOST_INITIALIZER { \
126 .initial_state = SURF_RESOURCE_ON,\
127 .power_trace = NULL,\
128 .state_trace = NULL,\
136 const char* link_down;
137 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
139 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
144 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
146 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
151 tmgr_trace_t bandwidth_trace;
153 tmgr_trace_t latency_trace;
154 e_surf_resource_state_t state;
155 tmgr_trace_t state_trace;
156 e_surf_link_sharing_policy_t policy;
157 xbt_dict_t properties;
158 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
160 #define SG_PLATF_LINK_INITIALIZER {\
163 .bandwidth_trace = NULL,\
165 .latency_trace = NULL,\
166 .state = SURF_RESOURCE_ON,\
167 .state_trace = NULL,\
168 .policy = SURF_LINK_SHARED,\
172 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
173 typedef struct s_sg_platf_peer_cbarg {
180 tmgr_trace_t availability_trace;
181 tmgr_trace_t state_trace;
182 } s_sg_platf_peer_cbarg_t;
184 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
186 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
187 typedef struct s_sg_platf_route_cbarg {
191 sg_routing_edge_t gw_src;
192 sg_routing_edge_t gw_dst;
193 xbt_dynar_t link_list;
194 } s_sg_platf_route_cbarg_t;
196 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
198 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
199 typedef struct s_sg_platf_cluster_cbarg {
213 e_surf_cluster_topology_t topology;
214 const char* topo_parameters;
215 xbt_dict_t properties;
216 const char* router_id;
217 e_surf_link_sharing_policy_t sharing_policy;
218 e_surf_link_sharing_policy_t bb_sharing_policy;
219 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
220 const char* state_trace;
221 } s_sg_platf_cluster_cbarg_t;
223 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
224 ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
226 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
227 typedef struct s_sg_platf_cabinet_cbarg {
235 } s_sg_platf_cabinet_cbarg_t;
237 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
243 const char* content_type;
244 xbt_dict_t properties;
246 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
248 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
254 const char* content_type;
255 xbt_dict_t properties;
256 xbt_dict_t model_properties;
258 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
260 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
265 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
267 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
270 const char* storageId;
272 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
274 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
276 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
277 typedef struct s_sg_platf_prop_cbarg {
280 } s_sg_platf_prop_cbarg_t;
282 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
284 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
285 typedef struct s_sg_platf_trace_cbarg {
290 } s_sg_platf_trace_cbarg_t;
292 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
294 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
295 typedef struct s_sg_platf_trace_connect_cbarg {
296 e_surf_trace_connect_kind_t kind;
299 } s_sg_platf_trace_connect_cbarg_t;
301 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
303 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
304 typedef struct s_sg_platf_process_cbarg {
307 xbt_dict_t properties;
309 const char *function;
312 e_surf_process_on_failure_t on_failure;
313 } s_sg_platf_process_cbarg_t;
315 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
317 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
318 typedef struct s_sg_platf_AS_cbarg {
321 } s_sg_platf_AS_cbarg_t;
323 #define SG_PLATF_AS_INITIALIZER {NULL,0}
325 /* ***************************************** */
326 /* TUTORIAL: New TAG */
328 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
329 typedef struct s_sg_platf_gpu_cbarg {
331 } s_sg_platf_gpu_cbarg_t;
333 #define SG_PLATF_GPU_INITIALIZER {NULL}
336 /* ***************************************** */
338 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
339 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
341 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
342 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
344 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
345 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
346 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
347 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
348 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
349 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
350 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
352 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
353 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
354 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
355 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
356 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
358 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
359 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
361 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
362 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
363 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
364 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
365 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
367 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
369 /* ***************************************** */
370 /* TUTORIAL: New TAG */
371 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
372 /* ***************************************** */
374 // Add route and Asroute without xml file with those functions
375 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
376 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
378 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
379 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
381 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
382 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
384 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
385 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
389 #endif /* SG_PLATF_H */