examples/s4u/async-waitany/s4u-async-waitany.cpp

   1 /* Copyright (c) 2010-2019. 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
  25 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_async_waitall, "Messages specific for this msg example");
  26
  27 class Sender {
  28   long messages_count;  /* - number of tasks */
  29   long receivers_count; /* - number of receivers */
  30   double msg_size;      /* - communication cost in bytes */
  31
  32 public:
  33   explicit Sender(std::vector<std::string> args)
  34   {
  35     xbt_assert(args.size() == 4, "Expecting 3 parameters from the XML deployment file but got %zu", args.size());
  36     messages_count  = std::stol(args[1]);
  37     msg_size        = std::stod(args[2]);
  38     receivers_count = std::stol(args[3]);
  39   }
  40   void operator()()
  41   {
  42     /* Vector in which we store all ongoing communications */
  43     std::vector<simgrid::s4u::CommPtr> pending_comms;
  44
  45     /* Make a vector of the mailboxes to use */
  46     std::vector<simgrid::s4u::Mailbox*> mboxes;
  47     for (int i = 0; i < receivers_count; i++)
  48       mboxes.push_back(simgrid::s4u::Mailbox::by_name(std::string("receiver-") + std::to_string(i)));
  49
  50     /* Start dispatching all messages to receivers, in a round robin fashion */
  51     for (int i = 0; i < messages_count; i++) {
  52       std::string msg_content = std::string("Message ") + std::to_string(i);
  53       // Copy the data we send: 'msg_content' is not a stable storage location.
  54       // It will be destroyed when this actor leaves the loop, ie before the receiver gets it
  55       std::string* payload = new std::string(msg_content);
  56
  57       XBT_INFO("Send '%s' to '%s'", msg_content.c_str(), mboxes[i % receivers_count]->get_cname());
  58
  59       /* Create a communication representing the ongoing communication, and store it in pending_comms */
  60       simgrid::s4u::CommPtr comm = mboxes[i % receivers_count]->put_async(payload, msg_size);
  61       pending_comms.push_back(comm);
  62     }
  63
  64     /* Start sending messages to let the workers know that they should stop */
  65     for (int i = 0; i < receivers_count; i++) {
  66       XBT_INFO("Send 'finalize' to 'receiver-%d'", i);
  67       simgrid::s4u::CommPtr comm = mboxes[i]->put_async(new std::string("finalize"), 0);
  68       pending_comms.push_back(comm);
  69     }
  70     XBT_INFO("Done dispatching all messages");
  71
  72     /* Now that all message exchanges were initiated, wait for their completion, in order of termination.
  73      *
  74      * This loop waits for first terminating message with wait_any() and remove it with erase(), until all comms are
  75      * terminated
  76      * Even in this simple example, the pending comms do not terminate in the exact same order of creation.
  77      */
  78     while (not pending_comms.empty()) {
  79       int changed_pos = simgrid::s4u::Comm::wait_any(&pending_comms);
  80       pending_comms.erase(pending_comms.begin() + changed_pos);
  81       if (changed_pos != 0)
  82         XBT_INFO("Remove the %dth pending comm: it terminated earlier than another comm that was initiated first.",
  83                  changed_pos);
  84     }
  85
  86     XBT_INFO("Goodbye now!");
  87   }
  88 };
  89
  90 /* Receiver actor expects 1 argument: its ID */
  91 class Receiver {
  92   simgrid::s4u::Mailbox* mbox;
  93
  94 public:
  95   explicit Receiver(std::vector<std::string> args)
  96   {
  97     xbt_assert(args.size() == 2, "Expecting one parameter from the XML deployment file but got %zu", args.size());
  98     std::string mboxName = std::string("receiver-") + args[1];
  99     mbox                 = simgrid::s4u::Mailbox::by_name(mboxName);
 100   }
 101   void operator()()
 102   {
 103     XBT_INFO("Wait for my first message");
 104     for (bool cont = true; cont;) {
 105       std::string* received = static_cast<std::string*>(mbox->get());
 106       XBT_INFO("I got a '%s'.", received->c_str());
 107       cont = (*received != "finalize"); // If it's a finalize message, we're done
 108       // Receiving the message was all we were supposed to do
 109       delete received;
 110     }
 111   }
 112 };
 113
 114 int main(int argc, char *argv[])
 115 {
 116   xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]);
 117
 118   simgrid::s4u::Engine e(&argc, argv);
 119   e.register_actor<Sender>("sender");
 120   e.register_actor<Receiver>("receiver");
 121
 122   e.load_platform(argv[1]);
 123   e.load_deployment(argv[2]);
 124   e.run();
 125
 126   return 0;
 127 }