src/smpi/internals/smpi_actor.cpp

   1 /* Copyright (c) 2009-2019. 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/simix/smx_private.hpp"
  11
  12 #if HAVE_PAPI
  13 #include "papi.h"
  14 extern std::string papi_default_config_name;
  15 #endif
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_process, smpi, "Logging specific to SMPI (kernel)");
  18
  19 namespace simgrid {
  20 namespace smpi {
  21
  22 ActorExt::ActorExt(s4u::ActorPtr actor) : actor_(actor)
  23 {
  24   mailbox_         = s4u::Mailbox::by_name("SMPI-" + std::to_string(actor_->get_pid()));
  25   mailbox_small_   = s4u::Mailbox::by_name("small-" + std::to_string(actor_->get_pid()));
  26   mailboxes_mutex_ = s4u::Mutex::create();
  27   timer_           = xbt_os_timer_new();
  28   state_           = SmpiProcessState::UNINITIALIZED;
  29   info_env_        = MPI_INFO_NULL;
  30   if (MC_is_active())
  31     MC_ignore_heap(timer_, xbt_os_timer_size());
  32
  33 #if HAVE_PAPI
  34   if (not simgrid::config::get_value<std::string>("smpi/papi-events").empty()) {
  35     // TODO: Implement host/process/thread based counters. This implementation
  36     // just always takes the values passed via "default", like this:
  37     // "default:COUNTER1:COUNTER2:COUNTER3;".
  38     auto it = units2papi_setup.find(papi_default_config_name);
  39     if (it != units2papi_setup.end()) {
  40       papi_event_set_    = it->second.event_set;
  41       papi_counter_data_ = it->second.counter_data;
  42       XBT_DEBUG("Setting PAPI set for process %li", actor->get_pid());
  43     } else {
  44       papi_event_set_ = PAPI_NULL;
  45       XBT_DEBUG("No PAPI set for process %li", actor->get_pid());
  46     }
  47   }
  48 #endif
  49 }
  50
  51 ActorExt::~ActorExt()
  52 {
  53   if (comm_self_ != MPI_COMM_NULL)
  54     simgrid::smpi::Comm::destroy(comm_self_);
  55   if (comm_intra_ != MPI_COMM_NULL)
  56     simgrid::smpi::Comm::destroy(comm_intra_);
  57   xbt_os_timer_free(timer_);
  58 }
  59
  60 /** @brief Prepares the current process for termination. */
  61 void ActorExt::finalize()
  62 {
  63   state_ = SmpiProcessState::FINALIZED;
  64   XBT_DEBUG("<%ld> Process left the game", actor_->get_pid());
  65
  66   // This leads to an explosion of the search graph which cannot be reduced:
  67   if (MC_is_active() || MC_record_replay_is_active())
  68     return;
  69   // wait for all pending asynchronous comms to finish
  70   finalization_barrier_->wait();
  71 }
  72
  73 /** @brief Check if a process is finalized */
  74 int ActorExt::finalized()
  75 {
  76   return (state_ == SmpiProcessState::FINALIZED);
  77 }
  78
  79 /** @brief Check if a process is partially initialized already */
  80 int ActorExt::initializing()
  81 {
  82   return (state_ == SmpiProcessState::INITIALIZING);
  83 }
  84
  85 /** @brief Check if a process is initialized */
  86 int ActorExt::initialized()
  87 {
  88   // TODO cheinrich: Check if we still need this. This should be a global condition, not for a
  89   // single process ... ?
  90   return (state_ == SmpiProcessState::INITIALIZED);
  91 }
  92
  93 /** @brief Mark a process as initialized (=MPI_Init called) */
  94 void ActorExt::mark_as_initialized()
  95 {
  96   if (state_ != SmpiProcessState::FINALIZED)
  97     state_ = SmpiProcessState::INITIALIZED;
  98 }
  99
 100 void ActorExt::set_replaying(bool value)
 101 {
 102   if (state_ != SmpiProcessState::FINALIZED)
 103     replaying_ = value;
 104 }
 105
 106 bool ActorExt::replaying()
 107 {
 108   return replaying_;
 109 }
 110
 111 s4u::ActorPtr ActorExt::get_actor()
 112 {
 113   return actor_;
 114 }
 115
 116 /**
 117  * @brief Returns a structure that stores the location (filename + linenumber) of the last calls to MPI_* functions.
 118  *
 119  * @see smpi_trace_set_call_location
 120  */
 121 smpi_trace_call_location_t* ActorExt::call_location()
 122 {
 123   return &trace_call_loc_;
 124 }
 125
 126 void ActorExt::set_privatized_region(smpi_privatization_region_t region)
 127 {
 128   privatized_region_ = region;
 129 }
 130
 131 smpi_privatization_region_t ActorExt::privatized_region()
 132 {
 133   return privatized_region_;
 134 }
 135
 136 MPI_Comm ActorExt::comm_world()
 137 {
 138   return comm_world_ == nullptr ? MPI_COMM_NULL : *comm_world_;
 139 }
 140
 141 s4u::MutexPtr ActorExt::mailboxes_mutex()
 142 {
 143   return mailboxes_mutex_;
 144 }
 145
 146 #if HAVE_PAPI
 147 int ActorExt::papi_event_set()
 148 {
 149   return papi_event_set_;
 150 }
 151
 152 papi_counter_t& ActorExt::papi_counters()
 153 {
 154   return papi_counter_data_;
 155 }
 156 #endif
 157
 158 xbt_os_timer_t ActorExt::timer()
 159 {
 160   return timer_;
 161 }
 162
 163 void ActorExt::simulated_start()
 164 {
 165   simulated_ = SIMIX_get_clock();
 166 }
 167
 168 double ActorExt::simulated_elapsed()
 169 {
 170   return SIMIX_get_clock() - simulated_;
 171 }
 172
 173 MPI_Comm ActorExt::comm_self()
 174 {
 175   if (comm_self_ == MPI_COMM_NULL) {
 176     MPI_Group group = new Group(1);
 177     comm_self_      = new Comm(group, nullptr);
 178     group->set_mapping(actor_, 0);
 179   }
 180   return comm_self_;
 181 }
 182
 183 MPI_Info ActorExt::info_env()
 184 {
 185   return info_env_;
 186 }
 187
 188 MPI_Comm ActorExt::comm_intra()
 189 {
 190   return comm_intra_;
 191 }
 192
 193 void ActorExt::set_comm_intra(MPI_Comm comm)
 194 {
 195   comm_intra_ = comm;
 196 }
 197
 198 void ActorExt::set_sampling(int s)
 199 {
 200   sampling_ = s;
 201 }
 202
 203 int ActorExt::sampling()
 204 {
 205   return sampling_;
 206 }
 207
 208 void ActorExt::init()
 209 {
 210   xbt_assert(smpi_get_universe_size() != 0, "SimGrid was not initialized properly before entering MPI_Init. "
 211                                             "Aborting, please check compilation process and use smpirun.");
 212
 213   simgrid::s4u::ActorPtr self = simgrid::s4u::Actor::self();
 214   // cheinrich: I'm not sure what the impact of the SMPI_switch_data_segment on this call is. I moved
 215   // this up here so that I can set the privatized region before the switch.
 216   ActorExt* ext = smpi_process();
 217   // if we are in MPI_Init and argc handling has already been done.
 218   if (ext->initialized())
 219     return;
 220
 221   if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
 222     /* Now using the segment index of this process  */
 223     ext->set_privatized_region(smpi_init_global_memory_segment_process());
 224     /* Done at the process's creation */
 225     SMPI_switch_data_segment(self);
 226   }
 227
 228   std::string instance_id = self->get_property("instance_id");
 229   const int rank          = xbt_str_parse_int(self->get_property("rank"), "Cannot parse rank");
 230
 231   ext->state_ = SmpiProcessState::INITIALIZING;
 232   smpi_deployment_register_process(instance_id, rank, self);
 233
 234   ext->instance_id_              = instance_id;
 235   ext->comm_world_               = smpi_deployment_comm_world(instance_id);
 236   simgrid::s4u::Barrier* barrier = smpi_deployment_finalization_barrier(instance_id);
 237   if (barrier != nullptr) // don't overwrite the current one if the instance has none
 238     ext->finalization_barrier_ = barrier;
 239
 240   // set the process attached to the mailbox
 241   ext->mailbox_small_->set_receiver(ext->actor_);
 242   XBT_DEBUG("<%ld> SMPI process has been initialized: %p", ext->actor_->get_pid(), ext->actor_.get());
 243 }
 244
 245 int ActorExt::get_optind()
 246 {
 247   return optind_;
 248 }
 249
 250 void ActorExt::set_optind(int new_optind)
 251 {
 252   optind_ = new_optind;
 253 }
 254
 255 } // namespace smpi
 256 } // namespace simgrid