Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
constify MPI_Datatype*
[simgrid.git] / src / smpi / include / smpi_datatype.hpp
1 /* Copyright (c) 2009-2019. 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_DATATYPE_HPP
7 #define SMPI_DATATYPE_HPP
8
9 #include "smpi_f2c.hpp"
10 #include "smpi_keyvals.hpp"
11 #include <string>
12
13 constexpr unsigned DT_FLAG_DESTROYED   = 0x0001; /**< user destroyed but some other layers still have a reference */
14 constexpr unsigned DT_FLAG_COMMITED    = 0x0002; /**< ready to be used for a send/recv operation */
15 constexpr unsigned DT_FLAG_CONTIGUOUS  = 0x0004; /**< contiguous datatype */
16 constexpr unsigned DT_FLAG_OVERLAP     = 0x0008; /**< datatype is unpropper for a recv operation */
17 constexpr unsigned DT_FLAG_USER_LB     = 0x0010; /**< has a user defined LB */
18 constexpr unsigned DT_FLAG_USER_UB     = 0x0020; /**< has a user defined UB */
19 constexpr unsigned DT_FLAG_PREDEFINED  = 0x0040; /**< cannot be removed: initial and predefined datatypes */
20 constexpr unsigned DT_FLAG_NO_GAPS     = 0x0080; /**< no gaps around the datatype */
21 constexpr unsigned DT_FLAG_DATA        = 0x0100; /**< data or control structure */
22 constexpr unsigned DT_FLAG_ONE_SIDED   = 0x0200; /**< datatype can be used for one sided operations */
23 constexpr unsigned DT_FLAG_UNAVAILABLE = 0x0400; /**< datatypes unavailable on the build (OS or compiler dependant) */
24 constexpr unsigned DT_FLAG_DERIVED     = 0x0800; /**< is the datatype derived ? */
25 /*
26  * We should make the difference here between the predefined contiguous and non contiguous
27  * datatypes. The DT_FLAG_BASIC is held by all predefined contiguous datatypes.
28  */
29 constexpr unsigned DT_FLAG_BASIC =
30     (DT_FLAG_PREDEFINED | DT_FLAG_CONTIGUOUS | DT_FLAG_NO_GAPS | DT_FLAG_DATA | DT_FLAG_COMMITED);
31
32 extern const MPI_Datatype MPI_PTR;
33
34 //The following are datatypes for the MPI functions MPI_MAXLOC and MPI_MINLOC.
35 struct float_int {
36   float value;
37   int index;
38 };
39 struct float_float {
40   float value;
41   float index;
42 };
43 struct long_long {
44   long value;
45   long index;
46 };
47 struct double_double {
48   double value;
49   double index;
50 };
51 struct long_int {
52   long value;
53   int index;
54 };
55 struct double_int {
56   double value;
57   int index;
58 };
59 struct short_int {
60   short value;
61   int index;
62 };
63 struct int_int {
64   int value;
65   int index;
66 };
67 struct long_double_int {
68   long double value;
69   int index;
70 };
71 struct integer128_t {
72   int64_t value;
73   int64_t index;
74 };
75
76 namespace simgrid{
77 namespace smpi{
78
79 class Datatype : public F2C, public Keyval{
80   char* name_;
81   /* The id here is the (unique) datatype id used for this datastructure.
82    * It's default value is set to -1 since some code expects this return value
83    * when no other id has been assigned
84    */
85   std::string id = "-1";
86   size_t size_;
87   MPI_Aint lb_;
88   MPI_Aint ub_;
89   int flags_;
90   int refcount_;
91
92 public:
93   static std::unordered_map<int, smpi_key_elem> keyvals_;
94   static int keyval_id_;
95
96   Datatype(int id, int size, MPI_Aint lb, MPI_Aint ub, int flags);
97   Datatype(char* name, int id, int size, MPI_Aint lb, MPI_Aint ub, int flags);
98   Datatype(int size, MPI_Aint lb, MPI_Aint ub, int flags);
99   Datatype(char* name, int size, MPI_Aint lb, MPI_Aint ub, int flags);
100   Datatype(Datatype* datatype, int* ret);
101   Datatype(const Datatype&) = delete;
102   Datatype& operator=(const Datatype&) = delete;
103   virtual ~Datatype();
104
105   char* name() { return name_; }
106   size_t size() { return size_; }
107   MPI_Aint lb() { return lb_; }
108   MPI_Aint ub() { return ub_; }
109   int flags() { return flags_; }
110   int refcount() { return refcount_; }
111
112   void ref();
113   static void unref(MPI_Datatype datatype);
114   void commit();
115   bool is_valid();
116   bool is_basic();
117   static const char* encode(MPI_Datatype dt) { return dt->id.c_str(); }
118   static MPI_Datatype decode(const std::string& datatype_id);
119   bool is_replayable();
120   void addflag(int flag);
121   int extent(MPI_Aint* lb, MPI_Aint* extent);
122   MPI_Aint get_extent() { return ub_ - lb_; };
123   void get_name(char* name, int* length);
124   void set_name(char* name);
125   static int copy(const void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int recvcount,
126                   MPI_Datatype recvtype);
127   virtual void serialize(const void* noncontiguous, void* contiguous, int count);
128   virtual void unserialize(const void* contiguous, void* noncontiguous, int count, MPI_Op op);
129   static int keyval_create(MPI_Type_copy_attr_function* copy_fn, MPI_Type_delete_attr_function* delete_fn, int* keyval,
130                            void* extra_state);
131   static int keyval_free(int* keyval);
132   int pack(const void* inbuf, int incount, void* outbuf, int outcount, int* position, MPI_Comm comm);
133   int unpack(const void* inbuf, int insize, int* position, void* outbuf, int outcount, MPI_Comm comm);
134
135   static int create_contiguous(int count, MPI_Datatype old_type, MPI_Aint lb, MPI_Datatype* new_type);
136   static int create_vector(int count, int blocklen, int stride, MPI_Datatype old_type, MPI_Datatype* new_type);
137   static int create_hvector(int count, int blocklen, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type);
138   static int create_indexed(int count, const int* blocklens, const int* indices, MPI_Datatype old_type, MPI_Datatype* new_type);
139   static int create_hindexed(int count, const int* blocklens, const MPI_Aint* indices, MPI_Datatype old_type,
140                              MPI_Datatype* new_type);
141   static int create_struct(int count, const int* blocklens, const MPI_Aint* indices, const MPI_Datatype* old_types,
142                            MPI_Datatype* new_type);
143   static int create_subarray(int ndims, const int* array_of_sizes,
144                              const int* array_of_subsizes, const int* array_of_starts,
145                              int order, MPI_Datatype oldtype, MPI_Datatype *newtype);
146   static int create_resized(MPI_Datatype oldtype,MPI_Aint lb, MPI_Aint extent,
147                              MPI_Datatype *newtype);
148   static Datatype* f2c(int id);
149 };
150
151 }
152 }
153
154 #endif