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);
20 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
22 /** opaque structure defining a event generator for availability based on a probability distribution */
23 typedef struct probabilist_event_generator *probabilist_event_generator_t;
25 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
26 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
29 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_generator(const char *id,
30 probabilist_event_generator_t generator1,
31 probabilist_event_generator_t generator2,
34 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
37 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
39 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
43 /** Defines whether a given resource is working or not */
45 SURF_RESOURCE_ON = 1, /**< Up & ready */
46 SURF_RESOURCE_OFF = 0 /**< Down & broken */
47 } e_surf_resource_state_t;
50 SURF_LINK_FULLDUPLEX = 2,
53 } e_surf_link_sharing_policy_t;
56 SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4,
57 SURF_TRACE_CONNECT_KIND_POWER = 3,
58 SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
59 SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
60 SURF_TRACE_CONNECT_KIND_LATENCY = 0
61 } e_surf_trace_connect_kin_t;
64 SURF_PROCESS_ON_FAILURE_DIE = 1,
65 SURF_PROCESS_ON_FAILURE_RESTART = 0
66 } e_surf_process_on_failure_t;
69 * Platform creation functions. Instead of passing 123 arguments to the creation functions
70 * (one for each possible XML attribute), we pass structures containing them all. It removes the
71 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
72 * old models can just continue to ignore it without having to update their headers.
74 * It shouldn't be too costly at runtime, provided that structures living on the stack are
75 * used, instead of malloced structures.
83 tmgr_trace_t power_trace;
84 e_surf_resource_state_t initial_state;
85 tmgr_trace_t state_trace;
87 xbt_dict_t properties;
88 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
93 const char* link_down;
94 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
100 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
105 tmgr_trace_t bandwidth_trace;
107 tmgr_trace_t latency_trace;
108 e_surf_resource_state_t state;
109 tmgr_trace_t state_trace;
110 e_surf_link_sharing_policy_t policy;
111 xbt_dict_t properties;
112 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
114 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
115 typedef struct s_sg_platf_peer_cbarg {
122 tmgr_trace_t availability_trace;
123 tmgr_trace_t state_trace;
124 } s_sg_platf_peer_cbarg_t;
126 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
127 typedef struct s_sg_platf_route_cbarg {
131 xbt_dynar_t link_list;
132 } s_sg_platf_route_cbarg_t;
134 typedef struct s_sg_platf_ASroute_cbarg *sg_platf_ASroute_cbarg_t;
135 typedef struct s_sg_platf_ASroute_cbarg {
141 xbt_dynar_t link_list;
142 } s_sg_platf_ASroute_cbarg_t;
144 typedef struct s_sg_platf_bypassRoute_cbarg *sg_platf_bypassRoute_cbarg_t;
145 typedef struct s_sg_platf_bypassRoute_cbarg {
148 xbt_dynar_t link_list;
149 } s_sg_platf_bypassRoute_cbarg_t;
151 typedef struct s_sg_platf_bypassASroute_cbarg *sg_platf_bypassASroute_cbarg_t;
152 typedef struct s_sg_platf_bypassASroute_cbarg {
157 xbt_dynar_t link_list;
158 } s_sg_platf_bypassASroute_cbarg_t;
160 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
161 typedef struct s_sg_platf_cluster_cbarg {
172 const char* router_id;
173 e_surf_link_sharing_policy_t sharing_policy;
174 e_surf_link_sharing_policy_t bb_sharing_policy;
175 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
176 const char* state_trace;
177 } s_sg_platf_cluster_cbarg_t;
179 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
180 typedef struct s_sg_platf_cabinet_cbarg {
188 } s_sg_platf_cabinet_cbarg_t;
194 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
200 xbt_dict_t properties;
201 unsigned long size; /* size in Gbytes */
202 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
207 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
212 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
214 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
215 typedef struct s_sg_platf_prop_cbarg {
218 } s_sg_platf_prop_cbarg_t;
220 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
221 typedef struct s_sg_platf_trace_cbarg {
226 } s_sg_platf_trace_cbarg_t;
228 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
229 typedef struct s_sg_platf_trace_connect_cbarg {
230 e_surf_trace_connect_kin_t kind;
233 } s_sg_platf_trace_connect_cbarg_t;
235 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
236 typedef struct s_sg_platf_process_cbarg {
239 xbt_dict_t properties;
241 const char *function;
244 e_surf_process_on_failure_t on_failure;
245 } s_sg_platf_process_cbarg_t;
247 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
248 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
250 XBT_PUBLIC(void) sg_platf_new_AS_begin(const char *id, int mode); // Begin description of new AS
251 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
253 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
254 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
255 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
256 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
257 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
258 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
259 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
261 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
262 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_ASroute_cbarg_t ASroute); // Add an ASroute
263 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_bypassRoute_cbarg_t bypassroute); // Add a bypassRoute
264 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_bypassASroute_cbarg_t bypassASroute); // Add an bypassASroute
265 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
267 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
268 XBT_PUBLIC(void) sg_platf_new_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
270 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
271 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
272 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
273 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
274 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
276 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
278 // Add route and Asroute without xml file with those functions
279 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
280 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
282 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_ASroute_cbarg_t ASroute); // Initialize ASroute
283 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_ASroute_cbarg_t ASroute); // Finalize and add a ASroute
285 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
286 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_ASroute_cbarg_t ASroute); // Add a link to link list
288 #endif /* SG_PLATF_H */