src/smpi/bindings/smpi_pmpi.cpp

   1 /* Copyright (c) 2007-2022. 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 "private.hpp"
   7 #include "simgrid/instr.h"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "simgrid/s4u/Host.hpp"
  10 #include "simgrid/version.h"
  11 #include "smpi_coll.hpp"
  12 #include "smpi_comm.hpp"
  13 #include "smpi_datatype_derived.hpp"
  14 #include "smpi_status.hpp"
  15 #include "src/kernel/EngineImpl.hpp"
  16 #include "src/kernel/actor/ActorImpl.hpp"
  17 #include "src/smpi/include/smpi_actor.hpp"
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_pmpi, smpi, "Logging specific to SMPI (pmpi)");
  20
  21 //this function need to be here because of the calls to smpi_bench
  22 void TRACE_smpi_set_category(const char *category)
  23 {
  24   //need to end bench otherwise categories for execution tasks are wrong
  25   const SmpiBenchGuard suspend_bench;
  26
  27   if (category != nullptr) {
  28     // declare category
  29     simgrid::instr::declare_tracing_category(category);
  30     smpi_process()->set_tracing_category(category);
  31   }
  32 }
  33
  34 /* PMPI User level calls */
  35
  36 int PMPI_Init(int*, char***)
  37 {
  38   xbt_assert(simgrid::s4u::Engine::is_initialized(),
  39              "Your MPI program was not properly initialized. The easiest is to use smpirun to start it.");
  40
  41   if(smpi_process()->initializing()){
  42     XBT_WARN("SMPI is already initializing - MPI_Init called twice ?");
  43     return MPI_ERR_OTHER;
  44   }
  45   if(smpi_process()->initialized()){
  46     XBT_WARN("SMPI already initialized once - MPI_Init called twice ?");
  47     return MPI_ERR_OTHER;
  48   }
  49   if(smpi_process()->finalized()){
  50     XBT_WARN("SMPI already finalized");
  51     return MPI_ERR_OTHER;
  52   }
  53
  54   simgrid::smpi::ActorExt::init();
  55   TRACE_smpi_init(simgrid::s4u::this_actor::get_pid(), __func__);
  56   smpi_bench_begin();
  57   smpi_process()->mark_as_initialized();
  58
  59   smpi_mpi_init();
  60
  61   return MPI_SUCCESS;
  62 }
  63
  64 int PMPI_Finalize()
  65 {
  66   smpi_bench_end();
  67   aid_t rank_traced = simgrid::s4u::this_actor::get_pid();
  68   smpi_process()->mark_as_finalizing();
  69   TRACE_smpi_comm_in(rank_traced, __func__, new simgrid::instr::NoOpTIData("finalize"));
  70
  71   if(simgrid::config::get_value<bool>("smpi/finalization-barrier"))
  72     simgrid::smpi::colls::barrier(MPI_COMM_WORLD);
  73
  74   smpi_process()->finalize();
  75
  76   TRACE_smpi_comm_out(rank_traced);
  77   return MPI_SUCCESS;
  78 }
  79
  80 int PMPI_Finalized(int* flag)
  81 {
  82   *flag=smpi_process()!=nullptr ? smpi_process()->finalized() : 0;
  83   return MPI_SUCCESS;
  84 }
  85
  86 int PMPI_Get_version (int *version,int *subversion){
  87   *version = MPI_VERSION;
  88   *subversion= MPI_SUBVERSION;
  89   return MPI_SUCCESS;
  90 }
  91
  92 int PMPI_Get_library_version (char *version,int *len){
  93   snprintf(version, MPI_MAX_LIBRARY_VERSION_STRING, "SMPI Version %d.%d. Copyright The SimGrid Team 2007-2022",
  94            SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR);
  95   *len = std::min(static_cast<int>(strlen(version)), MPI_MAX_LIBRARY_VERSION_STRING);
  96   return MPI_SUCCESS;
  97 }
  98
  99 int PMPI_Init_thread(int* argc, char*** argv, int /*required*/, int* provided)
 100 {
 101   if (provided != nullptr) {
 102     *provided = MPI_THREAD_SINGLE;
 103   }
 104   return MPI_Init(argc, argv);
 105 }
 106
 107 int PMPI_Query_thread(int *provided)
 108 {
 109   if (provided == nullptr) {
 110     return MPI_ERR_ARG;
 111   } else {
 112     *provided = MPI_THREAD_SINGLE;
 113     return MPI_SUCCESS;
 114   }
 115 }
 116
 117 int PMPI_Is_thread_main(int *flag)
 118 {
 119   // FIXME: The MPI standard seems to say that fatal errors need to be triggered
 120   // if MPI has been finalized or not yet been initialized
 121   if (flag == nullptr) {
 122     return MPI_ERR_ARG;
 123   } else {
 124     *flag = simgrid::s4u::this_actor::get_pid() ==
 125             1; // FIXME: I don't think this is correct: This just returns true if the process ID is 1,
 126                // regardless of whether this process called MPI_Thread_Init() or not.
 127     return MPI_SUCCESS;
 128   }
 129 }
 130
 131 int PMPI_Abort(MPI_Comm comm, int /*errorcode*/)
 132 {
 133   smpi_bench_end();
 134   CHECK_COMM(1)
 135   XBT_WARN("MPI_Abort was called, something went probably wrong in this simulation ! Killing all processes sharing the same MPI_COMM_WORLD");
 136   auto myself = simgrid::kernel::actor::ActorImpl::self();
 137   for (int i = 0; i < comm->size(); i++){
 138     auto actor = simgrid::kernel::EngineImpl::get_instance()->get_actor_by_pid(comm->group()->actor(i));
 139     if (actor != nullptr && actor != myself)
 140       simgrid::kernel::actor::simcall_answered([actor] { actor->exit(); });
 141   }
 142   // now ourself
 143   simgrid::kernel::actor::simcall_answered([myself] { myself->exit(); });
 144   return MPI_SUCCESS;
 145 }
 146
 147 double PMPI_Wtime()
 148 {
 149   return smpi_mpi_wtime();
 150 }
 151
 152 extern double sg_maxmin_precision;
 153 double PMPI_Wtick()
 154 {
 155   return sg_maxmin_precision;
 156 }
 157
 158 int PMPI_Address(const void* location, MPI_Aint* address)
 159 {
 160   if (address==nullptr) {
 161     return MPI_ERR_ARG;
 162   } else {
 163     *address = reinterpret_cast<MPI_Aint>(location);
 164     return MPI_SUCCESS;
 165   }
 166 }
 167
 168 int PMPI_Get_address(const void *location, MPI_Aint * address)
 169 {
 170   return PMPI_Address(location, address);
 171 }
 172
 173 MPI_Aint PMPI_Aint_add(MPI_Aint address, MPI_Aint disp)
 174 {
 175   xbt_assert(address <= PTRDIFF_MAX - disp, "overflow in MPI_Aint_add");
 176   return address + disp;
 177 }
 178
 179 MPI_Aint PMPI_Aint_diff(MPI_Aint address, MPI_Aint disp)
 180 {
 181   xbt_assert(address >= PTRDIFF_MIN + disp, "underflow in MPI_Aint_diff");
 182   return address - disp;
 183 }
 184
 185 int PMPI_Get_processor_name(char *name, int *resultlen)
 186 {
 187   int len = std::min(static_cast<int>(sg_host_self()->get_name().size()), MPI_MAX_PROCESSOR_NAME - 1);
 188   std::string(sg_host_self()->get_name()).copy(name, len);
 189   name[len]  = '\0';
 190   *resultlen = len;
 191
 192   return MPI_SUCCESS;
 193 }
 194
 195 int PMPI_Get_count(const MPI_Status * status, MPI_Datatype datatype, int *count)
 196 {
 197   if (status == nullptr || count == nullptr) {
 198     return MPI_ERR_ARG;
 199   } else if (not datatype->is_valid()) {
 200     return MPI_ERR_TYPE;
 201   } else {
 202     size_t size = datatype->size();
 203     if (size == 0) {
 204       *count = 0;
 205     } else if (status->count % size != 0) {
 206       *count = MPI_UNDEFINED;
 207     } else {
 208       *count = simgrid::smpi::Status::get_count(status, datatype);
 209     }
 210     return MPI_SUCCESS;
 211   }
 212 }
 213
 214 int PMPI_Initialized(int* flag) {
 215    *flag=(smpi_process()!=nullptr && smpi_process()->initialized());
 216    return MPI_SUCCESS;
 217 }
 218
 219 int PMPI_Alloc_mem(MPI_Aint size, MPI_Info /*info*/, void* baseptr)
 220 {
 221   CHECK_NEGATIVE(1, MPI_ERR_COUNT, size)
 222   void *ptr = xbt_malloc(size);
 223   *static_cast<void**>(baseptr) = ptr;
 224   return MPI_SUCCESS;
 225 }
 226
 227 int PMPI_Free_mem(void *baseptr){
 228   xbt_free(baseptr);
 229   return MPI_SUCCESS;
 230 }
 231
 232 int PMPI_Error_class(int errorcode, int* errorclass) {
 233   // assume smpi uses only standard mpi error codes
 234   *errorclass=errorcode;
 235   return MPI_SUCCESS;
 236 }
 237
 238 int PMPI_Error_string(int errorcode, char* string, int* resultlen)
 239 {
 240   static const std::vector<const char*> smpi_error_string = {FOREACH_ERROR(GENERATE_STRING)};
 241   if (errorcode < 0 || static_cast<size_t>(errorcode) >= smpi_error_string.size() || string == nullptr)
 242     return MPI_ERR_ARG;
 243
 244   int len    = snprintf(string, MPI_MAX_ERROR_STRING, "%s", smpi_error_string[errorcode]);
 245   *resultlen = std::min(len, MPI_MAX_ERROR_STRING - 1);
 246   return MPI_SUCCESS;
 247 }
 248
 249 int PMPI_Keyval_create(MPI_Copy_function* copy_fn, MPI_Delete_function* delete_fn, int* keyval, void* extra_state) {
 250   smpi_copy_fn _copy_fn={copy_fn,nullptr,nullptr,nullptr,nullptr,nullptr};
 251   smpi_delete_fn _delete_fn={delete_fn,nullptr,nullptr,nullptr,nullptr,nullptr};
 252   return simgrid::smpi::Keyval::keyval_create<simgrid::smpi::Comm>(_copy_fn, _delete_fn, keyval, extra_state);
 253 }
 254
 255 int PMPI_Keyval_free(int* keyval) {
 256   CHECK_NULL(1, MPI_ERR_ARG, keyval)
 257   CHECK_VAL(1, MPI_KEYVAL_INVALID, MPI_ERR_KEYVAL, *keyval)
 258   return simgrid::smpi::Keyval::keyval_free<simgrid::smpi::Comm>(keyval);
 259 }
 260
 261 int PMPI_Buffer_attach(void *buf, int size){
 262   if(buf==nullptr)
 263     return MPI_ERR_BUFFER;
 264   if(size<0)
 265     return MPI_ERR_ARG;
 266   return smpi_process()->set_bsend_buffer(buf, size);
 267 }
 268
 269 int PMPI_Buffer_detach(void* buffer, int* size){
 270   smpi_process()->bsend_buffer((void**)buffer, size);
 271   return smpi_process()->set_bsend_buffer(nullptr, 0);
 272 }