src/kernel/routing/VivaldiZone.cpp

   1 /* Copyright (c) 2013-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/kernel/routing/NetPoint.hpp>
   7 #include <simgrid/kernel/routing/VivaldiZone.hpp>
   8 #include <simgrid/s4u/Engine.hpp>
   9 #include <simgrid/s4u/Host.hpp>
  10
  11 #include "src/kernel/resource/StandardLinkImpl.hpp"
  12
  13 #include <boost/algorithm/string.hpp>
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing_vivaldi, ker_routing, "Kernel Vivaldi Routing");
  16
  17 namespace simgrid {
  18 namespace kernel::routing {
  19
  20 namespace vivaldi {
  21
  22 xbt::Extension<NetPoint, Coords> Coords::EXTENSION_ID;
  23
  24 Coords::Coords(NetPoint* netpoint, const std::string& coordStr)
  25 {
  26   if (not Coords::EXTENSION_ID.valid())
  27     Coords::EXTENSION_ID = NetPoint::extension_create<Coords>();
  28
  29   std::vector<std::string> string_values;
  30   boost::split(string_values, coordStr, boost::is_any_of(" "));
  31   xbt_assert(string_values.size() == 3, "Coordinates of %s must have 3 dimensions", netpoint->get_cname());
  32
  33   for (auto const& str : string_values)
  34     try {
  35       coords.push_back(std::stod(str));
  36     } catch (std::invalid_argument const& ia) {
  37       throw std::invalid_argument(std::string("Invalid coordinate: ") + ia.what());
  38     }
  39   coords.shrink_to_fit();
  40
  41   netpoint->extension_set<Coords>(this);
  42   XBT_DEBUG("Coords of %s %p: %s", netpoint->get_cname(), netpoint, coordStr.c_str());
  43 }
  44 } // namespace vivaldi
  45
  46 static inline double euclidean_dist_comp(double src_coord, double dst_coord)
  47 {
  48   return (src_coord - dst_coord) * (src_coord - dst_coord);
  49 }
  50
  51 static const std::vector<double>& netpoint_get_coords(const NetPoint* np)
  52 {
  53   const auto* coords = np->extension<vivaldi::Coords>();
  54   xbt_assert(coords, "Please specify the Vivaldi coordinates of %s %s (%p)",
  55              (np->is_netzone() ? "Netzone" : (np->is_host() ? "Host" : "Router")), np->get_cname(), np);
  56   return coords->coords;
  57 }
  58
  59 void VivaldiZone::set_peer_link(NetPoint* netpoint, double bw_in, double bw_out)
  60 {
  61   xbt_assert(netpoint->get_englobing_zone() == this,
  62              "Cannot add a peer link to a netpoint that is not in this netzone");
  63
  64   std::string link_up        = "link_" + netpoint->get_name() + "_UP";
  65   std::string link_down      = "link_" + netpoint->get_name() + "_DOWN";
  66   const auto* linkUp         = create_link(link_up, {bw_out})->seal();
  67   const auto* linkDown       = create_link(link_down, {bw_in})->seal();
  68   add_route(netpoint, nullptr, nullptr, nullptr, {s4u::LinkInRoute(linkUp)}, false);
  69   add_route(nullptr, netpoint, nullptr, nullptr, {s4u::LinkInRoute(linkDown)}, false);
  70 }
  71
  72 void VivaldiZone::get_local_route(const NetPoint* src, const NetPoint* dst, Route* route, double* lat)
  73 {
  74   XBT_DEBUG("vivaldi getLocalRoute from '%s'[%lu] '%s'[%lu]", src->get_cname(), src->id(), dst->get_cname(), dst->id());
  75   const auto* engine = s4u::Engine::get_instance();
  76   if (src->is_netzone()) {
  77     std::string srcName = "router_" + src->get_name();
  78     std::string dstName = "router_" + dst->get_name();
  79     route->gw_src_      = engine->netpoint_by_name_or_null(srcName);
  80     route->gw_dst_      = engine->netpoint_by_name_or_null(dstName);
  81   }
  82
  83   StarZone::get_local_route(src, dst, route, lat);
  84   /* Compute the extra latency due to the euclidean distance if needed */
  85   if (lat) {
  86     std::vector<double> srcCoords = netpoint_get_coords(src);
  87     std::vector<double> dstCoords = netpoint_get_coords(dst);
  88
  89     double euclidean_dist =
  90         sqrt(euclidean_dist_comp(srcCoords[0], dstCoords[0]) + euclidean_dist_comp(srcCoords[1], dstCoords[1])) +
  91         fabs(srcCoords[2]) + fabs(dstCoords[2]);
  92
  93     XBT_DEBUG("Updating latency %f += %f", *lat, euclidean_dist);
  94     *lat += euclidean_dist / 1000.0; // From .ms to .s
  95   }
  96 }
  97
  98 } // namespace kernel::routing
  99
 100 namespace s4u {
 101 NetZone* create_vivaldi_zone(const std::string& name)
 102 {
 103   return (new kernel::routing::VivaldiZone(name))->get_iface();
 104 }
 105 } // namespace s4u
 106
 107 } // namespace simgrid