Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' into 'master'
[simgrid.git] / src / surf / xml / surfxml_sax_cb.cpp
1 /* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "simgrid/kernel/routing/NetPoint.hpp"
7 #include "simgrid/s4u/Engine.hpp"
8 #include "simgrid/sg_config.hpp"
9 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
10 #include "src/kernel/resource/profile/Profile.hpp"
11 #include "src/surf/network_interface.hpp"
12 #include "src/surf/surf_interface.hpp"
13 #include "src/surf/xml/platf_private.hpp"
14 #include "surf/surf.hpp"
15 #include "xbt/file.hpp"
16
17 #include <boost/algorithm/string.hpp>
18 #include <boost/algorithm/string/classification.hpp>
19 #include <boost/algorithm/string/split.hpp>
20 #include <string>
21 #include <tuple>
22 #include <unordered_map>
23 #include <vector>
24
25 #include "simgrid_dtd.c"
26
27 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
28
29 static std::string surf_parsed_filename; // Currently parsed file (for the error messages)
30 std::vector<simgrid::kernel::resource::LinkImpl*>
31     parsed_link_list; /* temporary store of current list link of a route */
32
33 /*
34  * Helping functions
35  */
36 void surf_parse_assert(bool cond, const std::string& msg)
37 {
38   if (not cond) {
39     int lineno = surf_parse_lineno;
40     cleanup();
41     XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename.c_str(), lineno, msg.c_str());
42     surf_exit();
43     xbt_die("Exiting now");
44   }
45 }
46
47 void surf_parse_error(const std::string& msg)
48 {
49   int lineno = surf_parse_lineno;
50   cleanup();
51   XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename.c_str(), lineno, msg.c_str());
52   surf_exit();
53   xbt_die("Exiting now");
54 }
55
56 void surf_parse_assert_netpoint(const std::string& hostname, const std::string& pre, const std::string& post)
57 {
58   if (simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(hostname) != nullptr) // found
59     return;
60
61   std::string msg = pre + hostname + post + " Existing netpoints: \n";
62
63   std::vector<simgrid::kernel::routing::NetPoint*> netpoints =
64       simgrid::s4u::Engine::get_instance()->get_all_netpoints();
65   std::sort(netpoints.begin(), netpoints.end(),
66             [](simgrid::kernel::routing::NetPoint* a, simgrid::kernel::routing::NetPoint* b) {
67               return a->get_name() < b->get_name();
68             });
69   bool first = true;
70   for (auto const& np : netpoints) {
71     if (np->is_netzone())
72       continue;
73
74     if (not first)
75       msg += ",";
76     first = false;
77     msg += "'" + np->get_name() + "'";
78     if (msg.length() > 4096) {
79       msg.pop_back(); // remove trailing quote
80       msg += "...(list truncated)......";
81       break;
82     }
83   }
84   surf_parse_error(msg);
85 }
86
87 double surf_parse_get_double(const std::string& s)
88 {
89   try {
90     return std::stod(s);
91   } catch (const std::invalid_argument&) {
92     surf_parse_error(s + " is not a double");
93   }
94 }
95
96 int surf_parse_get_int(const std::string& s)
97 {
98   try {
99     return std::stoi(s);
100   } catch (const std::invalid_argument&) {
101     surf_parse_error(s + " is not a double");
102   }
103 }
104
105 namespace {
106
107 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
108 std::vector<int>* explodesRadical(const std::string& radicals)
109 {
110   std::vector<int>* exploded = new std::vector<int>();
111
112   // Make all hosts
113   std::vector<std::string> radical_elements;
114   boost::split(radical_elements, radicals, boost::is_any_of(","));
115   for (auto const& group : radical_elements) {
116     std::vector<std::string> radical_ends;
117     boost::split(radical_ends, group, boost::is_any_of("-"));
118     int start = surf_parse_get_int(radical_ends.front());
119     int end   = 0;
120
121     switch (radical_ends.size()) {
122       case 1:
123         end = start;
124         break;
125       case 2:
126         end = surf_parse_get_int(radical_ends.back());
127         break;
128       default:
129         surf_parse_error(std::string("Malformed radical: ") + group);
130     }
131     for (int i = start; i <= end; i++)
132       exploded->push_back(i);
133   }
134
135   return exploded;
136 }
137
138 class unit_scale : public std::unordered_map<std::string, double> {
139 public:
140   using std::unordered_map<std::string, double>::unordered_map;
141   // tuples are : <unit, value for unit, base (2 or 10), true if abbreviated>
142   explicit unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators);
143 };
144
145 unit_scale::unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators)
146 {
147   for (const auto& gen : generators) {
148     const std::string& unit = std::get<0>(gen);
149     double value            = std::get<1>(gen);
150     const int base          = std::get<2>(gen);
151     const bool abbrev       = std::get<3>(gen);
152     double mult;
153     std::vector<std::string> prefixes;
154     switch (base) {
155       case 2:
156         mult     = 1024.0;
157         prefixes = abbrev ? std::vector<std::string>{"Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi", "Yi"}
158                           : std::vector<std::string>{"kibi", "mebi", "gibi", "tebi", "pebi", "exbi", "zebi", "yobi"};
159         break;
160       case 10:
161         mult     = 1000.0;
162         prefixes = abbrev ? std::vector<std::string>{"k", "M", "G", "T", "P", "E", "Z", "Y"}
163                           : std::vector<std::string>{"kilo", "mega", "giga", "tera", "peta", "exa", "zeta", "yotta"};
164         break;
165       default:
166         THROW_IMPOSSIBLE;
167     }
168     emplace(unit, value);
169     for (const auto& prefix : prefixes) {
170       value *= mult;
171       emplace(prefix + unit, value);
172     }
173   }
174 }
175
176 /* Note: no warning is issued for unit-less values when `name' is empty. */
177 double surf_parse_get_value_with_unit(const char* string, const unit_scale& units, const char* entity_kind,
178                                       const std::string& name, const char* error_msg, const char* default_unit)
179 {
180   char* endptr;
181   errno = 0;
182   double res      = strtod(string, &endptr);
183   const char* ptr = endptr; // for const-correctness
184   if (errno == ERANGE)
185     surf_parse_error(std::string("value out of range: ") + string);
186   if (ptr == string)
187     surf_parse_error(std::string("cannot parse number:") + string);
188   if (ptr[0] == '\0') {
189     // Ok, 0 can be unit-less
190     if (res != 0 && not name.empty())
191       XBT_WARN("Deprecated unit-less value '%s' for %s %s. %s", string, entity_kind, name.c_str(), error_msg);
192     ptr = default_unit;
193   }
194   auto u = units.find(ptr);
195   if (u == units.end())
196     surf_parse_error(std::string("unknown unit: ") + ptr);
197   return res * u->second;
198 }
199 }
200
201 double surf_parse_get_time(const char* string, const char* entity_kind, const std::string& name)
202 {
203   static const unit_scale units{std::make_pair("w", 7 * 24 * 60 * 60),
204                                 std::make_pair("d", 24 * 60 * 60),
205                                 std::make_pair("h", 60 * 60),
206                                 std::make_pair("m", 60),
207                                 std::make_pair("s", 1.0),
208                                 std::make_pair("ms", 1e-3),
209                                 std::make_pair("us", 1e-6),
210                                 std::make_pair("ns", 1e-9),
211                                 std::make_pair("ps", 1e-12)};
212   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
213       "Append 's' to your time to get seconds", "s");
214 }
215
216 double surf_parse_get_size(const char* string, const char* entity_kind, const std::string& name)
217 {
218   static const unit_scale units{std::make_tuple("b", 0.125, 2, true), std::make_tuple("b", 0.125, 10, true),
219                                 std::make_tuple("B", 1.0, 2, true), std::make_tuple("B", 1.0, 10, true)};
220   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
221       "Append 'B' to get bytes (or 'b' for bits but 1B = 8b).", "B");
222 }
223
224 double surf_parse_get_bandwidth(const char* string, const char* entity_kind, const std::string& name)
225 {
226   static const unit_scale units{std::make_tuple("bps", 0.125, 2, true), std::make_tuple("bps", 0.125, 10, true),
227                                 std::make_tuple("Bps", 1.0, 2, true), std::make_tuple("Bps", 1.0, 10, true)};
228   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
229       "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
230 }
231
232 std::vector<double> surf_parse_get_bandwidths(const char* string, const char* entity_kind, const std::string& name)
233 {
234   static const unit_scale units{std::make_tuple("bps", 0.125, 2, true), std::make_tuple("bps", 0.125, 10, true),
235                                 std::make_tuple("Bps", 1.0, 2, true), std::make_tuple("Bps", 1.0, 10, true)};
236
237   std::vector<double> bandwidths;
238   std::vector<std::string> tokens;
239   boost::split(tokens, string, boost::is_any_of(";"));
240   for (auto token : tokens) {
241     bandwidths.push_back(surf_parse_get_value_with_unit(
242         token.c_str(), units, entity_kind, name,
243         "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps"));
244   }
245
246   return bandwidths;
247 }
248
249 double surf_parse_get_speed(const char* string, const char* entity_kind, const std::string& name)
250 {
251   static const unit_scale units{std::make_tuple("f", 1.0, 10, true), std::make_tuple("flops", 1.0, 10, false)};
252   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
253       "Append 'f' or 'flops' to your speed to get flop per second", "f");
254 }
255
256 static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* entity_kind, const std::string& id)
257 {
258
259   std::vector<double> speed_per_pstate;
260
261   if (strchr(speeds, ',') == nullptr){
262     double speed = surf_parse_get_speed(speeds, entity_kind, id);
263     speed_per_pstate.push_back(speed);
264   } else {
265     std::vector<std::string> pstate_list;
266     boost::split(pstate_list, speeds, boost::is_any_of(","));
267     for (auto speed_str : pstate_list) {
268       boost::trim(speed_str);
269       double speed = surf_parse_get_speed(speed_str.c_str(), entity_kind, id);
270       speed_per_pstate.push_back(speed);
271       XBT_DEBUG("Speed value: %f", speed);
272     }
273   }
274   return speed_per_pstate;
275 }
276
277 /*
278  * All the callback lists that can be overridden anywhere.
279  * (this list should probably be reduced to the bare minimum to allow the models to work)
280  */
281
282 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
283
284 /* The default current property receiver. Setup in the corresponding opening callbacks. */
285 std::unordered_map<std::string, std::string>* current_property_set       = nullptr;
286 std::unordered_map<std::string, std::string>* current_model_property_set = nullptr;
287 int ZONE_TAG                            = 0; // Whether we just opened a zone tag (to see what to do with the properties)
288
289 FILE *surf_file_to_parse = nullptr;
290
291 /* Stuff relative to storage */
292 void STag_surfxml_storage()
293 {
294   ZONE_TAG = 0;
295   XBT_DEBUG("STag_surfxml_storage");
296   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
297 }
298
299 void ETag_surfxml_storage()
300 {
301   simgrid::kernel::routing::StorageCreationArgs storage;
302
303   storage.properties   = current_property_set;
304   current_property_set = nullptr;
305
306   storage.id           = A_surfxml_storage_id;
307   storage.type_id      = A_surfxml_storage_typeId;
308   storage.content      = A_surfxml_storage_content;
309   storage.attach       = A_surfxml_storage_attach;
310
311   sg_platf_new_storage(&storage);
312 }
313 void STag_surfxml_storage___type()
314 {
315   ZONE_TAG = 0;
316   XBT_DEBUG("STag_surfxml_storage___type");
317   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
318   xbt_assert(current_model_property_set == nullptr, "Someone forgot to reset the model property set to nullptr in its closing tag (or XML malformed)");
319 }
320 void ETag_surfxml_storage___type()
321 {
322   simgrid::kernel::routing::StorageTypeCreationArgs storage_type;
323
324   storage_type.properties = current_property_set;
325   current_property_set    = nullptr;
326
327   storage_type.model_properties = current_model_property_set;
328   current_model_property_set    = nullptr;
329
330   storage_type.content = A_surfxml_storage___type_content;
331   storage_type.id      = A_surfxml_storage___type_id;
332   storage_type.model   = A_surfxml_storage___type_model;
333   storage_type.size =
334       surf_parse_get_size(A_surfxml_storage___type_size, "size of storage type", storage_type.id.c_str());
335   sg_platf_new_storage_type(&storage_type);
336 }
337
338 void STag_surfxml_mount()
339 {
340   XBT_DEBUG("STag_surfxml_mount");
341 }
342
343 void ETag_surfxml_mount()
344 {
345   simgrid::kernel::routing::MountCreationArgs mount;
346
347   mount.name      = A_surfxml_mount_name;
348   mount.storageId = A_surfxml_mount_storageId;
349   sg_platf_new_mount(&mount);
350 }
351
352 void STag_surfxml_include()
353 {
354   xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
355 }
356
357 void ETag_surfxml_include()
358 {
359   /* Won't happen since <include> is now removed since v3.18. */
360 }
361
362 /* Stag and Etag parse functions */
363 void STag_surfxml_platform() {
364   XBT_ATTRIB_UNUSED double version = surf_parse_get_double(A_surfxml_platform_version);
365
366   xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
367       "You're using an ancient XML file.\n"
368       "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
369       "instead of MBytes, MFlops and seconds.\n"
370
371       "Use simgrid_update_xml to update your file automatically. "
372       "This program is installed automatically with SimGrid, or "
373       "available in the tools/ directory of the source archive.\n"
374
375       "Please check also out the SURF section of the ChangeLog for "
376       "the 3.1 version for more information. \n"
377
378       "Last, do not forget to also update your values for "
379       "the calls to MSG_task_create (if any).");
380   xbt_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
381       "You're using an old XML file.\n"
382       "Use simgrid_update_xml to update your file automatically. "
383       "This program is installed automatically with SimGrid, or "
384       "available in the tools/ directory of the source archive.");
385   xbt_assert((version >= 4.0),
386              "******* FILE %s IS TOO OLD (v:%.1f) *********\n "
387              "Changes introduced in SimGrid 3.13:\n"
388              "  - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
389              "  - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
390              "  - DOCTYPE now point to the rignt URL.\n"
391              "  - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
392              "\n\n"
393              "Use simgrid_update_xml to update your file automatically. "
394              "This program is installed automatically with SimGrid, or "
395              "available in the tools/ directory of the source archive.",
396              surf_parsed_filename.c_str(), version);
397   if (version < 4.1) {
398     XBT_INFO("You're using a v%.1f XML file (%s) while the current standard is v4.1 "
399              "That's fine, the new version is backward compatible. \n\n"
400              "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
401              "This program is installed automatically with SimGrid, or "
402              "available in the tools/ directory of the source archive.",
403              version, surf_parsed_filename.c_str());
404   }
405   xbt_assert(version <= 4.1,
406              "******* FILE %s COMES FROM THE FUTURE (v:%.1f) *********\n "
407              "The most recent formalism that this version of SimGrid understands is v4.1.\n"
408              "Please update your code, or use another, more adapted, file.",
409              surf_parsed_filename.c_str(), version);
410 }
411 void ETag_surfxml_platform(){
412   simgrid::s4u::Engine::on_platform_created();
413 }
414
415 void STag_surfxml_host(){
416   ZONE_TAG = 0;
417   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
418 }
419
420 void STag_surfxml_prop()
421 {
422   if (ZONE_TAG) { // We need to retrieve the most recently opened zone
423     XBT_DEBUG("Set zone property %s -> %s", A_surfxml_prop_id, A_surfxml_prop_value);
424     simgrid::s4u::NetZone* netzone = simgrid::s4u::Engine::get_instance()->netzone_by_name_or_null(A_surfxml_zone_id);
425
426     netzone->set_property(std::string(A_surfxml_prop_id), A_surfxml_prop_value);
427   } else {
428     if (not current_property_set)
429       current_property_set = new std::unordered_map<std::string, std::string>; // Maybe, it should raise an error
430     current_property_set->insert({A_surfxml_prop_id, A_surfxml_prop_value});
431     XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
432               current_property_set);
433   }
434 }
435
436 void ETag_surfxml_host()    {
437   simgrid::kernel::routing::HostCreationArgs host;
438
439   host.properties = current_property_set;
440   current_property_set = nullptr;
441
442   host.id = A_surfxml_host_id;
443
444   host.speed_per_pstate = surf_parse_get_all_speeds(A_surfxml_host_speed, "speed of host", host.id);
445
446   XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
447   host.core_amount = surf_parse_get_int(A_surfxml_host_core);
448
449   host.speed_trace = nullptr;
450   if (A_surfxml_host_availability___file[0] != '\0') {
451     XBT_WARN("The availability_file attribute in <host> is now deprecated. Please, use 'speed_file' instead.");
452     host.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_host_availability___file);
453   }
454   if (A_surfxml_host_speed___file[0] != '\0')
455     host.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_host_speed___file);
456   host.state_trace = A_surfxml_host_state___file[0]
457                          ? simgrid::kernel::profile::Profile::from_file(A_surfxml_host_state___file)
458                          : nullptr;
459   host.pstate      = surf_parse_get_int(A_surfxml_host_pstate);
460   host.coord       = A_surfxml_host_coordinates;
461
462   sg_platf_new_host(&host);
463 }
464
465 void STag_surfxml_disk() {
466   THROW_UNIMPLEMENTED;
467 }
468 void ETag_surfxml_disk() {
469 }
470
471 void STag_surfxml_host___link(){
472   XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
473   simgrid::kernel::routing::HostLinkCreationArgs host_link;
474
475   host_link.id        = A_surfxml_host___link_id;
476   host_link.link_up   = A_surfxml_host___link_up;
477   host_link.link_down = A_surfxml_host___link_down;
478   sg_platf_new_hostlink(&host_link);
479 }
480
481 void STag_surfxml_router(){
482   sg_platf_new_router(A_surfxml_router_id, A_surfxml_router_coordinates);
483 }
484
485 void ETag_surfxml_cluster(){
486   simgrid::kernel::routing::ClusterCreationArgs cluster;
487   cluster.properties   = current_property_set;
488   current_property_set = nullptr;
489
490   cluster.id          = A_surfxml_cluster_id;
491   cluster.prefix      = A_surfxml_cluster_prefix;
492   cluster.suffix      = A_surfxml_cluster_suffix;
493   cluster.radicals    = explodesRadical(A_surfxml_cluster_radical);
494   cluster.speeds      = surf_parse_get_all_speeds(A_surfxml_cluster_speed, "speed of cluster", cluster.id);
495   cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
496   cluster.bw          = surf_parse_get_bandwidth(A_surfxml_cluster_bw, "bw of cluster", cluster.id);
497   cluster.lat         = surf_parse_get_time(A_surfxml_cluster_lat, "lat of cluster", cluster.id);
498   if(strcmp(A_surfxml_cluster_bb___bw,""))
499     cluster.bb_bw = surf_parse_get_bandwidth(A_surfxml_cluster_bb___bw, "bb_bw of cluster", cluster.id);
500   if(strcmp(A_surfxml_cluster_bb___lat,""))
501     cluster.bb_lat = surf_parse_get_time(A_surfxml_cluster_bb___lat, "bb_lat of cluster", cluster.id);
502   if(strcmp(A_surfxml_cluster_limiter___link,""))
503     cluster.limiter_link = surf_parse_get_bandwidth(A_surfxml_cluster_limiter___link, "limiter_link of cluster", cluster.id);
504   if(strcmp(A_surfxml_cluster_loopback___bw,""))
505     cluster.loopback_bw = surf_parse_get_bandwidth(A_surfxml_cluster_loopback___bw, "loopback_bw of cluster", cluster.id);
506   if(strcmp(A_surfxml_cluster_loopback___lat,""))
507     cluster.loopback_lat = surf_parse_get_time(A_surfxml_cluster_loopback___lat, "loopback_lat of cluster", cluster.id);
508
509   switch(AX_surfxml_cluster_topology){
510   case A_surfxml_cluster_topology_FLAT:
511     cluster.topology = simgrid::kernel::routing::ClusterTopology::FLAT;
512     break;
513   case A_surfxml_cluster_topology_TORUS:
514     cluster.topology = simgrid::kernel::routing::ClusterTopology::TORUS;
515     break;
516   case A_surfxml_cluster_topology_FAT___TREE:
517     cluster.topology = simgrid::kernel::routing::ClusterTopology::FAT_TREE;
518     break;
519   case A_surfxml_cluster_topology_DRAGONFLY:
520     cluster.topology = simgrid::kernel::routing::ClusterTopology::DRAGONFLY;
521     break;
522   default:
523     surf_parse_error(std::string("Invalid cluster topology for cluster ") + cluster.id);
524   }
525   cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
526   cluster.router_id = A_surfxml_cluster_router___id;
527
528   switch (AX_surfxml_cluster_sharing___policy) {
529   case A_surfxml_cluster_sharing___policy_SHARED:
530     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
531     break;
532   case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
533     XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
534     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
535     break;
536   case A_surfxml_cluster_sharing___policy_SPLITDUPLEX:
537     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
538     break;
539   case A_surfxml_cluster_sharing___policy_FATPIPE:
540     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
541     break;
542   default:
543     surf_parse_error(std::string("Invalid cluster sharing policy for cluster ") + cluster.id);
544   }
545   switch (AX_surfxml_cluster_bb___sharing___policy) {
546   case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
547     cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
548     break;
549   case A_surfxml_cluster_bb___sharing___policy_SHARED:
550     cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
551     break;
552   default:
553     surf_parse_error(std::string("Invalid bb sharing policy in cluster ") + cluster.id);
554   }
555
556   sg_platf_new_cluster(&cluster);
557 }
558
559 void STag_surfxml_cluster(){
560   ZONE_TAG = 0;
561   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
562 }
563
564 void STag_surfxml_cabinet(){
565   simgrid::kernel::routing::CabinetCreationArgs cabinet;
566   cabinet.id      = A_surfxml_cabinet_id;
567   cabinet.prefix  = A_surfxml_cabinet_prefix;
568   cabinet.suffix  = A_surfxml_cabinet_suffix;
569   cabinet.speed    = surf_parse_get_speed(A_surfxml_cabinet_speed, "speed of cabinet", cabinet.id.c_str());
570   cabinet.bw       = surf_parse_get_bandwidth(A_surfxml_cabinet_bw, "bw of cabinet", cabinet.id.c_str());
571   cabinet.lat      = surf_parse_get_time(A_surfxml_cabinet_lat, "lat of cabinet", cabinet.id.c_str());
572   cabinet.radicals = explodesRadical(A_surfxml_cabinet_radical);
573
574   sg_platf_new_cabinet(&cabinet);
575 }
576
577 void STag_surfxml_peer(){
578   simgrid::kernel::routing::PeerCreationArgs peer;
579
580   peer.id          = std::string(A_surfxml_peer_id);
581   peer.speed       = surf_parse_get_speed(A_surfxml_peer_speed, "speed of peer", peer.id.c_str());
582   peer.bw_in       = surf_parse_get_bandwidth(A_surfxml_peer_bw___in, "bw_in of peer", peer.id.c_str());
583   peer.bw_out      = surf_parse_get_bandwidth(A_surfxml_peer_bw___out, "bw_out of peer", peer.id.c_str());
584   peer.coord       = A_surfxml_peer_coordinates;
585   peer.speed_trace = nullptr;
586   if (A_surfxml_peer_availability___file[0] != '\0') {
587     XBT_WARN("The availability_file attribute in <peer> is now deprecated. Please, use 'speed_file' instead.");
588     peer.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_availability___file);
589   }
590   if (A_surfxml_peer_speed___file[0] != '\0')
591     peer.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_speed___file);
592   peer.state_trace = A_surfxml_peer_state___file[0]
593                          ? simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_state___file)
594                          : nullptr;
595
596   if (A_surfxml_peer_lat[0] != '\0')
597     XBT_WARN("The latency attribute in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
598              A_surfxml_peer_lat);
599
600   sg_platf_new_peer(&peer);
601 }
602
603 void STag_surfxml_link(){
604   ZONE_TAG = 0;
605   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
606 }
607
608 void ETag_surfxml_link(){
609   simgrid::kernel::routing::LinkCreationArgs link;
610
611   link.properties          = current_property_set;
612   current_property_set     = nullptr;
613
614   link.id                  = std::string(A_surfxml_link_id);
615   link.bandwidths          = surf_parse_get_bandwidths(A_surfxml_link_bandwidth, "bandwidth of link", link.id.c_str());
616   link.bandwidth_trace     = A_surfxml_link_bandwidth___file[0]
617                              ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_bandwidth___file)
618                              : nullptr;
619   link.latency             = surf_parse_get_time(A_surfxml_link_latency, "latency of link", link.id.c_str());
620   link.latency_trace       = A_surfxml_link_latency___file[0]
621                            ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_latency___file)
622                            : nullptr;
623   link.state_trace = A_surfxml_link_state___file[0]
624                          ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_state___file)
625                          : nullptr;
626
627   switch (A_surfxml_link_sharing___policy) {
628   case A_surfxml_link_sharing___policy_SHARED:
629     link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
630     break;
631   case A_surfxml_link_sharing___policy_FATPIPE:
632     link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
633     break;
634   case A_surfxml_link_sharing___policy_FULLDUPLEX:
635     XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
636     link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
637     break;
638   case A_surfxml_link_sharing___policy_SPLITDUPLEX:
639     link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
640     break;
641   case A_surfxml_link_sharing___policy_WIFI:
642     link.policy = simgrid::s4u::Link::SharingPolicy::WIFI;
643     break;
644   default:
645     surf_parse_error(std::string("Invalid sharing policy in link ") + link.id);
646   }
647
648   sg_platf_new_link(&link);
649 }
650
651 void STag_surfxml_link___ctn()
652 {
653   simgrid::kernel::resource::LinkImpl* link = nullptr;
654   switch (A_surfxml_link___ctn_direction) {
655   case AU_surfxml_link___ctn_direction:
656   case A_surfxml_link___ctn_direction_NONE:
657     link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id))->get_impl();
658     break;
659   case A_surfxml_link___ctn_direction_UP:
660     link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id) + "_UP")->get_impl();
661     break;
662   case A_surfxml_link___ctn_direction_DOWN:
663     link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id) + "_DOWN")->get_impl();
664     break;
665   default:
666     surf_parse_error(std::string("Invalid direction for link ") + A_surfxml_link___ctn_id);
667   }
668
669   const char* dirname = "";
670   switch (A_surfxml_link___ctn_direction) {
671     case A_surfxml_link___ctn_direction_UP:
672       dirname = " (upward)";
673       break;
674     case A_surfxml_link___ctn_direction_DOWN:
675       dirname = " (downward)";
676       break;
677     default:
678       dirname = "";
679   }
680   surf_parse_assert(link != nullptr, std::string("No such link: '") + A_surfxml_link___ctn_id + "'" + dirname);
681   parsed_link_list.push_back(link);
682 }
683
684 void ETag_surfxml_backbone(){
685   simgrid::kernel::routing::LinkCreationArgs link;
686
687   link.properties = nullptr;
688   link.id = std::string(A_surfxml_backbone_id);
689   link.bandwidths.push_back(
690       surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id.c_str()));
691   link.latency = surf_parse_get_time(A_surfxml_backbone_latency, "latency of backbone", link.id.c_str());
692   link.policy     = simgrid::s4u::Link::SharingPolicy::SHARED;
693
694   sg_platf_new_link(&link);
695   routing_cluster_add_backbone(simgrid::s4u::Link::by_name(std::string(A_surfxml_backbone_id))->get_impl());
696 }
697
698 void STag_surfxml_route(){
699   surf_parse_assert_netpoint(A_surfxml_route_src, "Route src='", "' does name a node.");
700   surf_parse_assert_netpoint(A_surfxml_route_dst, "Route dst='", "' does name a node.");
701 }
702
703 void STag_surfxml_ASroute(){
704   surf_parse_assert_netpoint(A_surfxml_ASroute_src, "ASroute src='", "' does name a node.");
705   surf_parse_assert_netpoint(A_surfxml_ASroute_dst, "ASroute dst='", "' does name a node.");
706
707   surf_parse_assert_netpoint(A_surfxml_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
708   surf_parse_assert_netpoint(A_surfxml_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
709 }
710 void STag_surfxml_zoneRoute(){
711   surf_parse_assert_netpoint(A_surfxml_zoneRoute_src, "zoneRoute src='", "' does name a node.");
712   surf_parse_assert_netpoint(A_surfxml_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
713   surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
714   surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
715 }
716
717 void STag_surfxml_bypassRoute(){
718   surf_parse_assert_netpoint(A_surfxml_bypassRoute_src, "bypassRoute src='", "' does name a node.");
719   surf_parse_assert_netpoint(A_surfxml_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
720 }
721
722 void STag_surfxml_bypassASroute(){
723   surf_parse_assert_netpoint(A_surfxml_bypassASroute_src, "bypassASroute src='", "' does name a node.");
724   surf_parse_assert_netpoint(A_surfxml_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
725   surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___src, "bypassASroute gw_src='", "' does name a node.");
726   surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___dst, "bypassASroute gw_dst='", "' does name a node.");
727 }
728 void STag_surfxml_bypassZoneRoute(){
729   surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
730   surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
731   surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='", "' does name a node.");
732   surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='", "' does name a node.");
733 }
734
735 void ETag_surfxml_route(){
736   simgrid::kernel::routing::RouteCreationArgs route;
737
738   route.src         = sg_netpoint_by_name_or_null(A_surfxml_route_src); // tested to not be nullptr in start tag
739   route.dst         = sg_netpoint_by_name_or_null(A_surfxml_route_dst); // tested to not be nullptr in start tag
740   route.gw_src    = nullptr;
741   route.gw_dst    = nullptr;
742   route.symmetrical = (A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES);
743
744   route.link_list.swap(parsed_link_list);
745
746   sg_platf_new_route(&route);
747 }
748
749 void ETag_surfxml_ASroute()
750 {
751   AX_surfxml_zoneRoute_src = AX_surfxml_ASroute_src;
752   AX_surfxml_zoneRoute_dst = AX_surfxml_ASroute_dst;
753   AX_surfxml_zoneRoute_gw___src = AX_surfxml_ASroute_gw___src;
754   AX_surfxml_zoneRoute_gw___dst = AX_surfxml_ASroute_gw___dst;
755   AX_surfxml_zoneRoute_symmetrical = (AT_surfxml_zoneRoute_symmetrical)AX_surfxml_ASroute_symmetrical;
756   ETag_surfxml_zoneRoute();
757 }
758 void ETag_surfxml_zoneRoute()
759 {
760   simgrid::kernel::routing::RouteCreationArgs ASroute;
761
762   ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_src); // tested to not be nullptr in start tag
763   ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_dst); // tested to not be nullptr in start tag
764
765   ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___src); // tested to not be nullptr in start tag
766   ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___dst); // tested to not be nullptr in start tag
767
768   ASroute.link_list.swap(parsed_link_list);
769
770   switch (A_surfxml_zoneRoute_symmetrical) {
771   case AU_surfxml_zoneRoute_symmetrical:
772   case A_surfxml_zoneRoute_symmetrical_YES:
773     ASroute.symmetrical = true;
774     break;
775   case A_surfxml_zoneRoute_symmetrical_NO:
776     ASroute.symmetrical = false;
777     break;
778   default:
779     THROW_IMPOSSIBLE;
780   }
781
782   sg_platf_new_route(&ASroute);
783 }
784
785 void ETag_surfxml_bypassRoute(){
786   simgrid::kernel::routing::RouteCreationArgs route;
787
788   route.src         = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_src); // tested to not be nullptr in start tag
789   route.dst         = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_dst); // tested to not be nullptr in start tag
790   route.gw_src = nullptr;
791   route.gw_dst = nullptr;
792   route.symmetrical = false;
793
794   route.link_list.swap(parsed_link_list);
795
796   sg_platf_new_bypassRoute(&route);
797 }
798
799 void ETag_surfxml_bypassASroute()
800 {
801   AX_surfxml_bypassZoneRoute_src = AX_surfxml_bypassASroute_src;
802   AX_surfxml_bypassZoneRoute_dst = AX_surfxml_bypassASroute_dst;
803   AX_surfxml_bypassZoneRoute_gw___src = AX_surfxml_bypassASroute_gw___src;
804   AX_surfxml_bypassZoneRoute_gw___dst = AX_surfxml_bypassASroute_gw___dst;
805   ETag_surfxml_bypassZoneRoute();
806 }
807 void ETag_surfxml_bypassZoneRoute()
808 {
809   simgrid::kernel::routing::RouteCreationArgs ASroute;
810
811   ASroute.src         = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_src);
812   ASroute.dst         = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_dst);
813   ASroute.link_list.swap(parsed_link_list);
814
815   ASroute.symmetrical = false;
816
817   ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___src);
818   ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___dst);
819
820   sg_platf_new_bypassRoute(&ASroute);
821 }
822
823 void ETag_surfxml_trace(){
824   simgrid::kernel::routing::ProfileCreationArgs trace;
825
826   trace.id = A_surfxml_trace_id;
827   trace.file = A_surfxml_trace_file;
828   trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
829   trace.pc_data = surfxml_pcdata;
830
831   sg_platf_new_trace(&trace);
832 }
833
834 void STag_surfxml_trace___connect()
835 {
836   simgrid::kernel::routing::TraceConnectCreationArgs trace_connect;
837
838   trace_connect.element = A_surfxml_trace___connect_element;
839   trace_connect.trace = A_surfxml_trace___connect_trace;
840
841   switch (A_surfxml_trace___connect_kind) {
842   case AU_surfxml_trace___connect_kind:
843   case A_surfxml_trace___connect_kind_SPEED:
844     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::SPEED;
845     break;
846   case A_surfxml_trace___connect_kind_BANDWIDTH:
847     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::BANDWIDTH;
848     break;
849   case A_surfxml_trace___connect_kind_HOST___AVAIL:
850     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL;
851     break;
852   case A_surfxml_trace___connect_kind_LATENCY:
853     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LATENCY;
854     break;
855   case A_surfxml_trace___connect_kind_LINK___AVAIL:
856     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL;
857     break;
858   default:
859     surf_parse_error("Invalid trace kind");
860   }
861   sg_platf_trace_connect(&trace_connect);
862 }
863
864 void STag_surfxml_AS()
865 {
866   AX_surfxml_zone_id = AX_surfxml_AS_id;
867   AX_surfxml_zone_routing = (AT_surfxml_zone_routing)AX_surfxml_AS_routing;
868   STag_surfxml_zone();
869 }
870
871 void ETag_surfxml_AS()
872 {
873   ETag_surfxml_zone();
874 }
875
876 void STag_surfxml_zone()
877 {
878   ZONE_TAG                 = 1;
879   simgrid::kernel::routing::ZoneCreationArgs zone;
880   zone.id      = A_surfxml_zone_id;
881   zone.routing = static_cast<int>(A_surfxml_zone_routing);
882
883   sg_platf_new_Zone_begin(&zone);
884 }
885
886 void ETag_surfxml_zone()
887 {
888   sg_platf_new_Zone_seal();
889 }
890
891 void STag_surfxml_config()
892 {
893   ZONE_TAG = 0;
894   xbt_assert(current_property_set == nullptr,
895              "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
896   XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
897   if (_sg_cfg_init_status == 2) {
898     surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
899                      "<link>, etc).");
900   }
901 }
902
903 void ETag_surfxml_config()
904 {
905   // Sort config elements before applying.
906   // That's a little waste of time, but not doing so would break the tests
907   std::vector<std::string> keys;
908   for (auto const& kv : *current_property_set) {
909     keys.push_back(kv.first);
910   }
911   std::sort(keys.begin(), keys.end());
912   for (std::string key : keys) {
913     if (simgrid::config::is_default(key.c_str())) {
914       std::string cfg = key + ":" + current_property_set->at(key);
915       simgrid::config::set_parse(std::move(cfg));
916     } else
917       XBT_INFO("The custom configuration '%s' is already defined by user!", key.c_str());
918   }
919   XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
920
921   delete current_property_set;
922   current_property_set = nullptr;
923 }
924
925 static std::vector<std::string> arguments;
926
927 void STag_surfxml_process()
928 {
929   AX_surfxml_actor_function = AX_surfxml_process_function;
930   STag_surfxml_actor();
931 }
932
933 void STag_surfxml_actor()
934 {
935   ZONE_TAG  = 0;
936   arguments.assign(1, A_surfxml_actor_function);
937   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
938 }
939
940 void ETag_surfxml_process()
941 {
942   AX_surfxml_actor_host = AX_surfxml_process_host;
943   AX_surfxml_actor_function = AX_surfxml_process_function;
944   AX_surfxml_actor_start___time = AX_surfxml_process_start___time;
945   AX_surfxml_actor_kill___time = AX_surfxml_process_kill___time;
946   AX_surfxml_actor_on___failure = (AT_surfxml_actor_on___failure)AX_surfxml_process_on___failure;
947   ETag_surfxml_actor();
948 }
949
950 void ETag_surfxml_actor()
951 {
952   simgrid::kernel::routing::ActorCreationArgs actor;
953
954   actor.properties     = current_property_set;
955   current_property_set = nullptr;
956
957   actor.args.swap(arguments);
958   actor.host       = A_surfxml_actor_host;
959   actor.function   = A_surfxml_actor_function;
960   actor.start_time = surf_parse_get_double(A_surfxml_actor_start___time);
961   actor.kill_time  = surf_parse_get_double(A_surfxml_actor_kill___time);
962
963   switch (A_surfxml_actor_on___failure) {
964   case AU_surfxml_actor_on___failure:
965   case A_surfxml_actor_on___failure_DIE:
966     actor.on_failure = simgrid::kernel::routing::ActorOnFailure::DIE;
967     break;
968   case A_surfxml_actor_on___failure_RESTART:
969     actor.on_failure = simgrid::kernel::routing::ActorOnFailure::RESTART;
970     break;
971   default:
972     surf_parse_error("Invalid on failure behavior");
973   }
974
975   sg_platf_new_actor(&actor);
976 }
977
978 void STag_surfxml_argument(){
979   arguments.push_back(A_surfxml_argument_value);
980 }
981
982 void STag_surfxml_model___prop(){
983   if (not current_model_property_set)
984     current_model_property_set = new std::unordered_map<std::string, std::string>();
985
986   current_model_property_set->insert({A_surfxml_model___prop_id, A_surfxml_model___prop_value});
987 }
988
989 void ETag_surfxml_prop(){/* Nothing to do */}
990 void STag_surfxml_random(){/* Nothing to do */}
991 void ETag_surfxml_random(){/* Nothing to do */}
992 void ETag_surfxml_trace___connect(){/* Nothing to do */}
993 void STag_surfxml_trace()
994 { /* Nothing to do */
995 }
996 void ETag_surfxml_router(){/*Nothing to do*/}
997 void ETag_surfxml_host___link(){/* Nothing to do */}
998 void ETag_surfxml_cabinet(){/* Nothing to do */}
999 void ETag_surfxml_peer(){/* Nothing to do */}
1000 void STag_surfxml_backbone(){/* Nothing to do */}
1001 void ETag_surfxml_link___ctn(){/* Nothing to do */}
1002 void ETag_surfxml_argument(){/* Nothing to do */}
1003 void ETag_surfxml_model___prop(){/* Nothing to do */}
1004
1005 /* Open and Close parse file */
1006 YY_BUFFER_STATE surf_input_buffer;
1007
1008 void surf_parse_open(const std::string& file)
1009 {
1010   surf_parsed_filename = file;
1011   std::string dir      = simgrid::xbt::Path(file).get_dir_name();
1012   surf_path.push_back(dir);
1013
1014   surf_file_to_parse = surf_fopen(file, "r");
1015   if (surf_file_to_parse == nullptr) {
1016     std::string cwd = simgrid::xbt::Path().get_name();
1017     xbt_die("Unable to open '%s' from '%s'\n", file.c_str(), cwd.c_str());
1018   }
1019   surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
1020   surf_parse__switch_to_buffer(surf_input_buffer);
1021   surf_parse_lineno = 1;
1022 }
1023
1024 void surf_parse_close()
1025 {
1026   surf_path.pop_back(); // remove the dirname of the opened file, that was added in surf_parse_open()
1027
1028   if (surf_file_to_parse) {
1029     surf_parse__delete_buffer(surf_input_buffer);
1030     fclose(surf_file_to_parse);
1031     surf_file_to_parse = nullptr; //Must be reset for Bypass
1032   }
1033 }
1034
1035 /* Call the lexer to parse the currently opened file */
1036 int surf_parse()
1037 {
1038   return surf_parse_lex();
1039 }