Logo AND Algorithmique Numérique Distribuée

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