From: Martin Quinson Date: Mon, 2 Oct 2017 22:27:13 +0000 (+0200) Subject: further reduce the differences between the s4u-async examples X-Git-Tag: v3_17~43 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/7c369294a45d31c519186fcb6cb10670ec1c1ac8 further reduce the differences between the s4u-async examples --- diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc index c581f801a2..97be9a1597 100644 --- a/examples/s4u/README.doc +++ b/examples/s4u/README.doc @@ -45,7 +45,8 @@ documentation, but it should remain readable directly. Illustrates how to have non-blocking communications, that are communications running in the background leaving the process free to do something else during their completion. The main functions - involved are @ref put_async and @ref get. + involved are @ref simgrid::s4u::Comm::put_async and + @ref simgrid::s4u::Comm::wait(). - Waiting for all communications in a set. @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n diff --git a/examples/s4u/async-wait/s4u-async-wait.cpp b/examples/s4u/async-wait/s4u-async-wait.cpp index f1bb5aa2d3..b4c36a6be4 100644 --- a/examples/s4u/async-wait/s4u-async-wait.cpp +++ b/examples/s4u/async-wait/s4u-async-wait.cpp @@ -3,8 +3,12 @@ /* 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 start many asynchronous communications, - * and block on them later. +/* 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" @@ -14,97 +18,96 @@ 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 msg_size; /* - communication cost in bytes */ - 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 args) -{ - xbt_assert(args.size() == 4, "The sender function expects 3 arguments from the XML deployment file"); - messages_count = std::stol(args[1]); - msg_size = std::stod(args[2]); - receivers_count = std::stol(args[3]); -} -void operator()() -{ - std::vector* pending_comms = new std::vector(); - - /* Start dispatching all messages to receivers, in a round robin fashion */ - for (int i = 0; i < messages_count; i++) { - - std::string mbox_name = std::string("receiver-") + std::to_string(i % receivers_count); - mbox = simgrid::s4u::Mailbox::byName(mbox_name); - - /* Create a communication representing the ongoing communication */ - 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 - - simgrid::s4u::CommPtr comm = mbox->put_async((void*)payload, msg_size); - XBT_INFO("Send to receiver-%ld Task_%d", i % receivers_count, i); - pending_comms->push_back(comm); + explicit Sender(std::vector 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 pending_comms; - /* Now that all comms are in flight, wait for all of them (one after the other) */ - for (int i = 0; i < messages_count; i++) { - 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 + /* 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 (in a synchronous way) */ - for (int i = 0; i < receivers_count; i++) { - char mailbox[80]; - char* payload = xbt_strdup("finalize"); - snprintf(mailbox, 79, "receiver-%d", i); - mbox->put((void*)payload, 0); // instantaneous message (payload size is 0) sent in a synchronous way (with put) - XBT_INFO("Send to receiver-%d finalize", i); - } + /* 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 - XBT_INFO("Goodbye now!"); + 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 1 arguments: its ID */ -class receiver { +/* Receiver actor expects 1 argument: its ID */ +class Receiver { simgrid::s4u::MailboxPtr mbox; - + public: - explicit receiver(std::vector args) + explicit Receiver(std::vector args) { - xbt_assert(args.size() == 2, "The receiver function takes a unique parameter from the XML deployment file"); - std::string mbox_name = std::string("receiver-") + args[1]; - 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()() -{ - while (1) { - XBT_INFO("Wait to receive a task"); - char* received = static_cast(mbox->get()); - 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(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(&argc, argv); - xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]); - e.registerFunction("sender"); - e.registerFunction("receiver"); + simgrid::s4u::Engine e(&argc, argv); + e.registerFunction("sender"); + e.registerFunction("receiver"); e.loadPlatform(argv[1]); e.loadDeployment(argv[2]); diff --git a/examples/s4u/async-waitall/s4u-async-waitall.cpp b/examples/s4u/async-waitall/s4u-async-waitall.cpp index de61d34a3e..405e049b77 100644 --- a/examples/s4u/async-waitall/s4u-async-waitall.cpp +++ b/examples/s4u/async-waitall/s4u-async-waitall.cpp @@ -19,84 +19,82 @@ XBT_LOG_NEW_DEFAULT_CATEGORY(msg_async_waitall, "Messages specific for this s4u example"); -class sender { - long messages_count; - long receivers_count; - double msg_size; /* in bytes */ +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 args) -{ - xbt_assert(args.size() == 4, "This function expects 4 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* pending_comms = new std::vector(); - - /* Start dispatching all messages to receivers, in a round robin fashion */ - for (int i = 0; i < messages_count; i++) { + explicit Sender(std::vector 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 pending_comms; + + /* 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); + } - 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 + /* 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 - 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 mbox_name = std::string("receiver-") + std::to_string(i % receivers_count); - simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(mbox_name); - 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"); + 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 one single call */ - simgrid::s4u::Comm::wait_all(pending_comms); + /* Now that all message exchanges were initiated, wait for their completion in one single call */ + simgrid::s4u::Comm::wait_all(&pending_comms); - XBT_INFO("Goodbye now!"); - delete pending_comms; -} + XBT_INFO("Goodbye now!"); + } }; -class receiver { +/* Receiver actor expects 1 argument: its ID */ +class Receiver { simgrid::s4u::MailboxPtr mbox; public: - explicit receiver(std::vector args) -{ - xbt_assert(args.size() == 2, "This function expects 2 parameters from the XML deployment file but got %zu", - args.size()); - int id = xbt_str_parse_int(args[1].c_str(), "Any process of this example must have a numerical name, not %s"); - std::string mbox_name = std::string("receiver-") + std::to_string(id); - mbox = simgrid::s4u::Mailbox::byName(mbox_name); -} -void operator()() -{ - XBT_INFO("Wait for my first message"); - while (1) { - char* received = static_cast(mbox->get()); - XBT_INFO("I got a '%s'.", received); - if (std::strcmp(received, "finalize") == 0) { /* If it's a finalize message, we're done */ + explicit Receiver(std::vector args) + { + 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()() + { + XBT_INFO("Wait for my first message"); + while (1) { + char* received = static_cast(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; } - /* Otherwise receiving the message was all we were supposed to do */ - xbt_free(received); } -} }; int main(int argc, char *argv[]) @@ -104,8 +102,8 @@ int main(int argc, char *argv[]) xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]); simgrid::s4u::Engine e(&argc, argv); - e.registerFunction("sender"); - e.registerFunction("receiver"); + e.registerFunction("sender"); + e.registerFunction("receiver"); e.loadPlatform(argv[1]); e.loadDeployment(argv[2]); diff --git a/examples/s4u/async-waitany/s4u-async-waitany.cpp b/examples/s4u/async-waitany/s4u-async-waitany.cpp index 9081044659..706fd082fb 100644 --- a/examples/s4u/async-waitany/s4u-async-waitany.cpp +++ b/examples/s4u/async-waitany/s4u-async-waitany.cpp @@ -24,96 +24,93 @@ XBT_LOG_NEW_DEFAULT_CATEGORY(msg_async_waitall, "Messages specific for this msg example"); -class sender { - long messages_count; - long receivers_count; - double msg_size; /* in bytes */ +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 args) -{ - xbt_assert(args.size() == 4, "This function expects 4 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* pending_comms = new std::vector(); + explicit Sender(std::vector 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 pending_comms; + + /* 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 dispatching all messages to receivers, in a round robin fashion */ - for (int i = 0; i < messages_count; i++) { + /* 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 - 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 + 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 termination. + * + * This loop waits for first terminating message with wait_any() and remove it with erase(), until all comms are + * terminated + * Even in this simple example, the pending comms do not terminate in the exact same order of creation. + */ + while (not pending_comms.empty()) { + int changed_pos = simgrid::s4u::Comm::wait_any(&pending_comms); + pending_comms.erase(pending_comms.begin() + changed_pos); + if (changed_pos != 0) + XBT_INFO("Remove the %dth pending comm: it terminated earlier than another comm that was initiated first.", + changed_pos); + } - 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 mbox_name = std::string("receiver-") + std::to_string(i % receivers_count); - simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(mbox_name); - 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("Goodbye now!"); } - XBT_INFO("Done dispatching all messages"); - - /* Now that all message exchanges were initiated, wait for their completion - * - * This loop waits for first terminating message with wait_any() and remove it with erase(), until all comms are - * terminated - * Even in this simple example, the pending comms do not terminate in the exact same order of creation. - * */ - for (int i = 0; i < messages_count + receivers_count; i++) { - int changed_pos = simgrid::s4u::Comm::wait_any(pending_comms); - pending_comms->erase(pending_comms->begin() + changed_pos); - if (changed_pos != 0) - XBT_INFO("Remove the %dth pending comm: it terminated earlier than another comm that was initiated first.", - changed_pos); - } - - XBT_INFO("Goodbye now!"); - delete pending_comms; -} }; -class receiver { +/* Receiver actor expects 1 argument: its ID */ +class Receiver { simgrid::s4u::MailboxPtr mbox; public: - explicit receiver(std::vector args) -{ - xbt_assert(args.size() == 2, "This function expects 2 parameters from the XML deployment file but got %zu", - args.size()); - int id = xbt_str_parse_int(args[1].c_str(), "Any process of this example must have a numerical name, not %s"); - std::string mbox_name = std::string("receiver-") + std::to_string(id); - mbox = simgrid::s4u::Mailbox::byName(mbox_name); -} -void operator()() -{ - XBT_INFO("Wait for my first message"); - while (1) { - char* received = static_cast(mbox->get()); - XBT_INFO("I got a '%s'.", received); - if (std::strcmp(received, "finalize") == 0) { /* If it's a finalize message, we're done */ + explicit Receiver(std::vector args) + { + 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()() + { + XBT_INFO("Wait for my first message"); + while (1) { + char* received = static_cast(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; } - /* Otherwise receiving the message was all we were supposed to do */ - xbt_free(received); } -} }; int main(int argc, char *argv[]) @@ -121,8 +118,8 @@ int main(int argc, char *argv[]) xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]); simgrid::s4u::Engine e(&argc, argv); - e.registerFunction("sender"); - e.registerFunction("receiver"); + e.registerFunction("sender"); + e.registerFunction("receiver"); e.loadPlatform(argv[1]); e.loadDeployment(argv[2]);