1 /* Copyright (c) 2009-2023. The SimGrid Team.
2 * All rights reserved. */
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. */
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).
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.
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)
29 #include <boost/algorithm/string.hpp>
31 #include <simgrid/s4u.hpp>
32 #include <smpi/smpi.h>
33 #include <xbt/file.hpp>
35 XBT_LOG_NEW_DEFAULT_CATEGORY(replay_multiple_manual, "Messages specific for this example");
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[.
47 static void smpi_replay_process(Job* job, simgrid::s4u::BarrierPtr barrier, int rank)
49 XBT_INFO("Replaying rank %d of job %d (smpi_app '%s')", rank, job->unique_job_number, job->smpi_app_name.c_str());
50 smpi_replay_run(job->smpi_app_name.c_str(), rank, 0, job->traces_filenames[rank].c_str());
51 XBT_INFO("Finished replaying rank %d of job %d (smpi_app '%s')", rank, job->unique_job_number,
52 job->smpi_app_name.c_str());
57 // Sleeps for a given amount of time
58 static int sleeper_process(int param)
60 XBT_DEBUG("Sleeping for %d seconds", param);
61 simgrid::s4u::this_actor::sleep_for(param);
65 // Launches some sleeper processes
66 static void pop_some_processes(int nb_processes, simgrid::s4u::Host* host)
68 for (int i = 0; i < nb_processes; ++i) {
70 simgrid::s4u::Actor::create("meh", host, sleeper_process, param);
74 static int job_executor_process(const std::vector<simgrid::s4u::Host*>& hosts, Job* job)
76 XBT_INFO("Executing job %d (smpi_app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
78 simgrid::s4u::BarrierPtr barrier = simgrid::s4u::Barrier::create(job->app_size + 1);
80 for (int i = 0; i < job->app_size; ++i) {
81 char* str_pname = bprintf("rank_%d_%d", job->unique_job_number, i);
82 simgrid::s4u::Actor::create(str_pname, hosts[job->allocation[i]], smpi_replay_process, job, barrier, i);
88 simgrid::s4u::this_actor::sleep_for(1);
89 XBT_INFO("Finished job %d (smpi_app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
94 // Executes a workload of SMPI processes
95 static int workload_executor_process(const std::vector<simgrid::s4u::Host*>& hosts,
96 const std::vector<std::unique_ptr<Job>>& workload, int noise_between_jobs)
98 for (auto const& job : workload) {
99 // Let's wait until the job's waiting time if needed
100 if (double curr_time = simgrid::s4u::Engine::get_clock(); job->starting_time > curr_time) {
101 double time_to_sleep = (double)job->starting_time - curr_time;
102 XBT_INFO("Sleeping %g seconds (waiting for job %d, app '%s')", time_to_sleep, job->starting_time,
103 job->smpi_app_name.c_str());
104 simgrid::s4u::this_actor::sleep_for(time_to_sleep);
107 if (noise_between_jobs > 0) {
108 // Let's add some process noise
109 XBT_DEBUG("Popping %d noise processes before running job %d (app '%s')", noise_between_jobs,
110 job->unique_job_number, job->smpi_app_name.c_str());
111 pop_some_processes(noise_between_jobs, hosts[job->allocation[0]]);
114 // Let's finally run the job executor
115 char* str_pname = bprintf("job_%04d", job->unique_job_number);
116 XBT_INFO("Launching the job executor of job %d (app '%s')", job->unique_job_number, job->smpi_app_name.c_str());
117 simgrid::s4u::Actor::create(str_pname, hosts[job->allocation[0]], job_executor_process, std::cref(hosts),
125 // Reads jobs from a workload file and returns them
126 static std::vector<std::unique_ptr<Job>> all_jobs(const std::string& workload_file)
128 std::ifstream f(workload_file);
129 xbt_assert(f.is_open(), "Cannot open file '%s'.", workload_file.c_str());
130 std::vector<std::unique_ptr<Job>> jobs;
132 simgrid::xbt::Path path(workload_file);
133 std::string dir = path.get_dir_name();
136 while (std::getline(f, line)) {
137 std::string app_name;
138 std::string filename_unprefixed;
143 std::istringstream is(line);
144 if (is >> app_name >> filename_unprefixed >> app_size >> starting_time >> alloc) {
146 auto job = std::make_unique<Job>();
147 job->smpi_app_name = app_name;
148 job->filename = dir + "/" + filename_unprefixed;
149 job->app_size = app_size;
150 job->starting_time = starting_time;
152 std::vector<std::string> subparts;
153 boost::split(subparts, alloc, boost::is_any_of(","), boost::token_compress_on);
155 if ((int)subparts.size() != job->app_size)
156 throw std::invalid_argument("size/alloc inconsistency");
158 job->allocation.resize(subparts.size());
159 for (unsigned int i = 0; i < subparts.size(); ++i)
160 job->allocation[i] = stoi(subparts[i]);
162 // Let's read the filename
163 std::ifstream traces_file(job->filename);
164 if (not traces_file.is_open())
165 throw std::invalid_argument("Cannot open file " + job->filename);
167 std::string traces_line;
168 while (std::getline(traces_file, traces_line)) {
169 boost::trim_right(traces_line);
170 job->traces_filenames.push_back(dir + "/" + traces_line);
173 if (static_cast<int>(job->traces_filenames.size()) < job->app_size)
174 throw std::invalid_argument("size/tracefiles inconsistency");
175 job->traces_filenames.resize(job->app_size);
177 XBT_INFO("Job read: app='%s', file='%s', size=%d, start=%d, "
179 job->smpi_app_name.c_str(), filename_unprefixed.c_str(), job->app_size, job->starting_time,
181 jobs.emplace_back(std::move(job));
182 } catch (const std::invalid_argument& e) {
183 xbt_die("Bad line '%s' of file '%s': %s.\n", line.c_str(), workload_file.c_str(), e.what());
188 // Jobs are sorted by ascending date, then by lexicographical order of their
190 sort(jobs.begin(), jobs.end(), [](auto const& j1, auto const& j2) {
191 if (j1->starting_time == j2->starting_time)
192 return j1->smpi_app_name < j2->smpi_app_name;
193 return j1->starting_time < j2->starting_time;
195 for (unsigned int i = 0; i < jobs.size(); ++i)
196 jobs[i]->unique_job_number = i;
201 int main(int argc, char* argv[])
204 "Usage: %s platform_file workload_file initial_noise noise_between_jobs\n"
205 "\tExample: %s platform.xml workload_compute\n",
208 // Simulation setting
209 simgrid::s4u::Engine e(&argc, argv);
210 e.load_platform(argv[1]);
211 const auto hosts = e.get_all_hosts();
212 xbt_assert(hosts.size() >= 4, "The given platform should contain at least 4 hosts (found %zu).", hosts.size());
214 // Let's retrieve all SMPI jobs
215 std::vector<std::unique_ptr<Job>> jobs = all_jobs(argv[2]);
217 // Let's register them
218 for (auto const& job : jobs)
219 SMPI_app_instance_register(job->smpi_app_name.c_str(), nullptr, job->app_size);
223 // Read noise arguments
224 int initial_noise = std::stoi(argv[3]);
225 xbt_assert(initial_noise >= 0, "Invalid initial_noise argument");
227 int noise_between_jobs = std::stoi(argv[4]);
228 xbt_assert(noise_between_jobs >= 0, "Invalid noise_between_jobs argument");
230 if (initial_noise > 0) {
231 XBT_DEBUG("Popping %d noise processes", initial_noise);
232 pop_some_processes(initial_noise, hosts[0]);
235 // Let's execute the workload
236 simgrid::s4u::Actor::create("workload", hosts[0], workload_executor_process, std::cref(hosts), std::cref(jobs),
240 XBT_INFO("Simulation finished! Final time: %g", simgrid::s4u::Engine::get_clock());