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