Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Misc sonar threats.
[simgrid.git] / src / surf / xml / surfxml_sax_cb.cpp
index d7d9c84..a363d6c 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
 
 /* 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. */
@@ -6,6 +6,8 @@
 #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"
 #include <unordered_map>
 #include <vector>
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
-
 #include "simgrid_dtd.c"
 
-static const char* surf_parsed_filename; // Currently parsed file (for the error messages)
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
+
+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 */
 
 /*
  * Helping functions
  */
-void surf_parse_assert(bool cond, std::string msg)
+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, lineno, msg.c_str());
+    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_error(std::string msg)
+void surf_parse_error(const std::string& msg)
 {
   int lineno = surf_parse_lineno;
   cleanup();
-  XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg.c_str());
+  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_netpoint(std::string hostname, std::string pre, std::string post)
+void surf_parse_assert_netpoint(const std::string& hostname, const std::string& pre, const std::string& post)
 {
-  if (sg_netpoint_by_name_or_null(hostname.c_str()) != nullptr) // found
+  if (simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(hostname) != nullptr) // found
     return;
 
   std::string msg = pre + hostname + post + " Existing netpoints: \n";
@@ -82,30 +84,28 @@ void surf_parse_assert_netpoint(std::string hostname, std::string pre, std::stri
   surf_parse_error(msg);
 }
 
-double surf_parse_get_double(std::string s)
+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");
-    return -1;
   }
 }
 
-int surf_parse_get_int(std::string s)
+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");
-    return -1;
   }
 }
 
 namespace {
 
 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
-std::vector<int>* explodesRadical(std::string radicals)
+std::vector<int>* explodesRadical(const std::string& radicals)
 {
   std::vector<int>* exploded = new std::vector<int>();
 
@@ -127,7 +127,6 @@ std::vector<int>* explodesRadical(std::string radicals)
         break;
       default:
         surf_parse_error(std::string("Malformed radical: ") + group);
-        break;
     }
     for (int i = start; i <= end; i++)
       exploded->push_back(i);
@@ -174,23 +173,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,
-                                      std::string name, const char* error_msg, const char* default_unit)
+                                      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') {
-    if (res == 0)
-      return res; // Ok, 0 can be unit-less
-
-    XBT_WARN("Deprecated unit-less value '%s' for %s %s. %s", string, entity_kind, name.c_str(), error_msg);
-    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())
@@ -199,7 +198,7 @@ double surf_parse_get_value_with_unit(const char* string, const unit_scale& unit
 }
 }
 
-double surf_parse_get_time(const char* string, const char* entity_kind, std::string name)
+double surf_parse_get_time(const char* string, const char* entity_kind, const std::string& name)
 {
   static const unit_scale units{std::make_pair("w", 7 * 24 * 60 * 60),
                                 std::make_pair("d", 24 * 60 * 60),
@@ -214,7 +213,7 @@ double surf_parse_get_time(const char* string, const char* entity_kind, std::str
       "Append 's' to your time to get seconds", "s");
 }
 
-double surf_parse_get_size(const char* string, const char* entity_kind, std::string name)
+double surf_parse_get_size(const char* string, const char* entity_kind, const std::string& name)
 {
   static const unit_scale units{std::make_tuple("b", 0.125, 2, true), std::make_tuple("b", 0.125, 10, true),
                                 std::make_tuple("B", 1.0, 2, true), std::make_tuple("B", 1.0, 10, true)};
@@ -222,7 +221,7 @@ double surf_parse_get_size(const char* string, const char* entity_kind, std::str
       "Append 'B' to get bytes (or 'b' for bits but 1B = 8b).", "B");
 }
 
-double surf_parse_get_bandwidth(const char* string, const char* entity_kind, std::string name)
+double surf_parse_get_bandwidth(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)};
@@ -230,14 +229,31 @@ double surf_parse_get_bandwidth(const char* string, const char* entity_kind, std
       "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
 }
 
-double surf_parse_get_speed(const char* string, const char* entity_kind, std::string name)
+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)};
   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
       "Append 'f' or 'flops' to your speed to get flop per second", "f");
 }
 
