src/smpi/include/smpi_datatype.hpp

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