include/simgrid/s4u/NetZone.hpp

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