-static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* entity_kind, std::string id)
+static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* entity_kind, const std::string& id)
 {
 
   std::vector<double> speed_per_pstate;
@@ -266,8 +282,8 @@ 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 */
 
 /* The default current property receiver. Setup in the corresponding opening callbacks. */
-std::map<std::string, std::string>* current_property_set       = nullptr;
-std::map<std::string, std::string>* current_model_property_set = nullptr;
+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;
@@ -371,25 +387,26 @@ void STag_surfxml_platform() {
              "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"
-             "  - DOCTYPE now point to the rignt URL: http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd\n"
+             "  - DOCTYPE now point to the rignt URL.\n"
              "  - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
              "\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, version);
+             surf_parsed_filename.c_str(), version);
   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"
              "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
              "This program is installed automatically with SimGrid, or "
              "available in the tools/ directory of the source archive.",
-             version, surf_parsed_filename);
+             version, surf_parsed_filename.c_str());
   }
-  xbt_assert(version <= 4.1, "******* FILE %s COMES FROM THE FUTURE (v:%.1f) *********\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, version);
+  xbt_assert(version <= 4.1,
+             "******* FILE %s COMES FROM THE FUTURE (v:%.1f) *********\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);
 }
 void ETag_surfxml_platform(){
   simgrid::s4u::on_platform_created();
@@ -406,10 +423,10 @@ void STag_surfxml_prop()
     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->setProperty(A_surfxml_prop_id, A_surfxml_prop_value);
+    netzone->set_property(std::string(A_surfxml_prop_id), A_surfxml_prop_value);
   } else {
     if (not current_property_set)
-      current_property_set = new std::map<std::string, std::string>; // Maybe, it should raise an error
+      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);
@@ -428,8 +445,17 @@ void ETag_surfxml_host()    {
 
   XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
   host.core_amount = surf_parse_get_int(A_surfxml_host_core);
-  host.speed_trace = A_surfxml_host_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_availability___file) : nullptr;
-  host.state_trace = A_surfxml_host_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_state___file) : nullptr;
+
+  host.speed_trace = nullptr;
+  if (A_surfxml_host_availability___file[0] != '\0') {
+    XBT_WARN("The availability_file attribute in <host> is now deprecated. Please, use 'speed_file' instead.");
+    host.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_host_availability___file);
+  }
+  if (A_surfxml_host_speed___file[0] != '\0')
+    host.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_host_speed___file);
+  host.state_trace = A_surfxml_host_state___file[0]
+                         ? simgrid::kernel::profile::Profile::from_file(A_surfxml_host_state___file)
+                         : nullptr;
   host.pstate      = surf_parse_get_int(A_surfxml_host_pstate);
   host.coord       = A_surfxml_host_coordinates;
 
@@ -489,7 +515,6 @@ void ETag_surfxml_cluster(){
     break;
   default:
     surf_parse_error(std::string("Invalid cluster topology for cluster ") + cluster.id);
-    break;
   }
   cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
   cluster.router_id = A_surfxml_cluster_router___id;
@@ -510,7 +535,6 @@ void ETag_surfxml_cluster(){
     break;
   default:
     surf_parse_error(std::string("Invalid cluster sharing policy for cluster ") + cluster.id);
-    break;
   }
   switch (AX_surfxml_cluster_bb___sharing___policy) {
   case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
@@ -521,7 +545,6 @@ void ETag_surfxml_cluster(){
     break;
   default:
     surf_parse_error(std::string("Invalid bb sharing policy in cluster ") + cluster.id);
-    break;
   }
 
   sg_platf_new_cluster(&cluster);
@@ -553,11 +576,19 @@ void STag_surfxml_peer(){
   peer.bw_in       = surf_parse_get_bandwidth(A_surfxml_peer_bw___in, "bw_in of peer", peer.id.c_str());
   peer.bw_out      = surf_parse_get_bandwidth(A_surfxml_peer_bw___out, "bw_out of peer", peer.id.c_str());
   peer.coord       = A_surfxml_peer_coordinates;
-  peer.speed_trace = A_surfxml_peer_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_availability___file) : nullptr;
-  peer.state_trace = A_surfxml_peer_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_state___file) : nullptr;
+  peer.speed_trace = nullptr;
+  if (A_surfxml_peer_availability___file[0] != '\0') {
+    XBT_WARN("The availability_file attribute in <peer> is now deprecated. Please, use 'speed_file' instead.");
+    peer.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_availability___file);
+  }
+  if (A_surfxml_peer_speed___file[0] != '\0')
+    peer.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_speed___file);
+  peer.state_trace = A_surfxml_peer_state___file[0]
+                         ? simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_state___file)
+                         : nullptr;
 
   if (A_surfxml_peer_lat[0] != '\0')
