File: opal_datatype_pack.h

package info (click to toggle)
openmpi 5.0.8-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • 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 (216 lines) | stat: -rw-r--r-- 10,352 bytes parent folder | download | duplicates (3)
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
/* -*- Mode: C; c-basic-offset:4 ; -*- */
/*
 * Copyright (c) 2004-2019 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  All rights
 *                         reserved.
 * Copyright (c) 2009      Oak Ridge National Labs.  All rights reserved.
 * Copyright (c) 2011      NVIDIA Corporation.  All rights reserved.
 * Copyright (c) 2017-2018 Research Organization for Information Science
 *                         and Technology (RIST).  All rights reserved.
 * Copyright (c) 2020      Cisco Systems, Inc.  All rights reserved.
 * Copyright (c) 2020-2021 IBM Corporation.  All rights reserved.
 * Copyright (c) 2022      Advanced Micro Devices, Inc. All rights reserved.
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 */

#ifndef OPAL_DATATYPE_PACK_H_HAS_BEEN_INCLUDED
#define OPAL_DATATYPE_PACK_H_HAS_BEEN_INCLUDED

#include "opal_config.h"
#include "opal/datatype/opal_datatype_pack_unpack_predefined.h"

#if !defined(CHECKSUM)
/* Make use of existing macro to do device style memcpy */
#    undef MEMCPY_CSUM
#    define MEMCPY_CSUM(DST, SRC, BLENGTH, CONVERTOR) \
        CONVERTOR->cbmemcpy((DST), (SRC), (BLENGTH), (CONVERTOR))
#endif

/**
 * This function deals only with partial elements. The COUNT points however to the whole leftover
 * count, but this function is only expected to operate on an amount less than blength, that would
 * allow the rest of the pack process to handle only entire blength blocks (plus the left over).
 *
 * Return 1 if we are now aligned on a block, 0 otherwise.
 */
static inline int pack_partial_blocklen(opal_convertor_t *CONVERTOR, const dt_elem_desc_t *ELEM,
                                        size_t *COUNT, unsigned char **memory,
                                        unsigned char **packed, size_t *SPACE)
{
    const ddt_elem_desc_t *_elem = &((ELEM)->elem);
    size_t do_now_bytes = opal_datatype_basicDatatypes[_elem->common.type]->size;
    size_t do_now = *(COUNT);
    unsigned char *_memory = (*memory) + _elem->disp;
    unsigned char *_packed = *packed;

    assert(*(COUNT) <= ((size_t) _elem->count * _elem->blocklen));

    /**
     * First check if we already did something on this element ? The COUNT is the number
     * of remaining predefined types in the current elem, not how many predefined types
     * should be manipulated in the current call (this number is instead reflected on the
     * SPACE).
     */
    if (0 == (do_now = (*COUNT) % _elem->blocklen))
        return 1;

    size_t left_in_block = do_now; /* left in the current blocklen */

    if ((do_now_bytes * do_now) > *(SPACE))
        do_now = (*SPACE) / do_now_bytes;

    do_now_bytes *= do_now;

    OPAL_DATATYPE_SAFEGUARD_POINTER(_memory, do_now_bytes, (CONVERTOR)->pBaseBuf,
                                    (CONVERTOR)->pDesc, (CONVERTOR)->count);
    DO_DEBUG(opal_output(0, "pack memcpy( %p, %p, %lu ) => space %lu [partial]\n", (void *) _packed,
                         (void *) _memory, (unsigned long) do_now_bytes,
                         (unsigned long) (*(SPACE))););
    MEMCPY_CSUM(_packed, _memory, do_now_bytes, (CONVERTOR));
    *(memory) += (ptrdiff_t) do_now_bytes;
    if (do_now == left_in_block) /* compensate if completed a blocklen */
        *(memory) += _elem->extent
                     - (_elem->blocklen * opal_datatype_basicDatatypes[_elem->common.type]->size);

    *(COUNT) -= do_now;
    *(SPACE) -= do_now_bytes;
    *(packed) += do_now_bytes;
    return (do_now == left_in_block);
}

