Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Inventive hack to get flex raising exceptions on parse error
[simgrid.git] / src / surf / xml / surfxml_sax_cb.cpp
index e57ae9f..0b49682 100644 (file)
@@ -3,9 +3,12 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
+#include "simgrid/Exception.hpp"
 #include "simgrid/kernel/routing/NetPoint.hpp"
 #include "simgrid/s4u/Engine.hpp"
 #include "simgrid/sg_config.hpp"
+#include "src/kernel/resource/profile/FutureEvtSet.hpp"
+#include "src/kernel/resource/profile/Profile.hpp"
 #include "src/surf/network_interface.hpp"
 #include "src/surf/surf_interface.hpp"
 #include "src/surf/xml/platf_private.hpp"
@@ -26,29 +29,24 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF
 
 static std::string surf_parsed_filename; // Currently parsed file (for the error messages)
 std::vector<simgrid::kernel::resource::LinkImpl*>
-    parsed_link_list; /* temporary store of current list link of a route */
-
+    parsed_link_list; /* temporary store of current link list of a route */
+std::vector<simgrid::kernel::resource::DiskImpl*> parsed_disk_list; /* temporary store of current disk list of a host */
 /*
  * Helping functions
  */
-void surf_parse_assert(bool cond, const std::string& msg)
-{
-  if (not cond) {
-    int lineno = surf_parse_lineno;
-    cleanup();
-    XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename.c_str(), lineno, msg.c_str());
-    surf_exit();
-    xbt_die("Exiting now");
-  }
+void surf_parse_assert(bool cond, std::string&& msg)
+{
+  if (not cond)
+    surf_parse_error(std::move(msg));
+}
+
+void surf_parse_error(const char* msg) {
+  throw simgrid::ParseError(surf_parse_lineno, surf_parsed_filename, std::string(msg));
 }
 
-void surf_parse_error(const std::string& msg)
+void surf_parse_error(std::string&& msg)
 {
-  int lineno = surf_parse_lineno;
-  cleanup();
-  XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename.c_str(), lineno, msg.c_str());
-  surf_exit();
-  xbt_die("Exiting now");
+  throw simgrid::ParseError(surf_parse_lineno, surf_parsed_filename, std::move(msg));
 }
 
 void surf_parse_assert_netpoint(const std::string& hostname, const std::string& pre, const std::string& post)
@@ -79,14 +77,14 @@ void surf_parse_assert_netpoint(const std::string& hostname, const std::string&
       break;
     }
   }
-  surf_parse_error(msg);
+  surf_parse_error(std::move(msg));
 }
 
 double surf_parse_get_double(const std::string& s)
 {
   try {
     return std::stod(s);
-  } catch (std::invalid_argument& ia) {
+  } catch (const std::invalid_argument&) {
     surf_parse_error(s + " is not a double");
   }
 }
@@ -95,7 +93,7 @@ int surf_parse_get_int(const std::string& s)
 {
   try {
     return std::stoi(s);
-  } catch (std::invalid_argument& ia) {
+  } catch (const std::invalid_argument&) {
     surf_parse_error(s + " is not a double");
   }
 }
@@ -171,19 +169,23 @@ unit_scale::unit_scale(std::initializer_list<std::tuple<const std::string, doubl
   }
 }
 
