1 /* platf_private.h - Interface to the SimGrid platforms which visibility should be limited to this directory */
3 /* Copyright (c) 2004-2015. 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. */
12 #include "simgrid/host.h"
13 #include "src/surf/xml/platf.hpp"
16 #include "src/surf/xml/simgrid_dtd.h"
18 #ifndef YY_TYPEDEF_YY_SIZE_T
19 #define YY_TYPEDEF_YY_SIZE_T
20 typedef size_t yy_size_t;
23 XBT_PUBLIC(sg_netcard_t) sg_netcard_by_name_or_null(const char *name);
26 SURF_CLUSTER_FAT_TREE=2,
27 SURF_CLUSTER_FLAT = 1,
28 SURF_CLUSTER_TORUS = 0
29 } e_surf_cluster_topology_t;
31 /* ***************************************** */
33 * Platform creation functions. Instead of passing 123 arguments to the creation functions
34 * (one for each possible XML attribute), we pass structures containing them all. It removes the
35 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
36 * old models can just continue to ignore it without having to update their headers.
38 * It shouldn't be too costly at runtime, provided that structures living on the stack are
39 * used, instead of malloced structures.
44 xbt_dynar_t speed_per_pstate;
47 tmgr_trace_t speed_trace;
48 tmgr_trace_t state_trace;
50 xbt_dict_t properties;
51 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
53 #define SG_PLATF_HOST_INITIALIZER { \
54 NULL, 0, 1, 1, NULL, NULL, NULL, NULL \
60 const char* link_down;
61 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
63 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
68 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
70 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
75 tmgr_trace_t bandwidth_trace;
77 tmgr_trace_t latency_trace;
78 tmgr_trace_t state_trace;
79 e_surf_link_sharing_policy_t policy;
80 xbt_dict_t properties;
81 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
83 #define SG_PLATF_LINK_INITIALIZER {\
84 NULL, 0., NULL, 0., NULL, NULL, SURF_LINK_SHARED, NULL \
87 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
88 typedef struct s_sg_platf_peer_cbarg {
95 tmgr_trace_t availability_trace;
96 tmgr_trace_t state_trace;
97 } s_sg_platf_peer_cbarg_t;
99 #define SG_PLATF_PEER_INITIALIZER {NULL,0.0,0.0,0.0,0.0,NULL,NULL,NULL}
101 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
102 typedef struct s_sg_platf_route_cbarg {
108 std::vector<Link*> *link_list;
109 } s_sg_platf_route_cbarg_t;
111 #define SG_PLATF_ROUTE_INITIALIZER {1,NULL,NULL,NULL,NULL,NULL}
113 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
114 typedef struct s_sg_platf_cluster_cbarg {
128 e_surf_cluster_topology_t topology;
129 const char* topo_parameters;
130 xbt_dict_t properties;
131 const char* router_id;
132 e_surf_link_sharing_policy_t sharing_policy;
133 e_surf_link_sharing_policy_t bb_sharing_policy;
134 const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
135 const char* state_trace;
136 } s_sg_platf_cluster_cbarg_t;
138 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,0.0,1 \
139 ,1.,1.,0.,0.,0.,0.,0. \
140 ,SURF_CLUSTER_FLAT,NULL,NULL,NULL, \
141 SURF_LINK_SHARED,SURF_LINK_SHARED,NULL \
144 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
145 typedef struct s_sg_platf_cabinet_cbarg {
153 } s_sg_platf_cabinet_cbarg_t;
155 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,0.0,0.0,0.0}
161 const char* content_type;
162 xbt_dict_t properties;
164 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
166 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL}
172 const char* content_type;
173 xbt_dict_t properties;
174 xbt_dict_t model_properties;
176 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
178 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,0}
181 const char* storageId;
183 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
185 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
187 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
188 typedef struct s_sg_platf_prop_cbarg {
191 } s_sg_platf_prop_cbarg_t;
193 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
195 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
196 typedef struct s_sg_platf_trace_cbarg {
201 } s_sg_platf_trace_cbarg_t;
203 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,0.0,NULL}
205 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
206 typedef struct s_sg_platf_trace_connect_cbarg {
207 e_surf_trace_connect_kind_t kind;
210 } s_sg_platf_trace_connect_cbarg_t;
212 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {SURF_TRACE_CONNECT_KIND_LATENCY,NULL,NULL}
214 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
215 typedef struct s_sg_platf_process_cbarg {
218 xbt_dict_t properties;
220 const char *function;
223 e_surf_process_on_failure_t on_failure;
224 } s_sg_platf_process_cbarg_t;
226 #define SG_PLATF_PROCESS_INITIALIZER {NULL,0,NULL,NULL,NULL,-1.0,-1.0,SURF_PROCESS_ON_FAILURE_DIE}
228 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
229 typedef struct s_sg_platf_AS_cbarg {
232 } s_sg_platf_AS_cbarg_t;
234 #define SG_PLATF_AS_INITIALIZER {NULL,0}
236 /********** Routing **********/
237 void routing_cluster_add_backbone(Link* bb);
238 /*** END of the parsing cruft ***/
240 XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
241 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
243 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
244 XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
246 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
247 XBT_PUBLIC(void) sg_platf_new_hostlink(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
248 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
249 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
250 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
251 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
252 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
254 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
255 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
257 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
259 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
260 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
261 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
263 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
264 XBT_PRIVATE void sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
266 /* Prototypes of the functions offered by flex */
267 XBT_PUBLIC(int) surf_parse_lex(void);
268 XBT_PUBLIC(int) surf_parse_get_lineno(void);
269 XBT_PUBLIC(FILE *) surf_parse_get_in(void);
270 XBT_PUBLIC(FILE *) surf_parse_get_out(void);
271 XBT_PUBLIC(yy_size_t) surf_parse_get_leng(void);
272 XBT_PUBLIC(char *) surf_parse_get_text(void);
273 XBT_PUBLIC(void) surf_parse_set_lineno(int line_number);
274 XBT_PUBLIC(void) surf_parse_set_in(FILE * in_str);
275 XBT_PUBLIC(void) surf_parse_set_out(FILE * out_str);
276 XBT_PUBLIC(int) surf_parse_get_debug(void);
277 XBT_PUBLIC(void) surf_parse_set_debug(int bdebug);
278 XBT_PUBLIC(int) surf_parse_lex_destroy(void);
280 /* To include files (?) */
281 XBT_PRIVATE void surfxml_bufferstack_push(int _new);
282 XBT_PRIVATE void surfxml_bufferstack_pop(int _new);
283 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
285 XBT_PUBLIC(void) routing_route_free(sg_platf_route_cbarg_t route);
286 /********** Instr. **********/
287 XBT_PRIVATE void sg_instr_AS_begin(sg_platf_AS_cbarg_t AS);
288 XBT_PRIVATE void sg_instr_new_router(sg_platf_router_cbarg_t router);
289 XBT_PRIVATE void sg_instr_new_host(sg_platf_host_cbarg_t host);
290 XBT_PRIVATE void sg_instr_AS_end(void);
292 typedef struct s_surf_parsing_link_up_down *surf_parsing_link_up_down_t;
293 typedef struct s_surf_parsing_link_up_down {
296 } s_surf_parsing_link_up_down_t;
304 extern XBT_PRIVATE simgrid::xbt::signal<void(sg_platf_link_cbarg_t)> on_link;
305 extern XBT_PRIVATE simgrid::xbt::signal<void(sg_platf_cluster_cbarg_t)> on_cluster;
310 #endif /* SG_PLATF_H */