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