src/smpi/include/smpi_request.hpp

   1 /* Copyright (c) 2010-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 #ifndef SMPI_REQUEST_HPP_INCLUDED
   7 #define SMPI_REQUEST_HPP_INCLUDED
   8
   9 #include "smpi/smpi.h"
  10 #include "smpi_f2c.hpp"
  11
  12 #include <memory>
  13
  14 namespace simgrid::smpi {
  15
  16 struct smpi_mpi_generalized_request_funcs_t {
  17   MPI_Grequest_query_function *query_fn;
  18   MPI_Grequest_free_function *free_fn;
  19   MPI_Grequest_cancel_function *cancel_fn;
  20   void* extra_state;
  21   s4u::ConditionVariablePtr cond;
  22   s4u::MutexPtr mutex;
  23 };
  24
  25 class Request : public F2C {
  26   void* buf_;
  27   /* in the case of non-contiguous memory the user address should be keep
  28    * to unserialize the data inside the user memory*/
  29   void* old_buf_;
  30   /* this is especially for derived datatypes that we need to serialize/unserialize.
  31    * It let us know how to unserialize at the end of the communication */
  32   MPI_Datatype type_;
  33   size_t size_;
  34   aid_t src_;
  35   aid_t dst_;
  36   int tag_;
  37   // to handle cases where we have an unknown sender
  38   // We can't override src, tag, and size, because the request may be reused later
  39   aid_t real_src_;
  40   int real_tag_;
  41   bool truncated_;
  42   bool unmatched_types_;
  43   size_t real_size_;
  44   MPI_Comm comm_;
  45   simgrid::kernel::activity::ActivityImplPtr action_;
  46   unsigned flags_;
  47   bool detached_;
  48   MPI_Request detached_sender_;
  49   int refcount_;
  50   std::vector<unsigned int> message_id_;
  51   MPI_Op op_;
  52   std::unique_ptr<smpi_mpi_generalized_request_funcs_t> generalized_funcs;
  53   std::vector<MPI_Request> nbc_requests_;
  54   s4u::Host* src_host_ = nullptr; //!< save SimGrid's source host since it can finished before the recv
  55   static bool match_common(MPI_Request req, MPI_Request sender, MPI_Request receiver);
  56   static bool match_types(MPI_Datatype stype, MPI_Datatype rtype);
  57
  58 public:
  59   Request() = default;
  60   Request(const void* buf, int count, MPI_Datatype datatype, aid_t src, aid_t dst, int tag, MPI_Comm comm,
  61           unsigned flags, MPI_Op op = MPI_REPLACE);
  62   MPI_Comm comm() const { return comm_; }
  63   size_t size() const { return size_; }
  64   size_t real_size() const { return real_size_; }
  65   aid_t src() const { return src_; }
  66   aid_t dst() const { return dst_; }
  67   int tag() const { return tag_; }
  68   int flags() const { return flags_; }
  69   bool detached() const { return detached_; }
  70   std::string name() const override { return "MPI_Request"; }
  71   MPI_Datatype type() const { return type_; }
  72   void print_request(const char* message) const;
  73   void start();
  74   void cancel();
  75   void init_buffer(int count);
  76   void ref();
  77   void start_nbc_requests(std::vector<MPI_Request> reqs);
  78   static int finish_nbc_requests(MPI_Request* req, int test);
  79   std::vector<MPI_Request> get_nbc_requests() const;
  80   static void finish_wait(MPI_Request* request, MPI_Status* status);
  81   static void unref(MPI_Request* request);
  82   static int wait(MPI_Request* req, MPI_Status* status);
  83   static MPI_Request bsend_init(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
  84   static MPI_Request send_init(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
  85   static MPI_Request isend_init(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
  86   static MPI_Request ssend_init(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
  87   static MPI_Request rma_send_init(const void* buf, int count, MPI_Datatype datatype, int src, int dst, int tag,
  88                                    MPI_Comm comm, MPI_Op op);
  89   static MPI_Request recv_init(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm);
  90   static MPI_Request rma_recv_init(void* buf, int count, MPI_Datatype datatype, int src, int dst, int tag,
  91                                    MPI_Comm comm, MPI_Op op);
  92   static MPI_Request irecv_init(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm);
  93   static MPI_Request ibsend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
  94   static MPI_Request isend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
  95   static MPI_Request issend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
  96   static MPI_Request irecv(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm);
  97
  98   static int recv(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm, MPI_Status* status);
  99   static void bsend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
 100   static void send(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
 101   static void ssend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
 102
 103   static void sendrecv(const void* sendbuf, int sendcount, MPI_Datatype sendtype, int dst, int sendtag, void* recvbuf,
 104                        int recvcount, MPI_Datatype recvtype, int src, int recvtag, MPI_Comm comm, MPI_Status* status);
 105   static void isendrecv(const void* sendbuf, int sendcount, MPI_Datatype sendtype, int dst, int sendtag, void* recvbuf,
 106                        int recvcount, MPI_Datatype recvtype, int src, int recvtag, MPI_Comm comm, MPI_Request* request);
 107
 108   static void startall(int count, MPI_Request* requests);
 109
 110   static int test(MPI_Request* request, MPI_Status* status, int* flag);
 111   static int testsome(int incount, MPI_Request requests[], int* outcounts, int* indices, MPI_Status status[]);
 112   static int testany(int count, MPI_Request requests[], int* index, int* flag, MPI_Status* status);
 113   static int testall(int count, MPI_Request requests[], int* flag, MPI_Status status[]);
 114
 115   static void probe(int source, int tag, MPI_Comm comm, MPI_Status* status);
 116   static void iprobe(int source, int tag, MPI_Comm comm, int* flag, MPI_Status* status);
 117
 118   static int waitany(int count, MPI_Request requests[], MPI_Status* status);
 119   static int waitall(int count, MPI_Request requests[], MPI_Status status[]);
 120   static int waitsome(int incount, MPI_Request requests[], int* indices, MPI_Status status[]);
 121
 122   static bool match_send(void* a, void* b, kernel::activity::CommImpl* ignored);
 123   static bool match_recv(void* a, void* b, kernel::activity::CommImpl* ignored);
 124
 125   static int grequest_start( MPI_Grequest_query_function *query_fn, MPI_Grequest_free_function *free_fn, MPI_Grequest_cancel_function *cancel_fn, void *extra_state, MPI_Request *request);
 126   static int grequest_complete( MPI_Request request);
 127   static int get_status(const Request* req, int* flag, MPI_Status* status);
 128
 129   static void free_f(int id);
 130   static Request* f2c(int);
 131 };
 132
 133 } // namespace simgrid::smpi
 134
 135 #endif