1 /* platf_private.h - Interface to the SimGrid platforms which visibility should be limited to this directory */
3 /* Copyright (c) 2004-2017. 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;
26 enum e_surf_cluster_topology_t {
27 SURF_CLUSTER_DRAGONFLY = 3,
28 SURF_CLUSTER_FAT_TREE = 2,
29 SURF_CLUSTER_FLAT = 1,
30 SURF_CLUSTER_TORUS = 0
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.
44 struct s_sg_platf_host_cbarg_t {
45 const char* id = nullptr;
46 std::vector<double> speed_per_pstate;
49 tmgr_trace_t speed_trace = nullptr;
50 tmgr_trace_t state_trace = nullptr;
51 const char* coord = nullptr;
52 std::map<std::string, std::string>* properties = nullptr;
54 typedef s_sg_platf_host_cbarg_t* sg_platf_host_cbarg_t;
56 class HostLinkCreationArgs {
60 std::string link_down;
63 class LinkCreationArgs {
67 tmgr_trace_t bandwidth_trace = nullptr;
69 tmgr_trace_t latency_trace = nullptr;
70 tmgr_trace_t state_trace = nullptr;
71 e_surf_link_sharing_policy_t policy = SURF_LINK_FATPIPE;
72 std::map<std::string, std::string>* properties = nullptr;
75 class PeerCreationArgs {
82 tmgr_trace_t speed_trace;
83 tmgr_trace_t state_trace;
86 struct s_sg_platf_route_cbarg_t {
87 bool symmetrical = false;
88 sg_netpoint_t src = nullptr;
89 sg_netpoint_t dst = nullptr;
90 sg_netpoint_t gw_src = nullptr;
91 sg_netpoint_t gw_dst = nullptr;
92 std::vector<simgrid::surf::LinkImpl*> link_list;
94 typedef s_sg_platf_route_cbarg_t* sg_platf_route_cbarg_t;
96 class ClusterCreationArgs {
101 std::vector<int>* radicals = nullptr;
102 std::vector<double> speeds;
108 double loopback_bw = 0;
109 double loopback_lat = 0;
110 double limiter_link = 0;
111 e_surf_cluster_topology_t topology;
112 std::string topo_parameters;
113 std::map<std::string, std::string>* properties;
114 std::string router_id;
115 e_surf_link_sharing_policy_t sharing_policy;
116 e_surf_link_sharing_policy_t bb_sharing_policy;
119 class CabinetCreationArgs {
124 std::vector<int>* radicals;
130 class StorageCreationArgs {
135 std::map<std::string, std::string>* properties;
139 class StorageTypeCreationArgs {
144 std::map<std::string, std::string>* properties;
145 std::map<std::string, std::string>* model_properties;
149 class MountCreationArgs {
151 std::string storageId;
155 struct s_sg_platf_prop_cbarg_t {
159 typedef s_sg_platf_prop_cbarg_t* sg_platf_prop_cbarg_t;
161 class TraceCreationArgs {
169 enum class TraceConnectKind { HOST_AVAIL, SPEED, LINK_AVAIL, BANDWIDTH, LATENCY };
171 class TraceConnectCreationArgs {
173 TraceConnectKind kind;
178 enum class ActorOnFailure { DIE, RESTART };
180 class ActorCreationArgs {
182 std::vector<std::string> args;
183 std::map<std::string, std::string>* properties = nullptr;
184 const char* host = nullptr;
185 const char* function = nullptr;
186 double start_time = 0.0;
187 double kill_time = 0.0;
188 ActorOnFailure on_failure;
191 class ZoneCreationArgs {
197 /********** Routing **********/
198 void routing_cluster_add_backbone(simgrid::surf::LinkImpl* bb);
199 /*** END of the parsing cruft ***/
201 XBT_PUBLIC(void) sg_platf_begin(); // Start a new platform
202 XBT_PUBLIC(void) sg_platf_end(); // Finish the creation of the platform
204 XBT_PUBLIC(simgrid::s4u::NetZone*) sg_platf_new_Zone_begin(ZoneCreationArgs* zone); // Begin description of new Zone
205 XBT_PUBLIC(void) sg_platf_new_Zone_seal(); // That Zone is fully described
207 XBT_PUBLIC(void) sg_platf_new_host(sg_platf_host_cbarg_t host); // Add a host to the current Zone
208 XBT_PUBLIC(void) sg_platf_new_hostlink(HostLinkCreationArgs* h); // Add a host_link to the current Zone
209 XBT_PUBLIC(void) sg_platf_new_link(LinkCreationArgs* link); // Add a link to the current Zone
210 XBT_PUBLIC(void) sg_platf_new_peer(PeerCreationArgs* peer); // Add a peer to the current Zone
211 XBT_PUBLIC(void) sg_platf_new_cluster(ClusterCreationArgs* clust); // Add a cluster to the current Zone
212 XBT_PUBLIC(void) sg_platf_new_cabinet(CabinetCreationArgs* cabinet); // Add a cabinet to the current Zone
213 XBT_PUBLIC(simgrid::kernel::routing::NetPoint*) // Add a router to the current Zone
214 sg_platf_new_router(std::string, const char* coords);
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(TraceCreationArgs* trace);
221 XBT_PUBLIC(void) sg_platf_new_storage(StorageCreationArgs* storage); // Add a storage to the current Zone
222 XBT_PUBLIC(void) sg_platf_new_storage_type(StorageTypeCreationArgs* storage_type);
223 XBT_PUBLIC(void) sg_platf_new_mount(MountCreationArgs* mount);
225 XBT_PUBLIC(void) sg_platf_new_process(ActorCreationArgs* actor);
226 XBT_PRIVATE void sg_platf_trace_connect(TraceConnectCreationArgs* 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(int) 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();
246 extern XBT_PRIVATE simgrid::xbt::signal<void(ClusterCreationArgs*)> on_cluster;
250 #endif /* SG_PLATF_H */