examples/s4u/async-wait/s4u-async-wait.cpp

   1 /* Copyright (c) 2010-2020. 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() to wait for a given communication.
   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.
  12  */
  13
  14 #include "simgrid/s4u.hpp"
  15 #include <cstdlib>
  16 #include <iostream>
  17 #include <string>
  18
  19 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_async_wait, "Messages specific for this s4u example");
  20
  21 static int sender(int argc, char** argv)
  22 {
  23   xbt_assert(argc == 4, "Expecting 3 parameters from the XML deployment file but got %d", argc);
  24   long messages_count  = std::stol(argv[1]); /* - number of tasks */
  25   double msg_size      = std::stol(argv[2]); /* - communication cost in bytes */
  26   long receivers_count = std::stod(argv[3]); /* - number of receivers */
  27
  28   /* Vector in which we store all ongoing communications */
  29   std::vector<simgrid::s4u::CommPtr> pending_comms;
  30
  31   /* Make a vector of the mailboxes to use */
  32   std::vector<simgrid::s4u::Mailbox*> mboxes;
  33   for (int i = 0; i < receivers_count; i++)
  34     mboxes.push_back(simgrid::s4u::Mailbox::by_name(std::string("receiver-") + std::to_string(i)));
  35
  36   /* Start dispatching all messages to receivers, in a round robin fashion */
  37   for (int i = 0; i < messages_count; i++) {
  38     std::string msg_content = std::string("Message ") + std::to_string(i);
  39     // Copy the data we send: 'msg_content' is not a stable storage location.
  40     // It will be destroyed when this actor leaves the loop, ie before the receiver gets it
  41     std::string* payload = new std::string(msg_content);
  42
  43     XBT_INFO("Send '%s' to '%s'", msg_content.c_str(), mboxes[i % receivers_count]->get_cname());
  44
  45     /* Create a communication representing the ongoing communication, and store it in pending_comms */
  46     simgrid::s4u::CommPtr comm = mboxes[i % receivers_count]->put_async(payload, msg_size);
  47     pending_comms.push_back(comm);
  48   }
  49
  50   /* Start sending messages to let the workers know that they should stop */
  51   for (int i = 0; i < receivers_count; i++) {
  52     XBT_INFO("Send 'finalize' to 'receiver-%d'", i);
  53     simgrid::s4u::CommPtr comm = mboxes[i]->put_async(new std::string("finalize"), 0);
  54     pending_comms.push_back(comm);
  55   }
  56   XBT_INFO("Done dispatching all messages");
  57
  58   /* Now that all message exchanges were initiated, wait for their completion, in order of creation. */
  59   while (not pending_comms.empty()) {
  60     simgrid::s4u::CommPtr comm = pending_comms.back();
  61     comm->wait();
  62     pending_comms.pop_back(); // remove it from the list
  63   }
  64
  65   XBT_INFO("Goodbye now!");
  66   return 0;
  67 }
  68
  69 /* Receiver actor expects 1 argument: its ID */
  70 static int receiver(int argc, char** argv)
  71 {
  72   xbt_assert(argc == 2, "Expecting one parameter from the XML deployment file but got %d", argc);
  73   simgrid::s4u::Mailbox* mbox = simgrid::s4u::Mailbox::by_name(std::string("receiver-") + argv[1]);
  74
  75   XBT_INFO("Wait for my first message");
  76   for (bool cont = true; cont;) {
  77     const std::string* received = static_cast<std::string*>(mbox->get());
  78     XBT_INFO("I got a '%s'.", received->c_str());
  79     if (*received == "finalize")
  80       cont = false; // If it's a finalize message, we're done.
  81     delete received;
  82   }
  83   return 0;
  84 }
  85
  86 int main(int argc, char *argv[])
  87 {
  88   xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]);
  89
  90   simgrid::s4u::Engine e(&argc, argv);
  91   e.register_function("sender", &sender);
  92   e.register_function("receiver", &receiver);
  93
  94   e.load_platform(argv[1]);
  95   e.load_deployment(argv[2]);
  96   e.run();
  97
  98   return 0;
  99 }