examples/cpp/comm-wait/s4u-comm-wait.cpp

   1 /* Copyright (c) 2010-2022. 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 namespace sg4 = simgrid::s4u;
  19
  20 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_comm_wait, "Messages specific for this s4u example");
  21
  22 static void sender(int messages_count, size_t payload_size)
  23 {
  24   double sleep_start_time = 5.0;
  25   double sleep_test_time  = 0;
  26
  27   sg4::Mailbox* mbox = sg4::Mailbox::by_name("receiver");
  28
  29   XBT_INFO("sleep_start_time : %f , sleep_test_time : %f", sleep_start_time, sleep_test_time);
  30   sg4::this_actor::sleep_for(sleep_start_time);
  31
  32   for (int i = 0; i < messages_count; i++) {
  33     std::string msg_content = std::string("Message ") + std::to_string(i);
  34     // Copy the data we send: the 'msg_content' variable is not a stable storage location.
  35     // It will be destroyed when this actor leaves the loop, ie before the receiver gets the data
  36     auto* payload = new std::string(msg_content);
  37
  38     /* Create a communication representing the ongoing communication and then */
  39     sg4::CommPtr comm = mbox->put_async(payload, payload_size);
  40     XBT_INFO("Send '%s' to '%s'", msg_content.c_str(), mbox->get_cname());
  41
  42     if (sleep_test_time > 0) {   /* - "test_time" is set to 0, wait */
  43       while (not comm->test()) { /* - Call test() every "sleep_test_time" otherwise */
  44         sg4::this_actor::sleep_for(sleep_test_time);
  45       }
  46     } else {
  47       comm->wait();
  48     }
  49   }
  50
  51   /* Send message to let the receiver know that it should stop */
  52   XBT_INFO("Send 'finalize' to 'receiver'");
  53   mbox->put(new std::string("finalize"), 0);
  54 }
  55
  56 /* Receiver actor expects 1 argument: its ID */
  57 static void receiver()
  58 {
  59   double sleep_start_time = 1.0;
  60   double sleep_test_time  = 0.1;
  61
  62   sg4::Mailbox* mbox = sg4::Mailbox::by_name("receiver");
  63
  64   XBT_INFO("sleep_start_time : %f , sleep_test_time : %f", sleep_start_time, sleep_test_time);
  65   sg4::this_actor::sleep_for(sleep_start_time);
  66
  67   XBT_INFO("Wait for my first message");
  68   for (bool cont = true; cont;) {
  69     std::string* received;
  70     sg4::CommPtr comm = mbox->get_async<std::string>(&received);
  71
  72     if (sleep_test_time > 0) {   /* - "test_time" is set to 0, wait */
  73       while (not comm->test()) { /* - Call test() every "sleep_test_time" otherwise */
  74         sg4::this_actor::sleep_for(sleep_test_time);
  75       }
  76     } else {
  77       comm->wait();
  78     }
  79
  80     XBT_INFO("I got a '%s'.", received->c_str());
  81     if (*received == "finalize")
  82       cont = false; // If it's a finalize message, we're done.
  83     delete received;
  84   }
  85 }
  86
  87 int main(int argc, char* argv[])
  88 {
  89   sg4::Engine e(&argc, argv);
  90
  91   e.load_platform(argv[1]);
  92
  93   sg4::Actor::create("sender", e.host_by_name("Tremblay"), sender, 3, 482117300);
  94   sg4::Actor::create("receiver", e.host_by_name("Ruby"), receiver);
  95
  96   e.run();
  97
  98   return 0;
  99 }