examples/cpp/comm-waitany/s4u-comm-waitany.cpp

   1 /* Copyright (c) 2010-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 /* This example shows how to use simgrid::s4u::this_actor::wait_any() to wait for the first occurring event.
   7  *
   8  * As for the other asynchronous examples, the sender initiate all the messages it wants to send and
   9  * pack the resulting simgrid::s4u::CommPtr objects in a vector. All messages thus occur concurrently.
  10  *
  11  * The sender then loops until there is no ongoing communication. Using wait_any() ensures that the sender
  12  * will notice events as soon as they occur even if it does not follow the order of the container.
  13  *
  14  * Here, finalize messages will terminate earlier because their size is 0, so they travel faster than the
  15  * other messages of this application.  As expected, the trace shows that the finalize of worker 1 is
  16  * processed before 'Message 5' that is sent to worker 0.
  17  *
  18  */
  19
  20 #include "simgrid/s4u.hpp"
  21 #include <cstdlib>
  22 #include <iostream>
  23 #include <string>
  24 namespace sg4 = simgrid::s4u;
  25
  26 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_comm_waitall, "Messages specific for this s4u example");
  27
  28 static void sender(unsigned int messages_count, unsigned int receivers_count, long msg_size)
  29 {
  30   if (messages_count == 0 || receivers_count == 0) {
  31     XBT_WARN("Sender has nothing to do. Bail out!");
  32     return;
  33   }
  34   /* Vector in which we store all ongoing communications */
  35   std::vector<sg4::CommPtr> pending_comms;
  36
  37   /* Make a vector of the mailboxes to use */
  38   std::vector<sg4::Mailbox*> mboxes;
  39   for (unsigned int i = 0; i < receivers_count; i++)
  40     mboxes.push_back(sg4::Mailbox::by_name("receiver-" + std::to_string(i)));
  41
  42   /* Start dispatching all messages to receivers, in a round robin fashion */
  43   for (unsigned int i = 0; i < messages_count; i++) {
  44     std::string msg_content = "Message " + std::to_string(i);
  45     // Copy the data we send: the 'msg_content' variable is not a stable storage location.
  46     // It will be destroyed when this actor leaves the loop, ie before the receiver gets it
  47     auto* payload = new std::string(msg_content);
  48
  49     XBT_INFO("Send '%s' to '%s'", msg_content.c_str(), mboxes[i % receivers_count]->get_cname());
  50
  51     /* Create a communication representing the ongoing communication, and store it in pending_comms */
  52     sg4::CommPtr comm = mboxes[i % receivers_count]->put_async(payload, msg_size);
  53     pending_comms.push_back(comm);
  54   }
  55
  56   /* Start sending messages to let the workers know that they should stop */
  57   for (unsigned int i = 0; i < receivers_count; i++) {
  58     XBT_INFO("Send 'finalize' to 'receiver-%u'", i);
  59     sg4::CommPtr comm = mboxes[i]->put_async(new std::string("finalize"), 0);
  60     pending_comms.push_back(comm);
  61   }
  62   XBT_INFO("Done dispatching all messages");
  63
  64   /* Now that all message exchanges were initiated, wait for their completion, in order of termination.
  65    *
  66    * This loop waits for first terminating message with wait_any() and remove it with erase(), until all comms are
  67    * terminated
  68    * Even in this simple example, the pending comms do not terminate in the exact same order of creation.
  69    */
  70   while (not pending_comms.empty()) {
  71     ssize_t changed_pos = sg4::Comm::wait_any(pending_comms);
  72     pending_comms.erase(pending_comms.begin() + changed_pos);
  73     if (changed_pos != 0)
  74       XBT_INFO("Remove the %zdth pending comm: it terminated earlier than another comm that was initiated first.",
  75                changed_pos);
  76   }
  77
  78   XBT_INFO("Goodbye now!");
  79 }
  80
  81 /* Receiver actor expects 1 argument: its ID */
  82 static void receiver(int id)
  83 {
  84   sg4::Mailbox* mbox = sg4::Mailbox::by_name("receiver-" + std::to_string(id));
  85   XBT_INFO("Wait for my first message");
  86   for (bool cont = true; cont;) {
  87     auto received = mbox->get_unique<std::string>();
  88     XBT_INFO("I got a '%s'.", received->c_str());
  89     cont = (*received != "finalize"); // If it's a finalize message, we're done
  90     // Receiving the message was all we were supposed to do
  91   }
  92 }
  93
  94 int main(int argc, char* argv[])
  95 {
  96   sg4::Engine e(&argc, argv);
  97
  98   e.load_platform(argv[1]);
  99
 100   sg4::Actor::create("sender", e.host_by_name("Tremblay"), sender, 6, 2, 1e6);
 101   sg4::Actor::create("receiver", e.host_by_name("Fafard"), receiver, 0);
 102   sg4::Actor::create("receiver", e.host_by_name("Jupiter"), receiver, 1);
 103
 104   e.run();
 105
 106   return 0;
 107 }