examples/cpp/clusters-multicpu/s4u-clusters-multicpu.cpp

   1 /* Copyright (c) 2010-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 /* This example shows how to build a torus cluster with multi-core hosts.
   7  *
   8  * However, each leaf in the torus is a StarZone, composed of several CPUs
   9  *
  10  * Each actor runs in a specific CPU. One sender broadcasts a message to all receivers.
  11  */
  12
  13 #include "simgrid/s4u.hpp"
  14 namespace sg4 = simgrid::s4u;
  15
  16 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_torus_multicpu, "Messages specific for this s4u example");
  17
  18 class Sender {
  19   long msg_size = 1e6; /* message size in bytes */
  20   std::vector<sg4::Host*> hosts_;
  21
  22 public:
  23   explicit Sender(const std::vector<sg4::Host*>& hosts) : hosts_{hosts} {}
  24   void operator()() const
  25   {
  26     /* Vector in which we store all ongoing communications */
  27     std::vector<sg4::CommPtr> pending_comms;
  28
  29     /* Make a vector of the mailboxes to use */
  30     std::vector<sg4::Mailbox*> mboxes;
  31
  32     /* Start dispatching 1 message to all receivers */
  33     std::string msg_content =
  34         std::string("Hello, I'm alive and running on ") + std::string(sg4::this_actor::get_host()->get_name());
  35     for (const auto* host : hosts_) {
  36       /* Copy the data we send: the 'msg_content' variable is not a stable storage location.
  37        * It will be destroyed when this actor leaves the loop, ie before the receiver gets it */
  38       auto* payload = new std::string(msg_content);
  39
  40       /* Create a communication representing the ongoing communication, and store it in pending_comms */
  41       auto mbox = sg4::Mailbox::by_name(host->get_name());
  42       mboxes.push_back(mbox);
  43       sg4::CommPtr comm = mbox->put_async(payload, msg_size);
  44       pending_comms.push_back(comm);
  45     }
  46
  47     XBT_INFO("Done dispatching all messages");
  48
  49     /* Now that all message exchanges were initiated, wait for their completion in one single call */
  50     sg4::Comm::wait_all(pending_comms);
  51
  52     XBT_INFO("Goodbye now!");
  53   }
  54 };
  55
  56 /* Receiver actor: wait for 1 message on the mailbox identified by the hostname */
  57 class Receiver {
  58 public:
  59   void operator()() const
  60   {
  61     auto mbox     = sg4::Mailbox::by_name(sg4::this_actor::get_host()->get_name());
  62     auto received = mbox->get_unique<std::string>();
  63     XBT_INFO("I got a '%s'.", received->c_str());
  64   }
  65 };
  66
  67 /*************************************************************************************************/
  68 /**
  69  * @brief Callback to set a cluster leaf/element
  70  *
  71  * In our example, each leaf if a StarZone, composed of 8 CPUs.
  72  * Each CPU is modeled as a host, connected to the outer world through a high-speed PCI link.
  73  * Obs.: CPU0 is the gateway for this zone
  74  *
  75  *    (outer world)
  76  *         CPU0 (gateway)
  77  *    up ->|   |
  78  *         |   |<-down
  79  *         +star+
  80  *      /   / \   \
  81  *     /   /   \   \<-- 100Gbs, 10us link (1 link UP and 1 link DOWN for full-duplex)
  82  *    /   /     \   \
  83  *   /   /       \   \
  84  *   CPU1   ...   CPU8
  85  *
  86  * @param zone Cluster netzone being created (usefull to create the hosts/links inside it)
  87  * @param coord Coordinates in the cluster
  88  * @param id Internal identifier in the torus (for information)
  89  * @return netpoint, gateway: the netpoint to the StarZone and CPU0 as gateway
  90  */
  91 static std::pair<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*>
  92 create_hostzone(const sg4::NetZone* zone, const std::vector<unsigned long>& /*coord*/, unsigned long id)
  93 {
  94   constexpr int num_cpus    = 8;     //!< Number of CPUs in the zone
  95   constexpr double speed    = 1e9;   //!< Speed of each CPU
  96   constexpr double link_bw  = 100e9; //!< Link bw connecting the CPU
  97   constexpr double link_lat = 1e-9;  //!< Link latency
  98
  99   std::string hostname = "host" + std::to_string(id);
 100   /* create the StarZone */
 101   auto* host_zone = sg4::create_star_zone(hostname);
 102   /* setting my Torus parent zone */
 103   host_zone->set_parent(zone);
 104
 105   const sg4::Host* gateway = nullptr;
 106   /* create CPUs */
 107   for (int i = 0; i < num_cpus; i++) {
 108     std::string cpu_name  = hostname + "-cpu" + std::to_string(i);
 109     const sg4::Host* host = host_zone->create_host(cpu_name, speed)->seal();
 110     /* the first CPU is the gateway */
 111     if (i == 0)
 112       gateway = host;
 113     /* create split-duplex link */
 114     sg4::SplitDuplexLink* link = host_zone->create_split_duplex_link("link-" + cpu_name, link_bw);
 115     link->set_latency(link_lat)->seal();
 116     /* connecting CPU to outer world */
 117     host_zone->add_route(host->get_netpoint(), nullptr, nullptr, nullptr, {{link, sg4::LinkInRoute::Direction::UP}},
 118                          true);
 119   }
 120   /* seal newly created netzone */
 121   host_zone->seal();
 122   return std::make_pair(host_zone->get_netpoint(), gateway->get_netpoint());
 123 }
 124
 125 /*************************************************************************************************/
 126 /**
 127  * @brief Callback to create limiter link (1Gbs) for each netpoint
 128  *
 129  * The coord parameter depends on the cluster being created:
 130  * - Torus: Direct translation of the Torus' dimensions, e.g. (0, 0, 0) for a 3-D Torus
 131  * - Fat-Tree: A pair (level in the tree, id), e.g. (0, 0) for first leaf in the tree and (1,0) for the first switch at
 132  * level 1.
 133  * - Dragonfly: a tuple (group, chassis, blades/routers, nodes), e.g. (0, 0, 0, 0) for first node in the cluster. To
 134  * identify the router inside a (group, chassis, blade), we use MAX_UINT in the last parameter (e.g. 0, 0, 0,
 135  * 4294967295).
 136  *
 137  * @param zone Torus netzone being created (usefull to create the hosts/links inside it)
 138  * @param coord Coordinates in the cluster
 139  * @param id Internal identifier in the torus (for information)
 140  * @return Limiter link
 141  */
 142 static sg4::Link* create_limiter(sg4::NetZone* zone, const std::vector<unsigned long>& /*coord*/, unsigned long id)
 143 {
 144   return zone->create_link("limiter-" + std::to_string(id), 1e9)->seal();
 145 }
 146
 147 /**
 148  * @brief Creates a TORUS cluster
 149  *
 150  * Creates a TORUS cluster with dimensions 2x2x2
 151  *
 152  * The cluster has 8 elements/leaves in total. Each element is a StarZone containing 8 Hosts.
 153  * Each pair in the torus is connected through 2 links:
 154  * 1) limiter: a 1Gbs limiter link (set by user through the set_limiter callback)
 155  * 2) link: 10Gbs link connecting the components (created automatically)
 156  *
 157  * (Y-axis=2)
 158  * A
 159  * |
 160  * |   D (Z-axis=2)
 161  * +  / 10 Gbs
 162  * | +
 163  * |/ limiter=1Gps
 164  * B-----+----C (X-axis=2)
 165  *
 166  * For example, a communication from A to C goes through:
 167  * <tt> A->limiter(A)->link(A-B)->limiter(B)->link(B-C)->limiter(C)->C </tt>
 168  *
 169  * More precisely, considering that A and C are StarZones, a
 170  * communication from A-CPU-3 to C-CPU-7 goes through:
 171  * 1) StarZone A: A-CPU-3 -> link-up-A-CPU-3 -> A-CPU-0
 172  * 2) A-CPU-0->limiter(A)->link(A-B)->limiter(B)->link(B-C)->limiter(C)->C-CPU-0
 173  * 3) StarZone C: C-CPU-0-> link-down-C-CPU-7 -> C-CPU-7
 174  *
 175  * Note that we don't have limiter links inside the StarZones(A, B, C),
 176  * but we have limiters in the Torus that are added to the links in the path (as we can see in "2)")
 177  *
 178  * More details in: <a href="https://simgrid.org/doc/latest/Platform_examples.html?highlight=torus#torus-cluster">Torus
 179  * Cluster</a>
 180  */
 181 static void create_torus_cluster()
 182 {
 183   /* create the torus cluster, 10Gbs link between elements in the cluster */
 184   sg4::create_torus_zone("cluster", nullptr, {2, 2, 2}, {create_hostzone, {}, create_limiter}, 10e9, 10e-6,
 185                          sg4::Link::SharingPolicy::SPLITDUPLEX)
 186       ->seal();
 187 }
 188
 189 /*************************************************************************************************/
 190 /**
 191  * @brief Creates a Fat-Tree cluster
 192  *
 193  * Creates a Fat-Tree cluster with 2 levels and 6 nodes
 194  * The following parameters are used to create this cluster:
 195  * - Levels: 2 - two-level of switches in the cluster
 196  * - Down links: 2, 3 - L2 routers is connected to 2 elements, L1 routers to 3 elements
 197  * - Up links: 1, 2 - Each node (A-F) is connected to 1 L1 router, L1 routers are connected to 2 L2
 198  * - Link count: 1, 1 - Use 1 link in each level
 199  *
 200  * The first parameter describes how many levels we have.
 201  * The following ones describe the connection between the elements and must have exactly n_levels components.
 202  *
 203  *
 204  *                         S3     S4                <-- Level 2 routers
 205  *    link:limiter -      /   \  /  \
 206  *                       +     ++    +
 207  *    link: 10GBps -->  |     /  \    |
 208  *     (full-duplex)    |    /    \   |
 209  *                      +   +      +  +
 210  *                      |  /        \ |
 211  *                      S1           S2             <-- Level 1 routers
 212  *   link:limiter ->    |             |
 213  *                      +             +
 214  *  link:10GBps  -->   /|\           /|\
 215  *                    / | \         / | \
 216  *                   +  +  +       +  +  +
 217  *  link:limiter -> /   |   \     /   |   \
 218  *                 A    B    C   D    E    F        <-- level 0 Nodes
 219  *
 220  * Each element (A to F) is a StarZone containing 8 Hosts.
 221  * The connection uses 2 links:
 222  * 1) limiter: a 1Gbs limiter link (set by user through the set_limiter callback)
 223  * 2) link: 10Gbs link connecting the components (created automatically)
 224  *
 225  * For example, a communication from A to C goes through:
 226  * <tt> A->limiter(A)->link(A-S1)->limiter(S1)->link(S1-C)->->limiter(C)->C</tt>
 227  *
 228  * More precisely, considering that A and C are StarZones, a
 229  * communication from A-CPU-3 to C-CPU-7 goes through:
 230  * 1) StarZone A: A-CPU-3 -> link-up-A-CPU-3 -> A-CPU-0
 231  * 2) A-CPU-0->limiter(A)->link(A-S1)->limiter(S1)->link(S1-C)->limiter(C)->C-CPU-0
 232  * 3) StarZone C: C-CPU-0-> link-down-C-CPU-7 -> C-CPU-7
 233  *
 234  * More details in: <a href="https://simgrid.org/doc/latest/Platform_examples.html#fat-tree-cluster">Fat-Tree
 235  * Cluster</a>
 236  */
 237 static void create_fatTree_cluster()
 238 {
 239   /* create the fat tree cluster, 10Gbs link between elements in the cluster */
 240   sg4::create_fatTree_zone("cluster", nullptr, {2, {2, 3}, {1, 2}, {1, 1}}, {create_hostzone, {}, create_limiter}, 10e9,
 241                            10e-6, sg4::Link::SharingPolicy::SPLITDUPLEX)
 242       ->seal();
 243 }
 244
 245 /*************************************************************************************************/
 246 /**
 247  * @brief Creates a Dragonfly cluster
 248  *
 249  * Creates a Dragonfly cluster with 2 groups and 16 nodes
 250  * The following parameters are used to create this cluster:
 251  * - Groups: 2 groups, connected with 2 links (blue links)
 252  * - Chassis: 2 chassis, connected with a single link (black links)
 253  * - Routers: 2 routers, connected with 2 links (green links)
 254  * - Nodes: 2 leaves per router, single link
 255  *
 256  * The diagram below illustrates a group in the dragonfly cluster
 257  *
 258  * +------------------------------------------------+
 259  * |        black link(1)                           |
 260  * |     +------------------------+                 |
 261  * | +---|--------------+     +---|--------------+  |
 262  * | |   |  green       |     |   |  green       |  |
 263  * | |   |  links (2)   |     |   |  links (2)   |  |   blue links(2)
 264  * | |   R1 ====== R2   |     |   R3 -----  R4 ======================> "Group 2"
 265  * | |  /  \      /  \  |     |  /  \      /  \  |  |
 266  * | | A    B    C    D |     | E    F    G    H |  |
 267  * | +------------------+     +------------------+  |
 268  * |      Chassis 1                Chassis 2        |
 269  * +------------------------------------------------+
 270  *  Group 1
 271  *
 272  * Each element (A, B, C, etc) is a StarZone containing 8 Hosts.
 273  * The connection between elements (e.g. A->R1) uses 2 links:
 274  * 1) limiter: a 1Gbs limiter link (set by user through the set_limiter callback)
 275  * 2) link: 10Gbs link connecting the components (created automatically)
 276  *
 277  * For example, a communication from A to C goes through:
 278  * <tt> A->limiter(A)->link(A-R1)->limiter(R1)->link(R1-R2)->limiter(R2)->link(R2-C)limiter(C)->C</tt>
 279  *
 280  * More details in: <a href="https://simgrid.org/doc/latest/Platform_examples.html#dragonfly-cluster">Dragonfly
 281  * Cluster</a>
 282  */
 283 static void create_dragonfly_cluster()
 284 {
 285   /* create the dragonfly cluster, 10Gbs link between elements in the cluster */
 286   sg4::create_dragonfly_zone("cluster", nullptr, {{2, 2}, {2, 1}, {2, 2}, 2}, {create_hostzone, {}, create_limiter},
 287                              10e9, 10e-6, sg4::Link::SharingPolicy::SPLITDUPLEX)
 288       ->seal();
 289 }
 290
 291 /*************************************************************************************************/
 292
 293 int main(int argc, char* argv[])
 294 {
 295   sg4::Engine e(&argc, argv);
 296   std::string platform = argv[1];
 297
 298   /* create platform */
 299   if (platform == "torus")
 300     create_torus_cluster();
 301   else if (platform == "fatTree")
 302     create_fatTree_cluster();
 303   else if (platform == "dragonfly")
 304     create_dragonfly_cluster();
 305
 306   std::vector<sg4::Host*> host_list = e.get_all_hosts();
 307   /* create the sender actor running on first host */
 308   sg4::Actor::create("sender", host_list[0], Sender(host_list));
 309   /* create receiver in every host */
 310   for (auto* host : host_list) {
 311     sg4::Actor::create(std::string("receiver-") + std::string(host->get_name()), host, Receiver());
 312   }
 313
 314   /* runs the simulation */
 315   e.run();
 316
 317   return 0;
 318 }