src/smpi/bindings/smpi_pmpi.cpp

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