src/smpi/internals/smpi_actor.cpp

   1 /* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/smpi/include/smpi_actor.hpp"
   7 #include "mc/mc.h"
   8 #include "smpi_comm.hpp"
   9 #include "src/mc/mc_replay.hpp"
  10 #include "src/msg/msg_private.hpp"
  11 #include "src/simix/smx_private.hpp"
  12
  13 #if HAVE_PAPI
  14 #include "papi.h"
  15 extern std::string papi_default_config_name;
  16 #endif
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_process, smpi, "Logging specific to SMPI (kernel)");
  19
  20 namespace simgrid {
  21 namespace smpi {
  22
  23 using simgrid::s4u::Actor;
  24 using simgrid::s4u::ActorPtr;
  25
  26 ActorExt::ActorExt(ActorPtr actor, simgrid::s4u::Barrier* finalization_barrier)
  27     : finalization_barrier_(finalization_barrier), actor_(actor)
  28 {
  29   mailbox_         = simgrid::s4u::Mailbox::by_name("SMPI-" + std::to_string(actor_->get_pid()));
  30   mailbox_small_   = simgrid::s4u::Mailbox::by_name("small-" + std::to_string(actor_->get_pid()));
  31   mailboxes_mutex_ = xbt_mutex_init();
  32   timer_           = xbt_os_timer_new();
  33   state_           = SmpiProcessState::UNINITIALIZED;
  34   if (MC_is_active())
  35     MC_ignore_heap(timer_, xbt_os_timer_size());
  36
  37 #if HAVE_PAPI
  38   if (not simgrid::config::get_value<std::string>("smpi/papi-events").empty()) {
  39     // TODO: Implement host/process/thread based counters. This implementation
  40     // just always takes the values passed via "default", like this:
  41     // "default:COUNTER1:COUNTER2:COUNTER3;".
  42     auto it = units2papi_setup.find(papi_default_config_name);
  43     if (it != units2papi_setup.end()) {
  44       papi_event_set_    = it->second.event_set;
  45       papi_counter_data_ = it->second.counter_data;
  46       XBT_DEBUG("Setting PAPI set for process %li", actor->get_pid());
  47     } else {
  48       papi_event_set_ = PAPI_NULL;
  49       XBT_DEBUG("No PAPI set for process %li", actor->get_pid());
  50     }
  51   }
  52 #endif
  53 }
  54
  55 ActorExt::~ActorExt()
  56 {
  57   if (comm_self_ != MPI_COMM_NULL)
  58     simgrid::smpi::Comm::destroy(comm_self_);
  59   if (comm_intra_ != MPI_COMM_NULL)
  60     simgrid::smpi::Comm::destroy(comm_intra_);
  61   xbt_os_timer_free(timer_);
  62   xbt_mutex_destroy(mailboxes_mutex_);
  63 }
  64
  65 void ActorExt::set_data(int* argc, char*** argv)
  66 {
  67   instance_id_                   = std::string((*argv)[1]);
  68   comm_world_                    = smpi_deployment_comm_world(instance_id_);
  69   simgrid::s4u::Barrier* barrier = smpi_deployment_finalization_barrier(instance_id_);
  70   if (barrier != nullptr) // don't overwrite the current one if the instance has none
  71     finalization_barrier_ = barrier;
  72
  73   static_cast<simgrid::msg::ActorExt*>(actor_->get_impl()->get_user_data())->data = this;
  74
  75   if (*argc > 3) {
  76     memmove(&(*argv)[0], &(*argv)[2], sizeof(char*) * (*argc - 2));
  77     (*argv)[(*argc) - 1] = nullptr;
  78     (*argv)[(*argc) - 2] = nullptr;
  79   }
  80   (*argc) -= 2;
  81   argc_ = argc;
  82   argv_ = argv;
  83   // set the process attached to the mailbox
  84   mailbox_small_->set_receiver(actor_);
  85   XBT_DEBUG("<%ld> SMPI process has been initialized: %p", actor_->get_pid(), actor_.get());
  86 }
  87
  88 /** @brief Prepares the current process for termination. */
  89 void ActorExt::finalize()
  90 {
  91   state_ = SmpiProcessState::FINALIZED;
  92   XBT_DEBUG("<%ld> Process left the game", actor_->get_pid());
  93
  94   // This leads to an explosion of the search graph which cannot be reduced:
  95   if (MC_is_active() || MC_record_replay_is_active())
  96     return;
  97   // wait for all pending asynchronous comms to finish
  98   finalization_barrier_->wait();
  99 }
 100
 101 /** @brief Check if a process is finalized */
 102 int ActorExt::finalized()
 103 {
 104   return (state_ == SmpiProcessState::FINALIZED);
 105 }
 106
 107 /** @brief Check if a process is initialized */
 108 int ActorExt::initialized()
 109 {
 110   // TODO cheinrich: Check if we still need this. This should be a global condition, not for a
 111   // single process ... ?
 112   return (state_ == SmpiProcessState::INITIALIZED);
 113 }
 114
 115 /** @brief Mark a process as initialized (=MPI_Init called) */
 116 void ActorExt::mark_as_initialized()
 117 {
 118   if (state_ != SmpiProcessState::FINALIZED)
 119     state_ = SmpiProcessState::INITIALIZED;
 120 }
 121
 122 void ActorExt::set_replaying(bool value)
 123 {
 124   if (state_ != SmpiProcessState::FINALIZED)
 125     replaying_ = value;
 126 }
 127
 128 bool ActorExt::replaying()
 129 {
 130   return replaying_;
 131 }
 132
 133 void ActorExt::set_user_data(void* data)
 134 {
 135   data_ = data;
 136 }
 137
 138 void* ActorExt::get_user_data()
 139 {
 140   return data_;
 141 }
 142
 143 ActorPtr ActorExt::get_actor()
 144 {
 145   return actor_;
 146 }
 147
 148 /**
 149  * \brief Returns a structure that stores the location (filename + linenumber) of the last calls to MPI_* functions.
 150  *
 151  * \see smpi_trace_set_call_location
 152  */
 153 smpi_trace_call_location_t* ActorExt::call_location()
 154 {
 155   return &trace_call_loc_;
 156 }
 157
 158 void ActorExt::set_privatized_region(smpi_privatization_region_t region)
 159 {
 160   privatized_region_ = region;
 161 }
 162
 163 smpi_privatization_region_t ActorExt::privatized_region()
 164 {
 165   return privatized_region_;
 166 }
 167
 168 MPI_Comm ActorExt::comm_world()
 169 {
 170   return comm_world_ == nullptr ? MPI_COMM_NULL : *comm_world_;
 171 }
 172
 173 smx_mailbox_t ActorExt::mailbox()
 174 {
 175   return mailbox_->get_impl();
 176 }
 177
 178 smx_mailbox_t ActorExt::mailbox_small()
 179 {
 180   return mailbox_small_->get_impl();
 181 }
 182
 183 xbt_mutex_t ActorExt::mailboxes_mutex()
 184 {
 185   return mailboxes_mutex_;
 186 }
 187
 188 #if HAVE_PAPI
 189 int ActorExt::papi_event_set()
 190 {
 191   return papi_event_set_;
 192 }
 193
 194 papi_counter_t& ActorExt::papi_counters()
 195 {
 196   return papi_counter_data_;
 197 }
 198 #endif
 199
 200 xbt_os_timer_t ActorExt::timer()
 201 {
 202   return timer_;
 203 }
 204
 205 void ActorExt::simulated_start()
 206 {
 207   simulated_ = SIMIX_get_clock();
 208 }
 209
 210 double ActorExt::simulated_elapsed()
 211 {
 212   return SIMIX_get_clock() - simulated_;
 213 }
 214
 215 MPI_Comm ActorExt::comm_self()
 216 {
 217   if (comm_self_ == MPI_COMM_NULL) {
 218     MPI_Group group = new Group(1);
 219     comm_self_      = new Comm(group, nullptr);
 220     group->set_mapping(actor_, 0);
 221   }
 222   return comm_self_;
 223 }
 224
 225 MPI_Comm ActorExt::comm_intra()
 226 {
 227   return comm_intra_;
 228 }
 229
 230 void ActorExt::set_comm_intra(MPI_Comm comm)
 231 {
 232   comm_intra_ = comm;
 233 }
 234
 235 void ActorExt::set_sampling(int s)
 236 {
 237   sampling_ = s;
 238 }
 239
 240 int ActorExt::sampling()
 241 {
 242   return sampling_;
 243 }
 244
 245 void ActorExt::init(int* argc, char*** argv)
 246 {
 247
 248   if (smpi_process_count() == 0) {
 249     xbt_die("SimGrid was not initialized properly before entering MPI_Init. Aborting, please check compilation process "
 250             "and use smpirun\n");
 251   }
 252   if (argc != nullptr && argv != nullptr) {
 253     simgrid::s4u::ActorPtr proc = simgrid::s4u::Actor::self();
 254     proc->get_impl()->context_->set_cleanup(&MSG_process_cleanup_from_SIMIX);
 255
 256     char* instance_id = (*argv)[1];
 257     try {
 258       int rank = std::stoi(std::string((*argv)[2]));
 259       smpi_deployment_register_process(instance_id, rank, proc);
 260     } catch (std::invalid_argument& ia) {
 261       throw std::invalid_argument(std::string("Invalid rank: ") + (*argv)[2]);
 262     }
 263
 264     // cheinrich: I'm not sure what the impact of the SMPI_switch_data_segment on this call is. I moved
 265     // this up here so that I can set the privatized region before the switch.
 266     ActorExt* process = smpi_process_remote(proc);
 267     if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
 268       /* Now using the segment index of this process  */
 269       process->set_privatized_region(smpi_init_global_memory_segment_process());
 270       /* Done at the process's creation */
 271       SMPI_switch_data_segment(proc);
 272     }
 273
 274     process->set_data(argc, argv);
 275   }
 276   xbt_assert(smpi_process(), "smpi_process() returned nullptr. You probably gave a nullptr parameter to MPI_Init. "
 277                              "Although it's required by MPI-2, this is currently not supported by SMPI. "
 278                              "Please use MPI_Init(&argc, &argv) as usual instead.");
 279 }
 280
 281 int ActorExt::get_optind()
 282 {
 283   return optind;
 284 }
 285 void ActorExt::set_optind(int new_optind)
 286 {
 287   optind = new_optind;
 288 }
 289
 290 } // namespace smpi
 291 } // namespace simgrid