Logo AND Algorithmique Numérique Distribuée

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