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"
19 #include "src/surf/xml/simgrid_dtd.h"
21 #ifndef YY_TYPEDEF_YY_SIZE_T
22 #define YY_TYPEDEF_YY_SIZE_T
23 typedef size_t yy_size_t;
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;
61 class LinkCreationArgs {
65 tmgr_trace_t bandwidth_trace = nullptr;
67 tmgr_trace_t latency_trace = nullptr;
68 tmgr_trace_t state_trace = nullptr;
69 e_surf_link_sharing_policy_t policy = SURF_LINK_FATPIPE;
70 xbt_dict_t properties = nullptr;
73 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
74 typedef struct s_sg_platf_peer_cbarg {
80 tmgr_trace_t speed_trace;
81 tmgr_trace_t state_trace;
82 } s_sg_platf_peer_cbarg_t;
84 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
85 typedef struct s_sg_platf_route_cbarg {
91 std::vector<simgrid::surf::LinkImpl*>* link_list;
92 } s_sg_platf_route_cbarg_t;
94 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
95 typedef struct s_sg_platf_cluster_cbarg {
99 std::vector<int>* radicals;
100 std::vector<double> speeds;
109 e_surf_cluster_topology_t topology;
110 const char* topo_parameters;
111 xbt_dict_t properties;
112 const char* router_id;
113 e_surf_link_sharing_policy_t sharing_policy;
114 e_surf_link_sharing_policy_t bb_sharing_policy;
115 } s_sg_platf_cluster_cbarg_t;
117 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
118 typedef struct s_sg_platf_cabinet_cbarg {
122 std::vector<int>* radicals;
126 } s_sg_platf_cabinet_cbarg_t;
132 const char* content_type;
133 xbt_dict_t properties;
135 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
141 const char* content_type;
142 xbt_dict_t properties;
143 std::map<std::string, std::string>* model_properties;
145 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
148 const char* storageId;
150 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
152 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
153 typedef struct s_sg_platf_prop_cbarg {
156 } s_sg_platf_prop_cbarg_t;
158 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
159 typedef struct s_sg_platf_trace_cbarg {
164 } s_sg_platf_trace_cbarg_t;
166 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
167 typedef struct s_sg_platf_trace_connect_cbarg {
168 e_surf_trace_connect_kind_t kind;
171 } s_sg_platf_trace_connect_cbarg_t;
173 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
174 typedef struct s_sg_platf_process_cbarg {
177 xbt_dict_t properties;
179 const char *function;
182 e_surf_process_on_failure_t on_failure;
183 } s_sg_platf_process_cbarg_t;
185 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
186 typedef struct s_sg_platf_AS_cbarg {
189 } s_sg_platf_AS_cbarg_t;
191 #define SG_PLATF_AS_INITIALIZER {nullptr,0}
193 /********** Routing **********/
194 void routing_cluster_add_backbone(simgrid::surf::LinkImpl* bb);
195 /*** END of the parsing cruft ***/
197 XBT_PUBLIC(void) sg_platf_begin(); // Start a new platform
198 XBT_PUBLIC(void) sg_platf_end(); // Finish the creation of the platform
200 XBT_PUBLIC(simgrid::s4u::NetZone*) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
201 XBT_PUBLIC(void) sg_platf_new_AS_seal(); // That AS is fully described
203 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
204 XBT_PUBLIC(void) sg_platf_new_hostlink(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
205 XBT_PUBLIC(simgrid::kernel::routing::NetPoint*)
206 sg_platf_new_router(const char* name, const char* coords); // Add a router to the currently described AS
207 XBT_PUBLIC(void) sg_platf_new_link(LinkCreationArgs* link); // Add a link to the currently described AS
208 XBT_PUBLIC(void) sg_platf_new_peer (sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
209 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
210 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
212 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
213 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
215 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
217 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
218 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
219 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
221 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
222 XBT_PRIVATE void sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
224 /* Prototypes of the functions offered by flex */
225 XBT_PUBLIC(int) surf_parse_lex();
226 XBT_PUBLIC(int) surf_parse_get_lineno();
227 XBT_PUBLIC(FILE *) surf_parse_get_in();
228 XBT_PUBLIC(FILE *) surf_parse_get_out();
229 XBT_PUBLIC(int) surf_parse_get_leng();
230 XBT_PUBLIC(char *) surf_parse_get_text();
231 XBT_PUBLIC(void) surf_parse_set_lineno(int line_number);
232 XBT_PUBLIC(void) surf_parse_set_in(FILE * in_str);
233 XBT_PUBLIC(void) surf_parse_set_out(FILE * out_str);
234 XBT_PUBLIC(int) surf_parse_get_debug();
235 XBT_PUBLIC(void) surf_parse_set_debug(int bdebug);
236 XBT_PUBLIC(int) surf_parse_lex_destroy();
238 /* To include files (?) */
239 XBT_PRIVATE void surfxml_bufferstack_push(int _new);
240 XBT_PRIVATE void surfxml_bufferstack_pop(int _new);
241 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
243 XBT_PUBLIC(void) routing_route_free(sg_platf_route_cbarg_t route);
244 /********** Instr. **********/
245 XBT_PRIVATE void sg_instr_AS_begin(sg_platf_AS_cbarg_t AS);
246 XBT_PRIVATE void sg_instr_new_router(const char* name);
247 XBT_PRIVATE void sg_instr_new_host(simgrid::s4u::Host& host);
248 XBT_PRIVATE void sg_instr_AS_end();
255 extern XBT_PRIVATE simgrid::xbt::signal<void(sg_platf_cluster_cbarg_t)> on_cluster;
260 #endif /* SG_PLATF_H */