src/smpi/internals/smpi_deployment.cpp

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