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_FLAT = 1,
49 SURF_CLUSTER_TORUS = 0
50 } e_surf_cluster_topology_t;
53 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
55 /** opaque structure defining a event generator for availability based on a probability distribution */
56 typedef struct probabilist_event_generator *probabilist_event_generator_t;
58 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
59 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
63 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
64 probabilist_event_generator_t date_generator,
65 probabilist_event_generator_t value_generator);
66 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
67 probabilist_event_generator_t date_generator,
68 e_surf_resource_state_t first_event_value);
69 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
70 probabilist_event_generator_t avail_duration_generator,
71 probabilist_event_generator_t unavail_duration_generator,
72 e_surf_resource_state_t first_event_value);
74 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
77 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
79 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
83 typedef xbt_dictelm_t sg_host_t;
84 static inline char* sg_host_name(sg_host_t host) {
88 typedef xbt_dictelm_t sg_storage_t;
89 static inline char* sg_storage_name(sg_storage_t storage) {
92 /** @ingroup m_datatypes_management_details
93 * @brief Type for any simgrid size
95 typedef unsigned long long sg_size_t;
98 * Platform creation functions. Instead of passing 123 arguments to the creation functions
99 * (one for each possible XML attribute), we pass structures containing them all. It removes the
100 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
101 * old models can just continue to ignore it without having to update their headers.
103 * It shouldn't be too costly at runtime, provided that structures living on the stack are
104 * used, instead of malloced structures.
109 xbt_dynar_t power_peak;
113 tmgr_trace_t power_trace;
114 e_surf_resource_state_t initial_state;
115 tmgr_trace_t state_trace;
117 xbt_dict_t properties;
118 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
120 #define SG_PLATF_HOST_INITIALIZER { \
125 .initial_state = SURF_RESOURCE_ON,\
126 .power_trace = NULL,\
127 .state_trace = NULL,\
135 const char* link_down;
136 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
138 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
143 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
145 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
150 tmgr_trace_t bandwidth_trace;
152 tmgr_trace_t latency_trace;
153 e_surf_resource_state_t state;
154 tmgr_trace_t state_trace;
155 e_surf_link_sharing_policy_t policy;
156 xbt_dict_t properties;
157 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
159 #define SG_PLATF_LINK_INITIALIZER {\
162 .bandwidth_trace = NULL,\
164 .latency_trace = NULL,\
165 .state = SURF_RESOURCE_ON,\
166 .state_trace = NULL,\
167 .policy = SURF_LINK_SHARED,\
171 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
172 typedef struct s_sg_platf_peer_cbarg {
179 tmgr_trace_t availability_trace;
180 tmgr_trace_t state_trace;
181 } s_sg_platf_peer_cbarg_t;
183 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
185 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
186 typedef struct s_sg_platf_route_cbarg {
190 sg_routing_edge_t gw_src;
191 sg_routing_edge_t gw_dst;
192 xbt_dynar_t link_list;
193 } s_sg_platf_route_cbarg_t;
195 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
197 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
198 typedef struct s_sg_platf_cluster_cbarg {
212 e_surf_cluster_topology_t topology;
213 const char* topo_parameters;
214 xbt_dict_t properties;
215 const char* router_id;
216 e_surf_link_sharing_policy_t sharing_policy;
217 e_surf_link_sharing_policy_t bb_sharing_policy;
218 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
219 const char* state_trace;
220 } s_sg_platf_cluster_cbarg_t;
222 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
223 ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
225 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
226 typedef struct s_sg_platf_cabinet_cbarg {
234 } s_sg_platf_cabinet_cbarg_t;
236 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
242 const char* content_type;
243 xbt_dict_t properties;
244 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
246 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
252 const char* content_type;
253 xbt_dict_t properties;
255 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
257 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
262 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
264 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
267 const char* storageId;
269 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
271 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
273 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
274 typedef struct s_sg_platf_prop_cbarg {
277 } s_sg_platf_prop_cbarg_t;
279 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
281 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
282 typedef struct s_sg_platf_trace_cbarg {
287 } s_sg_platf_trace_cbarg_t;
289 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
291 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
292 typedef struct s_sg_platf_trace_connect_cbarg {
293 e_surf_trace_connect_kind_t kind;
296 } s_sg_platf_trace_connect_cbarg_t;
298 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
300 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
301 typedef struct s_sg_platf_process_cbarg {
304 xbt_dict_t properties;
306 const char *function;
309 e_surf_process_on_failure_t on_failure;
310 } s_sg_platf_process_cbarg_t;
312 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
314 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
315 typedef struct s_sg_platf_AS_cbarg {
318 } s_sg_platf_AS_cbarg_t;
320 #define SG_PLATF_AS_INITIALIZER {NULL,0}
322 /* ***************************************** */
323 /* TUTORIAL: New TAG */
325 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
326 typedef struct s_sg_platf_gpu_cbarg {
328 } s_sg_platf_gpu_cbarg_t;
330 #define SG_PLATF_GPU_INITIALIZER {NULL}
332 /* ***************************************** */
334 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
335 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
337 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
338 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
340 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
341 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
342 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
343 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
344 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
345 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
346 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
348 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
349 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
350 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
351 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
352 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
354 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
355 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
357 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
358 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
359 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
360 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
361 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
363 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
365 /* ***************************************** */
366 /* TUTORIAL: New TAG */
367 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
368 /* ***************************************** */
370 // Add route and Asroute without xml file with those functions
371 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
372 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
374 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
375 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
377 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
378 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
380 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
381 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
385 #endif /* SG_PLATF_H */