/**
 * Pack entire blocks, plus a possible remainder if SPACE is constrained to less than COUNT
 * elements.
 */
static inline void pack_predefined_data(opal_convertor_t *CONVERTOR, const dt_elem_desc_t *ELEM,
                                        size_t *COUNT, unsigned char **memory,
                                        unsigned char **packed, size_t *SPACE)
{
    const ddt_elem_desc_t *_elem = &((ELEM)->elem);
    size_t blocklen_bytes = opal_datatype_basicDatatypes[_elem->common.type]->size;
    size_t cando_count = *(COUNT), do_now_bytes;
    unsigned char *_memory = (*memory) + _elem->disp;
    unsigned char *_packed = *packed;

    assert(0 == (cando_count % _elem->blocklen)); /* no partials here */
    assert(*(COUNT) <= ((size_t) _elem->count * _elem->blocklen));

    if ((blocklen_bytes * cando_count) > *(SPACE))
        cando_count = (*SPACE) / blocklen_bytes;

    /* preemptively update the number of COUNT we will return. */
    *(COUNT) -= cando_count;

    if (_elem->blocklen < 9) {
        if (!(CONVERTOR->flags & CONVERTOR_ACCELERATOR)
            && OPAL_LIKELY(
                OPAL_SUCCESS
                == opal_datatype_pack_predefined_element(&_memory, &_packed, cando_count, _elem))) {
            goto update_and_return;
        }
        /* else unrecognized _elem->common.type, use the memcpy path */
    }

    if (_elem->blocklen == 1) {
        for (; cando_count > 0; cando_count--) {
            OPAL_DATATYPE_SAFEGUARD_POINTER(_memory, blocklen_bytes, (CONVERTOR)->pBaseBuf,
                                            (CONVERTOR)->pDesc, (CONVERTOR)->count);
            DO_DEBUG(opal_output(0, "pack memcpy( %p, %p, %lu ) => space %lu [blen = 1]\n",
                                 (void *) _packed, (void *) _memory, (unsigned long) blocklen_bytes,
                                 (unsigned long) (*(SPACE) - (_packed - *(packed)))););
            MEMCPY_CSUM(_packed, _memory, blocklen_bytes, (CONVERTOR));
            _packed += blocklen_bytes;
            _memory += _elem->extent;
        }
        goto update_and_return;
    }

    if ((1 < _elem->count) && (_elem->blocklen <= cando_count)) {
        blocklen_bytes *= _elem->blocklen;

        do { /* Do as many full blocklen as possible */
            OPAL_DATATYPE_SAFEGUARD_POINTER(_memory, blocklen_bytes, (CONVERTOR)->pBaseBuf,
                                            (CONVERTOR)->pDesc, (CONVERTOR)->count);
            DO_DEBUG(opal_output(0, "pack 2. memcpy( %p, %p, %lu ) => space %lu\n",
                                 (void *) _packed, (void *) _memory, (unsigned long) blocklen_bytes,
                                 (unsigned long) (*(SPACE) - (_packed - *(packed)))););
            MEMCPY_CSUM(_packed, _memory, blocklen_bytes, (CONVERTOR));
            _packed += blocklen_bytes;
            _memory += _elem->extent;
            cando_count -= _elem->blocklen;
        } while (_elem->blocklen <= cando_count);
    }

    /**
     * As an epilog do anything left from the last blocklen.
     */
    if (0 != cando_count) {
        assert((cando_count < _elem->blocklen)
               || ((1 == _elem->count) && (cando_count <= _elem->blocklen)));
        do_now_bytes = cando_count * opal_datatype_basicDatatypes[_elem->common.type]->size;
        OPAL_DATATYPE_SAFEGUARD_POINTER(_memory, do_now_bytes, (CONVERTOR)->pBaseBuf,
                                        (CONVERTOR)->pDesc, (CONVERTOR)->count);
        DO_DEBUG(opal_output(0, "pack 3. memcpy( %p, %p, %lu ) => space %lu [epilog]\n",
                             (void *) _packed, (void *) _memory, (unsigned long) do_now_bytes,
                             (unsigned long) (*(SPACE) - (_packed - *(packed)))););
        MEMCPY_CSUM(_packed, _memory, do_now_bytes, (CONVERTOR));
        _memory += do_now_bytes;
        _packed += do_now_bytes;
    }

update_and_return:
    *(memory) = _memory - _elem->disp;
    *(SPACE) -= (_packed - *packed);
    *(packed) = _packed;
}

