File: benchmark_device_radix_sort.cpp

package info (click to toggle)
hipcub 6.4.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,528 kB
  • sloc: cpp: 56,703; python: 564; sh: 365; makefile: 118; xml: 26
file content (499 lines) | stat: -rw-r--r-- 22,504 bytes parent folder | download
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
// MIT License
//
// Copyright (c) 2020-2024 Advanced Micro Devices, Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#include "common_benchmark_header.hpp"

#include <memory>
#include <type_traits>

// HIP API
#include "hipcub/device/device_radix_sort.hpp"

#ifndef DEFAULT_N
const size_t DEFAULT_N = 1024 * 1024 * 32;
#endif

const unsigned int batch_size  = 10;
const unsigned int warmup_size = 5;

template<class Key>
std::vector<Key> generate_keys(size_t size)
{
    using key_type = Key;

    return benchmark_utils::get_random_data<key_type>(
        size,
        benchmark_utils::generate_limits<key_type>::min(),
        benchmark_utils::generate_limits<key_type>::max());
}

template<bool Descending, class Key>
auto invoke_sort_keys(void*       d_temp_storage,
                      size_t&     temp_storage_bytes,
                      Key*        d_keys_input,
                      Key*        d_keys_output,
                      size_t      size,
                      hipStream_t stream)
    -> std::enable_if_t<!Descending && !benchmark_utils::is_custom_type<Key>::value, hipError_t>
{
    return hipcub::DeviceRadixSort::SortKeys(d_temp_storage,
                                             temp_storage_bytes,
                                             d_keys_input,
                                             d_keys_output,
                                             size,
                                             0,
                                             sizeof(Key) * 8,
                                             stream);
}

template<bool Descending, class Key>
auto invoke_sort_keys(void*       d_temp_storage,
                      size_t&     temp_storage_bytes,
                      Key*        d_keys_input,
                      Key*        d_keys_output,
                      size_t      size,
                      hipStream_t stream)
    -> std::enable_if_t<Descending && !benchmark_utils::is_custom_type<Key>::value, hipError_t>
{
    return hipcub::DeviceRadixSort::SortKeysDescending(d_temp_storage,
                                                       temp_storage_bytes,
                                                       d_keys_input,
                                                       d_keys_output,
                                                       size,
                                                       0,
                                                       sizeof(Key) * 8,
                                                       stream);
}

template<bool Descending, class Key>
auto invoke_sort_keys(void*       d_temp_storage,
                      size_t&     temp_storage_bytes,
                      Key*        d_keys_input,
                      Key*        d_keys_output,
                      size_t      size,
                      hipStream_t stream)
    -> std::enable_if_t<!Descending && benchmark_utils::is_custom_type<Key>::value, hipError_t>
{
    return hipcub::DeviceRadixSort::SortKeys(d_temp_storage,
                                             temp_storage_bytes,
                                             d_keys_input,
                                             d_keys_output,
                                             size,
                                             benchmark_utils::custom_type_decomposer<Key>{},
                                             stream);
}

template<bool Descending, class Key>
auto invoke_sort_keys(void*       d_temp_storage,
                      size_t&     temp_storage_bytes,
                      Key*        d_keys_input,
                      Key*        d_keys_output,
                      size_t      size,
                      hipStream_t stream)
    -> std::enable_if_t<Descending && benchmark_utils::is_custom_type<Key>::value, hipError_t>
{
    return hipcub::DeviceRadixSort::SortKeysDescending(
        d_temp_storage,
        temp_storage_bytes,
        d_keys_input,
        d_keys_output,
        size,
        benchmark_utils::custom_type_decomposer<Key>{},
        stream);
}

