Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further reduce the differences between the s4u-async examples
[simgrid.git] / examples / s4u / async-wait / s4u-async-wait.cpp
index 73f3bff..b4c36a6 100644 (file)
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-/* This example shows how to block until the completion of a communication.
+/* This example shows how to use simgrid::s4u::this_actor::wait() to wait for a given communication.
+ *
+ * As for the other asynchronous examples, the sender initiate all the messages it wants to send and
+ * pack the resulting simgrid::s4u::CommPtr objects in a vector. All messages thus occurs concurrently.
+ *
+ * The sender then loops until there is no ongoing communication.
  */
 
- #include "simgrid/s4u.hpp"
- #include "xbt/str.h"
- #include <cstdlib>
- #include <iostream>
+#include "simgrid/s4u.hpp"
+#include "xbt/str.h"
+#include <cstdlib>
+#include <iostream>
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_async_wait, "Messages specific for this s4u example");
 
-/* Main function of the Sender process */
-class sender {
-  long messages_count;             /* - number of tasks */
-  long receivers_count;            /* - number of receivers */
-  double sleep_start_time;         /* - start time */
-  double sleep_test_time;          /* - test time */
-  double msg_size;                 /* - computational cost */
-  double task_comm_size;           /* - communication cost */
-  simgrid::s4u::MailboxPtr mbox;
-  
+class Sender {
+  long messages_count;  /* - number of tasks */
+  long receivers_count; /* - number of receivers */
+  double msg_size;      /* - communication cost in bytes */
+
 public:
-  explicit sender(std::vector<std::string> args)
-{
-  xbt_assert(args.size() == 7, "The sender function expects 6 arguments from the XML deployment file");
-  messages_count = std::stol(args[1]);
-  msg_size = std::stod(args[2]); 
-  task_comm_size = std::stod(args[3]); 
-  receivers_count = std::stol(args[4]);    
-  double sleep_start_time = std::stod(args[5]);
-  double sleep_test_time = std::stod(args[6]);
-  XBT_INFO("sleep_start_time : %f , sleep_test_time : %f", sleep_start_time, sleep_test_time);
-}
-void operator()()
-{
-  /* Start dispatching all messages to receivers, in a round robin fashion */
-  for (int i = 0; i < messages_count; i++) {
-    char mailbox[80];
-    char taskname[80];
-    
-    std::string mbox_name = std::string("receiver-") + std::to_string(i % receivers_count);
-    mbox = simgrid::s4u::Mailbox::byName(mbox_name);
-    snprintf(mailbox,79, "receiver-%ld", i % receivers_count);
-    snprintf(taskname,79, "Task_%d", i);
-    
-    /* Create a communication representing the ongoing communication */
-    simgrid::s4u::CommPtr comm = mbox->put_async((void*)mailbox, msg_size);
-    XBT_INFO("Send to receiver-%ld Task_%d", i % receivers_count, i);
-    comm->wait(task_comm_size);
-  }
-  /* Start sending messages to let the workers know that they should stop */
-  for (int i = 0; i < receivers_count; i++) {
-    char mailbox[80];
-    char* payload   = xbt_strdup("finalize"); 
-    snprintf(mailbox, 79, "receiver-%d", i);
-    simgrid::s4u::CommPtr comm = mbox->put_async((void*)payload, 0);
-    comm->wait(task_comm_size);
-    XBT_INFO("Send to receiver-%d finalize", i);
+  explicit Sender(std::vector<std::string> args)
+  {
+    xbt_assert(args.size() == 4, "Expecting 3 parameters from the XML deployment file but got %zu", args.size());
+    messages_count  = std::stol(args[1]);
+    msg_size        = std::stod(args[2]);
+    receivers_count = std::stol(args[3]);
   }
+  void operator()()
+  {
+    std::vector<simgrid::s4u::CommPtr> pending_comms;
 
-  XBT_INFO("Goodbye now!");
+    /* Start dispatching all messages to receivers, in a round robin fashion */
+    for (int i = 0; i < messages_count; i++) {
 
-}
+      std::string mboxName          = std::string("receiver-") + std::to_string(i % receivers_count);
+      simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(mboxName);
+      std::string msgName = std::string("Message ") + std::to_string(i);
+      char* payload = xbt_strdup(msgName.c_str()); // copy the data we send: 'msgName' is not a stable storage location
+
+      XBT_INFO("Send '%s' to '%s'", msgName.c_str(), mboxName.c_str());
+      /* Create a communication representing the ongoing communication */
+      simgrid::s4u::CommPtr comm = mbox->put_async((void*)payload, msg_size);
+      /* Add this comm to the vector of all known comms */
+      pending_comms.push_back(comm);
+    }
+
+    /* Start sending messages to let the workers know that they should stop */
+    for (int i = 0; i < receivers_count; i++) {
+      std::string mboxName          = std::string("receiver-") + std::to_string(i % receivers_count);
+      simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(mboxName);
+      char* payload                 = xbt_strdup("finalize"); // Make a copy of the data we will send
+
+      simgrid::s4u::CommPtr comm = mbox->put_async((void*)payload, 0);
+      pending_comms.push_back(comm);
+      XBT_INFO("Send 'finalize' to 'receiver-%ld'", i % receivers_count);
+    }
+    XBT_INFO("Done dispatching all messages");
+
+    /* Now that all message exchanges were initiated, wait for their completion, in order of creation. */
+    while (not pending_comms.empty()) {
+      simgrid::s4u::CommPtr comm = pending_comms.back();
+      comm->wait();             // we could provide a timeout as a parameter
+      pending_comms.pop_back(); // remove it from the list
+    }
+
+    XBT_INFO("Goodbye now!");
+  }
 };
 
-/* Receiver process expects 3 arguments: */
-class receiver {
-  int id;                   /* - unique id */
-  double sleep_start_time;  /* - start time */
-  double sleep_test_time;   /* - test time */
+/* Receiver actor expects 1 argument: its ID */
+class Receiver {
   simgrid::s4u::MailboxPtr mbox;
-  
+
 public:
-  explicit receiver(std::vector<std::string> args)
+  explicit Receiver(std::vector<std::string> args)
   {
-  xbt_assert(args.size() == 4, "The relay_runner function does not accept any parameter from the XML deployment file");
-  id = std::stoi(args[1]);
-  sleep_start_time = std::stod(args[2]); 
-  sleep_test_time = std::stod(args[3]);   
-  XBT_INFO("sleep_start_time : %f , sleep_test_time : %f", sleep_start_time, sleep_test_time);
-  std::string mbox_name = std::string("receiver-") + std::to_string(id);
-  mbox = simgrid::s4u::Mailbox::byName(mbox_name);
-}
+    xbt_assert(args.size() == 2, "Expecting one parameter from the XML deployment file but got %zu", args.size());
+    std::string mboxName = std::string("receiver-") + args[1];
+    mbox                 = simgrid::s4u::Mailbox::byName(mboxName);
+  }
 
-void operator()()
-{
-  char mailbox[80];
-  snprintf(mailbox,79, "receiver-%d", id);
-  while (1) {
-    char* received = static_cast<char*>(mbox->get());
-    XBT_INFO("Wait to receive a task");
-    XBT_INFO("I got a '%s'.", received);
-    if (std::strcmp(received, "finalize") == 0) { /* If it's a finalize message, we're done */
+  void operator()()
+  {
+    XBT_INFO("Wait for my first message");
+    while (1) {
+      char* received = static_cast<char*>(mbox->get());
+      XBT_INFO("I got a '%s'.", received);
+      if (std::strcmp(received, "finalize") == 0) { /* If it's a finalize message, we're done */
+        xbt_free(received);
+        break;
+      }
+      /* Otherwise receiving the message was all we were supposed to do */
       xbt_free(received);
-      break;
     }
   }
-}
 };
 
 int main(int argc, char *argv[])
 {
-  simgrid::s4u::Engine* e = new simgrid::s4u::Engine(&argc, argv);
-  
-    xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]);
-  
-    e->registerFunction<sender>("sender");
-    e->registerFunction<receiver>("receiver");
-  
-    e->loadPlatform(argv[1]);
-    e->loadDeployment(argv[2]);
-    e->run();
-  
-    return 0;
+  xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]);
+
+  simgrid::s4u::Engine e(&argc, argv);
+  e.registerFunction<Sender>("sender");
+  e.registerFunction<Receiver>("receiver");
+
+  e.loadPlatform(argv[1]);
+  e.loadDeployment(argv[2]);
+  e.run();
+
+  return 0;
 }