-/* Note: field `unit' for the last element of parameter `units' should be nullptr. */
+/* Note: no warning is issued for unit-less values when `name' is empty. */
 double surf_parse_get_value_with_unit(const char* string, const unit_scale& units, const char* entity_kind,
                                       const std::string& name, const char* error_msg, const char* default_unit)
 {
-  char* ptr;
+  char* endptr;
   errno = 0;
-  double res   = strtod(string, &ptr);
+  double res      = strtod(string, &endptr);
+  const char* ptr = endptr; // for const-correctness
   if (errno == ERANGE)
     surf_parse_error(std::string("value out of range: ") + string);
   if (ptr == string)
     surf_parse_error(std::string("cannot parse number:") + string);
   if (ptr[0] == '\0') {
-    ptr = (char*)default_unit;
+    // Ok, 0 can be unit-less
+    if (res != 0 && not name.empty())
+      XBT_WARN("Deprecated unit-less value '%s' for %s %s. %s", string, entity_kind, name.c_str(), error_msg);
+    ptr = default_unit;
   }
   auto u = units.find(ptr);
   if (u == units.end())
@@ -223,6 +225,23 @@ double surf_parse_get_bandwidth(const char* string, const char* entity_kind, con
       "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
 }
 
+std::vector<double> surf_parse_get_bandwidths(const char* string, const char* entity_kind, const std::string& name)
+{
+  static const unit_scale units{std::make_tuple("bps", 0.125, 2, true), std::make_tuple("bps", 0.125, 10, true),
+                                std::make_tuple("Bps", 1.0, 2, true), std::make_tuple("Bps", 1.0, 10, true)};
+
+  std::vector<double> bandwidths;
+  std::vector<std::string> tokens;
+  boost::split(tokens, string, boost::is_any_of(";"));
+  for (auto token : tokens) {
+    bandwidths.push_back(surf_parse_get_value_with_unit(
+        token.c_str(), units, entity_kind, name,
+        "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps"));
+  }
+
+  return bandwidths;
+}
+
 double surf_parse_get_speed(const char* string, const char* entity_kind, const std::string& name)
 {
   static const unit_scale units{std::make_tuple("f", 1.0, 10, true), std::make_tuple("flops", 1.0, 10, false)};
@@ -258,27 +277,26 @@ static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* e
 
 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
 
+std::vector<std::unordered_map<std::string, std::string>*> property_sets;
+
 /* The default current property receiver. Setup in the corresponding opening callbacks. */
-std::unordered_map<std::string, std::string>* current_property_set       = nullptr;
 std::unordered_map<std::string, std::string>* current_model_property_set = nullptr;
-int ZONE_TAG                            = 0; // Whether we just opened a zone tag (to see what to do with the properties)
 
 FILE *surf_file_to_parse = nullptr;
 
 /* Stuff relative to storage */
 void STag_surfxml_storage()
 {
-  ZONE_TAG = 0;
   XBT_DEBUG("STag_surfxml_storage");
-  xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
 }
 
 void ETag_surfxml_storage()
 {
   simgrid::kernel::routing::StorageCreationArgs storage;
 
-  storage.properties   = current_property_set;
-  current_property_set = nullptr;
+  storage.properties = property_sets.back();
+  property_sets.pop_back();
 
   storage.id           = A_surfxml_storage_id;
   storage.type_id      = A_surfxml_storage_typeId;
@@ -289,17 +307,16 @@ void ETag_surfxml_storage()
 }
 void STag_surfxml_storage___type()
 {
-  ZONE_TAG = 0;
   XBT_DEBUG("STag_surfxml_storage___type");
-  xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
   xbt_assert(current_model_property_set == nullptr, "Someone forgot to reset the model property set to nullptr in its closing tag (or XML malformed)");
 }
 void ETag_surfxml_storage___type()
 {
   simgrid::kernel::routing::StorageTypeCreationArgs storage_type;
 
-  storage_type.properties = current_property_set;
-  current_property_set    = nullptr;
+  storage_type.properties = property_sets.back();
+  property_sets.pop_back();
 
   storage_type.model_properties = current_model_property_set;
   current_model_property_set    = nullptr;
@@ -340,7 +357,7 @@ void ETag_surfxml_include()
 void STag_surfxml_platform() {
   XBT_ATTRIB_UNUSED double version = surf_parse_get_double(A_surfxml_platform_version);
 
-  xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
+  surf_parse_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
       "You're using an ancient XML file.\n"
       "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
       "instead of MBytes, MFlops and seconds.\n"
@@ -354,13 +371,13 @@ void STag_surfxml_platform() {
 
       "Last, do not forget to also update your values for "
       "the calls to MSG_task_create (if any).");
-  xbt_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
+  surf_parse_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
       "You're using an old XML file.\n"
       "Use simgrid_update_xml to update your file automatically. "
       "This program is installed automatically with SimGrid, or "
       "available in the tools/ directory of the source archive.");
-  xbt_assert((version >= 4.0),
-             "******* FILE %s IS TOO OLD (v:%.1f) *********\n "
+  surf_parse_assert((version >= 4.0),
+             std::string("******* THIS FILE IS TOO OLD (v:")+std::to_string(version)+") *********\n "
              "Changes introduced in SimGrid 3.13:\n"
              "  - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
              "  - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
@@ -369,8 +386,7 @@ void STag_surfxml_platform() {
              "\n\n"
              "Use simgrid_update_xml to update your file automatically. "
              "This program is installed automatically with SimGrid, or "
-             "available in the tools/ directory of the source archive.",
-             surf_parsed_filename.c_str(), version);
+             "available in the tools/ directory of the source archive.");
   if (version < 4.1) {
     XBT_INFO("You're using a v%.1f XML file (%s) while the current standard is v4.1 "
              "That's fine, the new version is backward compatible. \n\n"
@@ -379,42 +395,31 @@ void STag_surfxml_platform() {
              "available in the tools/ directory of the source archive.",
              version, surf_parsed_filename.c_str());
   }
-  xbt_assert(version <= 4.1,
-             "******* FILE %s COMES FROM THE FUTURE (v:%.1f) *********\n "
+  surf_parse_assert(version <= 4.1,
+             std::string("******* THIS FILE COMES FROM THE FUTURE (v:")+std::to_string(version)+") *********\n "
              "The most recent formalism that this version of SimGrid understands is v4.1.\n"
-             "Please update your code, or use another, more adapted, file.",
-             surf_parsed_filename.c_str(), version);
+             "Please update your code, or use another, more adapted, file.");
 }
 void ETag_surfxml_platform(){
-  simgrid::s4u::on_platform_created();
+  simgrid::s4u::Engine::on_platform_created();
 }
 
 void STag_surfxml_host(){
-  ZONE_TAG = 0;
-  xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
 }
 
 void STag_surfxml_prop()
 {
-  if (ZONE_TAG) { // We need to retrieve the most recently opened zone
-    XBT_DEBUG("Set zone property %s -> %s", A_surfxml_prop_id, A_surfxml_prop_value);
-    simgrid::s4u::NetZone* netzone = simgrid::s4u::Engine::get_instance()->netzone_by_name_or_null(A_surfxml_zone_id);
-
-    netzone->set_property(std::string(A_surfxml_prop_id), A_surfxml_prop_value);
-  } else {
-    if (not current_property_set)
-      current_property_set = new std::unordered_map<std::string, std::string>; // Maybe, it should raise an error
-    current_property_set->insert({A_surfxml_prop_id, A_surfxml_prop_value});
-    XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
-              current_property_set);
-  }
+  property_sets.back()->insert({A_surfxml_prop_id, A_surfxml_prop_value});
+  XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
+            property_sets.back());
 }
 
 void ETag_surfxml_host()    {
   simgrid::kernel::routing::HostCreationArgs host;
 
-  host.properties = current_property_set;
-  current_property_set = nullptr;
+  host.properties = property_sets.back();
+  property_sets.pop_back();
 
   host.id = A_surfxml_host_id;
 
@@ -435,10 +440,27 @@ void ETag_surfxml_host()    {
                          : nullptr;
   host.pstate      = surf_parse_get_int(A_surfxml_host_pstate);
   host.coord       = A_surfxml_host_coordinates;
+  host.disks.swap(parsed_disk_list);
 
   sg_platf_new_host(&host);
 }
 
+void STag_surfxml_disk() {
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
+}
+
+void ETag_surfxml_disk() {
+  simgrid::kernel::routing::DiskCreationArgs disk;
+  disk.properties = property_sets.back();
+  property_sets.pop_back();
+
+  disk.id       = A_surfxml_disk_id;
+  disk.read_bw  = surf_parse_get_bandwidth(A_surfxml_disk_read___bw, "read_bw of disk ", disk.id);
+  disk.write_bw = surf_parse_get_bandwidth(A_surfxml_disk_write___bw, "write_bw of disk ", disk.id);
+
+  parsed_disk_list.push_back(sg_platf_new_disk(&disk));
+}
+
 void STag_surfxml_host___link(){
   XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
   simgrid::kernel::routing::HostLinkCreationArgs host_link;
@@ -455,8 +477,8 @@ void STag_surfxml_router(){
 
 void ETag_surfxml_cluster(){
   simgrid::kernel::routing::ClusterCreationArgs cluster;
-  cluster.properties   = current_property_set;
-  current_property_set = nullptr;
+  cluster.properties = property_sets.back();
+  property_sets.pop_back();
 
   cluster.id          = A_surfxml_cluster_id;
   cluster.prefix      = A_surfxml_cluster_prefix;
@@ -528,8 +550,7 @@ void ETag_surfxml_cluster(){
 }
 
 void STag_surfxml_cluster(){
-  ZONE_TAG = 0;
-  xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
 }
 
 void STag_surfxml_cabinet(){
@@ -572,18 +593,17 @@ void STag_surfxml_peer(){
 }
 
 void STag_surfxml_link(){
-  ZONE_TAG = 0;
-  xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
 }
 
 void ETag_surfxml_link(){
   simgrid::kernel::routing::LinkCreationArgs link;
 
-  link.properties          = current_property_set;
-  current_property_set     = nullptr;
+  link.properties = property_sets.back();
+  property_sets.pop_back();
 
   link.id                  = std::string(A_surfxml_link_id);
-  link.bandwidth           = surf_parse_get_bandwidth(A_surfxml_link_bandwidth, "bandwidth of link", link.id.c_str());
+  link.bandwidths          = surf_parse_get_bandwidths(A_surfxml_link_bandwidth, "bandwidth of link", link.id.c_str());
   link.bandwidth_trace     = A_surfxml_link_bandwidth___file[0]
                              ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_bandwidth___file)
                              : nullptr;
@@ -609,6 +629,9 @@ void ETag_surfxml_link(){
   case A_surfxml_link_sharing___policy_SPLITDUPLEX:
     link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
     break;
+  case A_surfxml_link_sharing___policy_WIFI:
+    link.policy = simgrid::s4u::Link::SharingPolicy::WIFI;
+    break;
   default:
     surf_parse_error(std::string("Invalid sharing policy in link ") + link.id);
   }
@@ -654,7 +677,8 @@ void ETag_surfxml_backbone(){
 
   link.properties = nullptr;
   link.id = std::string(A_surfxml_backbone_id);
-  link.bandwidth = surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id.c_str());
+  link.bandwidths.push_back(
+      surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id.c_str()));
   link.latency = surf_parse_get_time(A_surfxml_backbone_latency, "latency of backbone", link.id.c_str());
   link.policy     = simgrid::s4u::Link::SharingPolicy::SHARED;
 
@@ -842,24 +866,25 @@ void ETag_surfxml_AS()
 
 void STag_surfxml_zone()
 {
-  ZONE_TAG                 = 1;
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
   simgrid::kernel::routing::ZoneCreationArgs zone;
   zone.id      = A_surfxml_zone_id;
   zone.routing = static_cast<int>(A_surfxml_zone_routing);
-
   sg_platf_new_Zone_begin(&zone);
 }
 
 void ETag_surfxml_zone()
 {
+  sg_platf_new_Zone_set_properties(property_sets.back());
+  delete property_sets.back();
+  property_sets.pop_back();
+
   sg_platf_new_Zone_seal();
 }
 
 void STag_surfxml_config()
 {
-  ZONE_TAG = 0;
-  xbt_assert(current_property_set == nullptr,
-             "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
   XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
   if (_sg_cfg_init_status == 2) {
     surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
@@ -871,6 +896,8 @@ void ETag_surfxml_config()
 {
   // Sort config elements before applying.
   // That's a little waste of time, but not doing so would break the tests
+  auto current_property_set = property_sets.back();
+
   std::vector<std::string> keys;
   for (auto const& kv : *current_property_set) {
     keys.push_back(kv.first);
@@ -886,7 +913,7 @@ void ETag_surfxml_config()
   XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
 
   delete current_property_set;
-  current_property_set = nullptr;
+  property_sets.pop_back();
 }
 
 static std::vector<std::string> arguments;
@@ -899,9 +926,8 @@ void STag_surfxml_process()
 
 void STag_surfxml_actor()
 {
-  ZONE_TAG  = 0;
+  property_sets.push_back(new std::unordered_map<std::string, std::string>());
   arguments.assign(1, A_surfxml_actor_function);
-  xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
 }
 
 void ETag_surfxml_process()
@@ -918,8 +944,8 @@ void ETag_surfxml_actor()
 {
   simgrid::kernel::routing::ActorCreationArgs actor;
 
-  actor.properties     = current_property_set;
-  current_property_set = nullptr;
+  actor.properties = property_sets.back();
+  property_sets.pop_back();
 
   actor.args.swap(arguments);
   actor.host       = A_surfxml_actor_host;
@@ -979,10 +1005,9 @@ void surf_parse_open(const std::string& file)
   surf_path.push_back(dir);
 
   surf_file_to_parse = surf_fopen(file, "r");
-  if (surf_file_to_parse == nullptr) {
-    std::string cwd = simgrid::xbt::Path().get_name();
-    xbt_die("Unable to open '%s' from '%s'\n", file.c_str(), cwd.c_str());
-  }
+  if (surf_file_to_parse == nullptr)
+    throw std::invalid_argument(std::string("Unable to open ')") + file + "' from '" + simgrid::xbt::Path().get_name() +
+                                "'. Does this file exist?");
   surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
   surf_parse__switch_to_buffer(surf_input_buffer);
   surf_parse_lineno = 1;
@@ -1000,7 +1025,8 @@ void surf_parse_close()
 }
 
 /* Call the lexer to parse the currently opened file */
-int surf_parse()
+void surf_parse()
 {
-  return surf_parse_lex();
+  bool err = surf_parse_lex();
+  surf_parse_assert(not err, "Flex returned an error code");
 }