template<class Key, bool Descending = false>
void run_sort_keys_benchmark(benchmark::State&                 state,
                             hipStream_t                       stream,
                             size_t                            size,
                             std::shared_ptr<std::vector<Key>> keys_input)
{
    using key_type = Key;
    key_type* d_keys_input;
    key_type* d_keys_output;
    HIP_CHECK(hipMalloc(&d_keys_input, size * sizeof(key_type)));
    HIP_CHECK(hipMalloc(&d_keys_output, size * sizeof(key_type)));
    HIP_CHECK(hipMemcpy(d_keys_input,
                        keys_input->data(),
                        size * sizeof(key_type),
                        hipMemcpyHostToDevice));

    void*  d_temporary_storage     = nullptr;
    size_t temporary_storage_bytes = 0;
    HIP_CHECK(invoke_sort_keys<Descending>(d_temporary_storage,
                                           temporary_storage_bytes,
                                           d_keys_input,
                                           d_keys_output,
                                           size,
                                           stream));

    HIP_CHECK(hipMalloc(&d_temporary_storage, temporary_storage_bytes));
    HIP_CHECK(hipDeviceSynchronize());

    // Warm-up
    for(size_t i = 0; i < warmup_size; i++)
    {
        HIP_CHECK(invoke_sort_keys<Descending>(d_temporary_storage,
                                               temporary_storage_bytes,
                                               d_keys_input,
                                               d_keys_output,
                                               size,
                                               stream));
    }
    HIP_CHECK(hipDeviceSynchronize());

    for(auto _ : state)
    {
        auto start = std::chrono::high_resolution_clock::now();

        for(size_t i = 0; i < batch_size; i++)
        {
            HIP_CHECK(invoke_sort_keys<Descending>(d_temporary_storage,
                                                   temporary_storage_bytes,
                                                   d_keys_input,
                                                   d_keys_output,
                                                   size,
                                                   stream));
        }
        HIP_CHECK(hipDeviceSynchronize());

        auto end = std::chrono::high_resolution_clock::now();
        auto elapsed_seconds
            = std::chrono::duration_cast<std::chrono::duration<double>>(end - start);
        state.SetIterationTime(elapsed_seconds.count());
    }
    state.SetBytesProcessed(state.iterations() * batch_size * size * sizeof(key_type));
    state.SetItemsProcessed(state.iterations() * batch_size * size);

    HIP_CHECK(hipFree(d_temporary_storage));
    HIP_CHECK(hipFree(d_keys_input));
    HIP_CHECK(hipFree(d_keys_output));
}

template<bool Descending, class Key, class Value>
auto invoke_sort_pairs(void*       d_temp_storage,
                       size_t&     temp_storage_bytes,
                       Key*        d_keys_input,
                       Key*        d_keys_output,
                       Value*      d_values_input,
                       Value*      d_values_output,
                       size_t      size,
                       hipStream_t stream)
    -> std::enable_if_t<!Descending && !benchmark_utils::is_custom_type<Key>::value, hipError_t>
{
    return hipcub::DeviceRadixSort::SortPairs(d_temp_storage,
                                              temp_storage_bytes,
                                              d_keys_input,
                                              d_keys_output,
                                              d_values_input,
                                              d_values_output,
                                              size,
                                              0,
                                              sizeof(Key) * 8,
                                              stream);
}

template<bool Descending, class Key, class Value>
auto invoke_sort_pairs(void*       d_temp_storage,
                       size_t&     temp_storage_bytes,
                       Key*        d_keys_input,
                       Key*        d_keys_output,
                       Value*      d_values_input,
                       Value*      d_values_output,
                       size_t      size,
                       hipStream_t stream)
    -> std::enable_if_t<Descending && !benchmark_utils::is_custom_type<Key>::value, hipError_t>
{
    return hipcub::DeviceRadixSort::SortPairsDescending(d_temp_storage,
                                                        temp_storage_bytes,
                                                        d_keys_input,
                                                        d_keys_output,
                                                        d_values_input,
                                                        d_values_output,
                                                        size,
                                                        0,
                                                        sizeof(Key) * 8,
                                                        stream);
}

template<bool Descending, class Key, class Value>
auto invoke_sort_pairs(void*       d_temp_storage,
                       size_t&     temp_storage_bytes,
                       Key*        d_keys_input,
                       Key*        d_keys_output,
                       Value*      d_values_input,
                       Value*      d_values_output,
                       size_t      size,
                       hipStream_t stream)
    -> std::enable_if_t<!Descending && benchmark_utils::is_custom_type<Key>::value, hipError_t>
{
    return hipcub::DeviceRadixSort::SortPairs(d_temp_storage,
                                              temp_storage_bytes,
                                              d_keys_input,
                                              d_keys_output,
                                              d_values_input,
                                              d_values_output,
                                              size,
                                              benchmark_utils::custom_type_decomposer<Key>{},
                                              stream);
}

template<bool Descending, class Key, class Value>
auto invoke_sort_pairs(void*       d_temp_storage,
                       size_t&     temp_storage_bytes,
                       Key*        d_keys_input,
                       Key*        d_keys_output,
                       Value*      d_values_input,
                       Value*      d_values_output,
                       size_t      size,
                       hipStream_t stream)
    -> std::enable_if_t<Descending && benchmark_utils::is_custom_type<Key>::value, hipError_t>
{
    return hipcub::DeviceRadixSort::SortPairsDescending(
        d_temp_storage,
        temp_storage_bytes,
        d_keys_input,
        d_keys_output,
        d_values_input,
        d_values_output,
        size,
        benchmark_utils::custom_type_decomposer<Key>{},
        stream);
}

