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

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