File: opal_datatype_internal.h

package info (click to toggle)
openmpi 5.0.8-4
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 201,684 kB
  • sloc: ansic: 613,078; makefile: 42,353; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (599 lines) | stat: -rw-r--r-- 32,172 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
 * Copyright (c) 2004-2006 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2019 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  All rights
 *                         reserved.
 * Copyright (c) 2004-2006 High Performance Computing Center Stuttgart,
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2006 The Regents of the University of California.
 *                         All rights reserved.
 * Copyright (c) 2009      Oak Ridge National Labs.  All rights reserved.
 * Copyright (c) 2013      Los Alamos National Security, LLC. All rights
 *                         reserved.
 * Copyright (c) 2013      Cisco Systems, Inc.  All rights reserved.
 * Copyright (c) 2017      Research Organization for Information Science
 *                         and Technology (RIST). All rights reserved.
 * Copyright (c) 2018      FUJITSU LIMITED.  All rights reserved.
 * Copyright (c) 2021      IBM Corporation. All rights reserved.
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 */

#ifndef OPAL_DATATYPE_INTERNAL_H_HAS_BEEN_INCLUDED
#define OPAL_DATATYPE_INTERNAL_H_HAS_BEEN_INCLUDED

#include "opal_config.h"

#include <stdarg.h>
#include <string.h>

#if defined(VERBOSE)
#    include "opal/util/output.h"

extern int opal_datatype_dfd;

#    define DDT_DUMP_STACK(PSTACK, STACK_POS, PDESC, NAME) \
        opal_datatype_dump_stack((PSTACK), (STACK_POS), (PDESC), (NAME))

#    define DUMP(...) opal_output(opal_datatype_dfd, __VA_ARGS__)

#else

#    define DDT_DUMP_STACK(PSTACK, STACK_POS, PDESC, NAME)
#    define DUMP(...)

#endif /* VERBOSE */

/*
 * There 3 types of predefined data types.
 * - the basic one composed by just one basic datatype which are
 *   definitively contiguous
 * - the derived ones where the same basic type is used multiple times.
 *   They should be most of the time contiguous.
 * - and finally the derived one where multiple basic types are used.
 *   Depending on the architecture they can be contiguous or not.
 *
 * At the OPAL-level we do not care from which language the datatype came from
 * (C, C++ or FORTRAN), we only focus on their internal representation in
 * the host memory. There is one notable exception, the long predefined type
 * which need to be handled at the lowest level due to it's variable size but
 * fixed XDR representation.
 *
 * NOTE: This predefined datatype order should be matched by any upper-level
 * users of the OPAL datatype.
 */
#define OPAL_DATATYPE_LOOP                0
#define OPAL_DATATYPE_END_LOOP            1
#define OPAL_DATATYPE_LB                  2
#define OPAL_DATATYPE_UB                  3
#define OPAL_DATATYPE_FIRST_TYPE          4 /* Number of first real type */
#define OPAL_DATATYPE_INT1                4
#define OPAL_DATATYPE_INT2                5
#define OPAL_DATATYPE_INT4                6
#define OPAL_DATATYPE_INT8                7
#define OPAL_DATATYPE_INT16               8
#define OPAL_DATATYPE_UINT1               9
#define OPAL_DATATYPE_UINT2               10
#define OPAL_DATATYPE_UINT4               11
#define OPAL_DATATYPE_UINT8               12
#define OPAL_DATATYPE_UINT16              13
#define OPAL_DATATYPE_FLOAT2              14
#define OPAL_DATATYPE_FLOAT4              15
#define OPAL_DATATYPE_FLOAT8              16
#define OPAL_DATATYPE_FLOAT12             17
#define OPAL_DATATYPE_FLOAT16             18
#define OPAL_DATATYPE_SHORT_FLOAT_COMPLEX 19
#define OPAL_DATATYPE_FLOAT_COMPLEX       20
#define OPAL_DATATYPE_DOUBLE_COMPLEX      21
#define OPAL_DATATYPE_LONG_DOUBLE_COMPLEX 22
#define OPAL_DATATYPE_BOOL                23
#define OPAL_DATATYPE_WCHAR               24
#define OPAL_DATATYPE_LONG                25
#define OPAL_DATATYPE_UNSIGNED_LONG       26
#define OPAL_DATATYPE_UNAVAILABLE         27