template<class Key, class Value, bool Descending = false>
void run_sort_pairs_benchmark(benchmark::State&                 state,
                              hipStream_t                       stream,
                              size_t                            size,
                              std::shared_ptr<std::vector<Key>> keys_input)
{
    using key_type   = Key;
    using value_type = Value;
    std::vector<value_type> values_input(size);
    for(size_t i = 0; i < size; i++)
    {
        values_input[i] = value_type(i);
    }

    key_type* d_keys_input;
    key_type* d_keys_output;
    HIP_CHECK(hipMalloc(&d_keys_input, size * sizeof(key_type)));
    HIP_CHECK(hipMalloc(&d_keys_output, size * sizeof(key_type)));
    HIP_CHECK(hipMemcpy(d_keys_input,
                        keys_input->data(),
                        size * sizeof(key_type),
                        hipMemcpyHostToDevice));

    value_type* d_values_input;
    value_type* d_values_output;
    HIP_CHECK(hipMalloc(&d_values_input, size * sizeof(value_type)));
    HIP_CHECK(hipMalloc(&d_values_output, size * sizeof(value_type)));
    HIP_CHECK(hipMemcpy(d_values_input,
                        values_input.data(),
                        size * sizeof(value_type),
                        hipMemcpyHostToDevice));

    void*  d_temporary_storage     = nullptr;
    size_t temporary_storage_bytes = 0;
    HIP_CHECK(invoke_sort_pairs<Descending>(d_temporary_storage,
                                            temporary_storage_bytes,
                                            d_keys_input,
                                            d_keys_output,
                                            d_values_input,
                                            d_values_output,
                                            size,
                                            stream));

    HIP_CHECK(hipMalloc(&d_temporary_storage, temporary_storage_bytes));
    HIP_CHECK(hipDeviceSynchronize());

    // Warm-up
    for(size_t i = 0; i < warmup_size; i++)
    {
        HIP_CHECK(invoke_sort_pairs<Descending>(d_temporary_storage,
                                                temporary_storage_bytes,
                                                d_keys_input,
                                                d_keys_output,
                                                d_values_input,
                                                d_values_output,
                                                size,
                                                stream));
    }
    HIP_CHECK(hipDeviceSynchronize());

    for(auto _ : state)
    {
        auto start = std::chrono::high_resolution_clock::now();

        for(size_t i = 0; i < batch_size; i++)
        {
            HIP_CHECK(invoke_sort_pairs<Descending>(d_temporary_storage,
                                                    temporary_storage_bytes,
                                                    d_keys_input,
                                                    d_keys_output,
                                                    d_values_input,
                                                    d_values_output,
                                                    size,
                                                    stream));
        }
        HIP_CHECK(hipDeviceSynchronize());

        auto end = std::chrono::high_resolution_clock::now();
        auto elapsed_seconds
            = std::chrono::duration_cast<std::chrono::duration<double>>(end - start);
        state.SetIterationTime(elapsed_seconds.count());
    }
    state.SetBytesProcessed(state.iterations() * batch_size * size
                            * (sizeof(key_type) + sizeof(value_type)));
    state.SetItemsProcessed(state.iterations() * batch_size * size);

    HIP_CHECK(hipFree(d_temporary_storage));
    HIP_CHECK(hipFree(d_keys_input));
    HIP_CHECK(hipFree(d_keys_output));
    HIP_CHECK(hipFree(d_values_input));
    HIP_CHECK(hipFree(d_values_output));
}