-    XBT_WARN("The latency parameter in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
+    XBT_WARN("The latency attribute in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
              A_surfxml_peer_lat);
 
   sg_platf_new_peer(&peer);
@@ -575,11 +606,17 @@ void ETag_surfxml_link(){
   current_property_set     = nullptr;
 
   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.bandwidth_trace     = A_surfxml_link_bandwidth___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_bandwidth___file) : nullptr;
+  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;
   link.latency             = surf_parse_get_time(A_surfxml_link_latency, "latency of link", link.id.c_str());
-  link.latency_trace       = A_surfxml_link_latency___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_latency___file) : nullptr;
-  link.state_trace         = A_surfxml_link_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_state___file):nullptr;
+  link.latency_trace       = A_surfxml_link_latency___file[0]
+                           ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_latency___file)
+                           : nullptr;
+  link.state_trace = A_surfxml_link_state___file[0]
+                         ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_state___file)
+                         : nullptr;
 
   switch (A_surfxml_link_sharing___policy) {
   case A_surfxml_link_sharing___policy_SHARED:
@@ -595,9 +632,11 @@ 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);
-    break;
   }
 
   sg_platf_new_link(&link);
@@ -619,7 +658,6 @@ void STag_surfxml_link___ctn()
     break;
   default:
     surf_parse_error(std::string("Invalid direction for link ") + A_surfxml_link___ctn_id);
-    break;
   }
 
   const char* dirname = "";
@@ -642,7 +680,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;
 
@@ -776,7 +815,7 @@ void ETag_surfxml_bypassZoneRoute()
 }
 
 void ETag_surfxml_trace(){
-  simgrid::kernel::routing::TraceCreationArgs trace;
+  simgrid::kernel::routing::ProfileCreationArgs trace;
 
   trace.id = A_surfxml_trace_id;
   trace.file = A_surfxml_trace_file;
@@ -812,7 +851,6 @@ void STag_surfxml_trace___connect()
     break;
   default:
     surf_parse_error("Invalid trace kind");
-    break;
   }
   sg_platf_trace_connect(&trace_connect);
 }
@@ -858,12 +896,19 @@ void STag_surfxml_config()
 
 void ETag_surfxml_config()
 {
-  for (auto const& elm : *current_property_set) {
-    if (simgrid::config::is_default(elm.first.c_str())) {
-      std::string cfg = elm.first + ":" + elm.second;
+  // Sort config elements before applying.
+  // That's a little waste of time, but not doing so would break the tests
+  std::vector<std::string> keys;
+  for (auto const& kv : *current_property_set) {
+    keys.push_back(kv.first);
+  }
+  std::sort(keys.begin(), keys.end());
+  for (std::string key : keys) {
+    if (simgrid::config::is_default(key.c_str())) {
+      std::string cfg = key + ":" + current_property_set->at(key);
       simgrid::config::set_parse(std::move(cfg));
     } else
-      XBT_INFO("The custom configuration '%s' is already defined by user!", elm.first.c_str());
+      XBT_INFO("The custom configuration '%s' is already defined by user!", key.c_str());
   }
   XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
 
@@ -919,7 +964,6 @@ void ETag_surfxml_actor()
     break;
   default:
     surf_parse_error("Invalid on failure behavior");
-    break;
   }
 
   sg_platf_new_actor(&actor);
@@ -931,7 +975,7 @@ void STag_surfxml_argument(){
 
 void STag_surfxml_model___prop(){
   if (not current_model_property_set)
-    current_model_property_set = new std::map<std::string, std::string>();
+    current_model_property_set = new std::unordered_map<std::string, std::string>();
 
   current_model_property_set->insert({A_surfxml_model___prop_id, A_surfxml_model___prop_value});
 }
@@ -955,17 +999,17 @@ void ETag_surfxml_model___prop(){/* Nothing to do */}
 /* Open and Close parse file */
 YY_BUFFER_STATE surf_input_buffer;
 
-void surf_parse_open(const char *file)
+void surf_parse_open(const std::string& file)
 {
-  xbt_assert(file, "Cannot parse the nullptr file. Bypassing the parser is strongly deprecated nowadays.");
-
   surf_parsed_filename = file;
   std::string dir      = simgrid::xbt::Path(file).get_dir_name();
   surf_path.push_back(dir);
 
   surf_file_to_parse = surf_fopen(file, "r");
-  if (surf_file_to_parse == nullptr)
-    xbt_die("Unable to open '%s'\n", file);
+  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());
+  }
   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;