Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add a free method for datatypes
[simgrid.git] / src / smpi / smpi_mpi_dt_private.h
1 /* smpi_mpi_dt_private.h -- functions of smpi_mpi_dt.c that are exported to other SMPI modules. */
2
3 /* Copyright (c) 2009, 2010. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7   * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef SMPI_DT_PRIVATE_H
10 #define SMPI_DT_PRIVATE_H
11
12 #include "private.h"
13
14 #define DT_FLAG_DESTROYED     0x0001  /**< user destroyed but some other layers still have a reference */
15 #define DT_FLAG_COMMITED      0x0002  /**< ready to be used for a send/recv operation */
16 #define DT_FLAG_CONTIGUOUS    0x0004  /**< contiguous datatype */
17 #define DT_FLAG_OVERLAP       0x0008  /**< datatype is unpropper for a recv operation */
18 #define DT_FLAG_USER_LB       0x0010  /**< has a user defined LB */
19 #define DT_FLAG_USER_UB       0x0020  /**< has a user defined UB */
20 #define DT_FLAG_PREDEFINED    0x0040  /**< cannot be removed: initial and predefined datatypes */
21 #define DT_FLAG_NO_GAPS       0x0080  /**< no gaps around the datatype */
22 #define DT_FLAG_DATA          0x0100  /**< data or control structure */
23 #define DT_FLAG_ONE_SIDED     0x0200  /**< datatype can be used for one sided operations */
24 #define DT_FLAG_UNAVAILABLE   0x0400  /**< datatypes unavailable on the build (OS or compiler dependant) */
25 #define DT_FLAG_VECTOR        0x0800  /**< valid only for loops. The loop contain only one element
26                                        **< without extent. It correspond to the vector type. */
27 /*
28  * We should make the difference here between the predefined contiguous and non contiguous
29  * datatypes. The DT_FLAG_BASIC is held by all predefined contiguous datatypes.
30  */
31 #define DT_FLAG_BASIC         (DT_FLAG_PREDEFINED | DT_FLAG_CONTIGUOUS | DT_FLAG_NO_GAPS | DT_FLAG_DATA | DT_FLAG_COMMITED)
32
33 extern MPI_Datatype MPI_PTR;
34
35
36 //*****************************************************************************************
37
38 /* 
39   These are the structures that handle complex data type information, 
40   used for serialization/unserialization of messages
41 */
42
43 typedef struct s_smpi_mpi_vector{
44   s_smpi_subtype_t base;
45   size_t block_stride;
46   size_t block_length;
47   size_t block_count;
48   MPI_Datatype old_type;
49   size_t size_oldtype;
50 } s_smpi_mpi_vector_t;
51
52 typedef struct s_smpi_mpi_hvector{
53   s_smpi_subtype_t base;
54   MPI_Aint block_stride;
55   size_t block_length;
56   size_t block_count;
57   MPI_Datatype old_type;
58   size_t size_oldtype;
59 } s_smpi_mpi_hvector_t;
60
61 typedef struct s_smpi_mpi_indexed{
62   s_smpi_subtype_t base;
63   int* block_lengths;
64   int* block_indices;
65   size_t block_count;
66   MPI_Datatype old_type;
67   size_t size_oldtype;
68 } s_smpi_mpi_indexed_t;
69
70 typedef struct s_smpi_mpi_hindexed{
71   s_smpi_subtype_t base;
72   int* block_lengths;
73   MPI_Aint* block_indices;
74   size_t block_count;
75   MPI_Datatype old_type;
76   size_t size_oldtype;
77 } s_smpi_mpi_hindexed_t;
78
79 typedef struct s_smpi_mpi_struct{
80   s_smpi_subtype_t base;
81   int* block_lengths;
82   MPI_Aint* block_indices;
83   size_t block_count;
84   MPI_Datatype* old_types;
85 } s_smpi_mpi_struct_t;
86
87 /*
88   Functions to handle serialization/unserialization of messages, 3 for each type of MPI_Type
89   One for creating the substructure to handle, one for serialization, one for unserialization
90 */
91
92 void unserialize_vector( const void *contiguous_vector,
93                          void *noncontiguous_vector,
94                          size_t count,
95                          void *type);
96
97 void serialize_vector( const void *noncontiguous_vector,
98                        void *contiguous_vector,
99                        size_t count,
100                        void *type);
101
102 void free_vector(MPI_Datatype* type);
103
104 s_smpi_mpi_vector_t* smpi_datatype_vector_create( int block_stride,
105                                                   int block_length,
106                                                   int block_count,
107                                                   MPI_Datatype old_type,
108                                                   int size_oldtype);
109
110 void unserialize_hvector( const void *contiguous_vector,
111                          void *noncontiguous_vector,
112                          size_t count,
113                          void *type);
114
115 void serialize_hvector( const void *noncontiguous_vector,
116                        void *contiguous_vector,
117                        size_t count,
118                        void *type);
119
120 void free_hvector(MPI_Datatype* type);
121
122 s_smpi_mpi_hvector_t* smpi_datatype_hvector_create( MPI_Aint block_stride,
123                                                   int block_length,
124                                                   int block_count,
125                                                   MPI_Datatype old_type,
126                                                   int size_oldtype);
127
128
129 void unserialize_indexed( const void *contiguous_indexed,
130                          void *noncontiguous_indexed,
131                          size_t count,
132                          void *type);
133
134 void serialize_indexed( const void *noncontiguous_vector,
135                        void *contiguous_vector,
136                        size_t count,
137                        void *type);
138
139 void free_indexed(MPI_Datatype* type);
140
141 s_smpi_mpi_indexed_t* smpi_datatype_indexed_create(int* block_lengths,
142                                                   int* block_indices,
143                                                   int block_count,
144                                                   MPI_Datatype old_type,
145                                                   int size_oldtype);
146
147 void unserialize_hindexed( const void *contiguous_indexed,
148                          void *noncontiguous_indexed,
149                          size_t count,
150                          void *type);
151
152 void serialize_hindexed( const void *noncontiguous_vector,
153                        void *contiguous_vector,
154                        size_t count,
155                        void *type);
156
157 void free_hindexed(MPI_Datatype* type);
158
159 s_smpi_mpi_hindexed_t* smpi_datatype_hindexed_create(int* block_lengths,
160                                                   MPI_Aint* block_indices,
161                                                   int block_count,
162                                                   MPI_Datatype old_type,
163                                                   int size_oldtype);
164
165 void unserialize_struct( const void *contiguous_indexed,
166                          void *noncontiguous_indexed,
167                          size_t count,
168                          void *type);
169
170 void serialize_struct( const void *noncontiguous_vector,
171                        void *contiguous_vector,
172                        size_t count,
173                        void *type);
174
175 void free_struct(MPI_Datatype* type);
176
177 s_smpi_mpi_struct_t* smpi_datatype_struct_create(int* block_lengths,
178                                                   MPI_Aint* block_indices,
179                                                   int block_count,
180                                                   MPI_Datatype* old_types);
181
182 #endif