src/smpi/bindings/smpi_pmpi.cpp

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