1 /* Copyright (c) 2007-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. */
7 #include "smpi_datatype_derived.hpp"
8 #include "smpi_comm.hpp"
10 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(smpi_pmpi);
12 /* PMPI User level calls */
14 int PMPI_Type_free(MPI_Datatype * datatype)
16 /* Free a predefined datatype is an error according to the standard, and should be checked for */
17 if (*datatype == MPI_DATATYPE_NULL || (*datatype)->flags() & DT_FLAG_PREDEFINED) {
20 (*datatype)->mark_as_deleted();
21 simgrid::smpi::Datatype::unref(*datatype);
22 *datatype=MPI_DATATYPE_NULL;
27 int PMPI_Type_size(MPI_Datatype datatype, int *size)
29 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
30 CHECK_NULL(2, MPI_ERR_ARG, size)
31 *size = static_cast<int>(datatype->size());
35 int PMPI_Type_size_x(MPI_Datatype datatype, MPI_Count *size)
37 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
38 CHECK_NULL(2, MPI_ERR_ARG, size)
39 *size = static_cast<MPI_Count>(datatype->size());
43 int PMPI_Type_get_extent(MPI_Datatype datatype, MPI_Aint * lb, MPI_Aint * extent)
45 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
46 CHECK_NULL(2, MPI_ERR_ARG, lb)
47 CHECK_NULL(3, MPI_ERR_ARG, extent)
48 return datatype->extent(lb, extent);
51 int PMPI_Type_get_extent_x(MPI_Datatype datatype, MPI_Count * lb, MPI_Count * extent)
55 int ret = PMPI_Type_get_extent(datatype, &tmplb, &tmpext);
56 if(ret == MPI_SUCCESS){
57 *lb = static_cast<MPI_Count>(tmplb);
58 *extent = static_cast<MPI_Count>(tmpext);
63 int PMPI_Type_get_true_extent(MPI_Datatype datatype, MPI_Aint * lb, MPI_Aint * extent)
65 return PMPI_Type_get_extent(datatype, lb, extent);
68 int PMPI_Type_get_true_extent_x(MPI_Datatype datatype, MPI_Count * lb, MPI_Count * extent)
70 return PMPI_Type_get_extent_x(datatype, lb, extent);
73 int PMPI_Type_extent(MPI_Datatype datatype, MPI_Aint * extent)
75 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
76 CHECK_NULL(2, MPI_ERR_ARG, extent)
77 *extent = datatype->get_extent();
81 int PMPI_Type_lb(MPI_Datatype datatype, MPI_Aint * disp)
83 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
84 CHECK_NULL(2, MPI_ERR_ARG, disp)
85 *disp = datatype->lb();
89 int PMPI_Type_ub(MPI_Datatype datatype, MPI_Aint * disp)
91 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
92 CHECK_NULL(2, MPI_ERR_ARG, disp)
93 *disp = datatype->ub();
97 int PMPI_Type_dup(MPI_Datatype datatype, MPI_Datatype *newtype){
98 int retval = MPI_SUCCESS;
99 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
100 retval = datatype->clone(newtype);
101 //error when duplicating, free the new datatype
102 if(retval!=MPI_SUCCESS){
103 simgrid::smpi::Datatype::unref(*newtype);
104 *newtype = MPI_DATATYPE_NULL;
109 int PMPI_Type_contiguous(int count, MPI_Datatype old_type, MPI_Datatype* new_type) {
110 CHECK_COUNT(1, count)
111 CHECK_MPI_NULL(2, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
112 CHECK_NULL(3, MPI_ERR_ARG, new_type)
113 return simgrid::smpi::Datatype::create_contiguous(count, old_type, 0, new_type);
116 int PMPI_Type_commit(MPI_Datatype* datatype) {
117 CHECK_NULL(1, MPI_ERR_ARG, datatype)
118 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, (*datatype))
119 (*datatype)->commit();
123 int PMPI_Type_vector(int count, int blocklen, int stride, MPI_Datatype old_type, MPI_Datatype* new_type) {
124 CHECK_COUNT(1, count)
125 CHECK_NEGATIVE(2, MPI_ERR_ARG, blocklen)
126 CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
127 return simgrid::smpi::Datatype::create_vector(count, blocklen, stride, old_type, new_type);
130 int PMPI_Type_hvector(int count, int blocklen, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type) {
131 CHECK_COUNT(1, count)
132 CHECK_NEGATIVE(2, MPI_ERR_ARG, blocklen)
133 CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
134 return simgrid::smpi::Datatype::create_hvector(count, blocklen, stride, old_type, new_type);
137 int PMPI_Type_create_hvector(int count, int blocklen, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type) {
138 return MPI_Type_hvector(count, blocklen, stride, old_type, new_type);
141 int PMPI_Type_indexed(int count, const int* blocklens, const int* indices, MPI_Datatype old_type, MPI_Datatype* new_type) {
142 CHECK_COUNT(1, count)
143 CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
144 return simgrid::smpi::Datatype::create_indexed(count, blocklens, indices, old_type, new_type);
147 int PMPI_Type_create_indexed(int count, const int* blocklens, const int* indices, MPI_Datatype old_type, MPI_Datatype* new_type) {
148 CHECK_COUNT(1, count)
149 CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
150 return simgrid::smpi::Datatype::create_indexed(count, blocklens, indices, old_type, new_type);
153 int PMPI_Type_create_indexed_block(int count, int blocklength, const int* indices, MPI_Datatype old_type,
154 MPI_Datatype* new_type)
156 CHECK_COUNT(1, count)
157 CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
158 auto* blocklens = static_cast<int*>(xbt_malloc(blocklength * count * sizeof(int)));
159 for (int i = 0; i < count; i++)
160 blocklens[i]=blocklength;
161 int retval = simgrid::smpi::Datatype::create_indexed(count, blocklens, indices, old_type, new_type);
166 int PMPI_Type_hindexed(int count, const int* blocklens, const MPI_Aint* indices, MPI_Datatype old_type,
167 MPI_Datatype* new_type)
169 CHECK_COUNT(1, count)
170 CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
171 return simgrid::smpi::Datatype::create_hindexed(count, blocklens, indices, old_type, new_type);
174 int PMPI_Type_create_hindexed(int count, const int* blocklens, const MPI_Aint* indices, MPI_Datatype old_type,
175 MPI_Datatype* new_type) {
176 return PMPI_Type_hindexed(count, blocklens, indices, old_type, new_type);
179 int PMPI_Type_create_hindexed_block(int count, int blocklength, const MPI_Aint* indices, MPI_Datatype old_type,
180 MPI_Datatype* new_type) {
181 CHECK_COUNT(1, count)
182 CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
183 auto* blocklens = static_cast<int*>(xbt_malloc(blocklength * count * sizeof(int)));
184 for (int i = 0; i < count; i++)
185 blocklens[i] = blocklength;
186 int retval = simgrid::smpi::Datatype::create_hindexed(count, blocklens, indices, old_type, new_type);
191 int PMPI_Type_struct(int count, const int* blocklens, const MPI_Aint* indices, const MPI_Datatype* old_types,
192 MPI_Datatype* new_type)
194 CHECK_COUNT(1, count)
195 for(int i=0; i<count; i++)
196 CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_types[i])
197 return simgrid::smpi::Datatype::create_struct(count, blocklens, indices, old_types, new_type);
200 int PMPI_Type_create_struct(int count, const int* blocklens, const MPI_Aint* indices, const MPI_Datatype* old_types,
201 MPI_Datatype* new_type) {
202 return PMPI_Type_struct(count, blocklens, indices, old_types, new_type);
206 int PMPI_Type_create_subarray(int ndims, const int* array_of_sizes,
207 const int* array_of_subsizes, const int* array_of_starts,
208 int order, MPI_Datatype oldtype, MPI_Datatype *newtype) {
209 CHECK_NEGATIVE(1, MPI_ERR_COUNT, ndims)
211 *newtype = MPI_DATATYPE_NULL;
214 CHECK_NULL(2, MPI_ERR_ARG, array_of_sizes)
215 CHECK_NULL(3, MPI_ERR_ARG, array_of_subsizes)
216 CHECK_NULL(4, MPI_ERR_ARG, array_of_starts)
217 for (int i = 0; i < ndims; i++) {
218 CHECK_NEGATIVE_OR_ZERO(2, MPI_ERR_COUNT, array_of_sizes[i])
219 CHECK_NEGATIVE(3, MPI_ERR_COUNT, array_of_subsizes[i])
220 CHECK_NEGATIVE(4, MPI_ERR_COUNT, array_of_starts[i])
223 simgrid::smpi::Datatype::create_contiguous( array_of_subsizes[0], oldtype, array_of_starts[0]*oldtype->get_extent(), newtype);
225 } else if (oldtype == MPI_DATATYPE_NULL || not oldtype->is_valid() ) {
227 } else if (order != MPI_ORDER_FORTRAN && order != MPI_ORDER_C){
230 return simgrid::smpi::Datatype::create_subarray(ndims, array_of_sizes, array_of_subsizes, array_of_starts, order, oldtype, newtype);
234 int PMPI_Type_create_resized(MPI_Datatype oldtype,MPI_Aint lb, MPI_Aint extent, MPI_Datatype *newtype){
235 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, oldtype)
236 return simgrid::smpi::Datatype::create_resized(oldtype, lb, extent, newtype);
240 int PMPI_Type_set_name(MPI_Datatype datatype, const char * name)
242 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
243 CHECK_NULL(2, MPI_ERR_ARG, name)
244 datatype->set_name(name);
248 int PMPI_Type_get_name(MPI_Datatype datatype, char * name, int* len)
250 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
251 CHECK_NULL(2, MPI_ERR_ARG, name)
252 datatype->get_name(name, len);
256 MPI_Datatype PMPI_Type_f2c(MPI_Fint datatype){
258 return MPI_DATATYPE_NULL;
259 return static_cast<MPI_Datatype>(simgrid::smpi::F2C::f2c(datatype));
262 MPI_Fint PMPI_Type_c2f(MPI_Datatype datatype){
263 if(datatype==MPI_DATATYPE_NULL)
265 return datatype->c2f();
268 int PMPI_Type_get_attr (MPI_Datatype type, int type_keyval, void *attribute_val, int* flag)
270 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
271 return type->attr_get<simgrid::smpi::Datatype>(type_keyval, attribute_val, flag);
274 int PMPI_Type_set_attr (MPI_Datatype type, int type_keyval, void *attribute_val)
276 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
277 return type->attr_put<simgrid::smpi::Datatype>(type_keyval, attribute_val);
280 int PMPI_Type_get_contents (MPI_Datatype type, int max_integers, int max_addresses,
281 int max_datatypes, int* array_of_integers, MPI_Aint* array_of_addresses,
282 MPI_Datatype *array_of_datatypes)
284 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
285 CHECK_NEGATIVE(2, MPI_ERR_COUNT, max_integers)
286 CHECK_NEGATIVE(3, MPI_ERR_COUNT, max_addresses)
287 CHECK_NEGATIVE(4, MPI_ERR_COUNT, max_datatypes)
289 CHECK_NULL(5, MPI_ERR_ARG, array_of_integers)
291 CHECK_NULL(6, MPI_ERR_ARG, array_of_addresses)
293 CHECK_NULL(7, MPI_ERR_ARG, array_of_datatypes)
294 return type->get_contents(max_integers, max_addresses, max_datatypes,
295 array_of_integers, array_of_addresses, array_of_datatypes);
298 int PMPI_Type_get_envelope (MPI_Datatype type, int *num_integers, int *num_addresses,
299 int *num_datatypes, int *combiner)
301 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
302 CHECK_NULL(2, MPI_ERR_ARG, num_integers)
303 CHECK_NULL(3, MPI_ERR_ARG, num_addresses)
304 CHECK_NULL(4, MPI_ERR_ARG, num_datatypes)
305 CHECK_NULL(5, MPI_ERR_ARG, combiner)
306 return type->get_envelope(num_integers, num_addresses, num_datatypes, combiner);
309 int PMPI_Type_delete_attr (MPI_Datatype type, int type_keyval)
311 CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
312 return type->attr_delete<simgrid::smpi::Datatype>(type_keyval);
315 int PMPI_Type_create_keyval(MPI_Type_copy_attr_function* copy_fn, MPI_Type_delete_attr_function* delete_fn, int* keyval,
318 smpi_copy_fn _copy_fn={nullptr,copy_fn,nullptr,nullptr,nullptr,nullptr};
319 smpi_delete_fn _delete_fn={nullptr,delete_fn,nullptr,nullptr,nullptr,nullptr};
320 return simgrid::smpi::Keyval::keyval_create<simgrid::smpi::Datatype>(_copy_fn, _delete_fn, keyval, extra_state);
323 int PMPI_Type_free_keyval(int* keyval) {
324 return simgrid::smpi::Keyval::keyval_free<simgrid::smpi::Datatype>(keyval);
327 int PMPI_Unpack(const void* inbuf, int incount, int* position, void* outbuf, int outcount, MPI_Datatype type, MPI_Comm comm) {
328 CHECK_NEGATIVE(2, MPI_ERR_COUNT, incount)
329 CHECK_NEGATIVE(5, MPI_ERR_COUNT, outcount)
330 CHECK_BUFFER(1, inbuf, incount)
331 CHECK_BUFFER(4, outbuf, outcount)
334 return type->unpack(inbuf, incount, position, outbuf,outcount, comm);
337 int PMPI_Pack(const void* inbuf, int incount, MPI_Datatype type, void* outbuf, int outcount, int* position, MPI_Comm comm) {
338 CHECK_NEGATIVE(2, MPI_ERR_COUNT, incount)
339 CHECK_NEGATIVE(5, MPI_ERR_COUNT, outcount)
340 CHECK_BUFFER(1, inbuf, incount)
341 CHECK_BUFFER(4, outbuf, outcount)
344 return type->pack(inbuf == MPI_BOTTOM ? nullptr : inbuf, incount, outbuf, outcount, position, comm);
347 int PMPI_Pack_size(int incount, MPI_Datatype datatype, MPI_Comm comm, int* size) {
348 CHECK_NEGATIVE(1, MPI_ERR_COUNT, incount)
349 CHECK_TYPE(2, datatype)
351 *size = incount * std::max<long>(datatype->size(), datatype->get_extent());