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