Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines.
[simgrid.git] / src / smpi / include / smpi_request.hpp
1 /* Copyright (c) 2010-2021. 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 old_type_;
34   size_t size_;
35   int src_;
36   int 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   int real_src_;
41   int real_tag_;
42   bool truncated_;
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   MPI_Op op_;
51   int cancelled_; // tri-state
52   std::unique_ptr<smpi_mpi_generalized_request_funcs_t> generalized_funcs;
53   MPI_Request* nbc_requests_;
54   int nbc_requests_size_;
55   static bool match_common(MPI_Request req, MPI_Request sender, MPI_Request receiver);
56
57 public:
58   Request() = default;
59   Request(const void* buf, int count, MPI_Datatype datatype, int src, int dst, int tag, MPI_Comm comm, unsigned flags, MPI_Op op = MPI_REPLACE);
60   MPI_Comm comm() const { return comm_; }
61   size_t size() const { return size_; }
62   size_t real_size() const { return real_size_; }
63   int src() const { return src_; }
64   int dst() const { return dst_; }
65   int tag() const { return tag_; }
66   int flags() const { return flags_; }
67   bool detached() const { return detached_; }
68   MPI_Datatype type() const { return old_type_; }
69   void print_request(const char* message) const;
70   void start();
71   void cancel();
72   void init_buffer(int count);
73   void ref();
74   void set_nbc_requests(MPI_Request* reqs, int size);
75   int get_nbc_requests_size() const;
76   MPI_Request* get_nbc_requests() const;
77   static void finish_wait(MPI_Request* request, MPI_Status* status);
78   static void unref(MPI_Request* request);
79   static int wait(MPI_Request* req, MPI_Status* status);
80   static MPI_Request bsend_init(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
81   static MPI_Request send_init(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
82   static MPI_Request isend_init(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
83   static MPI_Request ssend_init(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
84   static MPI_Request rma_send_init(const void* buf, int count, MPI_Datatype datatype, int src, int dst, int tag,
85                                    MPI_Comm comm, MPI_Op op);
86   static MPI_Request recv_init(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm);
87   static MPI_Request rma_recv_init(void* buf, int count, MPI_Datatype datatype, int src, int dst, int tag,
88                                    MPI_Comm comm, MPI_Op op);
89   static MPI_Request irecv_init(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm);
90   static MPI_Request ibsend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
91   static MPI_Request isend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
92   static MPI_Request issend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
93   static MPI_Request irecv(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm);
94
95   static void recv(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm, MPI_Status* status);
96   static void bsend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
97   static void send(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
98   static void ssend(const void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
99
100   static void sendrecv(const void* sendbuf, int sendcount, MPI_Datatype sendtype, int dst, int sendtag, void* recvbuf,
101                        int recvcount, MPI_Datatype recvtype, int src, int recvtag, MPI_Comm comm, MPI_Status* status);
102
103   static void startall(int count, MPI_Request* requests);
104
105   static int test(MPI_Request* request, MPI_Status* status, int* flag);
106   static int testsome(int incount, MPI_Request requests[], int* outcounts, int* indices, MPI_Status status[]);
107   static int testany(int count, MPI_Request requests[], int* index, int* flag, MPI_Status* status);
108   static int testall(int count, MPI_Request requests[], int* flag, MPI_Status status[]);
109
110   static void probe(int source, int tag, MPI_Comm comm, MPI_Status* status);
111   static void iprobe(int source, int tag, MPI_Comm comm, int* flag, MPI_Status* status);
112
113   static int waitany(int count, MPI_Request requests[], MPI_Status* status);
114   static int waitall(int count, MPI_Request requests[], MPI_Status status[]);
115   static int waitsome(int incount, MPI_Request requests[], int* indices, MPI_Status status[]);
116
117   static bool match_send(void* a, void* b, kernel::activity::CommImpl* ignored);
118   static bool match_recv(void* a, void* b, kernel::activity::CommImpl* ignored);
119
120   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);
121   static int grequest_complete( MPI_Request request);
122   static int get_status(const Request* req, int* flag, MPI_Status* status);
123
124   static void free_f(int id);
125   static Request* f2c(int);
126 };
127
128
129 }
130 }
131
132 #endif