src/surf/xml/surfxml_sax_cb.cpp

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