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