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