examples/smpi/replay_multiple_manual_deploy/replay_multiple_manual.cpp

   1 /* Copyright (c) 2009-2018. 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-indepent trace.
  18         3. Create inter-process noise, by spawning useless actors.
  19    4. Wait for completion (implicitly, via MSG_main's return)
  20 */
  21
  22 #include <algorithm>
  23 #include <fstream>
  24 #include <sstream>
  25 #include <stdexcept>
  26 #include <vector>
  27
  28 #include <boost/algorithm/string.hpp>
  29
  30 #include <simgrid/msg.h>
  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 std::vector<simgrid::s4u::Host*> hosts;
  49 int noise_between_jobs;
  50
  51 static bool job_comparator(const Job* j1, const Job* j2)
  52 {
  53   if (j1->starting_time == j2->starting_time)
  54     return j1->smpi_app_name < j2->smpi_app_name;
  55   return j1->starting_time < j2->starting_time;
  56 }
  57
  58 struct s_smpi_replay_process_args {
  59   Job* job;
  60   msg_sem_t semaphore;
  61   int rank;
  62 };
  63
  64 static int smpi_replay_process(int argc, char* argv[])
  65 {
  66   s_smpi_replay_process_args* args = static_cast<s_smpi_replay_process_args*>(MSG_process_get_data(MSG_process_self()));
  67
  68   if (args->semaphore != nullptr)
  69     MSG_sem_acquire(args->semaphore);
  70
  71   XBT_INFO("Replaying rank %d of job %d (smpi_app '%s')", args->rank, args->job->unique_job_number,
  72            args->job->smpi_app_name.c_str());
  73
  74   smpi_replay_run(&argc, &argv);
  75   XBT_INFO("Finished replaying rank %d of job %d (smpi_app '%s')", args->rank, args->job->unique_job_number,
  76            args->job->smpi_app_name.c_str());
  77
  78   if (args->semaphore != nullptr)
  79     MSG_sem_release(args->semaphore);
  80
  81   delete args;
  82   return 0;
  83 }
  84
  85 // Sleeps for a given amount of time
  86 static int sleeper_process(int* param)
  87 {
  88   XBT_DEBUG("Sleeping for %d seconds", *param);
  89   simgrid::s4u::this_actor::sleep_for(*param);
  90
  91   delete param;
  92
  93   return 0;
  94 }
  95
  96 // Launches some sleeper processes
  97 static void pop_some_processes(int nb_processes, simgrid::s4u::Host* host)
  98 {
  99   for (int i = 0; i < nb_processes; ++i) {
 100     int* param = new int;
 101     *param     = i + 1;
 102     simgrid::s4u::Actor::create("meh", host, sleeper_process, param);
 103   }
 104 }
 105
 106 static int job_executor_process(Job* job)
 107 {
 108   msg_sem_t job_semaphore = MSG_sem_init(1);
 109   XBT_INFO("Executing job %d (smpi_app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
 110
 111   for (int i = 0; i < job->app_size; ++i) {
 112     char** argv = xbt_new(char*, 5);
 113     argv[0]     = xbt_strdup("1");                              // log only?
 114     argv[1]     = xbt_strdup(job->smpi_app_name.c_str());       // application instance
 115     argv[2]     = bprintf("%d", i);                             // rank
 116     argv[3]     = xbt_strdup(job->traces_filenames[i].c_str()); // smpi trace file for this rank
 117     argv[4]     = xbt_strdup("0");   // ?
 118
 119     s_smpi_replay_process_args* args = new s_smpi_replay_process_args;
 120     args->job                        = job;
 121     args->semaphore                  = nullptr;
 122     args->rank                       = i;
 123
 124     if (i == 0)
 125       args->semaphore = job_semaphore;
 126
 127     char* str_pname = bprintf("%d_%d", job->unique_job_number, i);
 128     MSG_process_create_with_arguments(str_pname, smpi_replay_process, (void*)args, hosts[job->allocation[i]], 5, argv);
 129     xbt_free(str_pname);
 130   }
 131
 132   MSG_sem_acquire(job_semaphore);
 133   MSG_sem_destroy(job_semaphore);
 134
 135   XBT_INFO("Finished job %d (smpi_app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
 136
 137   return 0;
 138 }
 139
 140 // Executes a workload of SMPI processes
 141 static int workload_executor_process(std::vector<Job*>* workload)
 142 {
 143   for (Job* job : *workload) {
 144     // Let's wait until the job's waiting time if needed
 145     double curr_time = simgrid::s4u::Engine::get_clock();
 146     if (job->starting_time > curr_time) {
 147       double time_to_sleep = (double)job->starting_time - curr_time;
 148       XBT_INFO("Sleeping %g seconds (waiting for job %d, app '%s')", time_to_sleep, job->starting_time,
 149                job->smpi_app_name.c_str());
 150       simgrid::s4u::this_actor::sleep_for(time_to_sleep);
 151     }
 152
 153     if (noise_between_jobs > 0) {
 154       // Let's add some process noise
 155       XBT_DEBUG("Popping %d noise processes before running job %d (app '%s')", noise_between_jobs,
 156                 job->unique_job_number, job->smpi_app_name.c_str());
 157       pop_some_processes(noise_between_jobs, hosts[job->allocation[0]]);
 158     }
 159
 160     // Let's finally run the job executor
 161     std::string job_process_name = "job_" + job->smpi_app_name;
 162     XBT_INFO("Launching the job executor of job %d (app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
 163     simgrid::s4u::Actor::create(job_process_name.c_str(), hosts[job->allocation[0]], job_executor_process, job);
 164   }
 165
 166   return 0;
 167 }
 168
 169 // Reads jobs from a workload file and returns them
 170 static std::vector<Job*> all_jobs(const std::string& workload_file)
 171 {
 172   std::ifstream f(workload_file);
 173   xbt_assert(f.is_open(), "Cannot open file '%s'.", workload_file.c_str());
 174   std::vector<Job*> jobs;
 175
 176   simgrid::xbt::Path path(workload_file);
 177   std::string dir = path.get_dir_name();
 178
 179   std::string line;
 180   while (std::getline(f, line)) {
 181     std::string app_name;
 182     std::string filename_unprefixed;
 183     int app_size;
 184     int starting_time;
 185     std::string alloc;
 186
 187     std::istringstream is(line);
 188     if (is >> app_name >> filename_unprefixed >> app_size >> starting_time >> alloc) {
 189       try {
 190         Job job;
 191         job.smpi_app_name = app_name;
 192         job.filename      = dir + "/" + filename_unprefixed;
 193         job.app_size      = app_size;
 194         job.starting_time = starting_time;
 195
 196         std::vector<std::string> subparts;
 197         boost::split(subparts, alloc, boost::is_any_of(","), boost::token_compress_on);
 198
 199         if ((int)subparts.size() != job.app_size)
 200           throw std::invalid_argument("size/alloc inconsistency");
 201
 202         job.allocation.resize(subparts.size());
 203         for (unsigned int i = 0; i < subparts.size(); ++i)
 204           job.allocation[i] = stoi(subparts[i]);
 205
 206         // Let's read the filename
 207         std::ifstream traces_file(job.filename);
 208         if (!traces_file.is_open())
 209           throw std::invalid_argument("Cannot open file " + job.filename);
 210
 211         std::string traces_line;
 212         while (std::getline(traces_file, traces_line)) {
 213           boost::trim_right(traces_line);
 214           job.traces_filenames.push_back(dir + "/" + traces_line);
 215         }
 216
 217         if (static_cast<int>(job.traces_filenames.size()) < job.app_size)
 218           throw std::invalid_argument("size/tracefiles inconsistency");
 219         job.traces_filenames.resize(job.app_size);
 220
 221         XBT_INFO("Job read: app='%s', file='%s', size=%d, start=%d, "
 222                  "alloc='%s'",
 223                  job.smpi_app_name.c_str(), filename_unprefixed.c_str(), job.app_size, job.starting_time,
 224                  alloc.c_str());
 225         jobs.push_back(new Job(std::move(job)));
 226       } catch (const std::invalid_argument& e) {
 227         xbt_die("Bad line '%s' of file '%s': %s.\n", line.c_str(), workload_file.c_str(), e.what());
 228       }
 229     }
 230   }
 231
 232   // Jobs are sorted by ascending date, then by lexicographical order of their
 233   // application names
 234   sort(jobs.begin(), jobs.end(), job_comparator);
 235
 236   for (unsigned int i = 0; i < jobs.size(); ++i)
 237     jobs[i]->unique_job_number = i;
 238
 239   return jobs;
 240 }
 241
 242 int main(int argc, char* argv[])
 243 {
 244   xbt_assert(argc > 4,
 245              "Usage: %s platform_file workload_file initial_noise noise_between_jobs\n"
 246              "\tExample: %s platform.xml workload_compute\n",
 247              argv[0], argv[0]);
 248
 249   //  Simulation setting
 250   MSG_init(&argc, argv);
 251   simgrid::s4u::Engine e(&argc, argv);
 252   e.load_platform(argv[1]);
 253   hosts = e.get_all_hosts();
 254   xbt_assert(hosts.size() >= 4, "The given platform should contain at least 4 hosts (found %zu).", hosts.size());
 255
 256   // Let's retrieve all SMPI jobs
 257   std::vector<Job*> jobs = all_jobs(argv[2]);
 258
 259   // Let's register them
 260   for (const Job* job : jobs)
 261     SMPI_app_instance_register(job->smpi_app_name.c_str(), smpi_replay_process, job->app_size);
 262
 263   SMPI_init();
 264
 265   // Read noise arguments
 266   int initial_noise = std::stoi(argv[3]);
 267   xbt_assert(initial_noise >= 0, "Invalid initial_noise argument");
 268
 269   noise_between_jobs = std::stoi(argv[4]);
 270   xbt_assert(noise_between_jobs >= 0, "Invalid noise_between_jobs argument");
 271
 272   if (initial_noise > 0) {
 273     XBT_DEBUG("Popping %d noise processes", initial_noise);
 274     pop_some_processes(initial_noise, hosts[0]);
 275   }
 276
 277   // Let's execute the workload
 278   simgrid::s4u::Actor::create("workload_executor", hosts[0], workload_executor_process, &jobs);
 279
 280   e.run();
 281   XBT_INFO("Simulation finished! Final time: %g", e.get_clock());
 282
 283   SMPI_finalize();
 284
 285   for (const Job* job : jobs)
 286     delete job;
 287
 288   return 0;
 289 }