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"
17 #include "src/surf/xml/simgrid_dtd.h"
19 #ifndef YY_TYPEDEF_YY_SIZE_T
20 #define YY_TYPEDEF_YY_SIZE_T
21 typedef size_t yy_size_t;
24 XBT_PUBLIC(sg_netcard_t) sg_netcard_by_name_or_null(const char *name);
27 SURF_CLUSTER_DRAGONFLY=3,
28 SURF_CLUSTER_FAT_TREE=2,
29 SURF_CLUSTER_FLAT = 1,
30 SURF_CLUSTER_TORUS = 0
31 } e_surf_cluster_topology_t;
33 /* ***************************************** */
35 * Platform creation functions. Instead of passing 123 arguments to the creation functions
36 * (one for each possible XML attribute), we pass structures containing them all. It removes the
37 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
38 * old models can just continue to ignore it without having to update their headers.
40 * It shouldn't be too costly at runtime, provided that structures living on the stack are
41 * used, instead of malloced structures.
46 std::vector<double> speed_per_pstate;
49 tmgr_trace_t speed_trace;
50 tmgr_trace_t state_trace;
52 xbt_dict_t properties;
53 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
58 const char* link_down;
59 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
64 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
69 tmgr_trace_t bandwidth_trace;
71 tmgr_trace_t latency_trace;
72 tmgr_trace_t state_trace;
73 e_surf_link_sharing_policy_t policy;
74 xbt_dict_t properties;
75 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
77 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
78 typedef struct s_sg_platf_peer_cbarg {
85 tmgr_trace_t speed_trace;
86 tmgr_trace_t state_trace;
87 } s_sg_platf_peer_cbarg_t;
89 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
90 typedef struct s_sg_platf_route_cbarg {
96 std::vector<Link*> *link_list;
97 } s_sg_platf_route_cbarg_t;
99 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
100 typedef struct s_sg_platf_cluster_cbarg {
104 std::vector<int>* radicals;
114 e_surf_cluster_topology_t topology;
115 const char* topo_parameters;
116 xbt_dict_t properties;
117 const char* router_id;
118 e_surf_link_sharing_policy_t sharing_policy;
119 e_surf_link_sharing_policy_t bb_sharing_policy;
120 } s_sg_platf_cluster_cbarg_t;
122 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
123 typedef struct s_sg_platf_cabinet_cbarg {
127 std::vector<int>* radicals;
131 } s_sg_platf_cabinet_cbarg_t;
137 const char* content_type;
138 xbt_dict_t properties;
140 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
146 const char* content_type;
147 xbt_dict_t properties;
148 xbt_dict_t model_properties;
150 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
153 const char* storageId;
155 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
157 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
158 typedef struct s_sg_platf_prop_cbarg {
161 } s_sg_platf_prop_cbarg_t;
163 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
164 typedef struct s_sg_platf_trace_cbarg {
169 } s_sg_platf_trace_cbarg_t;
171 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
172 typedef struct s_sg_platf_trace_connect_cbarg {
173 e_surf_trace_connect_kind_t kind;
176 } s_sg_platf_trace_connect_cbarg_t;
178 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
179 typedef struct s_sg_platf_process_cbarg {
182 xbt_dict_t properties;
184 const char *function;
187 e_surf_process_on_failure_t on_failure;
188 } s_sg_platf_process_cbarg_t;
190 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
191 typedef struct s_sg_platf_AS_cbarg {
194 } s_sg_platf_AS_cbarg_t;
196 #define SG_PLATF_AS_INITIALIZER {nullptr,0}
198 /********** Routing **********/
199 void routing_cluster_add_backbone(Link* bb);
200 /*** END of the parsing cruft ***/
202 XBT_PUBLIC(void) sg_platf_begin(); // Start a new platform
203 XBT_PUBLIC(void) sg_platf_end(); // Finish the creation of the platform
205 XBT_PUBLIC(simgrid::s4u::As*) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
206 XBT_PUBLIC(void) sg_platf_new_AS_seal(); // That AS is fully described
208 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
209 XBT_PUBLIC(void) sg_platf_new_hostlink(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
210 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router to the currently described AS
211 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
212 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
213 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
214 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
216 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
217 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
219 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
221 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
222 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
223 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
225 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
226 XBT_PRIVATE void sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
228 /* Prototypes of the functions offered by flex */
229 XBT_PUBLIC(int) surf_parse_lex();
230 XBT_PUBLIC(int) surf_parse_get_lineno();
231 XBT_PUBLIC(FILE *) surf_parse_get_in();
232 XBT_PUBLIC(FILE *) surf_parse_get_out();
233 XBT_PUBLIC(yy_size_t) surf_parse_get_leng();
234 XBT_PUBLIC(char *) surf_parse_get_text();
235 XBT_PUBLIC(void) surf_parse_set_lineno(int line_number);
236 XBT_PUBLIC(void) surf_parse_set_in(FILE * in_str);
237 XBT_PUBLIC(void) surf_parse_set_out(FILE * out_str);
238 XBT_PUBLIC(int) surf_parse_get_debug();
239 XBT_PUBLIC(void) surf_parse_set_debug(int bdebug);
240 XBT_PUBLIC(int) surf_parse_lex_destroy();
242 /* To include files (?) */
243 XBT_PRIVATE void surfxml_bufferstack_push(int _new);
244 XBT_PRIVATE void surfxml_bufferstack_pop(int _new);
245 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
247 XBT_PUBLIC(void) routing_route_free(sg_platf_route_cbarg_t route);
248 /********** Instr. **********/
249 XBT_PRIVATE void sg_instr_AS_begin(sg_platf_AS_cbarg_t AS);
250 XBT_PRIVATE void sg_instr_new_router(sg_platf_router_cbarg_t router);
251 XBT_PRIVATE void sg_instr_new_host(simgrid::s4u::Host& host);
252 XBT_PRIVATE void sg_instr_AS_end();
254 typedef struct s_surf_parsing_link_up_down *surf_parsing_link_up_down_t;
255 typedef struct s_surf_parsing_link_up_down {
258 } s_surf_parsing_link_up_down_t;
265 extern XBT_PRIVATE simgrid::xbt::signal<void(sg_platf_link_cbarg_t)> on_link;
266 extern XBT_PRIVATE simgrid::xbt::signal<void(sg_platf_cluster_cbarg_t)> on_cluster;
271 #endif /* SG_PLATF_H */