1 /* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved. */
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. */
7 #include "simgrid/host.h"
8 #include "simgrid/instr.h"
9 #include "simgrid/s4u/Engine.hpp"
10 #include "simgrid/s4u/Host.hpp"
11 #include "simgrid/version.h"
12 #include "smpi_coll.hpp"
13 #include "smpi_comm.hpp"
14 #include "smpi_datatype_derived.hpp"
15 #include "smpi_status.hpp"
16 #include "src/kernel/EngineImpl.hpp"
17 #include "src/kernel/actor/ActorImpl.hpp"
18 #include "src/smpi/include/smpi_actor.hpp"
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_pmpi, smpi, "Logging specific to SMPI (pmpi)");
22 //this function need to be here because of the calls to smpi_bench
23 void TRACE_smpi_set_category(const char *category)
25 //need to end bench otherwise categories for execution tasks are wrong
26 const SmpiBenchGuard suspend_bench;
28 if (category != nullptr) {
30 simgrid::instr::declare_tracing_category(category);
31 smpi_process()->set_tracing_category(category);
35 /* PMPI User level calls */
37 int PMPI_Init(int*, char***)
39 xbt_assert(simgrid::s4u::Engine::is_initialized(),
40 "Your MPI program was not properly initialized. The easiest is to use smpirun to start it.");
42 if(smpi_process()->initializing()){
43 XBT_WARN("SMPI is already initializing - MPI_Init called twice ?");
46 if(smpi_process()->initialized()){
47 XBT_WARN("SMPI already initialized once - MPI_Init called twice ?");
50 if(smpi_process()->finalized()){
51 XBT_WARN("SMPI already finalized");
55 simgrid::smpi::ActorExt::init();
56 TRACE_smpi_init(simgrid::s4u::this_actor::get_pid(), __func__);
59 smpi_process()->mark_as_initialized();
61 CHECK_COLLECTIVE(smpi_process()->comm_world(), "MPI_Init")
69 CHECK_COLLECTIVE(smpi_process()->comm_world(), "MPI_Finalize")
70 aid_t rank_traced = simgrid::s4u::this_actor::get_pid();
71 smpi_process()->mark_as_finalizing();
72 TRACE_smpi_comm_in(rank_traced, __func__, new simgrid::instr::NoOpTIData("finalize"));
74 if (simgrid::config::get_value<bool>("smpi/barrier-finalization"))
75 simgrid::smpi::colls::barrier(MPI_COMM_WORLD);
77 smpi_process()->finalize();
79 TRACE_smpi_comm_out(rank_traced);
83 int PMPI_Finalized(int* flag)
85 *flag=smpi_process()!=nullptr ? smpi_process()->finalized() : 0;
89 int PMPI_Get_version (int *version,int *subversion){
90 *version = MPI_VERSION;
91 *subversion= MPI_SUBVERSION;
95 int PMPI_Get_library_version (char *version,int *len){
96 snprintf(version, MPI_MAX_LIBRARY_VERSION_STRING, "SMPI Version %d.%d. Copyright The SimGrid Team 2007-2023",
97 SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR);
98 *len = std::min(static_cast<int>(strlen(version)), MPI_MAX_LIBRARY_VERSION_STRING);
102 int PMPI_Init_thread(int* argc, char*** argv, int /*required*/, int* provided)
104 if (provided != nullptr) {
105 *provided = MPI_THREAD_SINGLE;
107 return MPI_Init(argc, argv);
110 int PMPI_Query_thread(int *provided)
112 if (provided == nullptr) {
115 *provided = MPI_THREAD_SINGLE;
120 int PMPI_Is_thread_main(int *flag)
122 // FIXME: The MPI standard seems to say that fatal errors need to be triggered
123 // if MPI has been finalized or not yet been initialized
124 if (flag == nullptr) {
127 *flag = simgrid::s4u::this_actor::get_pid() ==
128 1; // FIXME: I don't think this is correct: This just returns true if the process ID is 1,
129 // regardless of whether this process called MPI_Thread_Init() or not.
134 int PMPI_Abort(MPI_Comm comm, int /*errorcode*/)
138 XBT_WARN("MPI_Abort was called, something went probably wrong in this simulation ! Killing all processes sharing the same MPI_COMM_WORLD");
139 auto* myself = simgrid::kernel::actor::ActorImpl::self();
140 for (int i = 0; i < comm->size(); i++){
141 auto* actor = simgrid::kernel::EngineImpl::get_instance()->get_actor_by_pid(comm->group()->actor(i));
142 if (actor != nullptr && actor != myself)
143 simgrid::kernel::actor::simcall_answered([actor] { actor->exit(); });
146 simgrid::kernel::actor::simcall_answered([myself] { myself->exit(); });
152 return smpi_mpi_wtime();
155 extern double sg_precision_timing;
158 return sg_precision_timing;
161 int PMPI_Address(const void* location, MPI_Aint* address)
163 if (address==nullptr) {
166 *address = reinterpret_cast<MPI_Aint>(location);
171 int PMPI_Get_address(const void *location, MPI_Aint * address)
173 return PMPI_Address(location, address);
176 MPI_Aint PMPI_Aint_add(MPI_Aint address, MPI_Aint disp)
178 xbt_assert(address <= PTRDIFF_MAX - disp, "overflow in MPI_Aint_add");
179 return address + disp;
182 MPI_Aint PMPI_Aint_diff(MPI_Aint address, MPI_Aint disp)
184 xbt_assert(address >= PTRDIFF_MIN + disp, "underflow in MPI_Aint_diff");
185 return address - disp;
188 int PMPI_Get_processor_name(char *name, int *resultlen)
190 int len = std::min(static_cast<int>(sg_host_self()->get_name().size()), MPI_MAX_PROCESSOR_NAME - 1);
191 sg_host_self()->get_name().copy(name, len);
198 int PMPI_Get_count(const MPI_Status * status, MPI_Datatype datatype, int *count)
200 if (status == nullptr || count == nullptr) {
202 } else if (not datatype->is_valid()) {
205 if (datatype->size() == 0) {
207 } else if (status->count % datatype->size() != 0) {
208 *count = MPI_UNDEFINED;
210 *count = simgrid::smpi::Status::get_count(status, datatype);
216 int PMPI_Initialized(int* flag) {
217 *flag=(smpi_process()!=nullptr && smpi_process()->initialized());
221 int PMPI_Alloc_mem(MPI_Aint size, MPI_Info /*info*/, void* baseptr)
223 CHECK_NEGATIVE(1, MPI_ERR_COUNT, size)
224 void *ptr = xbt_malloc(size);
225 *static_cast<void**>(baseptr) = ptr;
229 int PMPI_Free_mem(void *baseptr){
234 int PMPI_Error_class(int errorcode, int* errorclass) {
235 // assume smpi uses only standard mpi error codes
236 *errorclass=errorcode;
240 int PMPI_Error_string(int errorcode, char* string, int* resultlen)
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)
246 int len = snprintf(string, MPI_MAX_ERROR_STRING, "%s", smpi_error_string[errorcode]);
247 *resultlen = std::min(len, MPI_MAX_ERROR_STRING - 1);
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);
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);
263 int PMPI_Buffer_attach(void *buf, int size){
265 return MPI_ERR_BUFFER;
268 return smpi_process()->set_bsend_buffer(buf, size);
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);