-/* Copyright (c) 2010-2016. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved. */
/* 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 use simgrid::s4u::this_actor::wait_any() to wait for the first occurring event.
+ *
+ * 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. Using wait_any() ensures that the sender
+ * will notice events as soon as they occur even if it does not follow the order of the container.
+ *
+ * Here, finalize messages will terminate earlier because their size is 0, so they travel faster than the
+ * other messages of this application. As expected, the trace shows that the finalize of worker 1 is
+ * processed before 'Message 5' that is sent to worker 0.
+ *
+ */
+
#include "simgrid/s4u.hpp"
+#include "xbt/str.h"
+#include <cstdlib>
+#include <iostream>
+
+XBT_LOG_NEW_DEFAULT_CATEGORY(msg_async_waitall, "Messages specific for this msg example");
-XBT_LOG_NEW_DEFAULT_CATEGORY(msg_async_waitany, "Messages specific for this msg example");
+class sender {
+ long messages_count;
+ long receivers_count;
+ double msg_size; /* in bytes */
-static int sender(std::vector<std::string> args)
+public:
+ explicit sender(std::vector<std::string> args)
{
- xbt_assert(args.size() == 5, "This function expects 5 parameters from the XML deployment file");
- long number_of_tasks = xbt_str_parse_int(argv[1], "Invalid amount of tasks: %s");
- double task_comp_size = xbt_str_parse_double(argv[2], "Invalid computational size: %s");
- double task_comm_size = xbt_str_parse_double(argv[3], "Invalid communication size: %s");
- long receivers_count = xbt_str_parse_int(argv[4], "Invalid amount of receivers: %s");
- int diff_com = xbt_str_parse_int(argv[5], "Invalid value for diff_comm: %s");
-
- std::vector<msg_comm_t> comms;
- /* First pack the communications in the dynar */
- for (int i = 0; i < number_of_tasks; i++) {
- double coef = (diff_com == 0) ? 1 : (i + 1);
-
- char mailbox[80];
- char taskname[80];
- snprintf(mailbox,79, "receiver-%ld", (i % receivers_count));
- snprintf(taskname,79, "Task_%d", i);
-
- double* task = new double();
- simgrid::s4u::Mailbox::byName(mailbox)->put(task, 1);
- comms.push_back(comm);
- XBT_INFO("Send to receiver-%ld %s comm_size %f", i % receivers_count, taskname, task_comm_size / coef);
- }
+ 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]);
- /* Here we are waiting for the completion of all communications */
- while (xbt_dynar_is_empty(comms) == 0) {
- msg_comm_t comm;
- comms.pop_back(&comm);
- MSG_comm_destroy(comm);
- }
- comms.clear();
+}
+void operator()()
+{
+ std::vector<simgrid::s4u::CommPtr>* pending_comms = new std::vector<simgrid::s4u::CommPtr>();
+
+ /* 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
- /* Here we are waiting for the completion of all tasks */
+ 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++) {
- msg_task_t task = NULL;
- msg_comm_t comm = MSG_task_irecv(&task, "finalize");
- msg_error_t res_wait = MSG_comm_wait(comm, -1);
- xbt_assert(res_wait == MSG_OK, "MSG_comm_wait failed");
- MSG_comm_destroy(comm);
- MSG_task_destroy(task);
+ 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");
+
+ /* 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!");
- return 0;
+ delete pending_comms;
}
+};
-static int receiver(int argc, char *argv[])
-{
- xbt_assert(argc==3, "This function expects 2 parameters from the XML deployment file");
- int id = xbt_str_parse_int(argv[1], "ID should be numerical, not %s");
- int task_amount = xbt_str_parse_int(argv[2], "Invalid amount of tasks: %s");
- msg_task_t *tasks = new msg_task_t[task_amount];
- std::vector<msg_comm_t> comms;
-
- char mailbox[80];
- snprintf(mailbox,79, "receiver-%d", id);
- simgrid::s4u::Actor::sleep_for(10.0);
- for (int i = 0; i < task_amount; i++) {
- XBT_INFO("Wait to receive task %d", i);
- tasks[i] = NULL;
- msg_comm_t comm = MSG_task_irecv(&tasks[i], mailbox);
- comms.push_back(comm);
- }
+class receiver {
+ simgrid::s4u::MailboxPtr mbox;
+ int message_count;
- /* Here we are waiting for the receiving of all communications */
- while (!xbt_dynar_is_empty(comms)) {
- msg_comm_t comm;
- // MSG_comm_waitany returns the rank of the comm that just ended. Remove it.
- comms.pop_back(&comm);
- msg_task_t task = MSG_comm_get_task(comm);
- MSG_comm_destroy(comm);
- XBT_INFO("Processing \"%s\"", MSG_task_get_name(task));
- MSG_task_execute(task);
- XBT_INFO("\"%s\" done", MSG_task_get_name(task));
- msg_error_t err = MSG_task_destroy(task);
- xbt_assert(err == MSG_OK, "MSG_task_destroy failed");
+public:
+ explicit receiver(std::vector<std::string> args)
+{
+ xbt_assert(args.size() == 3, "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);
+ message_count = xbt_str_parse_int(args[2].c_str(), "message_count parameter must be numerical but got '%s'");
+}
+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);
}
- comms.clear();
- delete [] tasks;
-
- /* Here we tell to sender that all tasks are done */
- MSG_task_send(MSG_task_create(NULL, 0, 0, NULL), "finalize");
- XBT_INFO("I'm done. See you!");
- return 0;
}
+};
int main(int argc, char *argv[])
{
- simgrid::s4u::Engine *e = new simgrid::s4u::Engine(&argc,argv);
+ simgrid::s4u::Engine* e = new simgrid::s4u::Engine(&argc, argv);
+
+ xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]);
- xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n"
- "\tExample: %s msg_platform.xml msg_deployment.xml\n", argv[0], argv[0]);
-
- e->registerFunction<Sender>("sender");
- e->registerFunction<Receiver>("receiver");
- e->loadDeployment(argv[2]); // And then, you load the deployment file
+ e->registerFunction<sender>("sender");
+ e->registerFunction<receiver>("receiver");
+ e->loadPlatform(argv[1]);
+ e->loadDeployment(argv[2]);
e->run();
- delete e;
return 0;
}
