src/smpi/internals/smpi_deployment.cpp

   1 /* Copyright (c) 2004-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 #include "smpi_host.hpp"
   8 #include "private.hpp"
   9 #include "simgrid/s4u/Engine.hpp"
  10 #include "simgrid/s4u/Barrier.hpp"
  11 #include "smpi_comm.hpp"
  12 #include <map>
  13
  14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(smpi);
  15
  16 namespace simgrid::smpi::app {
  17
  18 static int universe_size = 0;
  19
  20 class Instance {
  21 public:
  22   explicit Instance(int max_no_processes) : size_(max_no_processes)
  23   {
  24     auto* group = new simgrid::smpi::Group(size_);
  25     comm_world_ = new simgrid::smpi::Comm(group, nullptr, false, -1);
  26     universe_size += max_no_processes;
  27     bar_ = s4u::Barrier::create(size_);
  28   }
  29   s4u::BarrierPtr bar_;
  30   unsigned int size_;
  31   unsigned int finalized_ranks_ = 0;
  32   MPI_Comm comm_world_;
  33 };
  34 } // namespace simgrid::smpi::app
  35
  36 using simgrid::smpi::app::Instance;
  37
  38 static std::map<std::string, Instance, std::less<>> smpi_instances;
  39
  40 /** @ingroup smpi_simulation
  41  * @brief Registers a running instance of an MPI program.
  42  *
  43  * @param name the reference name of the function.
  44  * @param code either the main mpi function
  45  *             (must have a int ..(int argc, char *argv[]) prototype) or nullptr
  46  *             (if the function deployment is managed somewhere else —
  47  *              e.g., when deploying manually or using smpirun)
  48  * @param num_processes the size of the instance we want to deploy
  49  */
  50 void SMPI_app_instance_register(const char *name, xbt_main_func_t code, int num_processes)
  51 {
  52   if (code != nullptr) // When started with smpirun, we will not execute a function
  53     simgrid::s4u::Engine::get_instance()->register_function(name, code);
  54
  55   smpi_instances.try_emplace(name, num_processes);
  56 }
  57
  58 void smpi_deployment_register_process(const std::string& instance_id, int rank, const simgrid::s4u::Actor* actor)
  59 {
  60   const Instance& instance = smpi_instances.at(instance_id);
  61   instance.comm_world_->group()->set_mapping(actor->get_pid(), rank);
  62 }
  63
  64 void smpi_deployment_startup_barrier(const std::string& instance_id)
  65 {
  66   const Instance& instance = smpi_instances.at(instance_id);
  67   instance.bar_->wait();
  68 }
  69
  70 void smpi_deployment_unregister_process(const std::string& instance_id)
  71 {
  72   Instance& instance = smpi_instances.at(instance_id);
  73   instance.finalized_ranks_++;
  74
  75   if (instance.finalized_ranks_ == instance.size_) {
  76     simgrid::smpi::Comm::destroy(instance.comm_world_);
  77     smpi_instances.erase(instance_id);
  78   }
  79 }
  80
  81 MPI_Comm* smpi_deployment_comm_world(const std::string& instance_id)
  82 {
  83   Instance& instance = smpi_instances.at(instance_id);
  84   return &instance.comm_world_;
  85 }
  86
  87 void smpi_deployment_cleanup_instances(){
  88   for (auto const& [name, instance] : smpi_instances) {
  89     XBT_INFO("Stalling SMPI instance: %s. Do all your MPI ranks call MPI_Finalize()?", name.c_str());
  90     simgrid::smpi::Comm::destroy(instance.comm_world_);
  91   }
  92   smpi_instances.clear();
  93 }
  94
  95 int smpi_get_universe_size()
  96 {
  97   return simgrid::smpi::app::universe_size;
  98 }
  99
 100 /** @brief Auxiliary method to get list of hosts to deploy app */
 101 static std::vector<simgrid::s4u::Host*> smpi_get_hosts(const simgrid::s4u::Engine* e, const std::string& hostfile)
 102 {
 103   if (hostfile == "") {
 104     return e->get_all_hosts();
 105   }
 106   std::vector<simgrid::s4u::Host*> hosts;
 107   std::ifstream in(hostfile.c_str());
 108   xbt_assert(in, "smpirun: Cannot open the host file: %s", hostfile.c_str());
 109   std::string str;
 110   while (std::getline(in, str)) {
 111     if (not str.empty())
 112       hosts.emplace_back(e->host_by_name(str));
 113   }
 114   xbt_assert(not hosts.empty(), "smpirun: the hostfile '%s' is empty", hostfile.c_str());
 115   return hosts;
 116 }
 117
 118 /** @brief Read replay configuration from file */
 119 static std::vector<std::string> smpi_read_replay(const std::string& replayfile)
 120 {
 121   std::vector<std::string> replay;
 122   if (replayfile == "")
 123     return replay;
 124
 125   std::ifstream in(replayfile.c_str());
 126   xbt_assert(in, "smpirun: Cannot open the replay file: %s", replayfile.c_str());
 127   std::string str;
 128   while (std::getline(in, str)) {
 129     if (not str.empty())
 130       replay.emplace_back(str);
 131   }
 132
 133   return replay;
 134 }
 135
 136 /** @brief Build argument vector to pass to process */
 137 static std::vector<std::string> smpi_deployment_get_args(int rank_id, const std::vector<std::string>& replay,
 138                                                          const std::vector<const char*>& run_args)
 139 {
 140   std::vector<std::string> args{std::to_string(rank_id)};
 141   // pass arguments to process only if not a replay execution
 142   if (replay.empty())
 143     args.insert(args.end(), begin(run_args), end(run_args));
 144   /* one trace per process */
 145   if (replay.size() > 1)
 146     args.emplace_back(replay[rank_id]);
 147   return args;
 148 }
 149
 150 /**
 151  * @brief Deploy an SMPI application from a smpirun call
 152  *
 153  * This used to be done at smpirun script, parsing either the hostfile or the platform XML.
 154  * If hostfile isn't provided, get the list of hosts from engine.
 155  */
 156 int smpi_deployment_smpirun(const simgrid::s4u::Engine* e, const std::string& hostfile, int np,
 157                             const std::string& replayfile, int map, const std::vector<const char*>& run_args)
 158 {
 159   auto hosts     = smpi_get_hosts(e, hostfile);
 160   auto replay    = smpi_read_replay(replayfile);
 161   int hosts_size = static_cast<int>(hosts.size());
 162   if (np == 0)
 163     np = hosts_size;
 164
 165   xbt_assert(np > 0, "Invalid number of process (np must be > 0). Check your np parameter, platform or hostfile");
 166
 167   if (np > hosts_size) {
 168     XBT_INFO("You requested to use %d ranks, but there is only %d processes in your hostfile...", np, hosts_size);
 169   }
 170
 171   for (int i = 0; i < np; i++) {
 172     simgrid::s4u::Host* host = hosts[i % hosts_size];
 173     std::string rank_id      = std::to_string(i);
 174     auto args                = smpi_deployment_get_args(i, replay, run_args);
 175     auto actor               = simgrid::s4u::Actor::create(rank_id, host, rank_id, args);
 176     /* keeping the same behavior as done in smpirun script, print mapping rank/process */
 177     if (map != 0) {
 178       XBT_INFO("[rank %d] -> %s", i, host->get_cname());
 179     }
 180     actor->set_property("instance_id", "smpirun");
 181     actor->set_property("rank", rank_id);
 182     if (not replay.empty())
 183       actor->set_property("smpi_replay", "true");
 184     /* shared trace file, set it to rank 0 */
 185     if (i == 0 && replay.size() == 1)
 186       actor->set_property("tracefile", replay[0]);
 187   }
 188   return np;
 189 }