Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines.
[simgrid.git] / examples / s4u / app-masterworkers / s4u-app-masterworkers-fun.cpp
index b0ff1dd..0db8087 100644 (file)
@@ -1,84 +1,89 @@
-/* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2010-2021. 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. */
 
-#include "xbt/sysdep.h"
+/* ************************************************************************* */
+/* Take this tutorial online: https://simgrid.frama.io/simgrid/tuto_s4u.html */
+/* ************************************************************************* */
+
 #include <simgrid/s4u.hpp>
-#include <string>
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_app_masterworker, "Messages specific for this s4u example");
+XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_app_masterworker, "Messages specific for this example");
 
+// master-begin
 static void master(std::vector<std::string> args)
 {
-  xbt_assert(args.size() == 5, "The master function expects 4 arguments from the XML deployment file");
-
-  long number_of_tasks = std::stol(args[1]);
-  double comp_size     = std::stod(args[2]); /* - Task compute cost    */
-  double comm_size     = std::stod(args[3]); /* - Task communication size */
-  long workers_count   = std::stol(args[4]);
-
-  XBT_INFO("Got %ld workers and %ld tasks to process", workers_count, number_of_tasks);
+  xbt_assert(args.size() > 4, "The master function expects at least 3 arguments");
 
-  simgrid::s4u::MailboxPtr mailbox = nullptr;
+  long tasks_count        = std::stol(args[1]);
+  double compute_cost     = std::stod(args[2]);
+  long communication_cost = std::stol(args[3]);
+  std::vector<simgrid::s4u::Mailbox*> workers;
+  for (unsigned int i = 4; i < args.size(); i++)
+    workers.push_back(simgrid::s4u::Mailbox::by_name(args[i]));
 
-  for (int i = 0; i < number_of_tasks; i++) { /* For each task to be executed: */
-    /* - Select a @ref worker in a round-robin way */
-    mailbox = simgrid::s4u::Mailbox::by_name(std::string("worker-") + std::to_string(i % workers_count));
+  XBT_INFO("Got %zu workers and %ld tasks to process", workers.size(), tasks_count);
 
-    if (number_of_tasks < 10000 || (number_of_tasks < 100000 && i % 10000 == 0) || i % 100000 == 0)
-      XBT_INFO("Sending \"%s\" (of %ld) to mailbox \"%s\"", (std::string("Task_") + std::to_string(i)).c_str(),
-               number_of_tasks, mailbox->get_cname());
+  for (int i = 0; i < tasks_count; i++) { /* For each task to be executed: */
+    /* - Select a worker in a round-robin way */
+    simgrid::s4u::Mailbox* mailbox = workers[i % workers.size()];
 
-    /* - Send the computation amount to the @ref worker */
-    mailbox->put(new double(comp_size), comm_size);
+    /* - Send the computation cost to that worker */
+    XBT_INFO("Sending task %d of %ld to mailbox '%s'", i, tasks_count, mailbox->get_cname());
+    mailbox->put(new double(compute_cost), communication_cost);
   }
 
-  XBT_INFO("All tasks have been dispatched. Let's tell everybody the computation is over.");
-  for (int i = 0; i < workers_count; i++) {
-    /* - Eventually tell all the workers to stop by sending a "finalize" task */
-    mailbox = simgrid::s4u::Mailbox::by_name(std::string("worker-") + std::to_string(i % workers_count));
+  XBT_INFO("All tasks have been dispatched. Request all workers to stop.");
+  for (unsigned int i = 0; i < workers.size(); i++) {
+    /* The workers stop when receiving a negative compute_cost */
+    simgrid::s4u::Mailbox* mailbox = workers[i % workers.size()];
+
     mailbox->put(new double(-1.0), 0);
   }
 }
+// master-end
 
+// worker-begin
 static void worker(std::vector<std::string> args)
 {
-  xbt_assert(args.size() == 2, "The worker expects a single argument from the XML deployment file: "
-                               "its worker ID (its numerical rank)");
-  long id                          = std::stol(args[1]);
-  simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(std::string("worker-") + std::to_string(id));
-
-  while (1) { /* The worker waits in an infinite loop for tasks sent by the @ref master */
-    double* task = static_cast<double*>(mailbox->get());
-    xbt_assert(task != nullptr, "mailbox->get() failed");
-    double comp_size = *task;
-    delete task;
-    if (comp_size < 0) { /* - Exit when -1.0 is received */
-      XBT_INFO("I'm done. See you!");
-      break;
-    }
-    /*  - Otherwise, process the task */
-    simgrid::s4u::this_actor::execute(comp_size);
-  }
+  xbt_assert(args.size() == 1, "The worker expects no argument");
+
+  const simgrid::s4u::Host* my_host = simgrid::s4u::this_actor::get_host();
+  simgrid::s4u::Mailbox* mailbox   = simgrid::s4u::Mailbox::by_name(my_host->get_name());
+
+  double compute_cost;
+  do {
+    auto msg     = mailbox->get_unique<double>();
+    compute_cost = *msg;
+
+    if (compute_cost > 0) /* If compute_cost is valid, execute a computation of that cost */
+      simgrid::s4u::this_actor::execute(compute_cost);
+  } while (compute_cost > 0); /* Stop when receiving an invalid compute_cost */
+
+  XBT_INFO("Exiting now.");
 }
+// worker-end
 
+// main-begin
 int main(int argc, char* argv[])
 {
   simgrid::s4u::Engine e(&argc, argv);
-  xbt_assert(argc > 2,
-             "Usage: %s platform_file deployment_file\n"
-             "\tExample: %s msg_platform.xml msg_deployment.xml\n",
-             argv[0], argv[0]);
+  xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n", argv[0]);
 
-  e.load_platform(argv[1]); /* Load the platform description */
+  /* Register the functions representing the actors */
   e.register_function("master", &master);
   e.register_function("worker", &worker);
-  e.load_deployment(argv[2]); /* Deploy the application */
 
-  e.run(); /** - Run the simulation */
+  /* Load the platform description and then deploy the application */
+  e.load_platform(argv[1]);
+  e.load_deployment(argv[2]);
+
+  /* Run the simulation */
+  e.run();
 
-  XBT_INFO("Simulation time %g", e.get_clock());
+  XBT_INFO("Simulation is over");
 
   return 0;
 }
+// main-end