examples/smpi/replay_multiple_manual_deploy/replay_multiple_manual.cpp

   1 /* Copyright (c) 2009-2023. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 /* This example shows how to replay SMPI time-independent traces in a dynamic
   8    fashion. It is inspired from Batsim (https://github.com/oar-team/batsim).
   9
  10    The program workflow can be summarized as:
  11    1. Read an input workload (set of jobs).
  12       Each job is a time-independent trace and a starting time.
  13    2. Create initial noise, by spawning useless actors.
  14       This is done to avoid SMPI actors to start at actor_id=0.
  15    3. For each job:
  16         1. Sleep until job's starting time is reached (if needed)
  17         2. Launch the replay of the corresponding time-independent trace.
  18         3. Create inter-process noise, by spawning useless actors.
  19    4. Wait for completion (via s4u::Engine's run method)
  20 */
  21
  22 #include <algorithm>
  23 #include <fstream>
  24 #include <memory>
  25 #include <sstream>
  26 #include <stdexcept>
  27 #include <vector>
  28
  29 #include <boost/algorithm/string.hpp>
  30
  31 #include <simgrid/s4u.hpp>
  32 #include <smpi/smpi.h>
  33 #include <xbt/file.hpp>
  34
  35 XBT_LOG_NEW_DEFAULT_CATEGORY(replay_multiple_manual, "Messages specific for this example");
  36
  37 struct Job {
  38   std::string smpi_app_name;   //!< The unique name of the SMPI application
  39   std::string filename;        //!<  The filename of the main trace file (which contains other filenames for each rank)
  40   int app_size;                //!< The number of processes (actors) of the job
  41   int starting_time;           //!< When the job should start
  42   std::vector<int> allocation; //!< Where the job should be executed. Values are hosts indexes.
  43   std::vector<std::string> traces_filenames; //!< The filenames of the different action files. Read from filename.
  44   int unique_job_number;                     //!< The job unique number in [0, n[.
  45 };
  46
  47 // ugly globals to avoid creating structures for giving args to processes
  48 static std::vector<simgrid::s4u::Host*> hosts;
  49
  50 static void smpi_replay_process(Job* job, simgrid::s4u::BarrierPtr barrier, int rank)
  51 {
  52   XBT_INFO("Replaying rank %d of job %d (smpi_app '%s')", rank, job->unique_job_number, job->smpi_app_name.c_str());
  53   smpi_replay_run(job->smpi_app_name.c_str(), rank, 0, job->traces_filenames[rank].c_str());
  54   XBT_INFO("Finished replaying rank %d of job %d (smpi_app '%s')", rank, job->unique_job_number,
  55            job->smpi_app_name.c_str());
  56
  57   barrier->wait();
  58 }
  59
  60 // Sleeps for a given amount of time
  61 static int sleeper_process(int param)
  62 {
  63   XBT_DEBUG("Sleeping for %d seconds", param);
  64   simgrid::s4u::this_actor::sleep_for(param);
  65   return 0;
  66 }
  67
  68 // Launches some sleeper processes
  69 static void pop_some_processes(int nb_processes, simgrid::s4u::Host* host)
  70 {
  71   for (int i = 0; i < nb_processes; ++i) {
  72     int param = i + 1;
  73     simgrid::s4u::Actor::create("meh", host, sleeper_process, param);
  74   }
  75 }
  76
  77 static int job_executor_process(Job* job)
  78 {
  79   XBT_INFO("Executing job %d (smpi_app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
  80
  81   simgrid::s4u::BarrierPtr barrier = simgrid::s4u::Barrier::create(job->app_size + 1);
  82
  83   for (int i = 0; i < job->app_size; ++i) {
  84     char* str_pname = bprintf("rank_%d_%d", job->unique_job_number, i);
  85     simgrid::s4u::Actor::create(str_pname, hosts[job->allocation[i]], smpi_replay_process, job, barrier, i);
  86     xbt_free(str_pname);
  87   }
  88
  89   barrier->wait();
  90
  91   simgrid::s4u::this_actor::sleep_for(1);
  92   XBT_INFO("Finished job %d (smpi_app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
  93
  94   return 0;
  95 }
  96
  97 // Executes a workload of SMPI processes
  98 static int workload_executor_process(const std::vector<std::unique_ptr<Job>>& workload, int noise_between_jobs)
  99 {
 100   for (auto const& job : workload) {
 101     // Let's wait until the job's waiting time if needed
 102     if (double curr_time = simgrid::s4u::Engine::get_clock(); job->starting_time > curr_time) {
 103       double time_to_sleep = (double)job->starting_time - curr_time;
 104       XBT_INFO("Sleeping %g seconds (waiting for job %d, app '%s')", time_to_sleep, job->starting_time,
 105                job->smpi_app_name.c_str());
 106       simgrid::s4u::this_actor::sleep_for(time_to_sleep);
 107     }
 108
 109     if (noise_between_jobs > 0) {
 110       // Let's add some process noise
 111       XBT_DEBUG("Popping %d noise processes before running job %d (app '%s')", noise_between_jobs,
 112                 job->unique_job_number, job->smpi_app_name.c_str());
 113       pop_some_processes(noise_between_jobs, hosts[job->allocation[0]]);
 114     }
 115
 116     // Let's finally run the job executor
 117     char* str_pname = bprintf("job_%04d", job->unique_job_number);
 118     XBT_INFO("Launching the job executor of job %d (app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
 119     simgrid::s4u::Actor::create(str_pname, hosts[job->allocation[0]], job_executor_process, job.get());
 120     xbt_free(str_pname);
 121   }
 122
 123   return 0;
 124 }
 125
 126 // Reads jobs from a workload file and returns them
 127 static std::vector<std::unique_ptr<Job>> all_jobs(const std::string& workload_file)
 128 {
 129   std::ifstream f(workload_file);
 130   xbt_assert(f.is_open(), "Cannot open file '%s'.", workload_file.c_str());
 131   std::vector<std::unique_ptr<Job>> jobs;
 132
 133   simgrid::xbt::Path path(workload_file);
 134   std::string dir = path.get_dir_name();
 135
 136   std::string line;
 137   while (std::getline(f, line)) {
 138     std::string app_name;
 139     std::string filename_unprefixed;
 140     int app_size;
 141     int starting_time;
 142     std::string alloc;
 143
 144     std::istringstream is(line);
 145     if (is >> app_name >> filename_unprefixed >> app_size >> starting_time >> alloc) {
 146       try {
 147         auto job           = std::make_unique<Job>();
 148         job->smpi_app_name = app_name;
 149         job->filename      = dir + "/" + filename_unprefixed;
 150         job->app_size      = app_size;
 151         job->starting_time = starting_time;
 152
 153         std::vector<std::string> subparts;
 154         boost::split(subparts, alloc, boost::is_any_of(","), boost::token_compress_on);
 155
 156         if ((int)subparts.size() != job->app_size)
 157           throw std::invalid_argument("size/alloc inconsistency");
 158
 159         job->allocation.resize(subparts.size());
 160         for (unsigned int i = 0; i < subparts.size(); ++i)
 161           job->allocation[i] = stoi(subparts[i]);
 162
 163         // Let's read the filename
 164         std::ifstream traces_file(job->filename);
 165         if (not traces_file.is_open())
 166           throw std::invalid_argument("Cannot open file " + job->filename);
 167
 168         std::string traces_line;
 169         while (std::getline(traces_file, traces_line)) {
 170           boost::trim_right(traces_line);
 171           job->traces_filenames.push_back(dir + "/" + traces_line);
 172         }
 173
 174         if (static_cast<int>(job->traces_filenames.size()) < job->app_size)
 175           throw std::invalid_argument("size/tracefiles inconsistency");
 176         job->traces_filenames.resize(job->app_size);
 177
 178         XBT_INFO("Job read: app='%s', file='%s', size=%d, start=%d, "
 179                  "alloc='%s'",
 180                  job->smpi_app_name.c_str(), filename_unprefixed.c_str(), job->app_size, job->starting_time,
 181                  alloc.c_str());
 182         jobs.emplace_back(std::move(job));
 183       } catch (const std::invalid_argument& e) {
 184         xbt_die("Bad line '%s' of file '%s': %s.\n", line.c_str(), workload_file.c_str(), e.what());
 185       }
 186     }
 187   }
 188
 189   // Jobs are sorted by ascending date, then by lexicographical order of their
 190   // application names
 191   sort(jobs.begin(), jobs.end(), [](auto const& j1, auto const& j2) {
 192     if (j1->starting_time == j2->starting_time)
 193       return j1->smpi_app_name < j2->smpi_app_name;
 194     return j1->starting_time < j2->starting_time;
 195   });
 196   for (unsigned int i = 0; i < jobs.size(); ++i)
 197     jobs[i]->unique_job_number = i;
 198
 199   return jobs;
 200 }
 201
 202 int main(int argc, char* argv[])
 203 {
 204   xbt_assert(argc > 4,
 205              "Usage: %s platform_file workload_file initial_noise noise_between_jobs\n"
 206              "\tExample: %s platform.xml workload_compute\n",
 207              argv[0], argv[0]);
 208
 209   //  Simulation setting
 210   simgrid::s4u::Engine e(&argc, argv);
 211   e.load_platform(argv[1]);
 212   hosts = e.get_all_hosts();
 213   xbt_assert(hosts.size() >= 4, "The given platform should contain at least 4 hosts (found %zu).", hosts.size());
 214
 215   // Let's retrieve all SMPI jobs
 216   std::vector<std::unique_ptr<Job>> jobs = all_jobs(argv[2]);
 217
 218   // Let's register them
 219   for (auto const& job : jobs)
 220     SMPI_app_instance_register(job->smpi_app_name.c_str(), nullptr, job->app_size);
 221
 222   SMPI_init();
 223
 224   // Read noise arguments
 225   int initial_noise = std::stoi(argv[3]);
 226   xbt_assert(initial_noise >= 0, "Invalid initial_noise argument");
 227
 228   int noise_between_jobs = std::stoi(argv[4]);
 229   xbt_assert(noise_between_jobs >= 0, "Invalid noise_between_jobs argument");
 230
 231   if (initial_noise > 0) {
 232     XBT_DEBUG("Popping %d noise processes", initial_noise);
 233     pop_some_processes(initial_noise, hosts[0]);
 234   }
 235
 236   // Let's execute the workload
 237   simgrid::s4u::Actor::create("workload", hosts[0], workload_executor_process, std::cref(jobs), noise_between_jobs);
 238
 239   e.run();
 240   XBT_INFO("Simulation finished! Final time: %g", simgrid::s4u::Engine::get_clock());
 241
 242   SMPI_finalize();
 243
 244   return 0;
 245 }