src/smpi/mpi/smpi_request.cpp

   1 /* Copyright (c) 2007-2023. 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 "smpi_request.hpp"
   7
   8 #include "private.hpp"
   9 #include "simgrid/Exception.hpp"
  10 #include "simgrid/s4u/ConditionVariable.hpp"
  11 #include "simgrid/s4u/Exec.hpp"
  12 #include "simgrid/s4u/Mutex.hpp"
  13 #include "smpi_comm.hpp"
  14 #include "smpi_datatype.hpp"
  15 #include "smpi_host.hpp"
  16 #include "smpi_op.hpp"
  17 #include "src/kernel/EngineImpl.hpp"
  18 #include "src/kernel/activity/CommImpl.hpp"
  19 #include "src/kernel/actor/ActorImpl.hpp"
  20 #include "src/kernel/actor/SimcallObserver.hpp"
  21 #include "src/mc/mc.h"
  22 #include "src/mc/mc_replay.hpp"
  23 #include "src/smpi/include/smpi_actor.hpp"
  24
  25 #include <algorithm>
  26 #include <array>
  27 #include <mutex> // std::scoped_lock and std::unique_lock
  28
  29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_request, smpi, "Logging specific to SMPI (request)");
  30
  31 static simgrid::config::Flag<double> smpi_iprobe_sleep(
  32   "smpi/iprobe", "Minimum time to inject inside a call to MPI_Iprobe", 1e-4);
  33 static simgrid::config::Flag<double> smpi_test_sleep(
  34   "smpi/test", "Minimum time to inject inside a call to MPI_Test", 1e-4);
  35
  36 extern std::function<void(simgrid::kernel::activity::CommImpl*, void*, size_t)> smpi_comm_copy_data_callback;
  37
  38 namespace simgrid::smpi {
  39
  40 Request::Request(const void* buf, int count, MPI_Datatype datatype, aid_t src, aid_t dst, int tag, MPI_Comm comm,
  41                  unsigned flags, MPI_Op op)
  42     : buf_(const_cast<void*>(buf))
  43     , old_buf_(buf_)
  44     , type_(datatype)
  45     , size_(datatype->size() * count)
  46     , src_(src)
  47     , dst_(dst)
  48     , tag_(tag)
  49     , comm_(comm)
  50     , flags_(flags)
  51     , op_(op)
  52 {
  53   datatype->ref();
  54   comm_->ref();
  55   if(op != MPI_REPLACE && op != MPI_OP_NULL)
  56     op_->ref();
  57   action_          = nullptr;
  58   detached_        = false;
  59   detached_sender_ = nullptr;
  60   real_src_        = 0;
  61   // get src_host if it's available (src is valid)
  62   if (auto src_process = simgrid::s4u::Actor::by_pid(src))
  63     src_host_ = src_process->get_host();
  64   truncated_       = false;
  65   unmatched_types_ = false;
  66   real_size_       = 0;
  67   real_tag_        = 0;
  68   if (flags & MPI_REQ_PERSISTENT)
  69     refcount_ = 1;
  70   else
  71     refcount_ = 0;
  72   message_id_ = 0;
  73   init_buffer(count);
  74   this->add_f();
  75 }
  76
  77 void Request::ref(){
  78   refcount_++;
  79 }
  80
  81 void Request::unref(MPI_Request* request)
  82 {
  83   xbt_assert(*request != MPI_REQUEST_NULL, "freeing an already free request");
  84
  85   (*request)->refcount_--;
  86   if ((*request)->refcount_ < 0) {
  87     (*request)->print_request("wrong refcount");
  88     xbt_die("Whoops, wrong refcount");
  89   }
  90   if ((*request)->refcount_ == 0) {
  91     if ((*request)->flags_ & MPI_REQ_GENERALIZED) {
  92       ((*request)->generalized_funcs)->free_fn(((*request)->generalized_funcs)->extra_state);
  93     } else {
  94       Comm::unref((*request)->comm_);
  95       Datatype::unref((*request)->type_);
  96     }
  97     if ((*request)->op_ != MPI_REPLACE && (*request)->op_ != MPI_OP_NULL)
  98       Op::unref(&(*request)->op_);
  99
 100     (*request)->print_request("Destroying");
 101     F2C::free_f((*request)->f2c_id());
 102     delete *request;
 103     *request = MPI_REQUEST_NULL;
 104   } else {
 105     (*request)->print_request("Decrementing");
 106   }
 107 }
 108
 109 bool Request::match_types(MPI_Datatype stype, MPI_Datatype rtype){
 110   bool match = false;
 111   if ((stype == rtype) ||
 112      //byte and packed always match with anything
 113      (stype == MPI_PACKED || rtype == MPI_PACKED || stype == MPI_BYTE || rtype == MPI_BYTE) ||
 114      //complex datatypes - we don't properly match these yet, as it would mean checking each subtype recursively.
 115      (stype->flags() & DT_FLAG_DERIVED || rtype->flags() & DT_FLAG_DERIVED) ||
 116      //duplicated datatypes, check if underlying is ok
 117      (stype->duplicated_datatype()!=MPI_DATATYPE_NULL && match_types(stype->duplicated_datatype(), rtype)) ||
 118      (rtype->duplicated_datatype()!=MPI_DATATYPE_NULL && match_types(stype, rtype->duplicated_datatype())))
 119     match = true;
 120   if (not match)
 121     XBT_WARN("Mismatched datatypes : sending %s and receiving %s", stype->name().c_str(), rtype->name().c_str());
 122   return match;
 123 }
 124
 125
 126 bool Request::match_common(MPI_Request req, MPI_Request sender, MPI_Request receiver)
 127 {
 128   xbt_assert(sender, "Cannot match against null sender");
 129   xbt_assert(receiver, "Cannot match against null receiver");
 130   XBT_DEBUG("Trying to match %s of sender src %ld against %ld, tag %d against %d, id %d against %d",
 131             (req == receiver ? "send" : "recv"), sender->src_, receiver->src_, sender->tag_, receiver->tag_,
 132             sender->comm_->id(), receiver->comm_->id());
 133
 134   if ((receiver->comm_->id() == MPI_UNDEFINED || sender->comm_->id() == MPI_UNDEFINED ||
 135        receiver->comm_->id() == sender->comm_->id()) &&
 136       ((receiver->src_ == MPI_ANY_SOURCE && (receiver->comm_->group()->rank(sender->src_) != MPI_UNDEFINED)) ||
 137        receiver->src_ == sender->src_) &&
 138       ((receiver->tag_ == MPI_ANY_TAG && sender->tag_ >= 0) || receiver->tag_ == sender->tag_)) {
 139     // we match, we can transfer some values
 140     if (receiver->src_ == MPI_ANY_SOURCE) {
 141       receiver->real_src_ = sender->src_;
 142       receiver->src_host_ = sender->src_host_;
 143     }
 144     if (receiver->tag_ == MPI_ANY_TAG)
 145       receiver->real_tag_ = sender->tag_;
 146     if ((receiver->flags_ & MPI_REQ_PROBE) == 0 && receiver->real_size_ < sender->real_size_) {
 147       XBT_DEBUG("Truncating message - should not happen: receiver size : %zu < sender size : %zu", receiver->real_size_,
 148                 sender->real_size_);
 149       receiver->truncated_ = true;
 150     }
 151     //0-sized datatypes/counts should not interfere and match
 152     if (sender->real_size_ != 0 && receiver->real_size_ != 0 && not match_types(sender->type_, receiver->type_))
 153       receiver->unmatched_types_ = true;
 154     if (sender->detached_)
 155       receiver->detached_sender_ = sender; // tie the sender to the receiver, as it is detached and has to be freed in
 156                                            // the receiver
 157     req->flags_ |= MPI_REQ_MATCHED; // mark as impossible to cancel anymore
 158     XBT_DEBUG("match succeeded");
 159     return true;
 160   }
 161   return false;
 162 }
 163
 164 void Request::init_buffer(int count){
 165 // FIXME Handle the case of a partial shared malloc.
 166   // This part handles the problem of non-contiguous memory (for the unserialization at the reception)
 167   if (not smpi_process()->replaying() &&
 168      ((((flags_ & MPI_REQ_RECV) != 0) && ((flags_ & MPI_REQ_ACCUMULATE) != 0)) || (type_->flags() & DT_FLAG_DERIVED))) {
 169     // This part handles the problem of non-contiguous memory
 170     old_buf_ = buf_;
 171     if (count==0){
 172       buf_ = nullptr;
 173     }else {
 174       buf_ = xbt_malloc(count*type_->size());
 175       if ((type_->flags() & DT_FLAG_DERIVED) && ((flags_ & MPI_REQ_SEND) != 0)) {
 176         type_->serialize(old_buf_, buf_, count);
 177       }
 178     }
 179   }
 180 }
 181
 182 bool Request::match_recv(void* a, void* b, simgrid::kernel::activity::CommImpl*)
 183 {
 184   auto ref = static_cast<MPI_Request>(a);
 185   auto req = static_cast<MPI_Request>(b);
 186   bool match = match_common(req, req, ref);
 187   if (not match || ref->comm_ == MPI_COMM_UNINITIALIZED || ref->comm_->is_smp_comm())
 188     return match;
 189
 190   if (ref->comm_->get_received_messages_count(ref->comm_->group()->rank(req->src_),
 191                                               ref->comm_->group()->rank(req->dst_), req->tag_) == req->message_id_) {
 192     if (((ref->flags_ & MPI_REQ_PROBE) == 0) && ((req->flags_ & MPI_REQ_PROBE) == 0)) {
 193       XBT_DEBUG("increasing count in comm %p, which was %u from pid %ld, to pid %ld with tag %d", ref->comm_,
 194                 ref->comm_->get_received_messages_count(ref->comm_->group()->rank(req->src_),
 195                                                         ref->comm_->group()->rank(req->dst_), req->tag_),
 196                 req->src_, req->dst_, req->tag_);
 197       ref->comm_->increment_received_messages_count(ref->comm_->group()->rank(req->src_),
 198                                                     ref->comm_->group()->rank(req->dst_), req->tag_);
 199       if (ref->real_size_ > req->real_size_) {
 200         ref->real_size_ = req->real_size_;
 201       }
 202     }
 203   } else {
 204     match = false;
 205     req->flags_ &= ~MPI_REQ_MATCHED;
 206     ref->detached_sender_ = nullptr;
 207     XBT_DEBUG("Refusing to match message, as its ID is not the one I expect. in comm %p, %u != %u, "
 208               "from pid %ld to pid %ld, with tag %d",
 209               ref->comm_,
 210               ref->comm_->get_received_messages_count(ref->comm_->group()->rank(req->src_),
 211                                                       ref->comm_->group()->rank(req->dst_), req->tag_),
 212               req->message_id_, req->src_, req->dst_, req->tag_);
 213   }
 214   return match;
 215 }
 216
 217 bool Request::match_send(void* a, void* b, simgrid::kernel::activity::CommImpl*)
 218 {
 219   auto ref = static_cast<MPI_Request>(a);
 220   auto req = static_cast<MPI_Request>(b);
 221   return match_common(req, ref, req);
 222 }
 223
 224 void Request::print_request(const char* message) const
 225 {
 226   XBT_VERB("%s  request %p  [buf = %p, size = %zu, src = %ld, dst = %ld, tag = %d, flags = %x]", message, this, buf_,
 227            size_, src_, dst_, tag_, flags_);
 228 }
 229
 230 /* factories, to hide the internal flags from the caller */
 231 MPI_Request Request::bsend_init(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 232 {
 233   return new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 234                      dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 235                      MPI_REQ_PERSISTENT | MPI_REQ_SEND | MPI_REQ_PREPARED | MPI_REQ_BSEND);
 236 }
 237
 238 MPI_Request Request::send_init(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 239 {
 240   return new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 241                      dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 242                      MPI_REQ_PERSISTENT | MPI_REQ_SEND | MPI_REQ_PREPARED);
 243 }
 244
 245 MPI_Request Request::ssend_init(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 246 {
 247   return new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 248                      dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 249                      MPI_REQ_PERSISTENT | MPI_REQ_SSEND | MPI_REQ_SEND | MPI_REQ_PREPARED);
 250 }
 251
 252 MPI_Request Request::isend_init(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 253 {
 254   return new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 255                      dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 256                      MPI_REQ_PERSISTENT | MPI_REQ_ISEND | MPI_REQ_SEND | MPI_REQ_PREPARED);
 257 }
 258
 259 MPI_Request Request::rma_send_init(const void *buf, int count, MPI_Datatype datatype, int src, int dst, int tag, MPI_Comm comm,
 260                                MPI_Op op)
 261 {
 262   MPI_Request request;
 263   if(op==MPI_OP_NULL){
 264     request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, comm->group()->actor(src),
 265                           dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 266                           MPI_REQ_RMA | MPI_REQ_NON_PERSISTENT | MPI_REQ_ISEND | MPI_REQ_SEND | MPI_REQ_PREPARED);
 267   }else{
 268     request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, comm->group()->actor(src),
 269                           dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 270                           MPI_REQ_RMA | MPI_REQ_NON_PERSISTENT | MPI_REQ_ISEND | MPI_REQ_SEND | MPI_REQ_PREPARED |
 271                               MPI_REQ_ACCUMULATE,
 272                           op);
 273   }
 274   return request;
 275 }
 276
 277 MPI_Request Request::recv_init(void *buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm)
 278 {
 279   aid_t source = MPI_PROC_NULL;
 280   if (src == MPI_ANY_SOURCE)
 281     source = MPI_ANY_SOURCE;
 282   else if (src != MPI_PROC_NULL)
 283     source = comm->group()->actor(src);
 284   return new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype,
 285                      source,
 286                      simgrid::s4u::this_actor::get_pid(), tag, comm,
 287                      MPI_REQ_PERSISTENT | MPI_REQ_RECV | MPI_REQ_PREPARED);
 288 }
 289
 290 MPI_Request Request::rma_recv_init(void *buf, int count, MPI_Datatype datatype, int src, int dst, int tag, MPI_Comm comm,
 291                                MPI_Op op)
 292 {
 293   aid_t source        = MPI_PROC_NULL;
 294   if (src == MPI_ANY_SOURCE)
 295     source = MPI_ANY_SOURCE;
 296   else if (src != MPI_PROC_NULL)
 297     source = comm->group()->actor(src);
 298   MPI_Request request;
 299   if(op==MPI_OP_NULL){
 300     request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, source,
 301                           dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 302                           MPI_REQ_RMA | MPI_REQ_NON_PERSISTENT | MPI_REQ_RECV | MPI_REQ_PREPARED);
 303   }else{
 304     request =
 305         new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, source,
 306                     dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 307                     MPI_REQ_RMA | MPI_REQ_NON_PERSISTENT | MPI_REQ_RECV | MPI_REQ_PREPARED | MPI_REQ_ACCUMULATE, op);
 308   }
 309   return request;
 310 }
 311
 312 MPI_Request Request::irecv_init(void *buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm)
 313 {
 314   aid_t source = MPI_PROC_NULL;
 315   if (src == MPI_ANY_SOURCE)
 316     source = MPI_ANY_SOURCE;
 317   else if (src != MPI_PROC_NULL)
 318     source = comm->group()->actor(src);
 319   return new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype,
 320                      source, simgrid::s4u::this_actor::get_pid(), tag, comm,
 321                      MPI_REQ_PERSISTENT | MPI_REQ_RECV | MPI_REQ_PREPARED);
 322 }
 323
 324 MPI_Request Request::ibsend(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 325 {
 326   auto request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 327                              dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 328                              MPI_REQ_NON_PERSISTENT | MPI_REQ_ISEND | MPI_REQ_SEND | MPI_REQ_BSEND);
 329   if(dst != MPI_PROC_NULL)
 330     request->start();
 331   return request;
 332 }
 333
 334 MPI_Request Request::isend(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 335 {
 336   auto request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 337                              dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 338                              MPI_REQ_NON_PERSISTENT | MPI_REQ_ISEND | MPI_REQ_SEND);
 339   if(dst != MPI_PROC_NULL)
 340     request->start();
 341   return request;
 342 }
 343
 344 MPI_Request Request::issend(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 345 {
 346   auto request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 347                              dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 348                              MPI_REQ_NON_PERSISTENT | MPI_REQ_ISEND | MPI_REQ_SSEND | MPI_REQ_SEND);
 349   if(dst != MPI_PROC_NULL)
 350     request->start();
 351   return request;
 352 }
 353
 354 MPI_Request Request::irecv(void *buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm)
 355 {
 356   aid_t source        = MPI_PROC_NULL;
 357   if (src == MPI_ANY_SOURCE)
 358     source = MPI_ANY_SOURCE;
 359   else if (src != MPI_PROC_NULL)
 360     source = comm->group()->actor(src);
 361   auto request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, source,
 362                              simgrid::s4u::this_actor::get_pid(), tag, comm, MPI_REQ_NON_PERSISTENT | MPI_REQ_RECV);
 363   if(src != MPI_PROC_NULL)
 364     request->start();
 365   return request;
 366 }
 367
 368 int Request::recv(void *buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm, MPI_Status * status)
 369 {
 370   MPI_Request request = irecv(buf, count, datatype, src, tag, comm);
 371   int retval = wait(&request,status);
 372   return retval;
 373 }
 374
 375 void Request::bsend(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 376 {
 377   auto request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 378                              dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 379                              MPI_REQ_NON_PERSISTENT | MPI_REQ_SEND | MPI_REQ_BSEND);
 380
 381   if(dst != MPI_PROC_NULL)
 382    request->start();
 383   wait(&request, MPI_STATUS_IGNORE);
 384 }
 385
 386 void Request::send(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 387 {
 388   auto request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 389                              dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 390                              MPI_REQ_NON_PERSISTENT | MPI_REQ_SEND);
 391   if(dst != MPI_PROC_NULL)
 392    request->start();
 393   wait(&request, MPI_STATUS_IGNORE);
 394 }
 395
 396 void Request::ssend(const void *buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm)
 397 {
 398   auto request = new Request(buf == MPI_BOTTOM ? nullptr : buf, count, datatype, simgrid::s4u::this_actor::get_pid(),
 399                              dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL, tag, comm,
 400                              MPI_REQ_NON_PERSISTENT | MPI_REQ_SSEND | MPI_REQ_SEND);
 401
 402   if(dst != MPI_PROC_NULL)
 403    request->start();
 404   wait(&request,MPI_STATUS_IGNORE);
 405 }
 406
 407 void Request::sendrecv(const void *sendbuf, int sendcount, MPI_Datatype sendtype,int dst, int sendtag,
 408                        void *recvbuf, int recvcount, MPI_Datatype recvtype, int src, int recvtag,
 409                        MPI_Comm comm, MPI_Status * status)
 410 {
 411   aid_t source = MPI_PROC_NULL;
 412   if (src == MPI_ANY_SOURCE)
 413     source = MPI_ANY_SOURCE;
 414   else if (src != MPI_PROC_NULL)
 415     source = comm->group()->actor(src);
 416   aid_t destination = dst != MPI_PROC_NULL ? comm->group()->actor(dst) : MPI_PROC_NULL;
 417
 418   std::array<MPI_Request, 2> requests;
 419   std::array<MPI_Status, 2> stats;
 420   if (aid_t myid = simgrid::s4u::this_actor::get_pid(); (destination == myid) && (source == myid)) {
 421     Datatype::copy(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype);
 422     if (status != MPI_STATUS_IGNORE) {
 423       status->MPI_SOURCE = source;
 424       status->MPI_TAG    = recvtag;
 425       status->MPI_ERROR  = MPI_SUCCESS;
 426       status->count      = sendcount * sendtype->size();
 427     }
 428     return;
 429   }
 430   requests[0] = isend_init(sendbuf, sendcount, sendtype, dst, sendtag, comm);
 431   requests[1] = irecv_init(recvbuf, recvcount, recvtype, src, recvtag, comm);
 432   startall(2, requests.data());
 433   waitall(2, requests.data(), stats.data());
 434   unref(&requests[0]);
 435   unref(&requests[1]);
 436   if(status != MPI_STATUS_IGNORE) {
 437     // Copy receive status
 438     *status = stats[1];
 439   }
 440 }
 441
 442 void Request::start()
 443 {
 444   s4u::Mailbox* mailbox;
 445
 446   xbt_assert(action_ == nullptr, "Cannot (re-)start unfinished communication");
 447   //reinitialize temporary buffer for persistent requests
 448   if(real_size_ > 0 && flags_ & MPI_REQ_FINISHED){
 449     buf_ = old_buf_;
 450     init_buffer(real_size_/type_->size());
 451   }
 452   flags_ &= ~MPI_REQ_PREPARED;
 453   flags_ &= ~MPI_REQ_FINISHED;
 454   this->ref();
 455
 456   // we make a copy here, as the size is modified by simix, and we may reuse the request in another receive later
 457   real_size_=size_;
 458   if ((flags_ & MPI_REQ_RECV) != 0) {
 459     this->print_request("New recv");
 460
 461     simgrid::smpi::ActorExt* process = smpi_process_remote(simgrid::s4u::Actor::by_pid(dst_));
 462
 463     std::unique_lock<s4u::Mutex> mut_lock;
 464     if (smpi_cfg_async_small_thresh() != 0 || (flags_ & MPI_REQ_RMA) != 0)
 465       mut_lock = std::unique_lock(*process->mailboxes_mutex());
 466
 467     bool is_probe = ((flags_ & MPI_REQ_PROBE) != 0);
 468     flags_ |= MPI_REQ_PROBE;
 469
 470     if (smpi_cfg_async_small_thresh() == 0 && (flags_ & MPI_REQ_RMA) == 0) {
 471       mailbox = process->mailbox();
 472     } else if (((flags_ & MPI_REQ_RMA) != 0) || static_cast<int>(size_) < smpi_cfg_async_small_thresh()) {
 473       //We have to check both mailboxes (because SSEND messages are sent to the large mbox).
 474       //begin with the more appropriate one : the small one.
 475       mailbox = process->mailbox_small();
 476       XBT_DEBUG("Is there a corresponding send already posted in the small mailbox %s (in case of SSEND)?",
 477                 mailbox->get_cname());
 478       simgrid::kernel::activity::ActivityImplPtr action = mailbox->iprobe(0, &match_recv, static_cast<void*>(this));
 479
 480       if (action == nullptr) {
 481         mailbox = process->mailbox();
 482         XBT_DEBUG("No, nothing in the small mailbox test the other one : %s", mailbox->get_cname());
 483         action = mailbox->iprobe(0, &match_recv, static_cast<void*>(this));
 484         if (action == nullptr) {
 485           XBT_DEBUG("Still nothing, switch back to the small mailbox : %s", mailbox->get_cname());
 486           mailbox = process->mailbox_small();
 487         }
 488       } else {
 489         XBT_DEBUG("yes there was something for us in the small mailbox");
 490       }
 491     } else {
 492       mailbox = process->mailbox_small();
 493       XBT_DEBUG("Is there a corresponding send already posted the small mailbox?");
 494       simgrid::kernel::activity::ActivityImplPtr action = mailbox->iprobe(0, &match_recv, static_cast<void*>(this));
 495
 496       if (action == nullptr) {
 497         XBT_DEBUG("No, nothing in the permanent receive mailbox");
 498         mailbox = process->mailbox();
 499       } else {
 500         XBT_DEBUG("yes there was something for us in the small mailbox");
 501       }
 502     }
 503     if (not is_probe)
 504       flags_ &= ~MPI_REQ_PROBE;
 505     kernel::actor::CommIrecvSimcall observer{process->get_actor()->get_impl(),
 506                                              mailbox->get_impl(),
 507                                              static_cast<unsigned char*>(buf_),
 508                                              &real_size_,
 509                                              &match_recv,
 510                                              process->replaying() ? &smpi_comm_null_copy_buffer_callback
 511                                                                   : smpi_comm_copy_data_callback,
 512                                              this,
 513                                              -1.0};
 514     observer.set_tag(tag_);
 515
 516     action_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::irecv(&observer); },
 517                                               &observer);
 518
 519     XBT_DEBUG("recv simcall posted");
 520   } else { /* the RECV flag was not set, so this is a send */
 521     const simgrid::smpi::ActorExt* process = smpi_process_remote(simgrid::s4u::Actor::by_pid(dst_));
 522     xbt_assert(process, "Actor pid=%ld is gone??", dst_);
 523     if (TRACE_smpi_view_internals())
 524       TRACE_smpi_send(src_, src_, dst_, tag_, size_);
 525     this->print_request("New send");
 526
 527     message_id_=comm_->get_sent_messages_count(comm_->group()->rank(src_), comm_->group()->rank(dst_), tag_);
 528     comm_->increment_sent_messages_count(comm_->group()->rank(src_), comm_->group()->rank(dst_), tag_);
 529
 530     void* buf = buf_;
 531     if ((flags_ & MPI_REQ_SSEND) == 0 &&
 532         ((flags_ & MPI_REQ_RMA) != 0 || (flags_ & MPI_REQ_BSEND) != 0 ||
 533          static_cast<int>(size_) < smpi_cfg_detached_send_thresh())) {
 534       detached_    = true;
 535       XBT_DEBUG("Send request %p is detached", this);
 536       this->ref();
 537       if (not(type_->flags() & DT_FLAG_DERIVED)) {
 538         void* oldbuf = buf_;
 539         if (not process->replaying() && oldbuf != nullptr && size_ != 0) {
 540           if (smpi_switch_data_segment(simgrid::s4u::Actor::by_pid(src_), buf_))
 541             XBT_DEBUG("Privatization : We are sending from a zone inside global memory. Switch data segment ");
 542
 543           //we need this temporary buffer even for bsend, as it will be released in the copy callback and we don't have a way to differentiate it
 544           //so actually ... don't use manually attached buffer space.
 545           buf = xbt_malloc(size_);
 546           memcpy(buf,oldbuf,size_);
 547           XBT_DEBUG("buf %p copied into %p",oldbuf,buf);
 548         }
 549       }
 550     }
 551
 552     //if we are giving back the control to the user without waiting for completion, we have to inject timings
 553     double sleeptime = 0.0;
 554     if (detached_ || ((flags_ & (MPI_REQ_ISEND | MPI_REQ_SSEND)) != 0)) { // issend should be treated as isend
 555       // isend and send timings may be different
 556       sleeptime =
 557           ((flags_ & MPI_REQ_ISEND) != 0)
 558               ? simgrid::s4u::Actor::self()->get_host()->extension<simgrid::smpi::Host>()->oisend(
 559                     size_, simgrid::s4u::Actor::by_pid(src_)->get_host(), simgrid::s4u::Actor::by_pid(dst_)->get_host())
 560               : simgrid::s4u::Actor::self()->get_host()->extension<simgrid::smpi::Host>()->osend(
 561                     size_, simgrid::s4u::Actor::by_pid(src_)->get_host(),
 562                     simgrid::s4u::Actor::by_pid(dst_)->get_host());
 563     }
 564
 565     if(sleeptime > 0.0){
 566       simgrid::s4u::this_actor::sleep_for(sleeptime);
 567       XBT_DEBUG("sending size of %zu : sleep %f ", size_, sleeptime);
 568     }
 569
 570     std::unique_lock<s4u::Mutex> mut_lock;
 571     if (smpi_cfg_async_small_thresh() != 0 || (flags_ & MPI_REQ_RMA) != 0)
 572       mut_lock = std::unique_lock(*process->mailboxes_mutex());
 573
 574     if (not(smpi_cfg_async_small_thresh() != 0 || (flags_ & MPI_REQ_RMA) != 0)) {
 575       mailbox = process->mailbox();
 576     } else if (((flags_ & MPI_REQ_RMA) != 0) || static_cast<int>(size_) < smpi_cfg_async_small_thresh()) { // eager mode
 577       bool is_probe = ((flags_ & MPI_REQ_PROBE) != 0);
 578       flags_ |= MPI_REQ_PROBE;
 579
 580       mailbox = process->mailbox();
 581       XBT_DEBUG("Is there a corresponding recv already posted in the large mailbox %s?", mailbox->get_cname());
 582       if (not mailbox->iprobe(1, &match_send, static_cast<void*>(this))) {
 583         if ((flags_ & MPI_REQ_SSEND) == 0) {
 584           mailbox = process->mailbox_small();
 585           XBT_DEBUG("No, nothing in the large mailbox, message is to be sent on the small one %s",
 586                     mailbox->get_cname());
 587         } else {
 588           mailbox = process->mailbox_small();
 589           XBT_DEBUG("SSEND : Is there a corresponding recv already posted in the small mailbox %s?",
 590                     mailbox->get_cname());
 591           if (not mailbox->iprobe(1, &match_send, static_cast<void*>(this))) {
 592             XBT_DEBUG("No, we are first, send to large mailbox");
 593             mailbox = process->mailbox();
 594           }
 595         }
 596       } else {
 597         XBT_DEBUG("Yes there was something for us in the large mailbox");
 598       }
 599       if (not is_probe)
 600         flags_ &= ~MPI_REQ_PROBE;
 601     } else {
 602       mailbox = process->mailbox();
 603       XBT_DEBUG("Send request %p is in the large mailbox %s (buf: %p)", this, mailbox->get_cname(), buf_);
 604     }
 605
 606     size_t payload_size_ = size_ + 16;//MPI enveloppe size (tag+dest+communicator)
 607     kernel::actor::CommIsendSimcall observer{
 608         simgrid::kernel::EngineImpl::get_instance()->get_actor_by_pid(src_), mailbox->get_impl(),
 609         static_cast<double>(payload_size_), -1, static_cast<unsigned char*>(buf), real_size_, &match_send,
 610         &xbt_free_f, // how to free the userdata if a detached send fails
 611         process->replaying() ? &smpi_comm_null_copy_buffer_callback : smpi_comm_copy_data_callback, this,
 612         // detach if msg size < eager/rdv switch limit
 613         detached_};
 614     observer.set_tag(tag_);
 615     action_ = kernel::actor::simcall_answered([&observer] { return kernel::activity::CommImpl::isend(&observer); },
 616                                               &observer);
 617     XBT_DEBUG("send simcall posted");
 618
 619     /* FIXME: detached sends are not traceable (action_ == nullptr) */
 620     if (action_ != nullptr) {
 621       boost::static_pointer_cast<kernel::activity::CommImpl>(action_)->set_tracing_category(
 622           smpi_process()->get_tracing_category());
 623     }
 624   }
 625 }
 626
 627 void Request::startall(int count, MPI_Request * requests)
 628 {
 629   if(requests== nullptr)
 630     return;
 631
 632   for(int i = 0; i < count; i++) {
 633     if(requests[i]->src_ != MPI_PROC_NULL && requests[i]->dst_ != MPI_PROC_NULL)
 634       requests[i]->start();
 635   }
 636 }
 637
 638 void Request::cancel()
 639 {
 640   this->flags_ |= MPI_REQ_CANCELLED;
 641   if (this->action_ != nullptr)
 642     (boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(this->action_))->cancel();
 643 }
 644
 645 int Request::test(MPI_Request * request, MPI_Status * status, int* flag) {
 646   // assume that *request is not MPI_REQUEST_NULL (filtered in PMPI_Test or testall before)
 647   // to avoid deadlocks if used as a break condition, such as
 648   //     while (MPI_Test(request, flag, status) && flag) dostuff...
 649   // because the time will not normally advance when only calls to MPI_Test are made -> deadlock
 650   // multiplier to the sleeptime, to increase speed of execution, each failed test will increase it
 651   xbt_assert(*request != MPI_REQUEST_NULL);
 652
 653   static int nsleeps = 1;
 654   int ret = MPI_SUCCESS;
 655
 656   if(smpi_test_sleep > 0)
 657     simgrid::s4u::this_actor::sleep_for(nsleeps * smpi_test_sleep);
 658
 659   Status::empty(status);
 660   *flag = 1;
 661
 662   if ((*request)->flags_ & MPI_REQ_NBC){
 663     *flag = finish_nbc_requests(request, 1);
 664   }
 665
 666   if (((*request)->flags_ & (MPI_REQ_PREPARED | MPI_REQ_FINISHED)) == 0) {
 667     if ((*request)->action_ != nullptr && ((*request)->flags_ & MPI_REQ_CANCELLED) == 0){
 668       try{
 669         kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 670         kernel::actor::ActivityTestSimcall observer{issuer, (*request)->action_.get()};
 671         *flag = kernel::actor::simcall_answered(
 672             [&observer] { return observer.get_activity()->test(observer.get_issuer()); }, &observer);
 673       } catch (const Exception&) {
 674         *flag = 0;
 675         return ret;
 676       }
 677     }
 678     if (((*request)->flags_ & MPI_REQ_GENERALIZED) && not((*request)->flags_ & MPI_REQ_COMPLETE))
 679       *flag=0;
 680     if (*flag) {
 681       finish_wait(request, status); // may invalidate *request
 682       if (*request != MPI_REQUEST_NULL && ((*request)->flags_ & MPI_REQ_GENERALIZED)){
 683         MPI_Status tmp_status;
 684         MPI_Status* mystatus;
 685         if (status == MPI_STATUS_IGNORE) {
 686           mystatus = &tmp_status;
 687           Status::empty(mystatus);
 688         } else {
 689           mystatus = status;
 690         }
 691         ret = ((*request)->generalized_funcs)->query_fn(((*request)->generalized_funcs)->extra_state, mystatus);
 692       }
 693       nsleeps=1;//reset the number of sleeps we will do next time
 694       if (*request != MPI_REQUEST_NULL && ((*request)->flags_ & MPI_REQ_PERSISTENT) == 0)
 695         *request = MPI_REQUEST_NULL;
 696     } else if (smpi_cfg_grow_injected_times()) {
 697       nsleeps++;
 698     }
 699   }
 700   return ret;
 701 }
 702
 703 int Request::testsome(int incount, MPI_Request requests[], int *count, int *indices, MPI_Status status[])
 704 {
 705   int error=0;
 706   int count_dead = 0;
 707   int flag = 0;
 708   MPI_Status stat;
 709   MPI_Status *pstat = status == MPI_STATUSES_IGNORE ? MPI_STATUS_IGNORE : &stat;
 710
 711   *count = 0;
 712   for (int i = 0; i < incount; i++) {
 713     if (requests[i] != MPI_REQUEST_NULL && not (requests[i]->flags_ & MPI_REQ_FINISHED)) {
 714       if (test(&requests[i], pstat, &flag) != MPI_SUCCESS)
 715         error = 1;
 716       if(flag) {
 717         indices[*count] = i;
 718         if (status != MPI_STATUSES_IGNORE)
 719           status[*count] = *pstat;
 720         (*count)++;
 721         if ((requests[i] != MPI_REQUEST_NULL) && (requests[i]->flags_ & MPI_REQ_NON_PERSISTENT))
 722           requests[i] = MPI_REQUEST_NULL;
 723       }
 724     } else {
 725       count_dead++;
 726     }
 727   }
 728   if(count_dead==incount)*count=MPI_UNDEFINED;
 729   if(error!=0)
 730     return MPI_ERR_IN_STATUS;
 731   else
 732     return MPI_SUCCESS;
 733 }
 734
 735 int Request::testany(int count, MPI_Request requests[], int *index, int* flag, MPI_Status * status)
 736 {
 737   std::vector<simgrid::kernel::activity::ActivityImpl*> comms;
 738   comms.reserve(count);
 739
 740   *flag = 0;
 741   int ret = MPI_SUCCESS;
 742   *index = MPI_UNDEFINED;
 743
 744   std::vector<int> map; /** Maps all matching comms back to their location in requests **/
 745   for (int i = 0; i < count; i++) {
 746     if ((requests[i] != MPI_REQUEST_NULL) && requests[i]->action_ && not(requests[i]->flags_ & MPI_REQ_PREPARED)) {
 747       comms.push_back(requests[i]->action_.get());
 748       map.push_back(i);
 749     }
 750   }
 751   if (not map.empty()) {
 752     //multiplier to the sleeptime, to increase speed of execution, each failed testany will increase it
 753     static int nsleeps = 1;
 754     if(smpi_test_sleep > 0)
 755       simgrid::s4u::this_actor::sleep_for(nsleeps * smpi_test_sleep);
 756     ssize_t i;
 757     try{
 758       kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 759       kernel::actor::ActivityTestanySimcall observer{issuer, comms};
 760       i = kernel::actor::simcall_answered(
 761           [&observer] {
 762             return kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
 763           },
 764           &observer);
 765     } catch (const Exception&) {
 766       XBT_DEBUG("Exception in testany");
 767       return 0;
 768     }
 769
 770     if (i != -1) { // -1 is not MPI_UNDEFINED but a SIMIX return code. (nothing matches)
 771       *index = map[i];
 772       if (requests[*index] != MPI_REQUEST_NULL && (requests[*index]->flags_ & MPI_REQ_GENERALIZED) &&
 773           not(requests[*index]->flags_ & MPI_REQ_COMPLETE)) {
 774         *flag=0;
 775       } else {
 776         finish_wait(&requests[*index],status);
 777       if (requests[*index] != MPI_REQUEST_NULL && (requests[*index]->flags_ & MPI_REQ_GENERALIZED)){
 778         MPI_Status tmp_status;
 779         MPI_Status* mystatus;
 780         if (status == MPI_STATUS_IGNORE) {
 781           mystatus = &tmp_status;
 782           Status::empty(mystatus);
 783         } else {
 784           mystatus = status;
 785         }
 786         ret=(requests[*index]->generalized_funcs)->query_fn((requests[*index]->generalized_funcs)->extra_state, mystatus);
 787       }
 788
 789       if (requests[*index] != MPI_REQUEST_NULL && requests[*index]->flags_ & MPI_REQ_NBC){
 790         *flag = finish_nbc_requests(&requests[*index] , 1);
 791       }
 792
 793       if (requests[*index] != MPI_REQUEST_NULL && (requests[*index]->flags_ & MPI_REQ_NON_PERSISTENT))
 794           requests[*index] = MPI_REQUEST_NULL;
 795         XBT_DEBUG("Testany - returning with index %d", *index);
 796         *flag=1;
 797       }
 798       nsleeps = 1;
 799     } else {
 800       nsleeps++;
 801     }
 802   } else {
 803       XBT_DEBUG("Testany on inactive handles, returning flag=1 but empty status");
 804       //all requests are null or inactive, return true
 805       *flag = 1;
 806       *index = MPI_UNDEFINED;
 807       Status::empty(status);
 808   }
 809
 810   return ret;
 811 }
 812
 813 int Request::testall(int count, MPI_Request requests[], int* outflag, MPI_Status status[])
 814 {
 815   MPI_Status stat;
 816   MPI_Status *pstat = status == MPI_STATUSES_IGNORE ? MPI_STATUS_IGNORE : &stat;
 817   int flag;
 818   int error = 0;
 819   *outflag = 1;
 820   for(int i=0; i<count; i++){
 821     if (requests[i] != MPI_REQUEST_NULL && not(requests[i]->flags_ & MPI_REQ_PREPARED)) {
 822       int ret = test(&requests[i], pstat, &flag);
 823       if (flag){
 824         flag=0;
 825       }else{
 826         *outflag=0;
 827       }
 828       if (ret != MPI_SUCCESS)
 829         error = 1;
 830     }else{
 831       Status::empty(pstat);
 832     }
 833     if(status != MPI_STATUSES_IGNORE) {
 834       status[i] = *pstat;
 835     }
 836   }
 837   if (error == 1)
 838     return MPI_ERR_IN_STATUS;
 839   else
 840     return MPI_SUCCESS;
 841 }
 842
 843 void Request::probe(int source, int tag, MPI_Comm comm, MPI_Status* status){
 844   int flag=0;
 845   //FIXME find another way to avoid busy waiting ?
 846   // the issue here is that we have to wait on a nonexistent comm
 847   while(flag==0){
 848     iprobe(source, tag, comm, &flag, status);
 849     XBT_DEBUG("Busy Waiting on probing : %d", flag);
 850   }
 851 }
 852
 853 void Request::iprobe(int source, int tag, MPI_Comm comm, int* flag, MPI_Status* status){
 854   // to avoid deadlock, we have to sleep some time here, or the timer won't advance and we will only do iprobe simcalls
 855   // especially when used as a break condition, such as while (MPI_Iprobe(...)) dostuff...
 856   // nsleeps is a multiplier to the sleeptime, to increase speed of execution, each failed iprobe will increase it
 857   // This can speed up the execution of certain applications by an order of magnitude, such as HPL
 858   static int nsleeps = 1;
 859   double speed        = s4u::this_actor::get_host()->get_speed();
 860   double maxrate      = smpi_cfg_iprobe_cpu_usage();
 861   auto request =
 862       new Request(nullptr, 0, MPI_CHAR, source == MPI_ANY_SOURCE ? MPI_ANY_SOURCE : comm->group()->actor(source),
 863                   simgrid::s4u::this_actor::get_pid(), tag, comm, MPI_REQ_PERSISTENT | MPI_REQ_RECV | MPI_REQ_PROBE);
 864   if (smpi_iprobe_sleep > 0) {
 865     /** Compute the number of flops we will sleep **/
 866     s4u::this_actor::exec_init(/*nsleeps: See comment above */ nsleeps *
 867                                /*(seconds * flop/s -> total flops)*/ smpi_iprobe_sleep * speed * maxrate)
 868         ->set_name("iprobe")
 869         /* Not the entire CPU can be used when iprobing: This is important for
 870          * the energy consumption caused by polling with iprobes.
 871          * Note also that the number of flops that was
 872          * computed above contains a maxrate factor and is hence reduced (maxrate < 1)
 873          */
 874         ->set_bound(maxrate * speed)
 875         ->start()
 876         ->wait();
 877   }
 878   // behave like a receive, but don't do it
 879   s4u::Mailbox* mailbox;
 880
 881   request->print_request("New iprobe");
 882   // We have to test both mailboxes as we don't know if we will receive one or another
 883   if (smpi_cfg_async_small_thresh() > 0) {
 884     mailbox = smpi_process()->mailbox_small();
 885     XBT_DEBUG("Trying to probe the perm recv mailbox");
 886     request->action_ = mailbox->iprobe(0, &match_recv, static_cast<void*>(request));
 887   }
 888
 889   if (request->action_ == nullptr){
 890     mailbox = smpi_process()->mailbox();
 891     XBT_DEBUG("trying to probe the other mailbox");
 892     request->action_ = mailbox->iprobe(0, &match_recv, static_cast<void*>(request));
 893   }
 894
 895   if (request->action_ != nullptr){
 896     kernel::activity::CommImplPtr sync_comm = boost::static_pointer_cast<kernel::activity::CommImpl>(request->action_);
 897     const Request* req                      = static_cast<MPI_Request>(sync_comm->src_data_);
 898     *flag = 1;
 899     if (status != MPI_STATUS_IGNORE && (req->flags_ & MPI_REQ_PREPARED) == 0) {
 900       status->MPI_SOURCE = comm->group()->rank(req->src_);
 901       status->MPI_TAG    = req->tag_;
 902       status->MPI_ERROR  = MPI_SUCCESS;
 903       status->count      = req->real_size_;
 904     }
 905     nsleeps = 1;//reset the number of sleeps we will do next time
 906   }
 907   else {
 908     *flag = 0;
 909     if (smpi_cfg_grow_injected_times())
 910       nsleeps++;
 911   }
 912   unref(&request);
 913   xbt_assert(request == MPI_REQUEST_NULL);
 914 }
 915
 916 int Request::finish_nbc_requests(MPI_Request* request, int test){
 917   int flag = 1;
 918   int ret = 0;
 919   if(test == 0)
 920     ret = waitall((*request)->nbc_requests_.size(), (*request)->nbc_requests_.data(), MPI_STATUSES_IGNORE);
 921   else{
 922     ret = testall((*request)->nbc_requests_.size(), (*request)->nbc_requests_.data(), &flag, MPI_STATUSES_IGNORE);
 923   }
 924   if(ret!=MPI_SUCCESS)
 925     xbt_die("Failure when waiting on non blocking collective sub-requests");
 926   if(flag == 1){
 927     XBT_DEBUG("Finishing non blocking collective request with %zu sub-requests", (*request)->nbc_requests_.size());
 928     for(auto& req: (*request)->nbc_requests_){
 929       if((*request)->buf_!=nullptr && req!=MPI_REQUEST_NULL){//reduce case
 930         void * buf=req->buf_;
 931         if((*request)->type_->flags() & DT_FLAG_DERIVED)
 932           buf=req->old_buf_;
 933         if(req->flags_ & MPI_REQ_RECV ){
 934           if((*request)->op_!=MPI_OP_NULL){
 935             int count=(*request)->size_/ (*request)->type_->size();
 936             (*request)->op_->apply(buf, (*request)->buf_, &count, (*request)->type_);
 937           }
 938           smpi_free_tmp_buffer(static_cast<unsigned char*>(buf));
 939         }
 940       }
 941       if(req!=MPI_REQUEST_NULL)
 942         Request::unref(&req);
 943     }
 944     (*request)->nbc_requests_.clear();
 945   }
 946   return flag;
 947 }
 948
 949 void Request::finish_wait(MPI_Request* request, MPI_Status * status)
 950 {
 951   MPI_Request req = *request;
 952   Status::empty(status);
 953   if((req->flags_ & MPI_REQ_CANCELLED) != 0 && (req->flags_ & MPI_REQ_MATCHED) == 0) {
 954     if (status!=MPI_STATUS_IGNORE)
 955       status->cancelled=1;
 956     if(req->detached_sender_ != nullptr)
 957       unref(&(req->detached_sender_));
 958     unref(request);
 959     return;
 960   }
 961
 962   if ((req->flags_ & (MPI_REQ_PREPARED | MPI_REQ_GENERALIZED | MPI_REQ_FINISHED)) == 0) {
 963     if (status != MPI_STATUS_IGNORE) {
 964       if (req->src_== MPI_PROC_NULL || req->dst_== MPI_PROC_NULL){
 965         Status::empty(status);
 966         status->MPI_SOURCE = MPI_PROC_NULL;
 967       } else {
 968         aid_t src          = req->src_ == MPI_ANY_SOURCE ? req->real_src_ : req->src_;
 969         status->MPI_SOURCE = req->comm_->group()->rank(src);
 970         status->MPI_TAG = req->tag_ == MPI_ANY_TAG ? req->real_tag_ : req->tag_;
 971         status->MPI_ERROR  = req->truncated_ ? MPI_ERR_TRUNCATE : MPI_SUCCESS;
 972       }
 973       // this handles the case were size in receive differs from size in send
 974       status->count = req->real_size_;
 975     }
 976     //detached send will be finished at the other end
 977     if (not(req->detached_ && ((req->flags_ & MPI_REQ_SEND) != 0))) {
 978       req->print_request("Finishing");
 979       MPI_Datatype datatype = req->type_;
 980
 981       // FIXME Handle the case of a partial shared malloc.
 982       if (not smpi_process()->replaying() &&
 983         (((req->flags_ & MPI_REQ_ACCUMULATE) != 0) || (datatype->flags() & DT_FLAG_DERIVED))) {
 984         if (smpi_switch_data_segment(simgrid::s4u::Actor::self(), req->old_buf_))
 985           XBT_VERB("Privatization : We are unserializing to a zone in global memory  Switch data segment ");
 986
 987         if(datatype->flags() & DT_FLAG_DERIVED){
 988           // This part handles the problem of non-contiguous memory the unserialization at the reception
 989           if ((req->flags_ & MPI_REQ_RECV) && datatype->size() != 0)
 990             datatype->unserialize(req->buf_, req->old_buf_, req->real_size_/datatype->size() , req->op_);
 991           xbt_free(req->buf_);
 992           req->buf_=nullptr;
 993         } else if (req->flags_ & MPI_REQ_RECV) { // apply op on contiguous buffer for accumulate
 994           if (datatype->size() != 0) {
 995             int n = req->real_size_ / datatype->size();
 996             req->op_->apply(req->buf_, req->old_buf_, &n, datatype);
 997           }
 998           xbt_free(req->buf_);
 999           req->buf_=nullptr;
1000         }
1001       }
1002     }
1003   }
1004
1005   if (TRACE_smpi_view_internals() && ((req->flags_ & MPI_REQ_RECV) != 0)) {
1006     aid_t rank       = simgrid::s4u::this_actor::get_pid();
1007     aid_t src_traced = (req->src_ == MPI_ANY_SOURCE ? req->real_src_ : req->src_);
1008     TRACE_smpi_recv(src_traced, rank,req->tag_);
1009   }
1010   if(req->detached_sender_ != nullptr){
1011     //integrate pseudo-timing for buffering of small messages, do not bother to execute the simcall if 0
1012     simgrid::s4u::Host* dst_host = simgrid::s4u::Actor::by_pid(req->dst_)->get_host();
1013     if (double sleeptime = simgrid::s4u::Actor::self()->get_host()->extension<simgrid::smpi::Host>()->orecv(
1014             req->real_size(), req->src_host_, dst_host);
1015         sleeptime > 0.0) {
1016       simgrid::s4u::this_actor::sleep_for(sleeptime);
1017       XBT_DEBUG("receiving size of %zu : sleep %f ", req->real_size_, sleeptime);
1018     }
1019     unref(&(req->detached_sender_));
1020   }
1021   if (req->flags_ & MPI_REQ_PERSISTENT)
1022     req->action_ = nullptr;
1023   req->flags_ |= MPI_REQ_FINISHED;
1024
1025   if (req->truncated_ || req->unmatched_types_) {
1026     char error_string[MPI_MAX_ERROR_STRING];
1027     int error_size;
1028     int errkind;
1029     if(req->truncated_ )
1030       errkind = MPI_ERR_TRUNCATE;
1031     else
1032       errkind = MPI_ERR_TYPE;
1033     PMPI_Error_string(errkind, error_string, &error_size);
1034     MPI_Errhandler err = (req->comm_) ? (req->comm_)->errhandler() : MPI_ERRHANDLER_NULL;
1035     if (err == MPI_ERRHANDLER_NULL || err == MPI_ERRORS_RETURN)
1036       XBT_WARN("recv - returned %.*s instead of MPI_SUCCESS", error_size, error_string);
1037     else if (err == MPI_ERRORS_ARE_FATAL)
1038       xbt_die("recv - returned %.*s instead of MPI_SUCCESS", error_size, error_string);
1039     else
1040       err->call((req->comm_), errkind);
1041     if (err != MPI_ERRHANDLER_NULL)
1042       simgrid::smpi::Errhandler::unref(err);
1043     MC_assert(not MC_is_active()); /* Only fail in MC mode */
1044   }
1045   if(req->src_ != MPI_PROC_NULL && req->dst_ != MPI_PROC_NULL)
1046     unref(request);
1047 }
1048
1049 int Request::wait(MPI_Request * request, MPI_Status * status)
1050 {
1051   // assume that *request is not MPI_REQUEST_NULL (filtered in PMPI_Wait before)
1052   xbt_assert(*request != MPI_REQUEST_NULL);
1053
1054   int ret=MPI_SUCCESS;
1055
1056   if((*request)->src_ == MPI_PROC_NULL || (*request)->dst_ == MPI_PROC_NULL){
1057     if (status != MPI_STATUS_IGNORE) {
1058       Status::empty(status);
1059       status->MPI_SOURCE = MPI_PROC_NULL;
1060     }
1061     (*request)=MPI_REQUEST_NULL;
1062     return ret;
1063   }
1064
1065   (*request)->print_request("Waiting");
1066   if ((*request)->flags_ & (MPI_REQ_PREPARED | MPI_REQ_FINISHED)) {
1067     Status::empty(status);
1068     return ret;
1069   }
1070
1071   if ((*request)->action_ != nullptr){
1072       try{
1073         // this is not a detached send
1074         kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
1075         kernel::actor::ActivityWaitSimcall observer{issuer, (*request)->action_.get(), -1};
1076         kernel::actor::simcall_blocking([issuer, &observer] { observer.get_activity()->wait_for(issuer, -1); },
1077                                         &observer);
1078       } catch (const CancelException&) {
1079         XBT_VERB("Request cancelled");
1080       }
1081   }
1082
1083   if ((*request)->flags_ & MPI_REQ_GENERALIZED) {
1084     if (not((*request)->flags_ & MPI_REQ_COMPLETE)) {
1085       const std::scoped_lock lock(*(*request)->generalized_funcs->mutex);
1086       (*request)->generalized_funcs->cond->wait((*request)->generalized_funcs->mutex);
1087     }
1088     MPI_Status tmp_status;
1089     MPI_Status* mystatus;
1090     if (status == MPI_STATUS_IGNORE) {
1091       mystatus = &tmp_status;
1092       Status::empty(mystatus);
1093     } else {
1094       mystatus = status;
1095     }
1096     ret = ((*request)->generalized_funcs)->query_fn(((*request)->generalized_funcs)->extra_state, mystatus);
1097   }
1098
1099   if ((*request)->truncated_)
1100     ret = MPI_ERR_TRUNCATE;
1101
1102   if ((*request)->flags_ & MPI_REQ_NBC)
1103     finish_nbc_requests(request, 0);
1104
1105   finish_wait(request, status); // may invalidate *request
1106   if (*request != MPI_REQUEST_NULL && (((*request)->flags_ & MPI_REQ_NON_PERSISTENT) != 0))
1107     *request = MPI_REQUEST_NULL;
1108   return ret;
1109 }
1110
1111 int Request::waitany(int count, MPI_Request requests[], MPI_Status * status)
1112 {
1113   int index = MPI_UNDEFINED;
1114
1115   if(count > 0) {
1116     // Wait for a request to complete
1117     std::vector<simgrid::kernel::activity::ActivityImpl*> comms;
1118     std::vector<int> map;
1119     XBT_DEBUG("Wait for one of %d", count);
1120     for(int i = 0; i < count; i++) {
1121       if (requests[i] != MPI_REQUEST_NULL && not(requests[i]->flags_ & MPI_REQ_PREPARED) &&
1122           not(requests[i]->flags_ & MPI_REQ_FINISHED)) {
1123         if (requests[i]->action_ != nullptr) {
1124           XBT_DEBUG("Waiting any %p ", requests[i]);
1125           comms.push_back(requests[i]->action_.get());
1126           map.push_back(i);
1127         } else {
1128           // This is a finished detached request, let's return this one
1129           comms.clear(); // don't do the waitany call afterwards
1130           index = i;
1131           if (requests[index]->flags_ & MPI_REQ_NBC)
1132             finish_nbc_requests(&requests[index], 0);
1133           finish_wait(&requests[i], status); // cleanup if refcount = 0
1134           if (requests[i] != MPI_REQUEST_NULL && (requests[i]->flags_ & MPI_REQ_NON_PERSISTENT))
1135             requests[i] = MPI_REQUEST_NULL; // set to null
1136           break;
1137         }
1138       }
1139     }
1140     if (not comms.empty()) {
1141       XBT_DEBUG("Enter waitany for %zu comms", comms.size());
1142       ssize_t i;
1143       try{
1144         kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
1145         kernel::actor::ActivityWaitanySimcall observer{issuer, comms, -1};
1146         i = kernel::actor::simcall_blocking(
1147             [&observer] {
1148               kernel::activity::ActivityImpl::wait_any_for(observer.get_issuer(), observer.get_activities(),
1149                                                            observer.get_timeout());
1150             },
1151             &observer);
1152       } catch (const CancelException&) {
1153         XBT_INFO("request cancelled");
1154         i = -1;
1155       }
1156
1157       // not MPI_UNDEFINED, as this is a simix return code
1158       if (i != -1) {
1159         index = map[i];
1160         //in case of an accumulate, we have to wait the end of all requests to apply the operation, ordered correctly.
1161         if ((requests[index] == MPI_REQUEST_NULL) ||
1162             (not((requests[index]->flags_ & MPI_REQ_ACCUMULATE) && (requests[index]->flags_ & MPI_REQ_RECV)))) {
1163           finish_wait(&requests[index],status);
1164           if (requests[index] != MPI_REQUEST_NULL && (requests[index]->flags_ & MPI_REQ_NON_PERSISTENT))
1165             requests[index] = MPI_REQUEST_NULL;
1166         }
1167       }
1168     }
1169   }
1170
1171
1172   if (index==MPI_UNDEFINED)
1173     Status::empty(status);
1174
1175   return index;
1176 }
1177
1178 static int sort_accumulates(const Request* a, const Request* b)
1179 {
1180   return (a->tag() > b->tag());
1181 }
1182
1183 int Request::waitall(int count, MPI_Request requests[], MPI_Status status[])
1184 {
1185   std::vector<MPI_Request> accumulates;
1186   int index;
1187   MPI_Status stat;
1188   MPI_Status *pstat = (status == MPI_STATUSES_IGNORE ? MPI_STATUS_IGNORE : &stat);
1189   int retvalue = MPI_SUCCESS;
1190   //tag invalid requests in the set
1191   if (status != MPI_STATUSES_IGNORE) {
1192     for (int c = 0; c < count; c++) {
1193       if (requests[c] == MPI_REQUEST_NULL || requests[c]->dst_ == MPI_PROC_NULL ||
1194           (requests[c]->flags_ & MPI_REQ_PREPARED)) {
1195         Status::empty(&status[c]);
1196       } else if (requests[c]->src_ == MPI_PROC_NULL) {
1197         Status::empty(&status[c]);
1198         status[c].MPI_SOURCE = MPI_PROC_NULL;
1199       }
1200     }
1201   }
1202   for (int c = 0; c < count; c++) {
1203     if (MC_is_active() || MC_record_replay_is_active()) {
1204       wait(&requests[c],pstat);
1205       index = c;
1206     } else {
1207       index = waitany(count, requests, pstat);
1208
1209       if (index == MPI_UNDEFINED)
1210         break;
1211
1212       if (requests[index] != MPI_REQUEST_NULL && (requests[index]->flags_ & MPI_REQ_RECV) &&
1213           (requests[index]->flags_ & MPI_REQ_ACCUMULATE))
1214         accumulates.push_back(requests[index]);
1215       if (requests[index] != MPI_REQUEST_NULL && (requests[index]->flags_ & MPI_REQ_NON_PERSISTENT))
1216         requests[index] = MPI_REQUEST_NULL;
1217     }
1218     if (status != MPI_STATUSES_IGNORE) {
1219       status[index] = *pstat;
1220       if (status[index].MPI_ERROR == MPI_ERR_TRUNCATE)
1221         retvalue = MPI_ERR_IN_STATUS;
1222     }
1223   }
1224
1225   std::sort(accumulates.begin(), accumulates.end(), sort_accumulates);
1226   for (auto& req : accumulates)
1227     finish_wait(&req, status);
1228
1229   return retvalue;
1230 }
1231
1232 int Request::waitsome(int incount, MPI_Request requests[], int *indices, MPI_Status status[])
1233 {
1234   int count = 0;
1235   int flag = 0;
1236   int index = 0;
1237   MPI_Status stat;
1238   MPI_Status *pstat = status == MPI_STATUSES_IGNORE ? MPI_STATUS_IGNORE : &stat;
1239   index             = waitany(incount, requests, pstat);
1240   if(index==MPI_UNDEFINED) return MPI_UNDEFINED;
1241   if(status != MPI_STATUSES_IGNORE) {
1242     status[count] = *pstat;
1243   }
1244   indices[count] = index;
1245   count++;
1246   for (int i = 0; i < incount; i++) {
1247     if (i != index && requests[i] != MPI_REQUEST_NULL && not(requests[i]->flags_ & MPI_REQ_FINISHED)) {
1248       test(&requests[i], pstat,&flag);
1249       if (flag==1){
1250         indices[count] = i;
1251         if(status != MPI_STATUSES_IGNORE) {
1252           status[count] = *pstat;
1253         }
1254         if (requests[i] != MPI_REQUEST_NULL && (requests[i]->flags_ & MPI_REQ_NON_PERSISTENT))
1255           requests[i]=MPI_REQUEST_NULL;
1256         count++;
1257       }
1258     }
1259   }
1260   return count;
1261 }
1262
1263 MPI_Request Request::f2c(int id)
1264 {
1265   if(id==MPI_FORTRAN_REQUEST_NULL)
1266     return MPI_REQUEST_NULL;
1267   return static_cast<MPI_Request>(F2C::lookup()->at(id));
1268 }
1269
1270 void Request::free_f(int id)
1271 {
1272   if (id != MPI_FORTRAN_REQUEST_NULL) {
1273     F2C::lookup()->erase(id);
1274   }
1275 }
1276
1277 int Request::get_status(const Request* req, int* flag, MPI_Status* status)
1278 {
1279   if(req != MPI_REQUEST_NULL && req->action_ != nullptr) {
1280     req->iprobe(req->comm_->group()->rank(req->src_), req->tag_, req->comm_, flag, status);
1281     if(*flag)
1282       return MPI_SUCCESS;
1283   }
1284   if (req != MPI_REQUEST_NULL && (req->flags_ & MPI_REQ_GENERALIZED) && not(req->flags_ & MPI_REQ_COMPLETE)) {
1285     *flag = 0;
1286     return MPI_SUCCESS;
1287   }
1288
1289   *flag=1;
1290   if(req != MPI_REQUEST_NULL &&
1291      status != MPI_STATUS_IGNORE) {
1292     aid_t src          = req->src_ == MPI_ANY_SOURCE ? req->real_src_ : req->src_;
1293     status->MPI_SOURCE = req->comm_->group()->rank(src);
1294     status->MPI_TAG = req->tag_ == MPI_ANY_TAG ? req->real_tag_ : req->tag_;
1295     status->MPI_ERROR = req->truncated_ ? MPI_ERR_TRUNCATE : MPI_SUCCESS;
1296     status->count = req->real_size_;
1297   }
1298   return MPI_SUCCESS;
1299 }
1300
1301 int Request::grequest_start(MPI_Grequest_query_function* query_fn, MPI_Grequest_free_function* free_fn,
1302                             MPI_Grequest_cancel_function* cancel_fn, void* extra_state, MPI_Request* request)
1303 {
1304   *request = new Request();
1305   (*request)->flags_ |= MPI_REQ_GENERALIZED;
1306   (*request)->flags_ |= MPI_REQ_PERSISTENT;
1307   (*request)->refcount_ = 1;
1308   ((*request)->generalized_funcs)             = std::make_unique<smpi_mpi_generalized_request_funcs_t>();
1309   ((*request)->generalized_funcs)->query_fn=query_fn;
1310   ((*request)->generalized_funcs)->free_fn=free_fn;
1311   ((*request)->generalized_funcs)->cancel_fn=cancel_fn;
1312   ((*request)->generalized_funcs)->extra_state=extra_state;
1313   ((*request)->generalized_funcs)->cond = simgrid::s4u::ConditionVariable::create();
1314   ((*request)->generalized_funcs)->mutex = simgrid::s4u::Mutex::create();
1315   return MPI_SUCCESS;
1316 }
1317
1318 int Request::grequest_complete(MPI_Request request)
1319 {
1320   if ((not(request->flags_ & MPI_REQ_GENERALIZED)) || request->generalized_funcs->mutex == nullptr)
1321     return MPI_ERR_REQUEST;
1322   const std::scoped_lock lock(*request->generalized_funcs->mutex);
1323   request->flags_ |= MPI_REQ_COMPLETE; // in case wait would be called after complete
1324   request->generalized_funcs->cond->notify_one();
1325   return MPI_SUCCESS;
1326 }
1327
1328 void Request::start_nbc_requests(std::vector<MPI_Request> reqs){
1329   if (not reqs.empty()) {
1330     nbc_requests_ = reqs;
1331     Request::startall(reqs.size(), reqs.data());
1332   }
1333 }
1334
1335 std::vector<MPI_Request> Request::get_nbc_requests() const
1336 {
1337   return nbc_requests_;
1338 }
1339 } // namespace simgrid::smpi