Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
change e_surf_link_sharing_policy_t into a proper enum class
[simgrid.git] / src / surf / xml / platf_private.hpp
1 /* platf_private.h - Interface to the SimGrid platforms which visibility should be limited to this directory */
2
3 /* Copyright (c) 2004-2018. The SimGrid Team.
4  * All rights reserved.                                                     */
5
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. */
8
9 #ifndef SG_PLATF_H
10 #define SG_PLATF_H
11
12 #include "simgrid/host.h"
13 #include "simgrid/s4u/Link.hpp"
14 #include "src/surf/xml/platf.hpp"
15 #include "src/surf/xml/simgrid_dtd.h"
16
17 #include <map>
18 #include <string>
19 #include <vector>
20
21 namespace simgrid {
22 namespace kernel {
23 namespace routing {
24 /* ***************************************** */
25 /*
26  * Platform creation functions. Instead of passing 123 arguments to the creation functions
27  * (one for each possible XML attribute), we pass structures containing them all. It removes the
28  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
29  * old models can just continue to ignore it without having to update their headers.
30  *
31  * It shouldn't be too costly at runtime, provided that structures living on the stack are
32  * used, instead of malloced structures.
33  */
34
35 struct HostCreationArgs {
36   const char* id = nullptr;
37   std::vector<double> speed_per_pstate;
38   int pstate               = 0;
39   int core_amount          = 0;
40   tmgr_trace_t speed_trace = nullptr;
41   tmgr_trace_t state_trace = nullptr;
42   const char* coord        = nullptr;
43   std::map<std::string, std::string>* properties = nullptr;
44 };
45
46 class HostLinkCreationArgs {
47 public:
48   std::string id;
49   std::string link_up;
50   std::string link_down;
51 };
52
53 class LinkCreationArgs {
54 public:
55   std::string id;
56   double bandwidth                    = 0;
57   tmgr_trace_t bandwidth_trace        = nullptr;
58   double latency                      = 0;
59   tmgr_trace_t latency_trace          = nullptr;
60   tmgr_trace_t state_trace            = nullptr;
61   simgrid::s4u::Link::SharingPolicy policy       = simgrid::s4u::Link::SharingPolicy::FATPIPE;
62   std::map<std::string, std::string>* properties = nullptr;
63 };
64
65 class PeerCreationArgs {
66 public:
67   std::string id;
68   double speed;
69   double bw_in;
70   double bw_out;
71   std::string coord;
72   tmgr_trace_t speed_trace;
73   tmgr_trace_t state_trace;
74 };
75
76 class RouteCreationArgs {
77 public:
78   bool symmetrical = false;
79   NetPoint* src    = nullptr;
80   NetPoint* dst    = nullptr;
81   NetPoint* gw_src = nullptr;
82   NetPoint* gw_dst = nullptr;
83   std::vector<simgrid::kernel::resource::LinkImpl*> link_list;
84 };
85
86 enum class ClusterTopology { DRAGONFLY = 3, FAT_TREE = 2, FLAT = 1, TORUS = 0 };
87
88 class ClusterCreationArgs {
89 public:
90   std::string id;
91   std::string prefix;
92   std::string suffix;
93   std::vector<int>* radicals = nullptr;
94   std::vector<double> speeds;
95   int core_amount     = 0;
96   double bw           = 0;
97   double lat          = 0;
98   double bb_bw        = 0;
99   double bb_lat       = 0;
100   double loopback_bw  = 0;
101   double loopback_lat = 0;
102   double limiter_link = 0;
103   ClusterTopology topology;
104   std::string topo_parameters;
105   std::map<std::string, std::string>* properties;
106   std::string router_id;
107   simgrid::s4u::Link::SharingPolicy sharing_policy;
108   simgrid::s4u::Link::SharingPolicy bb_sharing_policy;
109 };
110
111 class CabinetCreationArgs {
112 public:
113   std::string id;
114   std::string prefix;
115   std::string suffix;
116   std::vector<int>* radicals;
117   double speed;
118   double bw;
119   double lat;
120 };
121
122 class StorageCreationArgs {
123 public:
124   std::string id;
125   std::string type_id;
126   std::string content;
127   std::map<std::string, std::string>* properties;
128   std::string attach;
129 };
130
131 class StorageTypeCreationArgs {
132 public:
133   std::string id;
134   std::string model;
135   std::string content;
136   std::map<std::string, std::string>* properties;
137   std::map<std::string, std::string>* model_properties;
138   sg_size_t size;
139 };
140
141 class MountCreationArgs {
142 public:
143   std::string storageId;
144   std::string name;
145 };
146
147 class TraceCreationArgs {
148 public:
149   std::string id;
150   std::string file;
151   double periodicity;
152   std::string pc_data;
153 };
154
155 enum class TraceConnectKind { HOST_AVAIL, SPEED, LINK_AVAIL, BANDWIDTH, LATENCY };
156
157 class TraceConnectCreationArgs {
158 public:
159   TraceConnectKind kind;
160   std::string trace;
161   std::string element;
162 };
163
164 enum class ActorOnFailure { DIE, RESTART }; // FIXME: move to a better namespace
165
166 class ActorCreationArgs {
167 public:
168   std::vector<std::string> args;
169   std::map<std::string, std::string>* properties = nullptr;
170   const char* host                       = nullptr;
171   const char* function                   = nullptr;
172   double start_time                      = 0.0;
173   double kill_time                       = 0.0;
174   ActorOnFailure on_failure;
175 };
176
177 class ZoneCreationArgs {
178 public:
179   std::string id;
180   int routing;
181 };
182 }}}
183
184 extern "C" {
185
186 /********** Routing **********/
187 void routing_cluster_add_backbone(simgrid::kernel::resource::LinkImpl* bb);
188 /*** END of the parsing cruft ***/
189
190 XBT_PUBLIC void sg_platf_begin(); // Start a new platform
191 XBT_PUBLIC void sg_platf_end();   // Finish the creation of the platform
192
193 XBT_PUBLIC simgrid::s4u::NetZone* sg_platf_new_Zone_begin(simgrid::kernel::routing::ZoneCreationArgs* zone); // Begin description of new Zone
194 XBT_PUBLIC void sg_platf_new_Zone_seal();                                          // That Zone is fully described
195
196 XBT_PUBLIC void sg_platf_new_host(simgrid::kernel::routing::HostCreationArgs* host);      // Add a host      to the current Zone
197 XBT_PUBLIC void sg_platf_new_hostlink(simgrid::kernel::routing::HostLinkCreationArgs* h);     // Add a host_link to the current Zone
198 XBT_PUBLIC void sg_platf_new_link(simgrid::kernel::routing::LinkCreationArgs* link);          // Add a link      to the current Zone
199 XBT_PUBLIC void sg_platf_new_peer(simgrid::kernel::routing::PeerCreationArgs* peer);          // Add a peer      to the current Zone
200 XBT_PUBLIC void sg_platf_new_cluster(simgrid::kernel::routing::ClusterCreationArgs* clust);   // Add a cluster   to the current Zone
201 XBT_PUBLIC void sg_platf_new_cabinet(simgrid::kernel::routing::CabinetCreationArgs* cabinet); // Add a cabinet   to the current Zone
202 XBT_PUBLIC simgrid::kernel::routing::NetPoint*                      // Add a router    to the current Zone
203     sg_platf_new_router(std::string, const char* coords);
204
205 XBT_PUBLIC void sg_platf_new_route(simgrid::kernel::routing::RouteCreationArgs* route);             // Add a route
206 XBT_PUBLIC void sg_platf_new_bypassRoute(simgrid::kernel::routing::RouteCreationArgs* bypassroute); // Add a bypassRoute
207
208 XBT_PUBLIC void sg_platf_new_trace(simgrid::kernel::routing::TraceCreationArgs* trace);
209
210 XBT_PUBLIC void sg_platf_new_storage(simgrid::kernel::routing::StorageCreationArgs* storage); // Add a storage to the current Zone
211 XBT_PUBLIC void sg_platf_new_storage_type(simgrid::kernel::routing::StorageTypeCreationArgs* storage_type);
212 XBT_PUBLIC void sg_platf_new_mount(simgrid::kernel::routing::MountCreationArgs* mount);
213
214 XBT_PUBLIC void sg_platf_new_actor(simgrid::kernel::routing::ActorCreationArgs* actor);
215 XBT_PRIVATE void sg_platf_trace_connect(simgrid::kernel::routing::TraceConnectCreationArgs* trace_connect);
216
217 /* Prototypes of the functions offered by flex */
218 XBT_PUBLIC int surf_parse_lex();
219 XBT_PUBLIC int surf_parse_get_lineno();
220 XBT_PUBLIC FILE* surf_parse_get_in();
221 XBT_PUBLIC FILE* surf_parse_get_out();
222 XBT_PUBLIC int surf_parse_get_leng();
223 XBT_PUBLIC char* surf_parse_get_text();
224 XBT_PUBLIC void surf_parse_set_lineno(int line_number);
225 XBT_PUBLIC void surf_parse_set_in(FILE* in_str);
226 XBT_PUBLIC void surf_parse_set_out(FILE* out_str);
227 XBT_PUBLIC int surf_parse_get_debug();
228 XBT_PUBLIC void surf_parse_set_debug(int bdebug);
229 XBT_PUBLIC int surf_parse_lex_destroy();
230 }
231
232 namespace simgrid {
233 namespace surf {
234
235 extern XBT_PRIVATE simgrid::xbt::signal<void(kernel::routing::ClusterCreationArgs*)> on_cluster;
236 }
237 }
238
239 #endif                          /* SG_PLATF_H */