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

   1 /* Copyright (c) 2010-2017. 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 occurs 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 "xbt/str.h"
  22 #include <cstdlib>
  23 #include <iostream>
  24
  25 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_async_waitall, "Messages specific for this msg example");
  26
  27 class sender {
  28   long messages_count;
  29   long receivers_count;
  30   double msg_size; /* in bytes */
  31
  32 public:
  33   explicit sender(std::vector<std::string> args)
  34 {
  35   xbt_assert(args.size() == 4, "This function expects 4 parameters from the XML deployment file but got %zu",
  36              args.size());
  37   messages_count  = std::stol(args[1]);
  38   msg_size        = std::stod(args[2]);
  39   receivers_count = std::stol(args[3]);
  40
  41 }
  42 void operator()()
  43 {
  44   std::vector<simgrid::s4u::CommPtr>* pending_comms = new std::vector<simgrid::s4u::CommPtr>();
  45
  46   /* Start dispatching all messages to receivers, in a round robin fashion */
  47   for (int i = 0; i < messages_count; i++) {
  48
  49     std::string mboxName          = std::string("receiver-") + std::to_string(i % receivers_count);
  50     simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(mboxName);
  51     std::string msgName           = std::string("Message ") + std::to_string(i);
  52     char* payload = xbt_strdup(msgName.c_str()); // copy the data we send: 'msgName' is not a stable storage location
  53
  54     XBT_INFO("Send '%s' to '%s'", msgName.c_str(), mboxName.c_str());
  55     /* Create a communication representing the ongoing communication */
  56     simgrid::s4u::CommPtr comm = mbox->put_async((void*)payload, msg_size);
  57     /* Add this comm to the vector of all known comms */
  58     pending_comms->push_back(comm);
  59   }
  60   /* Start sending messages to let the workers know that they should stop */
  61   for (int i = 0; i < receivers_count; i++) {
  62     std::string mbox_name         = std::string("receiver-") + std::to_string(i % receivers_count);
  63     simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(mbox_name);
  64     char* payload                 = xbt_strdup("finalize"); // Make a copy of the data we will send
  65
  66     simgrid::s4u::CommPtr comm = mbox->put_async((void*)payload, 0);
  67     pending_comms->push_back(comm);
  68     XBT_INFO("Send 'finalize' to 'receiver-%ld'", i % receivers_count);
  69   }
  70   XBT_INFO("Done dispatching all messages");
  71
  72   /* Now that all message exchanges were initiated, wait for their completion
  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   for (int i = 0; i < messages_count + receivers_count; i++) {
  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   delete pending_comms;
  88 }
  89 };
  90
  91 class receiver {
  92   simgrid::s4u::MailboxPtr mbox;
  93
  94 public:
  95   explicit receiver(std::vector<std::string> args)
  96 {
  97   xbt_assert(args.size() == 2, "This function expects 2 parameters from the XML deployment file but got %zu",
  98              args.size());
  99   int id = xbt_str_parse_int(args[1].c_str(), "Any process of this example must have a numerical name, not %s");
 100   std::string mbox_name = std::string("receiver-") + std::to_string(id);
 101   mbox                  = simgrid::s4u::Mailbox::byName(mbox_name);
 102 }
 103 void operator()()
 104 {
 105   XBT_INFO("Wait for my first message");
 106   while (1) {
 107     char* received = static_cast<char*>(mbox->get());
 108     XBT_INFO("I got a '%s'.", received);
 109     if (std::strcmp(received, "finalize") == 0) { /* If it's a finalize message, we're done */
 110       xbt_free(received);
 111       break;
 112     }
 113     /* Otherwise receiving the message was all we were supposed to do */
 114     xbt_free(received);
 115   }
 116 }
 117 };
 118
 119 int main(int argc, char *argv[])
 120 {
 121   simgrid::s4u::Engine* e = new simgrid::s4u::Engine(&argc, argv);
 122
 123   xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]);
 124
 125   e->registerFunction<sender>("sender");
 126   e->registerFunction<receiver>("receiver");
 127
 128   e->loadPlatform(argv[1]);
 129   e->loadDeployment(argv[2]);
 130   e->run();
 131
 132   return 0;
 133 }