#ifndef OPAL_DATATYPE_MAX_PREDEFINED
#    define OPAL_DATATYPE_MAX_PREDEFINED (OPAL_DATATYPE_UNAVAILABLE + 1)
#elif OPAL_DATATYPE_MAX_PREDEFINED <= OPAL_DATATYPE_UNAVAILABLE
/*
 * If the number of basic datatype should change update
 * OPAL_DATATYPE_MAX_PREDEFINED in opal_datatype.h
 */
#    error OPAL_DATATYPE_MAX_PREDEFINED should be updated to the next value after the OPAL_DATATYPE_UNAVAILABLE define
#endif

#define DT_INCREASE_STACK 8

BEGIN_C_DECLS

struct ddt_elem_id_description {
    uint16_t flags; /**< flags for the record */
    uint16_t type;  /**< the basic data type id */
};
typedef struct ddt_elem_id_description ddt_elem_id_description;

/**
 * The data element description. It is similar to a vector type, a contiguous
 * blocklen number of basic elements, with a displacement for the first element
 * and then an extent for all the extra count.
 */
struct ddt_elem_desc {
    ddt_elem_id_description common; /**< basic data description and flags */
    uint32_t count;                 /**< number of blocks */
    size_t blocklen;                /**< number of elements on each block */
    ptrdiff_t extent;               /**< extent of each block (in bytes) */
    ptrdiff_t disp;                 /**< displacement of the first block */
};
typedef struct ddt_elem_desc ddt_elem_desc_t;

/**
 * The loop description, with it's two markers: one for the beginning and one for
 * the end. The initial marker contains the number of repetitions, the number of
 * elements in the loop, and the extent of each loop. The end marker contains in
 * addition to the number of elements (so that we can easily pair together the
 * two markers), the size of the data contained inside and the displacement of
 * the first element.
 */
struct ddt_loop_desc {
    ddt_elem_id_description common; /**< basic data description and flags */
    uint32_t items;                 /**< number of items in the loop */
    uint32_t loops;                 /**< number of elements */
    size_t unused;                  /**< not used right now */
    ptrdiff_t extent;               /**< extent of the whole loop */
};
typedef struct ddt_loop_desc ddt_loop_desc_t;

struct ddt_endloop_desc {
    ddt_elem_id_description common; /**< basic data description and flags */
    uint32_t items;                 /**< number of elements */
    uint32_t unused;                /**< not used right now */
    size_t size;                    /**< real size of the data in the loop */
    ptrdiff_t first_elem_disp;      /**< the displacement of the first block in the loop */
};
typedef struct ddt_endloop_desc ddt_endloop_desc_t;

union dt_elem_desc {
    ddt_elem_desc_t elem;
    ddt_loop_desc_t loop;
    ddt_endloop_desc_t end_loop;
};

#define CREATE_LOOP_START(_place, _count, _items, _extent, _flags)         \
    do {                                                                   \
        (_place)->loop.common.type = OPAL_DATATYPE_LOOP;                   \
        (_place)->loop.common.flags = (_flags) & ~OPAL_DATATYPE_FLAG_DATA; \
        (_place)->loop.loops = (_count);                                   \
        (_place)->loop.items = (_items);                                   \
        (_place)->loop.extent = (_extent);                                 \
        (_place)->loop.unused = -1;                                        \
    } while (0)

#define CREATE_LOOP_END(_place, _items, _first_item_disp, _size, _flags)       \
    do {                                                                       \
        (_place)->end_loop.common.type = OPAL_DATATYPE_END_LOOP;               \
        (_place)->end_loop.common.flags = (_flags) & ~OPAL_DATATYPE_FLAG_DATA; \
        (_place)->end_loop.items = (_items);                                   \
        (_place)->end_loop.first_elem_disp = (_first_item_disp);               \
        (_place)->end_loop.size = (_size); /* the size inside the loop */      \
        (_place)->end_loop.unused = -1;                                        \
    } while (0)

/**
 * Create an element entry in the description. If the element is contiguous
 * collapse everything into the blocklen.
 */
#define CREATE_ELEM(_place, _type, _flags, _blocklen, _count, _disp, _extent)                 \
    do {                                                                                      \
        (_place)->elem.common.flags = (_flags) | OPAL_DATATYPE_FLAG_DATA;                     \
        (_place)->elem.common.type = (_type);                                                 \
        (_place)->elem.blocklen = (_blocklen);                                                \
        (_place)->elem.count = (_count);                                                      \
        (_place)->elem.extent = (_extent);                                                    \
        (_place)->elem.disp = (_disp);                                                        \
        if (_extent == (ptrdiff_t) (_blocklen * opal_datatype_basicDatatypes[_type]->size)) { \
            /* collapse it into a single large blocklen */                                    \
            (_place)->elem.blocklen *= _count;                                                \
            (_place)->elem.extent *= _count;                                                  \
            (_place)->elem.count = 1;                                                         \
        }                                                                                     \
    } while (0)