static inline void pack_contiguous_loop(opal_convertor_t *CONVERTOR, const dt_elem_desc_t *ELEM,
                                        size_t *COUNT, unsigned char **memory,
                                        unsigned char **packed, size_t *SPACE)
{
    const ddt_loop_desc_t *_loop = (ddt_loop_desc_t *) (ELEM);
    const ddt_endloop_desc_t *_end_loop = (ddt_endloop_desc_t *) ((ELEM) + _loop->items);
    unsigned char *_memory = (*memory) + _end_loop->first_elem_disp;
    size_t _copy_loops = *(COUNT);

    if ((_copy_loops * _end_loop->size) > *(SPACE))
        _copy_loops = (*(SPACE) / _end_loop->size);
    for (size_t _i = 0; _i < _copy_loops; _i++) {
        OPAL_DATATYPE_SAFEGUARD_POINTER(_memory, _end_loop->size, (CONVERTOR)->pBaseBuf,
                                        (CONVERTOR)->pDesc, (CONVERTOR)->count);
        DO_DEBUG(opal_output(0, "pack 3. memcpy( %p, %p, %lu ) => space %lu\n", (void *) *(packed),
                             (void *) _memory, (unsigned long) _end_loop->size,
                             (unsigned long) (*(SPACE) -_i * _end_loop->size)););
        MEMCPY_CSUM(*(packed), _memory, _end_loop->size, (CONVERTOR));
        *(packed) += _end_loop->size;
        _memory += _loop->extent;
    }
    *(memory) = _memory - _end_loop->first_elem_disp;
    *(SPACE) -= _copy_loops * _end_loop->size;
    *(COUNT) -= _copy_loops;
}

#define PACK_PARTIAL_BLOCKLEN(CONVERTOR, /* the convertor */                       \
                              ELEM,      /* the basic element to be packed */      \
                              COUNT,     /* the number of elements */              \
                              MEMORY,    /* the source pointer (char*) */          \
                              PACKED,    /* the destination pointer (char*) */     \
                              SPACE)     /* the space in the destination buffer */ \
    pack_partial_blocklen((CONVERTOR), (ELEM), &(COUNT), &(MEMORY), &(PACKED), &(SPACE))

#define PACK_PREDEFINED_DATATYPE(CONVERTOR, /* the convertor */                       \
                                 ELEM,      /* the basic element to be packed */      \
                                 COUNT,     /* the number of elements */              \
                                 MEMORY,    /* the source pointer (char*) */          \
                                 PACKED,    /* the destination pointer (char*) */     \
                                 SPACE)     /* the space in the destination buffer */ \
    pack_predefined_data((CONVERTOR), (ELEM), &(COUNT), &(MEMORY), &(PACKED), &(SPACE))

#define PACK_CONTIGUOUS_LOOP(CONVERTOR, ELEM, COUNT, MEMORY, PACKED, SPACE) \
    pack_contiguous_loop((CONVERTOR), (ELEM), &(COUNT), &(MEMORY), &(PACKED), &(SPACE))

#endif /* OPAL_DATATYPE_PACK_H_HAS_BEEN_INCLUDED */