src/surf/xml/surfxml_sax_cb.cpp

   1 /* Copyright (c) 2006-2023. 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/Exception.hpp>
   7 #include <simgrid/kernel/routing/NetPoint.hpp>
   8 #include <simgrid/s4u/Engine.hpp>
   9 #include <xbt/file.hpp>
  10 #include <xbt/parse_units.hpp>
  11
  12 #include "simgrid/sg_config.hpp"
  13 #include "src/kernel/resource/LinkImpl.hpp"
  14 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
  15 #include "src/kernel/resource/profile/Profile.hpp"
  16 #include "src/surf/xml/platf.hpp"
  17 #include "src/surf/xml/platf_private.hpp"
  18
  19 #include <boost/algorithm/string/classification.hpp>
  20 #include <boost/algorithm/string/split.hpp>
  21 #include <string>
  22 #include <tuple>
  23 #include <unordered_map>
  24 #include <vector>
  25
  26 #include "simgrid_dtd.c"
  27
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(platf_parse, ker_platform, "Logging specific to the parsing of platform files");
  29
  30 std::string surf_parsed_filename; // Currently parsed file (for the error messages)
  31 static std::vector<simgrid::s4u::LinkInRoute> parsed_link_list; /* temporary store of current link list of a route */
  32
  33 /* Helping functions */
  34 void surf_parse_assert(bool cond, const std::string& msg)
  35 {
  36   if (not cond)
  37     surf_parse_error(msg);
  38 }
  39
  40 void surf_parse_error(const std::string& msg)
  41 {
  42   throw simgrid::ParseError(surf_parsed_filename, surf_parse_lineno, msg);
  43 }
  44
  45 void surf_parse_assert_netpoint(const std::string& hostname, const std::string& pre, const std::string& post)
  46 {
  47   if (simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(hostname) != nullptr) // found
  48     return;
  49
  50   std::string msg = pre + hostname + post + " Existing netpoints:\n";
  51
  52   std::vector<simgrid::kernel::routing::NetPoint*> netpoints =
  53       simgrid::s4u::Engine::get_instance()->get_all_netpoints();
  54   std::sort(netpoints.begin(), netpoints.end(),
  55             [](const simgrid::kernel::routing::NetPoint* a, const simgrid::kernel::routing::NetPoint* b) {
  56               return a->get_name() < b->get_name();
  57             });
  58   bool first = true;
  59   for (auto const& np : netpoints) {
  60     if (np->is_netzone())
  61       continue;
  62
  63     if (not first)
  64       msg += ",";
  65     first = false;
  66     msg += "'" + np->get_name() + "'";
  67     if (msg.length() > 4096) {
  68       msg.pop_back(); // remove trailing quote
  69       msg += "...(list truncated)......";
  70       break;
  71     }
  72   }
  73   surf_parse_error(msg);
  74 }
  75
  76 double surf_parse_get_double(const std::string& s)
  77 {
  78   try {
  79     return std::stod(s);
  80   } catch (const std::invalid_argument&) {
  81     surf_parse_error(s + " is not a double");
  82   }
  83 }
  84
  85 int surf_parse_get_int(const std::string& s)
  86 {
  87   try {
  88     return std::stoi(s);
  89   } catch (const std::invalid_argument&) {
  90     surf_parse_error(s + " is not an int");
  91   }
  92 }
  93
  94 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
  95 static void explodesRadical(const std::string& radicals, std::vector<int>* exploded)
  96 {
  97   // Make all hosts
  98   std::vector<std::string> radical_elements;
  99   boost::split(radical_elements, radicals, boost::is_any_of(","));
 100   for (auto const& group : radical_elements) {
 101     std::vector<std::string> radical_ends;
 102     boost::split(radical_ends, group, boost::is_any_of("-"));
 103     int start = surf_parse_get_int(radical_ends.front());
 104     int end   = 0;
 105
 106     switch (radical_ends.size()) {
 107       case 1:
 108         end = start;
 109         break;
 110       case 2:
 111         end = surf_parse_get_int(radical_ends.back());
 112         break;
 113       default:
 114         surf_parse_error("Malformed radical: " + group);
 115     }
 116     for (int i = start; i <= end; i++)
 117       exploded->push_back(i);
 118   }
 119 }
 120
 121
 122 /*
 123  * All the callback lists that can be overridden anywhere.
 124  * (this list should probably be reduced to the bare minimum to allow the models to work)
 125  */
 126
 127 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
 128
 129 static std::vector<std::unordered_map<std::string, std::string>> property_sets;
 130
 131 static FILE* surf_file_to_parse = nullptr;
 132
 133 /* Stuff relative to storage */
 134 void STag_simgrid_parse_storage()
 135 {
 136   xbt_die("<storage> tag was removed in SimGrid v3.27. Please stop using it now.");
 137 }
 138
 139 void ETag_simgrid_parse_storage()
 140 {
 141   /* Won't happen since <storage> is now removed since v3.27. */
 142 }
 143 void STag_simgrid_parse_storage___type()
 144 {
 145   xbt_die("<storage_type> tag was removed in SimGrid v3.27. Please stop using it now.");
 146 }
 147 void ETag_simgrid_parse_storage___type()
 148 {
 149   /* Won't happen since <storage_type> is now removed since v3.27. */
 150 }
 151
 152 void STag_simgrid_parse_mount()
 153 {
 154   xbt_die("<mount> tag was removed in SimGrid v3.27. Please stop using it now.");
 155 }
 156
 157 void ETag_simgrid_parse_mount()
 158 {
 159   /* Won't happen since <mount> is now removed since v3.27. */
 160 }
 161
 162 void STag_simgrid_parse_include()
 163 {
 164   xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
 165 }
 166
 167 void ETag_simgrid_parse_include()
 168 {
 169   /* Won't happen since <include> is now removed since v3.18. */
 170 }
 171
 172 /* Stag and Etag parse functions */
 173 void STag_simgrid_parse_platform() {
 174   /* Use fixed point arithmetic to avoid rounding errors ("4.1" for example cannot be represented exactly as a floating
 175    * point number) */
 176   const long int version           = lround(100.0 * surf_parse_get_double(A_simgrid_parse_platform_version));
 177   const std::string version_string = std::to_string(version / 100) + "." + std::to_string(version % 100);
 178
 179   surf_parse_assert(version >= 100L, "******* BIG FAT WARNING *********\n "
 180                                      "You're using an ancient XML file.\n"
 181                                      "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
 182                                      "instead of MBytes, MFlops and seconds.\n"
 183
 184                                      "Use simgrid_update_xml to update your file automatically. "
 185                                      "This program is installed automatically with SimGrid, or "
 186                                      "available in the tools/ directory of the source archive.\n"
 187
 188                                      "Please check also out the SURF section of the ChangeLog for "
 189                                      "the 3.1 version for more information.");
 190   surf_parse_assert(version >= 300L, "******* BIG FAT WARNING *********\n "
 191                                      "You're using an old XML file.\n"
 192                                      "Use simgrid_update_xml to update your file automatically. "
 193                                      "This program is installed automatically with SimGrid, or "
 194                                      "available in the tools/ directory of the source archive.");
 195   surf_parse_assert(
 196       version >= 400L,
 197       "******* THIS FILE IS TOO OLD (v:" + version_string +
 198           ") *********\n "
 199           "Changes introduced in SimGrid 3.13:\n"
 200           "  - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
 201           "  - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
 202           "  - DOCTYPE now point to the rignt URL.\n"
 203           "  - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
 204           "\n\n"
 205           "Use simgrid_update_xml to update your file automatically. "
 206           "This program is installed automatically with SimGrid, or "
 207           "available in the tools/ directory of the source archive.");
 208   if (version < 410L) {
 209     XBT_INFO("You're using a v%s XML file (%s) while the current standard is v4.1 "
 210              "That's fine, the new version is backward compatible. \n\n"
 211              "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
 212              "This program is installed automatically with SimGrid, or "
 213              "available in the tools/ directory of the source archive.",
 214              version_string.c_str(), surf_parsed_filename.c_str());
 215   }
 216   surf_parse_assert(version <= 410L, "******* THIS FILE COMES FROM THE FUTURE (v:" + version_string +
 217                                          ") *********\n "
 218                                          "The most recent formalism that this version of SimGrid understands is v4.1.\n"
 219                                          "Please update your code, or use another, more adapted, file.");
 220 }
 221 void ETag_simgrid_parse_platform(){
 222   simgrid::s4u::Engine::on_platform_created();
 223 }
 224
 225 void STag_simgrid_parse_prop()
 226 {
 227   property_sets.back().try_emplace(A_simgrid_parse_prop_id, A_simgrid_parse_prop_value);
 228   XBT_DEBUG("add prop %s=%s into current property set %p", A_simgrid_parse_prop_id, A_simgrid_parse_prop_value,
 229             &(property_sets.back()));
 230 }
 231
 232 void STag_simgrid_parse_host()
 233 {
 234   simgrid::kernel::routing::HostCreationArgs host;
 235   property_sets.emplace_back();
 236   host.id = A_simgrid_parse_host_id;
 237
 238   host.speed_per_pstate = xbt_parse_get_all_speeds(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_host_speed,
 239                                                    "speed of host " + host.id);
 240
 241   XBT_DEBUG("pstate: %s", A_simgrid_parse_host_pstate);
 242   host.core_amount = surf_parse_get_int(A_simgrid_parse_host_core);
 243
 244   if (A_simgrid_parse_host_availability___file[0] != '\0') {
 245     XBT_WARN("The availability_file attribute in <host> is now deprecated. Please, use 'speed_file' instead.");
 246     host.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_availability___file);
 247   }
 248   if (A_simgrid_parse_host_speed___file[0] != '\0')
 249     host.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_speed___file);
 250   host.state_trace = A_simgrid_parse_host_state___file[0]
 251                          ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_state___file)
 252                          : nullptr;
 253   host.coord       = A_simgrid_parse_host_coordinates;
 254
 255   sg_platf_new_host_begin(&host);
 256 }
 257
 258 void ETag_simgrid_parse_host()
 259 {
 260   sg_platf_new_host_set_properties(property_sets.back());
 261   property_sets.pop_back();
 262
 263   sg_platf_new_host_seal(surf_parse_get_int(A_simgrid_parse_host_pstate));
 264 }
 265
 266 void STag_simgrid_parse_disk() {
 267   property_sets.emplace_back();
 268 }
 269
 270 void ETag_simgrid_parse_disk() {
 271   simgrid::kernel::routing::DiskCreationArgs disk;
 272   disk.properties = property_sets.back();
 273   property_sets.pop_back();
 274
 275   disk.id       = A_simgrid_parse_disk_id;
 276   disk.read_bw  = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_disk_read___bw,
 277                                          "read_bw of disk " + disk.id);
 278   disk.write_bw = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_disk_write___bw,
 279                                           "write_bw of disk " + disk.id);
 280
 281   sg_platf_new_disk(&disk);
 282 }
 283
 284 void STag_simgrid_parse_host___link(){
 285   XBT_DEBUG("Create a Host_link for %s",A_simgrid_parse_host___link_id);
 286   simgrid::kernel::routing::HostLinkCreationArgs host_link;
 287
 288   host_link.id        = A_simgrid_parse_host___link_id;
 289   host_link.link_up   = A_simgrid_parse_host___link_up;
 290   host_link.link_down = A_simgrid_parse_host___link_down;
 291   sg_platf_new_hostlink(&host_link);
 292 }
 293
 294 void STag_simgrid_parse_router(){
 295   sg_platf_new_router(A_simgrid_parse_router_id, A_simgrid_parse_router_coordinates);
 296 }
 297
 298 void ETag_simgrid_parse_cluster(){
 299   simgrid::kernel::routing::ClusterCreationArgs cluster;
 300   cluster.properties = property_sets.back();
 301   property_sets.pop_back();
 302
 303   cluster.id          = A_simgrid_parse_cluster_id;
 304   cluster.prefix      = A_simgrid_parse_cluster_prefix;
 305   cluster.suffix      = A_simgrid_parse_cluster_suffix;
 306   explodesRadical(A_simgrid_parse_cluster_radical, &cluster.radicals);
 307
 308   cluster.speeds = xbt_parse_get_all_speeds(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cluster_speed,
 309                                             "speed of cluster " + cluster.id);
 310   cluster.core_amount = surf_parse_get_int(A_simgrid_parse_cluster_core);
 311   cluster.bw          = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cluster_bw,
 312                                        "bw of cluster " + cluster.id);
 313   cluster.lat = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cluster_lat,
 314                                    "lat of cluster " + cluster.id);
 315   if(strcmp(A_simgrid_parse_cluster_bb___bw,""))
 316     cluster.bb_bw = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cluster_bb___bw,
 317                                             "bb_bw of cluster " + cluster.id);
 318   if(strcmp(A_simgrid_parse_cluster_bb___lat,""))
 319     cluster.bb_lat = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cluster_bb___lat,
 320                                         "bb_lat of cluster " + cluster.id);
 321   if(strcmp(A_simgrid_parse_cluster_limiter___link,""))
 322     cluster.limiter_link =
 323         xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cluster_limiter___link,
 324                                 "limiter_link of cluster " + cluster.id);
 325   if(strcmp(A_simgrid_parse_cluster_loopback___bw,""))
 326     cluster.loopback_bw =
 327         xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cluster_loopback___bw,
 328                                 "loopback_bw of cluster " + cluster.id);
 329   if(strcmp(A_simgrid_parse_cluster_loopback___lat,""))
 330     cluster.loopback_lat = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cluster_loopback___lat,
 331                                               "loopback_lat of cluster " + cluster.id);
 332
 333   switch(AX_simgrid_parse_cluster_topology){
 334   case A_simgrid_parse_cluster_topology_FLAT:
 335     cluster.topology = simgrid::kernel::routing::ClusterTopology::FLAT;
 336     break;
 337   case A_simgrid_parse_cluster_topology_TORUS:
 338     cluster.topology = simgrid::kernel::routing::ClusterTopology::TORUS;
 339     break;
 340   case A_simgrid_parse_cluster_topology_FAT___TREE:
 341     cluster.topology = simgrid::kernel::routing::ClusterTopology::FAT_TREE;
 342     break;
 343   case A_simgrid_parse_cluster_topology_DRAGONFLY:
 344     cluster.topology = simgrid::kernel::routing::ClusterTopology::DRAGONFLY;
 345     break;
 346   default:
 347     surf_parse_error("Invalid cluster topology for cluster " + cluster.id);
 348   }
 349   cluster.topo_parameters = A_simgrid_parse_cluster_topo___parameters;
 350   cluster.router_id = A_simgrid_parse_cluster_router___id;
 351
 352   switch (AX_simgrid_parse_cluster_sharing___policy) {
 353   case A_simgrid_parse_cluster_sharing___policy_SHARED:
 354     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
 355     break;
 356   case A_simgrid_parse_cluster_sharing___policy_FULLDUPLEX:
 357     XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
 358     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
 359     break;
 360   case A_simgrid_parse_cluster_sharing___policy_SPLITDUPLEX:
 361     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
 362     break;
 363   case A_simgrid_parse_cluster_sharing___policy_FATPIPE:
 364     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
 365     break;
 366   default:
 367     surf_parse_error("Invalid cluster sharing policy for cluster " + cluster.id);
 368   }
 369   switch (AX_simgrid_parse_cluster_bb___sharing___policy) {
 370   case A_simgrid_parse_cluster_bb___sharing___policy_FATPIPE:
 371     cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
 372     break;
 373   case A_simgrid_parse_cluster_bb___sharing___policy_SHARED:
 374     cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
 375     break;
 376   default:
 377     surf_parse_error("Invalid bb sharing policy in cluster " + cluster.id);
 378   }
 379
 380   sg_platf_new_tag_cluster(&cluster);
 381 }
 382
 383 void STag_simgrid_parse_cluster(){
 384   property_sets.emplace_back();
 385 }
 386
 387 void STag_simgrid_parse_cabinet(){
 388   simgrid::kernel::routing::CabinetCreationArgs cabinet;
 389   cabinet.id      = A_simgrid_parse_cabinet_id;
 390   cabinet.prefix  = A_simgrid_parse_cabinet_prefix;
 391   cabinet.suffix  = A_simgrid_parse_cabinet_suffix;
 392   cabinet.speed   = xbt_parse_get_speed(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cabinet_speed,
 393                                       "speed of cabinet " + cabinet.id);
 394   cabinet.bw = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cabinet_bw,
 395                                        "bw of cabinet " + cabinet.id);
 396   cabinet.lat = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_cabinet_lat,
 397                                    "lat of cabinet " + cabinet.id);
 398   explodesRadical(A_simgrid_parse_cabinet_radical, &cabinet.radicals);
 399
 400   sg_platf_new_cabinet(&cabinet);
 401 }
 402
 403 void STag_simgrid_parse_peer(){
 404   simgrid::kernel::routing::PeerCreationArgs peer;
 405
 406   peer.id = A_simgrid_parse_peer_id;
 407   peer.speed =
 408       xbt_parse_get_speed(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_peer_speed, "speed of peer " + peer.id);
 409   peer.bw_in = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_peer_bw___in,
 410                                        "bw_in of peer " + peer.id);
 411   peer.bw_out = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_peer_bw___out,
 412                                         "bw_out of peer " + peer.id);
 413   peer.coord       = A_simgrid_parse_peer_coordinates;
 414   peer.speed_trace = nullptr;
 415   if (A_simgrid_parse_peer_availability___file[0] != '\0') {
 416     XBT_WARN("The availability_file attribute in <peer> is now deprecated. Please, use 'speed_file' instead.");
 417     peer.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_availability___file);
 418   }
 419   if (A_simgrid_parse_peer_speed___file[0] != '\0')
 420     peer.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_speed___file);
 421   peer.state_trace = A_simgrid_parse_peer_state___file[0]
 422                          ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_state___file)
 423                          : nullptr;
 424
 425   if (A_simgrid_parse_peer_lat[0] != '\0')
 426     XBT_WARN("The latency attribute in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
 427              A_simgrid_parse_peer_lat);
 428
 429   sg_platf_new_peer(&peer);
 430 }
 431
 432 void STag_simgrid_parse_link(){
 433   property_sets.emplace_back();
 434 }
 435
 436 void ETag_simgrid_parse_link(){
 437   simgrid::kernel::routing::LinkCreationArgs link;
 438
 439   link.properties = property_sets.back();
 440   property_sets.pop_back();
 441
 442   link.id                  = A_simgrid_parse_link_id;
 443   link.bandwidths          = xbt_parse_get_bandwidths(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_link_bandwidth,
 444                                              "bandwidth of link " + link.id);
 445   link.bandwidth_trace     = A_simgrid_parse_link_bandwidth___file[0]
 446                              ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_bandwidth___file)
 447                              : nullptr;
 448   link.latency =
 449       xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_link_latency, "latency of link " + link.id);
 450   link.latency_trace       = A_simgrid_parse_link_latency___file[0]
 451                            ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_latency___file)
 452                            : nullptr;
 453   link.state_trace = A_simgrid_parse_link_state___file[0]
 454                          ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_state___file)
 455                          : nullptr;
 456
 457   switch (A_simgrid_parse_link_sharing___policy) {
 458   case A_simgrid_parse_link_sharing___policy_SHARED:
 459     link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
 460     break;
 461   case A_simgrid_parse_link_sharing___policy_FATPIPE:
 462     link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
 463     break;
 464   case A_simgrid_parse_link_sharing___policy_FULLDUPLEX:
 465     XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
 466     link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
 467     break;
 468   case A_simgrid_parse_link_sharing___policy_SPLITDUPLEX:
 469     link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
 470     break;
 471   case A_simgrid_parse_link_sharing___policy_WIFI:
 472     link.policy = simgrid::s4u::Link::SharingPolicy::WIFI;
 473     break;
 474   default:
 475     surf_parse_error("Invalid sharing policy in link " + link.id);
 476   }
 477
 478   sg_platf_new_link(&link);
 479 }
 480
 481 void STag_simgrid_parse_link___ctn()
 482 {
 483   const auto engine = simgrid::s4u::Engine::get_instance();
 484   const simgrid::s4u::Link* link;
 485   simgrid::s4u::LinkInRoute::Direction direction = simgrid::s4u::LinkInRoute::Direction::NONE;
 486   switch (A_simgrid_parse_link___ctn_direction) {
 487   case AU_simgrid_parse_link___ctn_direction:
 488   case A_simgrid_parse_link___ctn_direction_NONE:
 489     link = engine->link_by_name(A_simgrid_parse_link___ctn_id);
 490     break;
 491   case A_simgrid_parse_link___ctn_direction_UP:
 492     link      = engine->split_duplex_link_by_name(A_simgrid_parse_link___ctn_id);
 493     direction = simgrid::s4u::LinkInRoute::Direction::UP;
 494     break;
 495   case A_simgrid_parse_link___ctn_direction_DOWN:
 496     link      = engine->split_duplex_link_by_name(A_simgrid_parse_link___ctn_id);
 497     direction = simgrid::s4u::LinkInRoute::Direction::DOWN;
 498     break;
 499   default:
 500     surf_parse_error(std::string("Invalid direction for link ") + A_simgrid_parse_link___ctn_id);
 501   }
 502
 503   const char* dirname;
 504   switch (A_simgrid_parse_link___ctn_direction) {
 505     case A_simgrid_parse_link___ctn_direction_UP:
 506       dirname = " (upward)";
 507       break;
 508     case A_simgrid_parse_link___ctn_direction_DOWN:
 509       dirname = " (downward)";
 510       break;
 511     default:
 512       dirname = "";
 513   }
 514   surf_parse_assert(link != nullptr, std::string("No such link: '") + A_simgrid_parse_link___ctn_id + "'" + dirname);
 515   parsed_link_list.emplace_back(link, direction);
 516 }
 517
 518 void ETag_simgrid_parse_backbone()
 519 {
 520   auto link = std::make_unique<simgrid::kernel::routing::LinkCreationArgs>();
 521
 522   link->id = A_simgrid_parse_backbone_id;
 523   link->bandwidths.push_back(xbt_parse_get_bandwidth(
 524       surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_backbone_bandwidth, "bandwidth of backbone " + link->id));
 525   link->latency = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_simgrid_parse_backbone_latency,
 526                                      "latency of backbone " + link->id);
 527   link->policy  = simgrid::s4u::Link::SharingPolicy::SHARED;
 528
 529   routing_cluster_add_backbone(std::move(link));
 530 }
 531
 532 void STag_simgrid_parse_route(){
 533   surf_parse_assert_netpoint(A_simgrid_parse_route_src, "Route src='", "' does name a node.");
 534   surf_parse_assert_netpoint(A_simgrid_parse_route_dst, "Route dst='", "' does name a node.");
 535 }
 536
 537 void STag_simgrid_parse_ASroute(){
 538   surf_parse_assert_netpoint(A_simgrid_parse_ASroute_src, "ASroute src='", "' does name a node.");
 539   surf_parse_assert_netpoint(A_simgrid_parse_ASroute_dst, "ASroute dst='", "' does name a node.");
 540
 541   surf_parse_assert_netpoint(A_simgrid_parse_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
 542   surf_parse_assert_netpoint(A_simgrid_parse_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
 543 }
 544 void STag_simgrid_parse_zoneRoute(){
 545   surf_parse_assert_netpoint(A_simgrid_parse_zoneRoute_src, "zoneRoute src='", "' does name a node.");
 546   surf_parse_assert_netpoint(A_simgrid_parse_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
 547   surf_parse_assert_netpoint(A_simgrid_parse_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
 548   surf_parse_assert_netpoint(A_simgrid_parse_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
 549 }
 550
 551 void STag_simgrid_parse_bypassRoute(){
 552   surf_parse_assert_netpoint(A_simgrid_parse_bypassRoute_src, "bypassRoute src='", "' does name a node.");
 553   surf_parse_assert_netpoint(A_simgrid_parse_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
 554 }
 555
 556 void STag_simgrid_parse_bypassASroute(){
 557   surf_parse_assert_netpoint(A_simgrid_parse_bypassASroute_src, "bypassASroute src='", "' does name a node.");
 558   surf_parse_assert_netpoint(A_simgrid_parse_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
 559   surf_parse_assert_netpoint(A_simgrid_parse_bypassASroute_gw___src, "bypassASroute gw_src='", "' does name a node.");
 560   surf_parse_assert_netpoint(A_simgrid_parse_bypassASroute_gw___dst, "bypassASroute gw_dst='", "' does name a node.");
 561 }
 562 void STag_simgrid_parse_bypassZoneRoute(){
 563   surf_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
 564   surf_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
 565   surf_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='", "' does name a node.");
 566   surf_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='", "' does name a node.");
 567 }
 568
 569 void ETag_simgrid_parse_route(){
 570   simgrid::kernel::routing::RouteCreationArgs route;
 571
 572   route.src         = sg_netpoint_by_name_or_null(A_simgrid_parse_route_src); // tested to not be nullptr in start tag
 573   route.dst         = sg_netpoint_by_name_or_null(A_simgrid_parse_route_dst); // tested to not be nullptr in start tag
 574   route.symmetrical = (A_simgrid_parse_route_symmetrical == AU_simgrid_parse_route_symmetrical ||
 575                        A_simgrid_parse_route_symmetrical == A_simgrid_parse_route_symmetrical_YES ||
 576                        A_simgrid_parse_route_symmetrical == A_simgrid_parse_route_symmetrical_yes);
 577
 578   route.link_list.swap(parsed_link_list);
 579
 580   sg_platf_new_route(&route);
 581 }
 582
 583 void ETag_simgrid_parse_ASroute()
 584 {
 585   AX_simgrid_parse_zoneRoute_src = AX_simgrid_parse_ASroute_src;
 586   AX_simgrid_parse_zoneRoute_dst = AX_simgrid_parse_ASroute_dst;
 587   AX_simgrid_parse_zoneRoute_gw___src = AX_simgrid_parse_ASroute_gw___src;
 588   AX_simgrid_parse_zoneRoute_gw___dst = AX_simgrid_parse_ASroute_gw___dst;
 589   AX_simgrid_parse_zoneRoute_symmetrical = (AT_simgrid_parse_zoneRoute_symmetrical)AX_simgrid_parse_ASroute_symmetrical;
 590   ETag_simgrid_parse_zoneRoute();
 591 }
 592 void ETag_simgrid_parse_zoneRoute()
 593 {
 594   simgrid::kernel::routing::RouteCreationArgs ASroute;
 595
 596   ASroute.src = sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_src); // tested to not be nullptr in start tag
 597   ASroute.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_dst); // tested to not be nullptr in start tag
 598
 599   ASroute.gw_src = sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_gw___src); // tested to not be nullptr in start tag
 600   ASroute.gw_dst = sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_gw___dst); // tested to not be nullptr in start tag
 601
 602   ASroute.link_list.swap(parsed_link_list);
 603
 604   ASroute.symmetrical = (A_simgrid_parse_zoneRoute_symmetrical == AU_simgrid_parse_zoneRoute_symmetrical ||
 605                          A_simgrid_parse_zoneRoute_symmetrical == A_simgrid_parse_zoneRoute_symmetrical_YES ||
 606                          A_simgrid_parse_zoneRoute_symmetrical == A_simgrid_parse_zoneRoute_symmetrical_yes);
 607
 608   sg_platf_new_route(&ASroute);
 609 }
 610
 611 void ETag_simgrid_parse_bypassRoute(){
 612   simgrid::kernel::routing::RouteCreationArgs route;
 613
 614   route.src         = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassRoute_src); // tested to not be nullptr in start tag
 615   route.dst         = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassRoute_dst); // tested to not be nullptr in start tag
 616   route.symmetrical = false;
 617
 618   route.link_list.swap(parsed_link_list);
 619
 620   sg_platf_new_bypass_route(&route);
 621 }
 622
 623 void ETag_simgrid_parse_bypassASroute()
 624 {
 625   AX_simgrid_parse_bypassZoneRoute_src = AX_simgrid_parse_bypassASroute_src;
 626   AX_simgrid_parse_bypassZoneRoute_dst = AX_simgrid_parse_bypassASroute_dst;
 627   AX_simgrid_parse_bypassZoneRoute_gw___src = AX_simgrid_parse_bypassASroute_gw___src;
 628   AX_simgrid_parse_bypassZoneRoute_gw___dst = AX_simgrid_parse_bypassASroute_gw___dst;
 629   ETag_simgrid_parse_bypassZoneRoute();
 630 }
 631 void ETag_simgrid_parse_bypassZoneRoute()
 632 {
 633   simgrid::kernel::routing::RouteCreationArgs ASroute;
 634
 635   ASroute.src         = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_src);
 636   ASroute.dst         = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_dst);
 637   ASroute.link_list.swap(parsed_link_list);
 638
 639   ASroute.symmetrical = false;
 640
 641   ASroute.gw_src = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_gw___src);
 642   ASroute.gw_dst = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_gw___dst);
 643
 644   sg_platf_new_bypass_route(&ASroute);
 645 }
 646
 647 void ETag_simgrid_parse_trace(){
 648   simgrid::kernel::routing::ProfileCreationArgs trace;
 649
 650   trace.id = A_simgrid_parse_trace_id;
 651   trace.file = A_simgrid_parse_trace_file;
 652   trace.periodicity = surf_parse_get_double(A_simgrid_parse_trace_periodicity);
 653   trace.pc_data = simgrid_parse_pcdata;
 654
 655   sg_platf_new_trace(&trace);
 656 }
 657
 658 void STag_simgrid_parse_trace___connect()
 659 {
 660   simgrid::kernel::routing::TraceConnectCreationArgs trace_connect;
 661
 662   trace_connect.element = A_simgrid_parse_trace___connect_element;
 663   trace_connect.trace   = A_simgrid_parse_trace___connect_trace;
 664
 665   switch (A_simgrid_parse_trace___connect_kind) {
 666     case AU_simgrid_parse_trace___connect_kind:
 667     case A_simgrid_parse_trace___connect_kind_SPEED:
 668       trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::SPEED;
 669       break;
 670     case A_simgrid_parse_trace___connect_kind_BANDWIDTH:
 671       trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::BANDWIDTH;
 672       break;
 673     case A_simgrid_parse_trace___connect_kind_HOST___AVAIL:
 674       trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL;
 675       break;
 676     case A_simgrid_parse_trace___connect_kind_LATENCY:
 677       trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LATENCY;
 678       break;
 679     case A_simgrid_parse_trace___connect_kind_LINK___AVAIL:
 680       trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL;
 681       break;
 682     default:
 683       surf_parse_error("Invalid trace kind");
 684   }
 685   sg_platf_trace_connect(&trace_connect);
 686 }
 687
 688 void STag_simgrid_parse_AS()
 689 {
 690   AX_simgrid_parse_zone_id = AX_simgrid_parse_AS_id;
 691   AX_simgrid_parse_zone_routing = AX_simgrid_parse_AS_routing;
 692   STag_simgrid_parse_zone();
 693 }
 694
 695 void ETag_simgrid_parse_AS()
 696 {
 697   ETag_simgrid_parse_zone();
 698 }
 699
 700 void STag_simgrid_parse_zone()
 701 {
 702   property_sets.emplace_back();
 703   simgrid::kernel::routing::ZoneCreationArgs zone;
 704   zone.id      = A_simgrid_parse_zone_id;
 705   zone.routing = A_simgrid_parse_zone_routing;
 706   sg_platf_new_zone_begin(&zone);
 707 }
 708
 709 void ETag_simgrid_parse_zone()
 710 {
 711   sg_platf_new_zone_set_properties(property_sets.back());
 712   property_sets.pop_back();
 713   sg_platf_new_zone_seal();
 714 }
 715
 716 void STag_simgrid_parse_config()
 717 {
 718   property_sets.emplace_back();
 719   XBT_DEBUG("START configuration name = %s",A_simgrid_parse_config_id);
 720   if (_sg_cfg_init_status == 2) {
 721     surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
 722                      "<link>, etc).");
 723   }
 724 }
 725
 726 void ETag_simgrid_parse_config()
 727 {
 728   // Sort config elements before applying.
 729   // That's a little waste of time, but not doing so would break the tests
 730   auto current_property_set = property_sets.back();
 731
 732   std::vector<std::string> keys;
 733   for (auto const& [key, _] : current_property_set) {
 734     keys.push_back(key);
 735   }
 736   std::sort(keys.begin(), keys.end());
 737   for (const std::string& key : keys) {
 738     if (simgrid::config::is_default(key.c_str())) {
 739       std::string cfg = key + ":" + current_property_set.at(key);
 740       simgrid::config::set_parse(cfg);
 741     } else
 742       XBT_INFO("The custom configuration '%s' is already defined by user!", key.c_str());
 743   }
 744   XBT_DEBUG("End configuration name = %s",A_simgrid_parse_config_id);
 745
 746   property_sets.pop_back();
 747 }
 748
 749 static std::vector<std::string> arguments;
 750
 751 void STag_simgrid_parse_process()
 752 {
 753   AX_simgrid_parse_actor_function = AX_simgrid_parse_process_function;
 754   STag_simgrid_parse_actor();
 755 }
 756
 757 void STag_simgrid_parse_actor()
 758 {
 759   property_sets.emplace_back();
 760   arguments.assign(1, A_simgrid_parse_actor_function);
 761 }
 762
 763 void ETag_simgrid_parse_process()
 764 {
 765   AX_simgrid_parse_actor_host = AX_simgrid_parse_process_host;
 766   AX_simgrid_parse_actor_function = AX_simgrid_parse_process_function;
 767   AX_simgrid_parse_actor_start___time = AX_simgrid_parse_process_start___time;
 768   AX_simgrid_parse_actor_kill___time = AX_simgrid_parse_process_kill___time;
 769   AX_simgrid_parse_actor_on___failure = (AT_simgrid_parse_actor_on___failure)AX_simgrid_parse_process_on___failure;
 770   ETag_simgrid_parse_actor();
 771 }
 772
 773 void ETag_simgrid_parse_actor()
 774 {
 775   simgrid::kernel::routing::ActorCreationArgs actor;
 776
 777   actor.properties = property_sets.back();
 778   property_sets.pop_back();
 779
 780   actor.args.swap(arguments);
 781   actor.host       = A_simgrid_parse_actor_host;
 782   actor.function   = A_simgrid_parse_actor_function;
 783   actor.start_time = surf_parse_get_double(A_simgrid_parse_actor_start___time);
 784   actor.kill_time  = surf_parse_get_double(A_simgrid_parse_actor_kill___time);
 785
 786   switch (A_simgrid_parse_actor_on___failure) {
 787   case AU_simgrid_parse_actor_on___failure:
 788   case A_simgrid_parse_actor_on___failure_DIE:
 789     actor.restart_on_failure = false;
 790     break;
 791   case A_simgrid_parse_actor_on___failure_RESTART:
 792     actor.restart_on_failure = true;
 793     break;
 794   default:
 795     surf_parse_error("Invalid on failure behavior");
 796   }
 797
 798   sg_platf_new_actor(&actor);
 799 }
 800
 801 void STag_simgrid_parse_argument(){
 802   arguments.emplace_back(A_simgrid_parse_argument_value);
 803 }
 804
 805 void STag_simgrid_parse_model___prop(){
 806   XBT_INFO("Deprecated tag <model_prop> ignored");
 807 }
 808
 809 void ETag_simgrid_parse_prop(){/* Nothing to do */}
 810 void STag_simgrid_parse_random(){/* Nothing to do */}
 811 void ETag_simgrid_parse_random(){/* Nothing to do */}
 812 void ETag_simgrid_parse_trace___connect()
 813 { /* Nothing to do */
 814 }
 815 void STag_simgrid_parse_trace()
 816 { /* Nothing to do */
 817 }
 818 void ETag_simgrid_parse_router(){/*Nothing to do*/}
 819 void ETag_simgrid_parse_host___link(){/* Nothing to do */}
 820 void ETag_simgrid_parse_cabinet(){/* Nothing to do */}
 821 void ETag_simgrid_parse_peer(){/* Nothing to do */}
 822 void STag_simgrid_parse_backbone(){/* Nothing to do */}
 823 void ETag_simgrid_parse_link___ctn(){/* Nothing to do */}
 824 void ETag_simgrid_parse_argument(){/* Nothing to do */}
 825 void ETag_simgrid_parse_model___prop(){/* Nothing to do */}
 826
 827 /* Open and Close parse file */
 828 static YY_BUFFER_STATE surf_input_buffer;
 829
 830 void surf_parse_open(const std::string& file)
 831 {
 832   surf_parsed_filename = file;
 833   std::string dir      = simgrid::xbt::Path(file).get_dir_name();
 834   simgrid::xbt::path_push(dir);
 835
 836   surf_file_to_parse = simgrid::xbt::path_fopen(file, "r");
 837   if (surf_file_to_parse == nullptr)
 838     throw std::invalid_argument("Unable to open '" + file + "' from '" + simgrid::xbt::Path().get_name() +
 839                                 "'. Does this file exist?");
 840   surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
 841   surf_parse__switch_to_buffer(surf_input_buffer);
 842   surf_parse_lineno = 1;
 843 }
 844
 845 void surf_parse_close()
 846 {
 847   simgrid::xbt::path_pop(); // remove the dirname of the opened file, that was added in surf_parse_open()
 848
 849   if (surf_file_to_parse) {
 850     surf_parse__delete_buffer(surf_input_buffer);
 851     fclose(surf_file_to_parse);
 852     surf_file_to_parse = nullptr; //Must be reset for Bypass
 853   }
 854 }
 855
 856 /* Call the lexer to parse the currently opened file */
 857 void surf_parse()
 858 {
 859   bool err = surf_parse_lex();
 860   surf_parse_assert(not err, "Flex returned an error code");
 861 }