/*
 * This array holds the descriptions desc.desc[2] of the predefined basic datatypes.
 */
OPAL_DECLSPEC extern union dt_elem_desc
    opal_datatype_predefined_elem_desc[2 * OPAL_DATATYPE_MAX_PREDEFINED];
struct opal_datatype_t;

/* Other fields starting after bdt_used (index of OPAL_DATATYPE_LOOP should be ONE) */
/*
 * NOTE: The order of initialization *MUST* match the order of the OPAL_DATATYPE_-numbers.
 * Unfortunateley, I don't get the preprocessor to replace
 *     OPAL_DATATYPE_INIT_BTYPES_ARRAY_ ## OPAL_DATATYPE ## NAME
 * into
 *     OPAL_DATATYPE_INIT_BTYPES_ARRAY_[0-21], then order and naming would _not_ matter....
 */

#define OPAL_DATATYPE_INIT_PTYPES_ARRAY_UNAVAILABLE NULL
#define OPAL_DATATYPE_INIT_PTYPES_ARRAY(NAME)                              \
    (size_t[OPAL_DATATYPE_MAX_PREDEFINED])                                 \
    {                                                                      \
        [OPAL_DATATYPE_##NAME] = 1, [OPAL_DATATYPE_MAX_PREDEFINED - 1] = 0 \
    }

#define OPAL_DATATYPE_INIT_NAME(NAME) "OPAL_" #NAME

/*
 * Macro to initialize the main description for basic types, setting the pointer
 * into the array opal_datatype_predefined_type_desc, which is initialized at
 * runtime in opal_datatype_init(). Each basic type has two desc-elements....
 */
#define OPAL_DATATYPE_INIT_DESC_PREDEFINED(NAME)                                \
    {                                                                           \
        .length = 1, .used = 1,                                                 \
        .desc = &(opal_datatype_predefined_elem_desc[2 * OPAL_DATATYPE_##NAME]) \
    }
#define OPAL_DATATYPE_INIT_DESC_NULL         \
    {                                        \
        .length = 0, .used = 0, .desc = NULL \
    }

#define OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED(NAME, FLAGS)                                   \
    {                                                                                              \
        .super = OPAL_OBJ_STATIC_INIT(opal_datatype_t),                                            \
        .flags = OPAL_DATATYPE_FLAG_UNAVAILABLE | OPAL_DATATYPE_FLAG_PREDEFINED | (FLAGS),         \
        .id = OPAL_DATATYPE_##NAME, .bdt_used = 0, .size = 0, .true_lb = 0, .true_ub = 0, .lb = 0, \
        .ub = 0, .align = 0, .nbElems = 1, .name = OPAL_DATATYPE_INIT_NAME(NAME),                  \
        .desc = OPAL_DATATYPE_INIT_DESC_PREDEFINED(UNAVAILABLE),                                   \
        .opt_desc = OPAL_DATATYPE_INIT_DESC_PREDEFINED(UNAVAILABLE),                               \
        .ptypes = OPAL_DATATYPE_INIT_PTYPES_ARRAY_UNAVAILABLE                                      \
    }

#define OPAL_DATATYPE_INITIALIZER_UNAVAILABLE(FLAGS) \
    OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED(UNAVAILABLE, (FLAGS))

#define OPAL_DATATYPE_INITIALIZER_EMPTY(FLAGS)                                               \
    {                                                                                        \
        .super = OPAL_OBJ_STATIC_INIT(opal_datatype_t),                                      \
        .flags = OPAL_DATATYPE_FLAG_PREDEFINED | (FLAGS), .id = 0, .bdt_used = 0, .size = 0, \
        .true_lb = 0, .true_ub = 0, .lb = 0, .ub = 0, .align = 0, .nbElems = 1,              \
        .name = OPAL_DATATYPE_INIT_NAME(EMPTY), .desc = OPAL_DATATYPE_INIT_DESC_NULL,        \
        .opt_desc = OPAL_DATATYPE_INIT_DESC_NULL,                                            \
        .ptypes = OPAL_DATATYPE_INIT_PTYPES_ARRAY_UNAVAILABLE                                \
    }

#define OPAL_DATATYPE_INIT_BASIC_TYPE(TYPE, NAME, FLAGS)                                        \
    {                                                                                           \
        .super = OPAL_OBJ_STATIC_INIT(opal_datatype_t),                                         \
        .flags = OPAL_DATATYPE_FLAG_PREDEFINED | (FLAGS), .id = TYPE,                           \
        .bdt_used = (((uint32_t) 1) << (TYPE)), .size = 0, .true_lb = 0, .true_ub = 0, .lb = 0, \
        .ub = 0, .align = 0, .nbElems = 1, .name = OPAL_DATATYPE_INIT_NAME(NAME),               \
        .desc = OPAL_DATATYPE_INIT_DESC_NULL, .opt_desc = OPAL_DATATYPE_INIT_DESC_NULL,         \
        .ptypes = OPAL_DATATYPE_INIT_PTYPES_ARRAY_UNAVAILABLE                                   \
    }

#define OPAL_DATATYPE_INIT_BASIC_DATATYPE(TYPE, ALIGN, NAME, FLAGS)                           \
    {                                                                                         \
        .super = OPAL_OBJ_STATIC_INIT(opal_datatype_t),                                       \
        .flags = OPAL_DATATYPE_FLAG_BASIC | (FLAGS), .id = OPAL_DATATYPE_##NAME,              \
        .bdt_used = (((uint32_t) 1) << (OPAL_DATATYPE_##NAME)), .size = sizeof(TYPE),         \
        .true_lb = 0, .true_ub = sizeof(TYPE), .lb = 0, .ub = sizeof(TYPE), .align = (ALIGN), \
        .nbElems = 1, .name = OPAL_DATATYPE_INIT_NAME(NAME),                                  \
        .desc = OPAL_DATATYPE_INIT_DESC_PREDEFINED(NAME),                                     \
        .opt_desc = OPAL_DATATYPE_INIT_DESC_PREDEFINED(NAME),                                 \
        .ptypes = OPAL_DATATYPE_INIT_PTYPES_ARRAY_UNAVAILABLE                                 \
    }

#define OPAL_DATATYPE_INITIALIZER_INT1(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_INT1(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                              OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_INT2(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_INT2(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                              OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_INT4(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_INT4(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                              OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_INT8(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_INT8(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                              OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_INT16(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_INT16(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                               OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_UINT1(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_UINT1(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                               OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_UINT2(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_UINT2(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                               OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_UINT4(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_UINT4(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                               OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_UINT8(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_UINT8(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                               OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_UINT16(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_UINT16(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_FLOAT2(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_FLOAT2(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_FLOAT4(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_FLOAT4(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_FLOAT8(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_FLOAT8(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_FLOAT12(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_FLOAT12(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                 OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_FLOAT16(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_FLOAT16(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                 OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_SHORT_FLOAT_COMPLEX(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_SHORT_FLOAT_COMPLEX(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                             OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_FLOAT_COMPLEX(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_FLOAT_COMPLEX(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                       OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_DOUBLE_COMPLEX(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_DOUBLE_COMPLEX(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                        OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_LONG_DOUBLE_COMPLEX(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_LONG_DOUBLE_COMPLEX(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                                             OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_BOOL(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_BOOL(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                              OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_WCHAR(FLAGS)                    \
    OPAL_DATATYPE_HANDLE_WCHAR(OPAL_DATATYPE_INIT_BASIC_DATATYPE, \
                               OPAL_DATATYPE_INITIALIZER_UNAVAILABLE_NAMED, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_LOOP(FLAGS) \
    OPAL_DATATYPE_INIT_BASIC_TYPE(OPAL_DATATYPE_LOOP, LOOP_S, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_END_LOOP(FLAGS) \
    OPAL_DATATYPE_INIT_BASIC_TYPE(OPAL_DATATYPE_END_LOOP, LOOP_E, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_LB(FLAGS) \
    OPAL_DATATYPE_INIT_BASIC_TYPE(OPAL_DATATYPE_LB, LB, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_UB(FLAGS) \
    OPAL_DATATYPE_INIT_BASIC_TYPE(OPAL_DATATYPE_UB, UB, FLAGS)

#define OPAL_DATATYPE_HANDLE_INT1(AV, NOTAV, FLAGS) AV(int8_t, OPAL_ALIGNMENT_INT8, INT1, FLAGS)
#define OPAL_DATATYPE_HANDLE_INT2(AV, NOTAV, FLAGS) AV(int16_t, OPAL_ALIGNMENT_INT16, INT2, FLAGS)
#define OPAL_DATATYPE_HANDLE_INT4(AV, NOTAV, FLAGS) AV(int32_t, OPAL_ALIGNMENT_INT32, INT4, FLAGS)
#define OPAL_DATATYPE_HANDLE_INT8(AV, NOTAV, FLAGS) AV(int64_t, OPAL_ALIGNMENT_INT64, INT8, FLAGS)
#ifdef HAVE_INT128_T
#    define OPAL_DATATYPE_HANDLE_INT16(AV, NOTAV, FLAGS) \
        AV(int128_t, OPAL_ALIGNMENT_INT128, INT16, FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_INT16(AV, NOTAV, FLAGS) NOTAV(INT16, FLAGS)
#endif
#define OPAL_DATATYPE_HANDLE_UINT1(AV, NOTAV, FLAGS) AV(uint8_t, OPAL_ALIGNMENT_INT8, UINT1, FLAGS)
#define OPAL_DATATYPE_HANDLE_UINT2(AV, NOTAV, FLAGS) \
    AV(uint16_t, OPAL_ALIGNMENT_INT16, UINT2, FLAGS)
#define OPAL_DATATYPE_HANDLE_UINT4(AV, NOTAV, FLAGS) \
    AV(uint32_t, OPAL_ALIGNMENT_INT32, UINT4, FLAGS)
#define OPAL_DATATYPE_HANDLE_UINT8(AV, NOTAV, FLAGS) \
    AV(uint64_t, OPAL_ALIGNMENT_INT64, UINT8, FLAGS)
#ifdef HAVE_UINT128_T
#    define OPAL_DATATYPE_HANDLE_UINT16(AV, NOTAV, FLAGS) \
        AV(uint128_t, OPAL_ALIGNMENT_INT128, UINT16, FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_UINT16(AV, NOTAV, FLAGS) NOTAV(INT16, FLAGS)
#endif


#define OPAL_DATATYPE_INITIALIZER_LONG(FLAGS)  \
     OPAL_DATATYPE_INIT_BASIC_DATATYPE(long, OPAL_ALIGNMENT_LONG, LONG, FLAGS)
#define OPAL_DATATYPE_INITIALIZER_UNSIGNED_LONG(FLAGS)  \
     OPAL_DATATYPE_INIT_BASIC_DATATYPE(unsigned long, OPAL_ALIGNMENT_LONG, UNSIGNED_LONG, FLAGS)

#if defined(HAVE_SHORT_FLOAT) && SIZEOF_SHORT_FLOAT == 2
#    define OPAL_DATATYPE_HANDLE_FLOAT2(AV, NOTAV, FLAGS) \
        AV(short float, OPAL_ALIGNMENT_SHORT_FLOAT, FLOAT2, FLAGS)
#elif SIZEOF_FLOAT == 2
#    define OPAL_DATATYPE_HANDLE_FLOAT2(AV, NOTAV, FLAGS) \
        AV(float, OPAL_ALIGNMENT_FLOAT, FLOAT2, FLAGS)
#elif SIZEOF_DOUBLE == 2
#    define OPAL_DATATYPE_HANDLE_FLOAT2(AV, NOTAV, FLAGS) \
        AV(double, OPAL_ALIGNMENT_DOUBLE, FLOAT2, FLAGS)
#elif SIZEOF_LONG_DOUBLE == 2
#    define OPAL_DATATYPE_HANDLE_FLOAT2(AV, NOTAV, FLAGS) \
        AV(long double, OPAL_ALIGNMENT_LONG_DOUBLE, FLOAT2, FLAGS)
#elif defined(HAVE_OPAL_SHORT_FLOAT_T) && SIZEOF_OPAL_SHORT_FLOAT_T == 2
#    define OPAL_DATATYPE_HANDLE_FLOAT2(AV, NOTAV, FLAGS) \
        AV(opal_short_float_t, OPAL_ALIGNMENT_OPAL_SHORT_FLOAT_T, FLOAT2, FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_FLOAT2(AV, NOTAV, FLAGS) NOTAV(FLOAT2, FLAGS)
#endif

#if defined(HAVE_SHORT_FLOAT) && SIZEOF_SHORT_FLOAT == 4
#    define OPAL_DATATYPE_HANDLE_FLOAT4(AV, NOTAV, FLAGS) \
        AV(short float, OPAL_ALIGNMENT_SHORT_FLOAT, FLOAT4, FLAGS)
#elif SIZEOF_FLOAT == 4
#    define OPAL_DATATYPE_HANDLE_FLOAT4(AV, NOTAV, FLAGS) \
        AV(float, OPAL_ALIGNMENT_FLOAT, FLOAT4, FLAGS)
#elif SIZEOF_DOUBLE == 4
#    define OPAL_DATATYPE_HANDLE_FLOAT4(AV, NOTAV, FLAGS) \
        AV(double, OPAL_ALIGNMENT_DOUBLE, FLOAT4, FLAGS)
#elif SIZEOF_LONG_DOUBLE == 4
#    define OPAL_DATATYPE_HANDLE_FLOAT4(AV, NOTAV, FLAGS) \
        AV(long double, OPAL_ALIGNMENT_LONG_DOUBLE, FLOAT4, FLAGS)
#elif defined(HAVE_OPAL_SHORT_FLOAT_T) && SIZEOF_OPAL_SHORT_FLOAT_T == 4
#    define OPAL_DATATYPE_HANDLE_FLOAT4(AV, NOTAV, FLAGS) \
        AV(opal_short_float_t, OPAL_ALIGNMENT_OPAL_SHORT_FLOAT_T, FLOAT4, FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_FLOAT4(AV, NOTAV, FLAGS) NOTAV(FLOAT4, FLAGS)
#endif

#if defined(HAVE_SHORT_FLOAT) && SIZEOF_SHORT_FLOAT == 8
#    define OPAL_DATATYPE_HANDLE_FLOAT8(AV, NOTAV, FLAGS) \
        AV(short float, OPAL_ALIGNMENT_SHORT_FLOAT, FLOAT8, FLAGS)
#elif SIZEOF_FLOAT == 8
#    define OPAL_DATATYPE_HANDLE_FLOAT8(AV, NOTAV, FLAGS) \
        AV(float, OPAL_ALIGNMENT_FLOAT, FLOAT8, FLAGS)
#elif SIZEOF_DOUBLE == 8
#    define OPAL_DATATYPE_HANDLE_FLOAT8(AV, NOTAV, FLAGS) \
        AV(double, OPAL_ALIGNMENT_DOUBLE, FLOAT8, FLAGS)
#elif SIZEOF_LONG_DOUBLE == 8
#    define OPAL_DATATYPE_HANDLE_FLOAT8(AV, NOTAV, FLAGS) \
        AV(long double, OPAL_ALIGNMENT_LONG_DOUBLE, FLOAT8, FLAGS)
#elif defined(HAVE_OPAL_SHORT_FLOAT_T) && SIZEOF_OPAL_SHORT_FLOAT_T == 8
#    define OPAL_DATATYPE_HANDLE_FLOAT8(AV, NOTAV, FLAGS) \
        AV(opal_short_float_t, OPAL_ALIGNMENT_OPAL_SHORT_FLOAT_T, FLOAT8, FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_FLOAT8(AV, NOTAV, FLAGS) NOTAV(FLOAT8, FLAGS)
#endif

#if defined(HAVE_SHORT_FLOAT) && SIZEOF_SHORT_FLOAT == 12
#    define OPAL_DATATYPE_HANDLE_FLOAT12(AV, NOTAV, FLAGS) \
        AV(short float, OPAL_ALIGNMENT_SHORT_FLOAT, FLOAT12, FLAGS)
#elif SIZEOF_FLOAT == 12
#    define OPAL_DATATYPE_HANDLE_FLOAT12(AV, NOTAV, FLAGS) \
        AV(float, OPAL_ALIGNMENT_FLOAT, FLOAT12, FLAGS)
#elif SIZEOF_DOUBLE == 12
#    define OPAL_DATATYPE_HANDLE_FLOAT12(AV, NOTAV, FLAGS) \
        AV(double, OPAL_ALIGNMENT_DOUBLE, FLOAT12, FLAGS)
#elif SIZEOF_LONG_DOUBLE == 12
#    define OPAL_DATATYPE_HANDLE_FLOAT12(AV, NOTAV, FLAGS) \
        AV(long double, OPAL_ALIGNMENT_LONG_DOUBLE, FLOAT12, FLAGS)
#elif defined(HAVE_OPAL_SHORT_FLOAT_T) && SIZEOF_OPAL_SHORT_FLOAT_T == 12
#    define OPAL_DATATYPE_HANDLE_FLOAT12(AV, NOTAV, FLAGS) \
        AV(opal_short_float_t, OPAL_ALIGNMENT_OPAL_SHORT_FLOAT_T, FLOAT12, FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_FLOAT12(AV, NOTAV, FLAGS) NOTAV(FLOAT12, FLAGS)
#endif

#if defined(HAVE_SHORT_FLOAT) && SIZEOF_SHORT_FLOAT == 16
#    define OPAL_DATATYPE_HANDLE_FLOAT16(AV, NOTAV, FLAGS) \
        AV(short float, OPAL_ALIGNMENT_SHORT_FLOAT, FLOAT16, FLAGS)
#elif SIZEOF_FLOAT == 16
#    define OPAL_DATATYPE_HANDLE_FLOAT16(AV, NOTAV, FLAGS) \
        AV(float, OPAL_ALIGNMENT_FLOAT, FLOAT16, FLAGS)
#elif SIZEOF_DOUBLE == 16
#    define OPAL_DATATYPE_HANDLE_FLOAT16(AV, NOTAV, FLAGS) \
        AV(double, OPAL_ALIGNMENT_DOUBLE, FLOAT16, FLAGS)
#elif SIZEOF_LONG_DOUBLE == 16
#    define OPAL_DATATYPE_HANDLE_FLOAT16(AV, NOTAV, FLAGS) \
        AV(long double, OPAL_ALIGNMENT_LONG_DOUBLE, FLOAT16, FLAGS)
#elif defined(HAVE_OPAL_SHORT_FLOAT_T) && SIZEOF_OPAL_SHORT_FLOAT_T == 16
#    define OPAL_DATATYPE_HANDLE_FLOAT16(AV, NOTAV, FLAGS) \
        AV(opal_short_float_t, OPAL_ALIGNMENT_OPAL_SHORT_FLOAT_T, FLOAT16, FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_FLOAT16(AV, NOTAV, FLAGS) NOTAV(FLOAT16, FLAGS)
#endif

#if defined(HAVE_SHORT_FLOAT__COMPLEX)
#    define OPAL_DATATYPE_HANDLE_SHORT_FLOAT_COMPLEX(AV, NOTAV, FLAGS) \
        AV(short float _Complex, OPAL_ALIGNMENT_SHORT_FLOAT_COMPLEX, SHORT_FLOAT_COMPLEX, FLAGS)
#elif defined(HAVE_OPAL_SHORT_FLOAT_COMPLEX_T)
#    define OPAL_DATATYPE_HANDLE_SHORT_FLOAT_COMPLEX(AV, NOTAV, FLAGS)                         \
        AV(opal_short_float_complex_t, OPAL_ALIGNMENT_OPAL_SHORT_FLOAT_T, SHORT_FLOAT_COMPLEX, \
           FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_SHORT_FLOAT_COMPLEX(AV, NOTAV, FLAGS) \
        NOTAV(SHORT_FLOAT_COMPLEX, FLAGS)
#endif

#define OPAL_DATATYPE_HANDLE_FLOAT_COMPLEX(AV, NOTAV, FLAGS) \
    AV(float _Complex, OPAL_ALIGNMENT_FLOAT_COMPLEX, FLOAT_COMPLEX, FLAGS)

#define OPAL_DATATYPE_HANDLE_DOUBLE_COMPLEX(AV, NOTAV, FLAGS) \
    AV(double _Complex, OPAL_ALIGNMENT_DOUBLE_COMPLEX, DOUBLE_COMPLEX, FLAGS)

#define OPAL_DATATYPE_HANDLE_LONG_DOUBLE_COMPLEX(AV, NOTAV, FLAGS) \
    AV(long double _Complex, OPAL_ALIGNMENT_LONG_DOUBLE_COMPLEX, LONG_DOUBLE_COMPLEX, FLAGS)

#define OPAL_DATATYPE_HANDLE_BOOL(AV, NOTAV, FLAGS) \
    AV(_Bool, OPAL_ALIGNMENT_BOOL, BOOL, FLAGS)

#if OPAL_ALIGNMENT_WCHAR != 0
#    define OPAL_DATATYPE_HANDLE_WCHAR(AV, NOTAV, FLAGS) \
        AV(wchar_t, OPAL_ALIGNMENT_WCHAR, WCHAR, FLAGS)
#else
#    define OPAL_DATATYPE_HANDLE_WCHAR(AV, NOTAV, FLAGS) NOTAV(WCHAR, FLAGS)
#endif

#define BASIC_DDT_FROM_ELEM(ELEM) (opal_datatype_basicDatatypes[(ELEM).elem.common.type])

#define SAVE_STACK(PSTACK, INDEX, TYPE, COUNT, DISP) \
    do {                                             \
        (PSTACK)->index = (INDEX);                   \
        (PSTACK)->type = (TYPE);                     \
        (PSTACK)->count = (COUNT);                   \
        (PSTACK)->disp = (DISP);                     \
    } while (0)

#define PUSH_STACK(PSTACK, STACK_POS, INDEX, TYPE, COUNT, DISP)   \
    do {                                                          \
        dt_stack_t *pTempStack = (PSTACK) + 1;                    \
        SAVE_STACK(pTempStack, (INDEX), (TYPE), (COUNT), (DISP)); \
        (STACK_POS)++;                                            \
        (PSTACK) = pTempStack;                                    \
    } while (0)

#if OPAL_ENABLE_DEBUG
#    define OPAL_DATATYPE_SAFEGUARD_POINTER(ACTPTR, LENGTH, INITPTR, PDATA, COUNT)                \
        {                                                                                         \
            unsigned char *__lower_bound = (INITPTR), *__upper_bound;                             \
            assert( (COUNT) != 0 );                                                               \
            __lower_bound += (PDATA)->true_lb;                                                    \
            __upper_bound = (INITPTR) + (PDATA)->true_ub +                                        \
                            ((PDATA)->ub - (PDATA)->lb) * ((COUNT) -1);                           \
            if (((ACTPTR) < __lower_bound) || ((ACTPTR) >= __upper_bound)) {                      \
                opal_datatype_safeguard_pointer_debug_breakpoint((ACTPTR), (LENGTH), (INITPTR),   \
                                                                 (PDATA), (COUNT));               \
                opal_output(0,                                                                    \
                            "%s:%d\n\tPointer %p size %lu is outside [%p,%p] for\n\tbase ptr %p " \
                            "count %lu and data \n",                                              \
                            __FILE__, __LINE__, (void *) (ACTPTR), (unsigned long) (LENGTH),      \
                            (void *) __lower_bound, (void *) __upper_bound, (void *) (INITPTR),   \
                            (unsigned long) (COUNT));                                             \
                opal_datatype_dump((PDATA));                                                      \
            }                                                                                     \
        }

#else
#    define OPAL_DATATYPE_SAFEGUARD_POINTER(ACTPTR, LENGTH, INITPTR, PDATA, COUNT)
#endif /* OPAL_ENABLE_DEBUG */

static inline int GET_FIRST_NON_LOOP(const union dt_elem_desc *_pElem)
{
    int element_index = 0;

    /* We dont have to check for the end as we always put an END_LOOP
     * at the end of all datatype descriptions.
     */
    while (_pElem->elem.common.type == OPAL_DATATYPE_LOOP) {
        ++_pElem;
        element_index++;
    }
    return element_index;
}

#define UPDATE_INTERNAL_COUNTERS(DESCRIPTION, POSITION, ELEMENT, COUNTER) \
    do {                                                                  \
        (ELEMENT) = &((DESCRIPTION)[(POSITION)]);                         \
        if (OPAL_DATATYPE_LOOP == (ELEMENT)->elem.common.type)            \
            (COUNTER) = (ELEMENT)->loop.loops;                            \
        else                                                              \
            (COUNTER) = (ELEMENT)->elem.count * (ELEMENT)->elem.blocklen; \
    } while (0)

OPAL_DECLSPEC int opal_datatype_contain_basic_datatypes(const struct opal_datatype_t *pData,
                                                        char *ptr, size_t length);
OPAL_DECLSPEC int opal_datatype_dump_data_flags(unsigned short usflags, char *ptr, size_t length);
OPAL_DECLSPEC int opal_datatype_dump_data_desc(union dt_elem_desc *pDesc, int nbElems, char *ptr,
                                               size_t length);

extern bool opal_ddt_position_debug;
extern bool opal_ddt_copy_debug;
extern bool opal_ddt_unpack_debug;
extern bool opal_ddt_pack_debug;
extern bool opal_ddt_raw_debug;

END_C_DECLS
#endif /* OPAL_DATATYPE_INTERNAL_H_HAS_BEEN_INCLUDED */