include/simgrid/s4u/NetZone.hpp

   1 /* Copyright (c) 2016-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 #ifndef SIMGRID_S4U_NETZONE_HPP
   7 #define SIMGRID_S4U_NETZONE_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/s4u/Link.hpp>
  11 #include <xbt/graph.h>
  12 #include <xbt/signal.hpp>
  13
  14 #include <map>
  15 #include <string>
  16 #include <unordered_map>
  17 #include <unordered_set>
  18 #include <utility>
  19 #include <vector>
  20
  21 namespace simgrid::s4u {
  22
  23 /** @brief Networking Zones
  24  *
  25  * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
  26  * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
  27  * s4u::Engine).
  28  */
  29 class XBT_PUBLIC NetZone {
  30 #ifndef DOXYGEN
  31   friend kernel::routing::NetZoneImpl;
  32 #endif
  33
  34   kernel::routing::NetZoneImpl* const pimpl_;
  35
  36 protected:
  37   explicit NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
  38
  39 public:
  40   /** @brief Retrieves the name of that netzone as a C++ string */
  41   const std::string& get_name() const;
  42   /** @brief Retrieves the name of that netzone as a C string */
  43   const char* get_cname() const;
  44
  45   NetZone* get_parent() const;
  46   NetZone* set_parent(const NetZone* parent);
  47   std::vector<NetZone*> get_children() const;
  48
  49   std::vector<Host*> get_all_hosts() const;
  50   size_t get_host_count() const;
  51
  52   kernel::routing::NetZoneImpl* get_impl() const { return pimpl_; }
  53
  54   /** Get the properties assigned to a netzone */
  55   const std::unordered_map<std::string, std::string>* get_properties() const;
  56   /** Retrieve the property value (or nullptr if not set) */
  57   const char* get_property(const std::string& key) const;
  58   void set_property(const std::string& key, const std::string& value);
  59   /** @brief Get the netpoint associated to this netzone */
  60   kernel::routing::NetPoint* get_netpoint();
  61
  62   void extract_xbt_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
  63                          std::map<std::string, xbt_edge_t, std::less<>>* edges);
  64
  65   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
  66   unsigned long add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
  67
  68   /**
  69    * @brief Add a route between 2 netpoints
  70    *
  71    * Create a route:
  72    * - route between 2 hosts/routers in same netzone, no gateway is needed
  73    * - route between 2 netzones, connecting 2 gateways.
  74    *
  75    * @param src Source netzone's netpoint
  76    * @param dst Destination netzone' netpoint
  77    * @param gw_src Netpoint of the gateway in the source netzone
  78    * @param gw_dst Netpoint of the gateway in the destination netzone
  79    * @param link_list List of links and their direction used in this communication
  80    * @param symmetrical Bi-directional communication
  81    */
  82   void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  83                  kernel::routing::NetPoint* gw_dst, const std::vector<LinkInRoute>& link_list, bool symmetrical = true);
  84   /**
  85    * @brief Add a route between 2 netpoints, and same in other direction
  86    *
  87    * Create a route:
  88    * - route between 2 hosts/routers in same netzone, no gateway is needed
  89    * - route between 2 netzones, connecting 2 gateways.
  90    *
  91    * @param src Source netzone's netpoint
  92    * @param dst Destination netzone' netpoint
  93    * @param gw_src Netpoint of the gateway in the source netzone
  94    * @param gw_dst Netpoint of the gateway in the destination netzone
  95    * @param link_list List of links
  96    */
  97   void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  98                  kernel::routing::NetPoint* gw_dst, const std::vector<const Link*>& links);
  99
 100   /**
 101    * @brief Add a route between 2 hosts
 102    *
 103    * @param src Source host
 104    * @param dst Destination host
 105    * @param link_list List of links and their direction used in this communication
 106    * @param symmetrical Bi-directional communication
 107    */
 108   void add_route(const Host* src, const Host* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical = true);
 109   /**
 110    * @brief Add a route between 2 hosts
 111    *
 112    * @param src Source host
 113    * @param dst Destination host
 114    * @param link_list List of links. The UP direction will be used on src->dst and DOWN direction on dst->src
 115    */
 116   void add_route(const Host* src, const Host* dst, const std::vector<const Link*>& links);
 117
 118   void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
 119                         kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
 120                         const std::vector<LinkInRoute>& link_list);
 121
 122 private:
 123 #ifndef DOXYGEN
 124   static xbt::signal<void(NetZone const&)> on_creation;
 125   static xbt::signal<void(NetZone const&)> on_seal;
 126 #endif
 127
 128 public:
 129   /** \static Add a callback fired on each newly created NetZone */
 130   static void on_creation_cb(const std::function<void(NetZone const&)>& cb) { on_creation.connect(cb); }
 131   /** \static Add a callback fired on each newly sealed NetZone */
 132   static void on_seal_cb(const std::function<void(NetZone const&)>& cb) { on_seal.connect(cb); }
 133
 134   /**
 135    * @brief Create a host
 136    *
 137    * @param name Host name
 138    * @param speed_per_pstate Vector of CPU's speeds
 139    */
 140   s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate);
 141   s4u::Host* create_host(const std::string& name, double speed);
 142   /**
 143    * @brief Create a Host (string version)
 144    *
 145    * @throw std::invalid_argument if speed format is incorrect.
 146    */
 147   s4u::Host* create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate);
 148   s4u::Host* create_host(const std::string& name, const std::string& speed);
 149
 150   /**
 151    * @brief Create a link
 152    *
 153    * @param name Link name
 154    * @param bandwidths Link's speed (vector for wifi links)
 155    * @throw std::invalid_argument if bandwidth format is incorrect.
 156    */
 157   s4u::Link* create_link(const std::string& name, const std::vector<double>& bandwidths);
 158   s4u::Link* create_link(const std::string& name, double bandwidth);
 159
 160   /** @brief Create a link (string version) */
 161   s4u::Link* create_link(const std::string& name, const std::vector<std::string>& bandwidths);
 162   s4u::Link* create_link(const std::string& name, const std::string& bandwidth);
 163
 164   /**
 165    * @brief Create a split-duplex link
 166    *
 167    * In SimGrid, split-duplex links are a composition of 2 regular (shared) links (up/down).
 168    *
 169    * This function eases its utilization by creating the 2 links for you. We append a suffix
 170    * "_UP" and "_DOWN" to your link name to identify each of them.
 171    *
 172    * Both up/down links have exactly the same bandwidth
 173    *
 174    * @param name Name of the link
 175    * @param bandwidth Speed
 176    */
 177   s4u::SplitDuplexLink* create_split_duplex_link(const std::string& name, const std::string& bandwidth);
 178   s4u::SplitDuplexLink* create_split_duplex_link(const std::string& name, double bandwidth);
 179
 180   kernel::resource::NetworkModel* get_network_model() const;
 181
 182   /**
 183    * @brief Make a router within that NetZone
 184    *
 185    * @param name Router name
 186    */
 187   kernel::routing::NetPoint* create_router(const std::string& name);
 188
 189   /** @brief Seal this netzone configuration */
 190   NetZone* seal();
 191
 192   void
 193   set_latency_factor_cb(std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
 194                                              const std::vector<s4u::Link*>& /*links*/,
 195                                              const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const;
 196   void
 197   set_bandwidth_factor_cb(std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
 198                                                const std::vector<s4u::Link*>& /*links*/,
 199                                                const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const;
 200 };
 201
 202 // External constructors so that the types (and the types of their content) remain hidden
 203 XBT_PUBLIC NetZone* create_full_zone(const std::string& name);
 204 XBT_PUBLIC NetZone* create_star_zone(const std::string& name);
 205 XBT_PUBLIC NetZone* create_dijkstra_zone(const std::string& name, bool cache);
 206 XBT_PUBLIC NetZone* create_empty_zone(const std::string& name);
 207 XBT_PUBLIC NetZone* create_floyd_zone(const std::string& name);
 208 XBT_PUBLIC NetZone* create_vivaldi_zone(const std::string& name);
 209 XBT_PUBLIC NetZone* create_wifi_zone(const std::string& name);
 210
 211 // Extra data structure for complex constructors
 212
 213 /** @brief Aggregates the callbacks used to build clusters netzones (Torus/Dragronfly/Fat-Tree) */
 214 struct ClusterCallbacks {
 215   /**
 216    * @brief Callback used to set the netpoint and gateway located at some leaf of clusters (Torus, FatTree, etc)
 217    *
 218    * The netpoint can be either a host, router or another netzone.
 219    * Gateway must be non-null if netpoint is a netzone
 220    *
 221    * @param zone: The newly create zone, needed for creating new resources (hosts, links)
 222    * @param coord: the coordinates of the element
 223    * @param id: Internal identifier of the element
 224    * @return pair<NetPoint*, NetPoint*>: returns a pair of netpoint and gateway.
 225    */
 226   using ClusterNetPointCb = std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*>(
 227       NetZone* zone, const std::vector<unsigned long>& coord, unsigned long id);
 228   /**
 229    * @brief Callback used to set the links for some leaf of the cluster (Torus, FatTree, etc)
 230    *
 231    * The coord parameter depends on the cluster being created:
 232    * - Torus: Direct translation of the Torus' dimensions, e.g. (0, 0, 0) for a 3-D Torus
 233    * - Fat-Tree: A pair (level in the tree, id), e.g. (0, 0): first leaf and (1,0): first switch at level 1.
 234    * - Dragonfly: a tuple (group, chassis, blades/routers, nodes), e.g. (0, 0, 0, 0) for first node in the cluster.
 235    * Important: To identify the router inside a "group, chassis, blade", we use MAX_UINT in the last parameter (e.g. 0,
 236    * 0, 0, 4294967295).
 237    *
 238    * @param zone: The newly create zone, needed for creating new resources (hosts, links)
 239    * @param coord: the coordinates of the element
 240    * @param id: Internal identifier of the element
 241    * @return Pointer to the Link
 242    */
 243   using ClusterLinkCb = Link*(NetZone* zone, const std::vector<unsigned long>& coord, unsigned long id);
 244
 245   std::function<ClusterNetPointCb> netpoint;
 246   std::function<ClusterLinkCb> loopback = {};
 247   std::function<ClusterLinkCb> limiter  = {};
 248   explicit ClusterCallbacks(const std::function<ClusterNetPointCb>& set_netpoint)
 249       : netpoint(set_netpoint){/*nothing to do */};
 250   ClusterCallbacks(const std::function<ClusterNetPointCb>& set_netpoint,
 251                    const std::function<ClusterLinkCb>& set_loopback, const std::function<ClusterLinkCb>& set_limiter)
 252       : netpoint(set_netpoint), loopback(set_loopback), limiter(set_limiter){/*nothing to do */};
 253 };
 254 /**
 255  * @brief Create a torus zone
 256  *
 257  * Torus clusters are characterized by:
 258  * - dimensions, eg. {3,3,3} creates a torus with X = 3 elements, Y = 3 and Z = 3. In total, this cluster have 27
 259  * elements
 260  * - inter-node communication: (bandwidth, latency, sharing_policy) the elements are connected through regular links
 261  * with these characteristics
 262  * More details in: <a href="https://simgrid.org/doc/latest/Platform_examples.html?highlight=torus#torus-cluster">Torus
 263  * Cluster</a>
 264  *
 265  * Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
 266  *
 267  * Note that the all elements in a Torus cluster must have (or not) the same elements (loopback and limiter)
 268  *
 269  * @param name NetZone's name
 270  * @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
 271  * the netzone
 272  * @param dimensions List of positive integers (> 0) which determines the torus' dimensions
 273  * @param set_callbacks Callbacks to set properties from cluster elements (netpoint, loopback and limiter)
 274  * @param bandwidth Characteristics of the inter-nodes link
 275  * @param latency Characteristics of the inter-nodes link
 276  * @param sharing_policy Characteristics of the inter-nodes link
 277  * @return Pointer to new netzone
 278  */
 279 XBT_PUBLIC NetZone* create_torus_zone(const std::string& name, const NetZone* parent,
 280                                       const std::vector<unsigned long>& dimensions,
 281                                       const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
 282                                       Link::SharingPolicy sharing_policy);
 283
 284 /** @brief Aggregates the parameters necessary to build a Fat-tree zone */
 285 struct XBT_PUBLIC FatTreeParams {
 286   unsigned int levels;
 287   std::vector<unsigned int> down;
 288   std::vector<unsigned int> up;
 289   std::vector<unsigned int> number;
 290   FatTreeParams(unsigned int n_levels, const std::vector<unsigned int>& down_links,
 291                 const std::vector<unsigned int>& up_links, const std::vector<unsigned int>& links_number);
 292 };
 293 /**
 294  * @brief Create a Fat-Tree zone
 295  *
 296  * Fat-Tree clusters are characterized by:
 297  * - levels: number of levels in the cluster, e.g. 2 (the final tree will have n+1 levels)
 298  * - downlinks: for each level, how many connections between elements below them, e.g. 2, 3: level 1 nodes are connected
 299  * to 2 nodes in level 2, which are connected to 3 nodes below. Determines the number total of leaves in the tree.
 300  * - uplinks: for each level, how nodes are connected, e.g. 1, 2
 301  * - link count: for each level, number of links connecting the nodes, e.g. 1, 1
 302  *
 303  * The best way to understand it is looking to the doc available in: <a
 304  * href="https://simgrid.org/doc/latest/Platform_examples.html#fat-tree-cluster">Fat Tree Cluster</a>
 305  *
 306  * Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
 307  *
 308  * Note that the all elements in a Fat-Tree cluster must have (or not) the same elements (loopback and limiter)
 309  *
 310  * @param name NetZone's name
 311  * @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
 312  * the netzone
 313  * @param parameters Characteristics of this Fat-Tree
 314  * @param set_callbacks Callbacks to set properties from cluster elements (netpoint, loopback and limiter)
 315  * @param bandwidth Characteristics of the inter-nodes link
 316  * @param latency Characteristics of the inter-nodes link
 317  * @param sharing_policy Characteristics of the inter-nodes link
 318  * @return Pointer to new netzone
 319  */
 320 XBT_PUBLIC NetZone* create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters,
 321                                         const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
 322                                         Link::SharingPolicy sharing_policy);
 323
 324 /** @brief Aggregates the parameters necessary to build a Dragonfly zone */
 325 struct XBT_PUBLIC DragonflyParams {
 326   std::pair<unsigned int, unsigned int> groups;
 327   std::pair<unsigned int, unsigned int> chassis;
 328   std::pair<unsigned int, unsigned int> routers;
 329   unsigned int nodes;
 330   DragonflyParams(const std::pair<unsigned int, unsigned int>& groups,
 331                   const std::pair<unsigned int, unsigned int>& chassis,
 332                   const std::pair<unsigned int, unsigned int>& routers, unsigned int nodes);
 333 };
 334 /**
 335  * @brief Create a Dragonfly zone
 336  *
 337  * Dragonfly clusters are characterized by:
 338  * - groups: number of groups and links between each group, e.g. 2,2.
 339  * - chassis: number of chassis in each group and the number of links used to connect the chassis, e.g. 2,3
 340  * - routers: number of routers in each chassis and their links, e.g. 3,1
 341  * - nodes: number of nodes connected to each router using a single link, e.g. 2
 342  *
 343  * In total, the cluster will have groups * chassis * routers * nodes elements/leaves.
 344  *
 345  * The best way to understand it is looking to the doc available in: <a
 346  * href="https://simgrid.org/doc/latest/Platform_examples.html#dragonfly-cluster">Dragonfly Cluster</a>
 347  *
 348  * Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
 349  *
 350  * Note that the all elements in a Dragonfly cluster must have (or not) the same elements (loopback and limiter)
 351  *
 352  * @param name NetZone's name
 353  * @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
 354  * the netzone
 355  * @param parameters Characteristics of this Dragonfly
 356  * @param set_callbacks Callbacks to set properties from cluster elements (netpoint, loopback and limiter)
 357  * @param bandwidth Characteristics of the inter-nodes link
 358  * @param latency Characteristics of the inter-nodes link
 359  * @param sharing_policy Characteristics of the inter-nodes link
 360  * @return Pointer to new netzone
 361  */
 362 XBT_PUBLIC NetZone* create_dragonfly_zone(const std::string& name, const NetZone* parent,
 363                                           const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks,
 364                                           double bandwidth, double latency, Link::SharingPolicy sharing_policy);
 365
 366 } // namespace simgrid::s4u
 367
 368 #endif /* SIMGRID_S4U_NETZONE_HPP */