1 /* Copyright (c) 2004-2022. 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 #include "smpi_host.hpp"
9 #include "simgrid/s4u/Engine.hpp"
10 #include "simgrid/s4u/Barrier.hpp"
11 #include "smpi_comm.hpp"
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(smpi);
20 static int universe_size = 0;
24 explicit Instance(int max_no_processes) : size_(max_no_processes)
26 auto* group = new simgrid::smpi::Group(size_);
27 comm_world_ = new simgrid::smpi::Comm(group, nullptr, false, -1);
28 universe_size += max_no_processes;
29 bar_ = std::make_shared<s4u::Barrier>(size_);
31 std::shared_ptr<s4u::Barrier> bar_;
33 unsigned int finalized_ranks_ = 0;
40 using simgrid::smpi::app::Instance;
42 static std::map<std::string, Instance, std::less<>> smpi_instances;
44 /** @ingroup smpi_simulation
45 * @brief Registers a running instance of an MPI program.
47 * @param name the reference name of the function.
48 * @param code either the main mpi function
49 * (must have a int ..(int argc, char *argv[]) prototype) or nullptr
50 * (if the function deployment is managed somewhere else —
51 * e.g., when deploying manually or using smpirun)
52 * @param num_processes the size of the instance we want to deploy
54 void SMPI_app_instance_register(const char *name, xbt_main_func_t code, int num_processes)
56 if (code != nullptr) // When started with smpirun, we will not execute a function
57 simgrid::s4u::Engine::get_instance()->register_function(name, code);
59 Instance instance(num_processes);
61 smpi_instances.insert(std::pair<std::string, Instance>(name, instance));
64 void smpi_deployment_register_process(const std::string& instance_id, int rank, const simgrid::s4u::Actor* actor)
66 const Instance& instance = smpi_instances.at(instance_id);
67 instance.comm_world_->group()->set_mapping(actor->get_pid(), rank);
70 void smpi_deployment_startup_barrier(const std::string& instance_id)
72 const Instance& instance = smpi_instances.at(instance_id);
73 instance.bar_->wait();
76 void smpi_deployment_unregister_process(const std::string& instance_id)
78 Instance& instance = smpi_instances.at(instance_id);
79 instance.finalized_ranks_++;
81 if (instance.finalized_ranks_ == instance.size_) {
82 simgrid::smpi::Comm::destroy(instance.comm_world_);
83 smpi_instances.erase(instance_id);
87 MPI_Comm* smpi_deployment_comm_world(const std::string& instance_id)
90 .empty()) { // no instance registered, we probably used smpirun. (FIXME: I guess this never happens for real)
93 Instance& instance = smpi_instances.at(instance_id);
94 return &instance.comm_world_;
97 void smpi_deployment_cleanup_instances(){
98 for (auto const& item : smpi_instances) {
99 XBT_INFO("Stalling SMPI instance: %s. Do all your MPI ranks call MPI_Finalize()?", item.first.c_str());
100 Instance instance = item.second;
101 simgrid::smpi::Comm::destroy(instance.comm_world_);
103 smpi_instances.clear();
106 int smpi_get_universe_size()
108 return simgrid::smpi::app::universe_size;
111 /** @brief Auxiliary method to get list of hosts to deploy app */
112 static std::vector<simgrid::s4u::Host*> smpi_get_hosts(const simgrid::s4u::Engine* e, const std::string& hostfile)
114 if (hostfile == "") {
115 return e->get_all_hosts();
117 std::vector<simgrid::s4u::Host*> hosts;
118 std::ifstream in(hostfile.c_str());
119 xbt_assert(in, "smpirun: Cannot open the host file: %s", hostfile.c_str());
121 while (std::getline(in, str)) {
123 hosts.emplace_back(e->host_by_name(str));
125 xbt_assert(not hosts.empty(), "smpirun: the hostfile '%s' is empty", hostfile.c_str());
129 /** @brief Read replay configuration from file */
130 static std::vector<std::string> smpi_read_replay(const std::string& replayfile)
132 std::vector<std::string> replay;
133 if (replayfile == "")
136 std::ifstream in(replayfile.c_str());
137 xbt_assert(in, "smpirun: Cannot open the replay file: %s", replayfile.c_str());
139 while (std::getline(in, str)) {
141 replay.emplace_back(str);
147 /** @brief Build argument vector to pass to process */
148 static std::vector<std::string> smpi_deployment_get_args(int rank_id, const std::vector<std::string>& replay,
149 const std::vector<const char*>& run_args)
151 std::vector<std::string> args{std::to_string(rank_id)};
152 // pass arguments to process only if not a replay execution
154 args.insert(args.end(), begin(run_args), end(run_args));
155 /* one trace per process */
156 if (replay.size() > 1)
157 args.emplace_back(replay[rank_id]);
162 * @brief Deploy an SMPI application from a smpirun call
164 * This used to be done at smpirun script, parsing either the hostfile or the platform XML.
165 * If hostfile isn't provided, get the list of hosts from engine.
167 int smpi_deployment_smpirun(const simgrid::s4u::Engine* e, const std::string& hostfile, int np,
168 const std::string& replayfile, int map, const std::vector<const char*>& run_args)
170 auto hosts = smpi_get_hosts(e, hostfile);
171 auto replay = smpi_read_replay(replayfile);
172 int hosts_size = static_cast<int>(hosts.size());
176 xbt_assert(np > 0, "Invalid number of process (np must be > 0). Check your np parameter, platform or hostfile");
178 if (np > hosts_size) {
179 XBT_INFO("You requested to use %d ranks, but there is only %d processes in your hostfile...", np, hosts_size);
182 for (int i = 0; i < np; i++) {
183 simgrid::s4u::Host* host = hosts[i % hosts_size];
184 std::string rank_id = std::to_string(i);
185 auto args = smpi_deployment_get_args(i, replay, run_args);
186 auto actor = simgrid::s4u::Actor::create(rank_id, host, rank_id, args);
187 /* keeping the same behavior as done in smpirun script, print mapping rank/process */
189 XBT_INFO("[rank %d] -> %s", i, host->get_cname());
191 actor->set_property("instance_id", "smpirun");
192 actor->set_property("rank", rank_id);
193 if (not replay.empty())
194 actor->set_property("smpi_replay", "true");
195 /* shared trace file, set it to rank 0 */
196 if (i == 0 && replay.size() == 1)
197 actor->set_property("tracefile", replay[0]);