Logo AND Algorithmique Numérique Distribuée

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