1 /* Copyright (c) 2009-2020. 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"
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 unproper 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 ? */
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.
29 constexpr unsigned DT_FLAG_BASIC =
30 (DT_FLAG_PREDEFINED | DT_FLAG_CONTIGUOUS | DT_FLAG_NO_GAPS | DT_FLAG_DATA | DT_FLAG_COMMITED);
32 extern const MPI_Datatype MPI_PTR;
34 //The following are datatypes for the MPI functions MPI_MAXLOC and MPI_MINLOC.
47 struct double_double {
67 struct long_double_int {
78 class Datatype_contents {
81 int number_of_integers_;
83 int number_of_addresses_;
85 int number_of_datatypes_;
86 MPI_Datatype* datatypes_;
87 Datatype_contents(int combiner,
88 int number_of_integers, const int* integers,
89 int number_of_addresses, const MPI_Aint* addresses,
90 int number_of_datatypes, const MPI_Datatype* datatypes);
91 Datatype_contents(const Datatype_contents&) = delete;
92 Datatype_contents& operator=(const Datatype_contents&) = delete;
96 class Datatype : public F2C, public Keyval{
97 char* name_ = nullptr;
98 /* The id here is the (unique) datatype id used for this datastructure.
99 * It's default value is set to -1 since some code expects this return value
100 * when no other id has been assigned
102 std::string id = "-1";
110 static std::unordered_map<int, smpi_key_elem> keyvals_;
111 static int keyval_id_;
112 Datatype_contents* contents_ = nullptr;
114 Datatype(int id, int size, MPI_Aint lb, MPI_Aint ub, int flags);
115 Datatype(char* name, int id, int size, MPI_Aint lb, MPI_Aint ub, int flags);
116 Datatype(int size, MPI_Aint lb, MPI_Aint ub, int flags);
117 Datatype(char* name, int size, MPI_Aint lb, MPI_Aint ub, int flags);
118 Datatype(Datatype* datatype, int* ret);
119 Datatype(const Datatype&) = delete;
120 Datatype& operator=(const Datatype&) = delete;
123 char* name() { return name_; }
124 size_t size() { return size_; }
125 MPI_Aint lb() { return lb_; }
126 MPI_Aint ub() { return ub_; }
127 int flags() { return flags_; }
128 int refcount() { return refcount_; }
131 static void unref(MPI_Datatype datatype);
135 static const char* encode(const Datatype* dt) { return dt->id.c_str(); }
136 static MPI_Datatype decode(const std::string& datatype_id);
137 bool is_replayable();
138 void addflag(int flag);
139 int extent(MPI_Aint* lb, MPI_Aint* extent);
140 MPI_Aint get_extent() { return ub_ - lb_; };
141 void get_name(char* name, int* length);
142 void set_name(const char* name);
143 static int copy(const void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int recvcount,
144 MPI_Datatype recvtype);
145 virtual MPI_Datatype clone();
146 virtual void serialize(const void* noncontiguous, void* contiguous, int count);
147 virtual void unserialize(const void* contiguous, void* noncontiguous, int count, MPI_Op op);
148 static int keyval_create(MPI_Type_copy_attr_function* copy_fn, MPI_Type_delete_attr_function* delete_fn, int* keyval,
150 static int keyval_free(int* keyval);
151 int pack(const void* inbuf, int incount, void* outbuf, int outcount, int* position, const Comm* comm);
152 int unpack(const void* inbuf, int insize, int* position, void* outbuf, int outcount, const Comm* comm);
153 int get_contents(int max_integers, int max_addresses,
154 int max_datatypes, int* array_of_integers, MPI_Aint* array_of_addresses,
155 MPI_Datatype *array_of_datatypes);
156 int get_envelope(int* num_integers, int* num_addresses,
157 int* num_datatypes, int* combiner);
158 static int create_contiguous(int count, MPI_Datatype old_type, MPI_Aint lb, MPI_Datatype* new_type);
159 static int create_vector(int count, int blocklen, int stride, MPI_Datatype old_type, MPI_Datatype* new_type);
160 static int create_hvector(int count, int blocklen, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type);
161 static int create_indexed(int count, const int* blocklens, const int* indices, MPI_Datatype old_type, MPI_Datatype* new_type);
162 static int create_hindexed(int count, const int* blocklens, const MPI_Aint* indices, MPI_Datatype old_type,
163 MPI_Datatype* new_type);
164 static int create_struct(int count, const int* blocklens, const MPI_Aint* indices, const MPI_Datatype* old_types,
165 MPI_Datatype* new_type);
166 static int create_subarray(int ndims, const int* array_of_sizes,
167 const int* array_of_subsizes, const int* array_of_starts,
168 int order, MPI_Datatype oldtype, MPI_Datatype *newtype);
169 static int create_resized(MPI_Datatype oldtype,MPI_Aint lb, MPI_Aint extent,
170 MPI_Datatype *newtype);
171 static Datatype* f2c(int id);