1 /* Copyright (c) 2009-2021. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SMPI_DATATYPE_HPP
7 #define SMPI_DATATYPE_HPP
9 #include "smpi_f2c.hpp"
10 #include "smpi_keyvals.hpp"
14 constexpr unsigned DT_FLAG_DESTROYED = 0x00001; /**< user destroyed but some other layers still have a reference */
15 constexpr unsigned DT_FLAG_COMMITED = 0x00002; /**< ready to be used for a send/recv operation */
16 constexpr unsigned DT_FLAG_CONTIGUOUS = 0x00004; /**< contiguous datatype */
17 constexpr unsigned DT_FLAG_OVERLAP = 0x00008; /**< datatype is unproper for a recv operation */
18 constexpr unsigned DT_FLAG_USER_LB = 0x00010; /**< has a user defined LB */
19 constexpr unsigned DT_FLAG_USER_UB = 0x00020; /**< has a user defined UB */
20 constexpr unsigned DT_FLAG_PREDEFINED = 0x00040; /**< cannot be removed: initial and predefined datatypes */
21 constexpr unsigned DT_FLAG_NO_GAPS = 0x00080; /**< no gaps around the datatype */
22 constexpr unsigned DT_FLAG_DATA = 0x00100; /**< data or control structure */
23 constexpr unsigned DT_FLAG_ONE_SIDED = 0x00200; /**< datatype can be used for one sided operations */
24 constexpr unsigned DT_FLAG_UNAVAILABLE = 0x00400; /**< datatypes unavailable on the build (OS or compiler dependent) */
25 constexpr unsigned DT_FLAG_DERIVED = 0x00800; /**< is the datatype derived ? */
26 constexpr unsigned DT_FLAG_C_INTEGER = 0x01000; /**< Family: C ints */
27 constexpr unsigned DT_FLAG_F_INTEGER = 0x02000; /**< Family: F ints */
28 constexpr unsigned DT_FLAG_FP = 0x04000; /**< Family: Floating point */
29 constexpr unsigned DT_FLAG_LOGICAL = 0x08000; /**< Family: Logical */
30 constexpr unsigned DT_FLAG_COMPLEX = 0x10000; /**< Family: Complex */
31 constexpr unsigned DT_FLAG_BYTE = 0x20000; /**< Family: Poor lonesome byte */
32 constexpr unsigned DT_FLAG_MULTILANG = 0x40000; /**< Family: Multi-language */
33 constexpr unsigned DT_FLAG_REDUCTION = 0x80000; /**< Family: Dual types for maxloc/minloc */
35 * We should make the difference here between the predefined contiguous and non contiguous
36 * datatypes. The DT_FLAG_BASIC is held by all predefined contiguous datatypes.
38 constexpr unsigned DT_FLAG_BASIC =
39 (DT_FLAG_PREDEFINED | DT_FLAG_CONTIGUOUS | DT_FLAG_NO_GAPS | DT_FLAG_DATA | DT_FLAG_COMMITED);
41 extern MPI_Datatype MPI_PTR;
43 //The following are datatypes for the MPI functions MPI_MAXLOC and MPI_MINLOC.
56 struct double_double {
76 struct long_double_int {
87 class Datatype_contents {
90 std::vector<int> integers_;
91 std::vector<MPI_Aint> addresses_;
92 std::vector<MPI_Datatype> datatypes_;
93 Datatype_contents(int combiner,
94 int number_of_integers, const int* integers,
95 int number_of_addresses, const MPI_Aint* addresses,
96 int number_of_datatypes, const MPI_Datatype* datatypes);
99 class Datatype : public F2C, public Keyval{
100 std::string name_ = "";
101 /* The id here is the (unique) datatype id used for this datastructure.
102 * It's default value is set to -1 since some code expects this return value
103 * when no other id has been assigned
105 std::string id = "-1";
111 std::unique_ptr<Datatype_contents> contents_ = nullptr;
114 template <typename... Args> void set_contents(Args&&... args)
116 contents_ = std::make_unique<Datatype_contents>(std::forward<Args>(args)...);
120 static std::unordered_map<int, smpi_key_elem> keyvals_;
121 static int keyval_id_;
123 Datatype(int ident, int size, MPI_Aint lb, MPI_Aint ub, int flags);
124 Datatype(const char* name, int ident, int size, MPI_Aint lb, MPI_Aint ub, int flags);
125 Datatype(int size, MPI_Aint lb, MPI_Aint ub, int flags);
126 Datatype(Datatype* datatype, int* ret);
127 Datatype(const Datatype&) = delete;
128 Datatype& operator=(const Datatype&) = delete;
129 ~Datatype() override;
130 std::string name() const override {return name_.empty() ? std::string("MPI_Datatype") : name_;}
131 size_t size() const { return size_; }
132 MPI_Aint lb() const { return lb_; }
133 MPI_Aint ub() const { return ub_; }
134 int flags() const { return flags_; }
135 int refcount() const { return refcount_; }
138 static void unref(MPI_Datatype datatype);
140 int copy_attrs(Datatype* datatype);
141 bool is_valid() const;
142 bool is_basic() const;
143 static const char* encode(const Datatype* dt) { return dt->id.c_str(); }
144 static MPI_Datatype decode(const std::string& datatype_id);
145 bool is_replayable() const;
146 void addflag(int flag);
147 int extent(MPI_Aint* lb, MPI_Aint* extent) const;
148 MPI_Aint get_extent() const { return ub_ - lb_; };
149 void get_name(char* name, int* length) const;
150 void set_name(const char* name);
151 static int copy(const void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int recvcount,
152 MPI_Datatype recvtype);
153 virtual int clone(MPI_Datatype* type);
154 virtual void serialize(const void* noncontiguous, void* contiguous, int count);
155 virtual void unserialize(const void* contiguous, void* noncontiguous, int count, MPI_Op op);
156 static int keyval_create(MPI_Type_copy_attr_function* copy_fn, MPI_Type_delete_attr_function* delete_fn, int* keyval,
158 static int keyval_free(int* keyval);
159 int pack(const void* inbuf, int incount, void* outbuf, int outcount, int* position, const Comm* comm);
160 int unpack(const void* inbuf, int insize, int* position, void* outbuf, int outcount, const Comm* comm);
161 int get_contents(int max_integers, int max_addresses, int max_datatypes, int* array_of_integers,
162 MPI_Aint* array_of_addresses, MPI_Datatype* array_of_datatypes) const;
163 int get_envelope(int* num_integers, int* num_addresses, int* num_datatypes, int* combiner) const;
164 static int create_contiguous(int count, MPI_Datatype old_type, MPI_Aint lb, MPI_Datatype* new_type);
165 static int create_vector(int count, int blocklen, int stride, MPI_Datatype old_type, MPI_Datatype* new_type);
166 static int create_hvector(int count, int blocklen, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type);
167 static int create_indexed(int count, const int* blocklens, const int* indices, MPI_Datatype old_type, MPI_Datatype* new_type);
168 static int create_hindexed(int count, const int* blocklens, const MPI_Aint* indices, MPI_Datatype old_type,
169 MPI_Datatype* new_type);
170 static int create_struct(int count, const int* blocklens, const MPI_Aint* indices, const MPI_Datatype* old_types,
171 MPI_Datatype* new_type);
172 static int create_subarray(int ndims, const int* array_of_sizes,
173 const int* array_of_subsizes, const int* array_of_starts,
174 int order, MPI_Datatype oldtype, MPI_Datatype *newtype);
175 static int create_resized(MPI_Datatype oldtype,MPI_Aint lb, MPI_Aint extent,
176 MPI_Datatype *newtype);
177 static Datatype* f2c(int id);