#define CREATE_SORT_KEYS_BENCHMARK(Key)                                                 \
    {                                                                                   \
        auto keys_input = std::make_shared<std::vector<Key>>(generate_keys<Key>(size)); \
        benchmarks.push_back(benchmark::RegisterBenchmark(                              \
            std::string("device_radix_sort_keys_ascending"                              \
                        "<key_data_type:" #Key ">.")                                    \
                .c_str(),                                                               \
            [=](benchmark::State& state)                                                \
            { run_sort_keys_benchmark<Key>(state, stream, size, keys_input); }));       \
        benchmarks.push_back(benchmark::RegisterBenchmark(                              \
            std::string("device_radix_sort_keys_descending"                             \
                        "<key_data_type:" #Key ">.")                                    \
                .c_str(),                                                               \
            [=](benchmark::State& state)                                                \
            { run_sort_keys_benchmark<Key, true>(state, stream, size, keys_input); })); \
    }

#define CREATE_SORT_PAIRS_BENCHMARK(Key, Value)                                                 \
    {                                                                                           \
        auto keys_input = std::make_shared<std::vector<Key>>(generate_keys<Key>(size));         \
        benchmarks.push_back(benchmark::RegisterBenchmark(                                      \
            std::string("device_radix_sort_pairs_ascending"                                     \
                        "<key_data_type:" #Key ",value_data_type:" #Value ">.")                 \
                .c_str(),                                                                       \
            [=](benchmark::State& state)                                                        \
            { run_sort_pairs_benchmark<Key, Value>(state, stream, size, keys_input); }));       \
        benchmarks.push_back(benchmark::RegisterBenchmark(                                      \
            std::string("device_radix_sort_pairs_descending"                                    \
                        "<key_data_type:" #Key ",value_data_type:" #Value ">.")                 \
                .c_str(),                                                                       \
            [=](benchmark::State& state)                                                        \
            { run_sort_pairs_benchmark<Key, Value, true>(state, stream, size, keys_input); })); \
    }

void add_sort_keys_benchmarks(std::vector<benchmark::internal::Benchmark*>& benchmarks,
                              hipStream_t                                   stream,
                              size_t                                        size)
{
    using custom_int_t = benchmark_utils::custom_type<int>;
    CREATE_SORT_KEYS_BENCHMARK(int)
    CREATE_SORT_KEYS_BENCHMARK(long long)
    CREATE_SORT_KEYS_BENCHMARK(int8_t)
    CREATE_SORT_KEYS_BENCHMARK(uint8_t)
    CREATE_SORT_KEYS_BENCHMARK(short)
    CREATE_SORT_KEYS_BENCHMARK(custom_int_t)
}

void add_sort_pairs_benchmarks(std::vector<benchmark::internal::Benchmark*>& benchmarks,
                               hipStream_t                                   stream,
                               size_t                                        size)
{
    using custom_float2      = benchmark_utils::custom_type<float, float>;
    using custom_double2     = benchmark_utils::custom_type<double, double>;
    using custom_char_double = benchmark_utils::custom_type<char, double>;
    using custom_double_char = benchmark_utils::custom_type<double, char>;
    using custom_int_t       = benchmark_utils::custom_type<int>;

    CREATE_SORT_PAIRS_BENCHMARK(int, float)
    CREATE_SORT_PAIRS_BENCHMARK(int, double)
    CREATE_SORT_PAIRS_BENCHMARK(int, custom_float2)
    CREATE_SORT_PAIRS_BENCHMARK(int, custom_double2)
    CREATE_SORT_PAIRS_BENCHMARK(int, custom_char_double)
    CREATE_SORT_PAIRS_BENCHMARK(int, custom_double_char)

    CREATE_SORT_PAIRS_BENCHMARK(long long, float)
    CREATE_SORT_PAIRS_BENCHMARK(long long, double)
    CREATE_SORT_PAIRS_BENCHMARK(long long, custom_float2)
    CREATE_SORT_PAIRS_BENCHMARK(long long, custom_char_double)
    CREATE_SORT_PAIRS_BENCHMARK(long long, custom_double_char)
    CREATE_SORT_PAIRS_BENCHMARK(long long, custom_double2)

    CREATE_SORT_PAIRS_BENCHMARK(int8_t, int8_t)
    CREATE_SORT_PAIRS_BENCHMARK(uint8_t, uint8_t)

    CREATE_SORT_PAIRS_BENCHMARK(custom_int_t, float)
}

int main(int argc, char* argv[])
{
    cli::Parser parser(argc, argv);
    parser.set_optional<size_t>("size", "size", DEFAULT_N, "number of values");
    parser.set_optional<int>("trials", "trials", -1, "number of iterations");
    parser.run_and_exit_if_error();

    // Parse argv
    benchmark::Initialize(&argc, argv);
    const size_t size   = parser.get<size_t>("size");
    const int    trials = parser.get<int>("trials");

    std::cout << "benchmark_device_radix_sort" << std::endl;

    // HIP
    hipStream_t     stream = 0; // default
    hipDeviceProp_t devProp;
    int             device_id = 0;
    HIP_CHECK(hipGetDevice(&device_id));
    HIP_CHECK(hipGetDeviceProperties(&devProp, device_id));
    std::cout << "[HIP] Device name: " << devProp.name << std::endl;

    // Add benchmarks
    std::vector<benchmark::internal::Benchmark*> benchmarks;
    add_sort_keys_benchmarks(benchmarks, stream, size);
    add_sort_pairs_benchmarks(benchmarks, stream, size);

    // Use manual timing
    for(auto& b : benchmarks)
    {
        b->UseManualTime();
        b->Unit(benchmark::kMillisecond);
    }

    // Force number of iterations
    if(trials > 0)
    {
        for(auto& b : benchmarks)
        {
            b->Iterations(trials);
        }
    }

    // Run benchmarks
    benchmark::RunSpecifiedBenchmarks();
    return 0;
}