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   xbt_assert(not smpi_process()->initializing());
  41   xbt_assert(not smpi_process()->initialized());
  42
  43   simgrid::smpi::ActorExt::init();
  44   int rank_traced = simgrid::s4u::this_actor::get_pid();
  45   TRACE_smpi_init(rank_traced, __func__);
  46   smpi_bench_begin();
  47   smpi_process()->mark_as_initialized();
  48
  49   smpi_mpi_init();
  50
  51   return MPI_SUCCESS;
  52 }
  53
  54 int PMPI_Finalize()
  55 {
  56   smpi_bench_end();
  57   int rank_traced = simgrid::s4u::this_actor::get_pid();
  58   TRACE_smpi_comm_in(rank_traced, __func__, new simgrid::instr::NoOpTIData("finalize"));
  59
  60   smpi_process()->finalize();
  61
  62   TRACE_smpi_comm_out(rank_traced);
  63   return MPI_SUCCESS;
  64 }
  65
  66 int PMPI_Finalized(int* flag)
  67 {
  68   *flag=smpi_process()!=nullptr ? smpi_process()->finalized() : 0;
  69   return MPI_SUCCESS;
  70 }
  71
  72 int PMPI_Get_version (int *version,int *subversion){
  73   *version = MPI_VERSION;
  74   *subversion= MPI_SUBVERSION;
  75   return MPI_SUCCESS;
  76 }
  77
  78 int PMPI_Get_library_version (char *version,int *len){
  79   snprintf(version, MPI_MAX_LIBRARY_VERSION_STRING, "SMPI Version %d.%d. Copyright The SimGrid Team 2007-2021",
  80            SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR);
  81   *len = strlen(version) > MPI_MAX_LIBRARY_VERSION_STRING ? MPI_MAX_LIBRARY_VERSION_STRING : strlen(version);
  82   return MPI_SUCCESS;
  83 }
  84
  85 int PMPI_Init_thread(int* argc, char*** argv, int /*required*/, int* provided)
  86 {
  87   if (provided != nullptr) {
  88     *provided = MPI_THREAD_SINGLE;
  89   }
  90   return MPI_Init(argc, argv);
  91 }
  92
  93 int PMPI_Query_thread(int *provided)
  94 {
  95   if (provided == nullptr) {
  96     return MPI_ERR_ARG;
  97   } else {
  98     *provided = MPI_THREAD_SINGLE;
  99     return MPI_SUCCESS;
 100   }
 101 }
 102
 103 int PMPI_Is_thread_main(int *flag)
 104 {
 105   // FIXME: The MPI standard seems to say that fatal errors need to be triggered
 106   // if MPI has been finalized or not yet been initialized
 107   if (flag == nullptr) {
 108     return MPI_ERR_ARG;
 109   } else {
 110     *flag = simgrid::s4u::this_actor::get_pid() ==
 111             1; // FIXME: I don't think this is correct: This just returns true if the process ID is 1,
 112                // regardless of whether this process called MPI_Thread_Init() or not.
 113     return MPI_SUCCESS;
 114   }
 115 }
 116
 117 int PMPI_Abort(MPI_Comm /*comm*/, int /*errorcode*/)
 118 {
 119   smpi_bench_end();
 120   // FIXME: should kill all processes in comm instead
 121   XBT_WARN("MPI_Abort was called, something went probably wrong in this simulation ! Killing this process");
 122   smx_actor_t actor = SIMIX_process_self();
 123   simgrid::kernel::actor::simcall([actor] { actor->exit(); });
 124   return MPI_SUCCESS;
 125 }
 126
 127 double PMPI_Wtime()
 128 {
 129   return smpi_mpi_wtime();
 130 }
 131
 132 extern double sg_maxmin_precision;
 133 double PMPI_Wtick()
 134 {
 135   return sg_maxmin_precision;
 136 }
 137
 138 int PMPI_Address(const void* location, MPI_Aint* address)
 139 {
 140   if (address==nullptr) {
 141     return MPI_ERR_ARG;
 142   } else {
 143     *address = reinterpret_cast<MPI_Aint>(location);
 144     return MPI_SUCCESS;
 145   }
 146 }
 147
 148 int PMPI_Get_address(const void *location, MPI_Aint * address)
 149 {
 150   return PMPI_Address(location, address);
 151 }
 152
 153 MPI_Aint PMPI_Aint_add(MPI_Aint address, MPI_Aint disp)
 154 {
 155   if(address > PTRDIFF_MAX - disp)
 156     xbt_die("overflow in MPI_Aint_add");
 157   return address + disp;
 158 }
 159
 160 MPI_Aint PMPI_Aint_diff(MPI_Aint address, MPI_Aint disp)
 161 {
 162   if(address < PTRDIFF_MIN + disp)
 163     xbt_die("underflow in MPI_Aint_diff");
 164   return address - disp;
 165 }
 166
 167 int PMPI_Get_processor_name(char *name, int *resultlen)
 168 {
 169   int len = std::min<int>(sg_host_self()->get_name().size(), MPI_MAX_PROCESSOR_NAME - 1);
 170   std::string(sg_host_self()->get_name()).copy(name, len);
 171   name[len]  = '\0';
 172   *resultlen = len;
 173
 174   return MPI_SUCCESS;
 175 }
 176
 177 int PMPI_Get_count(const MPI_Status * status, MPI_Datatype datatype, int *count)
 178 {
 179   if (status == nullptr || count == nullptr) {
 180     return MPI_ERR_ARG;
 181   } else if (not datatype->is_valid()) {
 182     return MPI_ERR_TYPE;
 183   } else {
 184     size_t size = datatype->size();
 185     if (size == 0) {
 186       *count = 0;
 187       return MPI_SUCCESS;
 188     } else if (status->count % size != 0) {
 189       return MPI_UNDEFINED;
 190     } else {
 191       *count = simgrid::smpi::Status::get_count(status, datatype);
 192       return MPI_SUCCESS;
 193     }
 194   }
 195 }
 196
 197 int PMPI_Initialized(int* flag) {
 198    *flag=(smpi_process()!=nullptr && smpi_process()->initialized());
 199    return MPI_SUCCESS;
 200 }
 201
 202 int PMPI_Alloc_mem(MPI_Aint size, MPI_Info /*info*/, void* baseptr)
 203 {
 204   void *ptr = xbt_malloc(size);
 205   *static_cast<void**>(baseptr) = ptr;
 206   return MPI_SUCCESS;
 207 }
 208
 209 int PMPI_Free_mem(void *baseptr){
 210   xbt_free(baseptr);
 211   return MPI_SUCCESS;
 212 }
 213
 214 int PMPI_Error_class(int errorcode, int* errorclass) {
 215   // assume smpi uses only standard mpi error codes
 216   *errorclass=errorcode;
 217   return MPI_SUCCESS;
 218 }
 219
 220 int PMPI_Error_string(int errorcode, char* string, int* resultlen)
 221 {
 222   static const std::vector<const char*> smpi_error_string = {FOREACH_ERROR(GENERATE_STRING)};
 223   if (errorcode < 0 || static_cast<size_t>(errorcode) >= smpi_error_string.size() || string == nullptr)
 224     return MPI_ERR_ARG;
 225
 226   int len    = snprintf(string, MPI_MAX_ERROR_STRING, "%s", smpi_error_string[errorcode]);
 227   *resultlen = std::min(len, MPI_MAX_ERROR_STRING - 1);
 228   return MPI_SUCCESS;
 229 }
 230
 231 int PMPI_Keyval_create(MPI_Copy_function* copy_fn, MPI_Delete_function* delete_fn, int* keyval, void* extra_state) {
 232   smpi_copy_fn _copy_fn={copy_fn,nullptr,nullptr,nullptr,nullptr,nullptr};
 233   smpi_delete_fn _delete_fn={delete_fn,nullptr,nullptr,nullptr,nullptr,nullptr};
 234   return simgrid::smpi::Keyval::keyval_create<simgrid::smpi::Comm>(_copy_fn, _delete_fn, keyval, extra_state);
 235 }
 236
 237 int PMPI_Keyval_free(int* keyval) {
 238   return simgrid::smpi::Keyval::keyval_free<simgrid::smpi::Comm>(keyval);
 239 }
 240
 241 MPI_Errhandler PMPI_Errhandler_f2c(MPI_Fint errhan){
 242   if(errhan==-1)
 243     return MPI_ERRHANDLER_NULL;
 244   return simgrid::smpi::Errhandler::f2c(errhan);
 245 }
 246
 247 MPI_Fint PMPI_Errhandler_c2f(MPI_Errhandler errhan){
 248   if(errhan==MPI_ERRHANDLER_NULL)
 249     return -1;
 250   return errhan->c2f();
 251 }
 252
 253 int PMPI_Buffer_attach(void *buf, int size){
 254   if(buf==nullptr)
 255     return MPI_ERR_BUFFER;
 256   if(size<0)
 257     return MPI_ERR_ARG;
 258   smpi_process()->set_bsend_buffer(buf, size);
 259   return MPI_SUCCESS;
 260 }
 261
 262 int PMPI_Buffer_detach(void* buffer, int* size){
 263   smpi_process()->bsend_buffer((void**)buffer, size);
 264   smpi_process()->set_bsend_buffer(nullptr, 0);
 265   return MPI_SUCCESS;
 266 }