Logo AND Algorithmique Numérique Distribuée

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