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