Logo AND Algorithmique Numérique Distribuée

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