File size: 25,908 Bytes
47993d5 | 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 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 | /******************************************************************************
* Copyright (c) 2011-2021, NVIDIA CORPORATION. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the NVIDIA CORPORATION nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************/
//! @file Operations for reading linear tiles of data into the CUDA warp.
#pragma once
#include <cub/config.cuh>
#if defined(_CCCL_IMPLICIT_SYSTEM_HEADER_GCC)
# pragma GCC system_header
#elif defined(_CCCL_IMPLICIT_SYSTEM_HEADER_CLANG)
# pragma clang system_header
#elif defined(_CCCL_IMPLICIT_SYSTEM_HEADER_MSVC)
# pragma system_header
#endif // no system header
#include <cub/block/block_load.cuh>
#include <cub/iterator/cache_modified_input_iterator.cuh>
#include <cub/util_ptx.cuh>
#include <cub/util_type.cuh>
#include <cub/warp/warp_exchange.cuh>
#include <iterator>
#include <type_traits>
CUB_NAMESPACE_BEGIN
//! @rst
//! ``cub::WarpLoadAlgorithm`` enumerates alternative algorithms for :cpp:struct:`cub::WarpLoad` to
//! read a linear segment of data from memory into a CUDA warp.
//! @endrst
enum WarpLoadAlgorithm
{
//! @rst
//! Overview
//! ++++++++++++++++++++++++++
//!
//! A :ref:`blocked arrangement <flexible-data-arrangement>` of data is read directly from memory.
//!
//! Performance Considerations
//! ++++++++++++++++++++++++++
//!
//! The utilization of memory transactions (coalescing) decreases as the
//! access stride between threads increases (i.e., the number items per thread).
//! @endrst
WARP_LOAD_DIRECT,
//! @rst
//! Overview
//! ++++++++++++++++++++++++++
//!
//! A :ref:`striped arrangement <flexible-data-arrangement>` of data is read directly from memory.
//!
//! Performance Considerations
//! ++++++++++++++++++++++++++
//!
//! The utilization of memory transactions (coalescing) doesn't depend on
//! the number of items per thread.
//! @endrst
WARP_LOAD_STRIPED,
//! @rst
//! Overview
//! ++++++++++++++++++++++++++
//!
//! A :ref:`blocked arrangement <flexible-data-arrangement>` of data is read from memory using
//! CUDA's built-in vectorized loads as a coalescing optimization.
//! For example, ``ld.global.v4.s32`` instructions will be generated when ``T = int`` and
//! ``ITEMS_PER_THREAD % 4 == 0``.
//!
//! Performance Considerations
//! ++++++++++++++++++++++++++
//!
//! - The utilization of memory transactions (coalescing) remains high until the the
//! access stride between threads (i.e., the number items per thread) exceeds the
//! maximum vector load width (typically 4 items or 64B, whichever is lower).
//! - The following conditions will prevent vectorization and loading will fall
//! back to cub::WARP_LOAD_DIRECT:
//!
//! - ``ITEMS_PER_THREAD`` is odd
//! - The ``InputIteratorT`` is not a simple pointer type
//! - The block input offset is not quadword-aligned
//! - The data type ``T`` is not a built-in primitive or CUDA vector type
//! (e.g., ``short``, ``int2``, ``double``, ``float2``, etc.)
//! @endrst
WARP_LOAD_VECTORIZE,
//! @rst
//! Overview
//! ++++++++++++++++++++++++++
//!
//! A :ref:`striped arrangement <flexible-data-arrangement>` of data is read efficiently from
//! memory and then locally transposed into a
//! :ref:`blocked arrangement <flexible-data-arrangement>`.
//!
//! Performance Considerations
//! ++++++++++++++++++++++++++
//!
//! - The utilization of memory transactions (coalescing) remains high
//! regardless of items loaded per thread.
//! - The local reordering incurs slightly longer latencies and throughput than the direct
//! ``cub::WARP_LOAD_DIRECT`` and ``cub::WARP_LOAD_VECTORIZE`` alternatives.
//! @endrst
WARP_LOAD_TRANSPOSE
};
//! @rst
//! The WarpLoad class provides :ref:`collective <collective-primitives>` data movement methods for
//! loading a linear segment of items from memory into a
//! :ref:`blocked arrangement <flexible-data-arrangement>` across a CUDA thread warp.
//!
//! Overview
//! ++++++++++++++++
//!
//! - The WarpLoad class provides a single data movement abstraction that can be
//! specialized to implement different cub::WarpLoadAlgorithm strategies. This
//! facilitates different performance policies for different architectures, data
//! types, granularity sizes, etc.
//! - WarpLoad can be optionally specialized by different data movement strategies:
//!
//! #. :cpp:enumerator:`cub::WARP_LOAD_DIRECT`:
//! a :ref:`blocked arrangement <flexible-data-arrangement>` of data is read directly from
//! memory.
//! #. :cpp:enumerator:`cub::WARP_LOAD_STRIPED`:
//! a :ref:`striped arrangement <flexible-data-arrangement>` of data is read directly from
//! memory.
//! #. :cpp:enumerator:`cub::WARP_LOAD_VECTORIZE`:
//! a :ref:`blocked arrangement <flexible-data-arrangement>` of data is read directly from
//! memory using CUDA's built-in vectorized loads as a coalescing optimization.
//! #. :cpp:enumerator:`cub::WARP_LOAD_TRANSPOSE`:
//! a :ref:`striped arrangement <flexible-data-arrangement>` of data is read directly from
//! memory and is then locally transposed into a
//! :ref:`blocked arrangement <flexible-data-arrangement>`.
//!
//! A Simple Example
//! ++++++++++++++++
//!
//! The code snippet below illustrates the loading of a linear segment of 64
//! integers into a "blocked" arrangement across 16 threads where each thread
//! owns 4 consecutive items. The load is specialized for ``WARP_LOAD_TRANSPOSE``,
//! meaning memory references are efficiently coalesced using a warp-striped access
//! pattern (after which items are locally reordered among threads).
//!
//! .. code-block:: c++
//!
//! #include <cub/cub.cuh> // or equivalently <cub/warp/warp_load.cuh>
//!
//! __global__ void ExampleKernel(int *d_data, ...)
//! {
//! constexpr int warp_threads = 16;
//! constexpr int block_threads = 256;
//! constexpr int items_per_thread = 4;
//!
//! // Specialize WarpLoad for a warp of 16 threads owning 4 integer items each
//! using WarpLoadT = WarpLoad<int,
//! items_per_thread,
//! cub::WARP_LOAD_TRANSPOSE,
//! warp_threads>;
//!
//! constexpr int warps_in_block = block_threads / warp_threads;
//! constexpr int tile_size = items_per_thread * warp_threads;
//! const int warp_id = static_cast<int>(threadIdx.x) / warp_threads;
//!
//! // Allocate shared memory for WarpLoad
//! __shared__ typename WarpLoadT::TempStorage temp_storage[warps_in_block];
//!
//! // Load a segment of consecutive items that are blocked across threads
//! int thread_data[items_per_thread];
//! WarpLoadT(temp_storage[warp_id]).Load(d_data + warp_id * tile_size,
//! thread_data);
//!
//! Suppose the input ``d_data`` is ``0, 1, 2, 3, 4, 5, ...``.
//! The set of ``thread_data`` across the first logical warp of threads in those
//! threads will be: ``{ [0,1,2,3], [4,5,6,7], ..., [60,61,62,63] }``.
//! @endrst
//!
//! @tparam InputT
//! The data type to read into (which must be convertible from the input
//! iterator's value type).
//!
//! @tparam ITEMS_PER_THREAD
//! The number of consecutive items partitioned onto each thread.
//!
//! @tparam ALGORITHM
//! <b>[optional]</b> cub::WarpLoadAlgorithm tuning policy.
//! default: cub::WARP_LOAD_DIRECT.
//!
//! @tparam LOGICAL_WARP_THREADS
//! <b>[optional]</b> The number of threads per "logical" warp (may be less
//! than the number of hardware warp threads). Default is the warp size of the
//! targeted CUDA compute-capability (e.g., 32 threads for SM86). Must be a
//! power of two.
//!
//! @tparam LEGACY_PTX_ARCH
//! Unused.
template <typename InputT,
int ITEMS_PER_THREAD,
WarpLoadAlgorithm ALGORITHM = WARP_LOAD_DIRECT,
int LOGICAL_WARP_THREADS = CUB_PTX_WARP_THREADS,
int LEGACY_PTX_ARCH = 0>
class WarpLoad
{
static constexpr bool IS_ARCH_WARP = LOGICAL_WARP_THREADS == CUB_WARP_THREADS(0);
static_assert(PowerOfTwo<LOGICAL_WARP_THREADS>::VALUE,
"LOGICAL_WARP_THREADS must be a power of two");
private:
/*****************************************************************************
* Algorithmic variants
****************************************************************************/
/// Load helper
template <WarpLoadAlgorithm _POLICY, int DUMMY>
struct LoadInternal;
template <int DUMMY>
struct LoadInternal<WARP_LOAD_DIRECT, DUMMY>
{
using TempStorage = NullType;
int linear_tid;
__device__ __forceinline__ LoadInternal(TempStorage & /*temp_storage*/, int linear_tid)
: linear_tid(linear_tid)
{}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD])
{
LoadDirectBlocked(linear_tid, block_itr, items);
}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items)
{
LoadDirectBlocked(linear_tid, block_itr, items, valid_items);
}
template <typename InputIteratorT, typename DefaultT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items,
DefaultT oob_default)
{
LoadDirectBlocked(linear_tid, block_itr, items, valid_items, oob_default);
}
};
template <int DUMMY>
struct LoadInternal<WARP_LOAD_STRIPED, DUMMY>
{
using TempStorage = NullType;
int linear_tid;
__device__ __forceinline__ LoadInternal(TempStorage & /*temp_storage*/, int linear_tid)
: linear_tid(linear_tid)
{}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD])
{
LoadDirectStriped<LOGICAL_WARP_THREADS>(linear_tid, block_itr, items);
}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items)
{
LoadDirectStriped<LOGICAL_WARP_THREADS>(linear_tid, block_itr, items, valid_items);
}
template <typename InputIteratorT, typename DefaultT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items,
DefaultT oob_default)
{
LoadDirectStriped<LOGICAL_WARP_THREADS>(linear_tid,
block_itr,
items,
valid_items,
oob_default);
}
};
template <int DUMMY>
struct LoadInternal<WARP_LOAD_VECTORIZE, DUMMY>
{
using TempStorage = NullType;
int linear_tid;
__device__ __forceinline__ LoadInternal(TempStorage & /*temp_storage*/, int linear_tid)
: linear_tid(linear_tid)
{}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputT *block_ptr, InputT (&items)[ITEMS_PER_THREAD])
{
InternalLoadDirectBlockedVectorized<LOAD_DEFAULT>(linear_tid, block_ptr, items);
}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(const InputT *block_ptr, InputT (&items)[ITEMS_PER_THREAD])
{
InternalLoadDirectBlockedVectorized<LOAD_DEFAULT>(linear_tid, block_ptr, items);
}
template <CacheLoadModifier MODIFIER, typename ValueType, typename OffsetT>
__device__ __forceinline__ void
Load(CacheModifiedInputIterator<MODIFIER, ValueType, OffsetT> block_itr,
InputT (&items)[ITEMS_PER_THREAD])
{
InternalLoadDirectBlockedVectorized<MODIFIER>(linear_tid, block_itr.ptr, items);
}
template <typename _InputIteratorT>
__device__ __forceinline__ void Load(_InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD])
{
LoadDirectBlocked(linear_tid, block_itr, items);
}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items)
{
LoadDirectBlocked(linear_tid, block_itr, items, valid_items);
}
template <typename InputIteratorT, typename DefaultT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items,
DefaultT oob_default)
{
LoadDirectBlocked(linear_tid, block_itr, items, valid_items, oob_default);
}
};
template <int DUMMY>
struct LoadInternal<WARP_LOAD_TRANSPOSE, DUMMY>
{
using WarpExchangeT = WarpExchange<InputT, ITEMS_PER_THREAD, LOGICAL_WARP_THREADS>;
struct _TempStorage : WarpExchangeT::TempStorage
{};
struct TempStorage : Uninitialized<_TempStorage>
{};
_TempStorage &temp_storage;
int linear_tid;
__device__ __forceinline__ LoadInternal(TempStorage &temp_storage, int linear_tid)
: temp_storage(temp_storage.Alias())
, linear_tid(linear_tid)
{}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD])
{
LoadDirectStriped<LOGICAL_WARP_THREADS>(linear_tid, block_itr, items);
WarpExchangeT(temp_storage).StripedToBlocked(items, items);
}
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items)
{
LoadDirectStriped<LOGICAL_WARP_THREADS>(linear_tid, block_itr, items, valid_items);
WarpExchangeT(temp_storage).StripedToBlocked(items, items);
}
template <typename InputIteratorT, typename DefaultT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items,
DefaultT oob_default)
{
LoadDirectStriped<LOGICAL_WARP_THREADS>(linear_tid,
block_itr,
items,
valid_items,
oob_default);
WarpExchangeT(temp_storage).StripedToBlocked(items, items);
}
};
/*****************************************************************************
* Type definitions
****************************************************************************/
/// Internal load implementation to use
using InternalLoad = LoadInternal<ALGORITHM, 0>;
/// Shared memory storage layout type
using _TempStorage = typename InternalLoad::TempStorage;
/*****************************************************************************
* Utility methods
****************************************************************************/
/// Internal storage allocator
__device__ __forceinline__ _TempStorage &PrivateStorage()
{
__shared__ _TempStorage private_storage;
return private_storage;
}
/*****************************************************************************
* Thread fields
****************************************************************************/
/// Thread reference to shared storage
_TempStorage &temp_storage;
/// Linear thread-id
int linear_tid;
public:
/// @smemstorage{WarpLoad}
struct TempStorage : Uninitialized<_TempStorage>
{};
//! @name Collective constructors
//! @{
//! @brief Collective constructor using a private static allocation of
//! shared memory as temporary storage.
__device__ __forceinline__ WarpLoad()
: temp_storage(PrivateStorage())
, linear_tid(IS_ARCH_WARP ? LaneId() : (LaneId() % LOGICAL_WARP_THREADS))
{}
//! @brief Collective constructor using the specified memory allocation as
//! temporary storage.
__device__ __forceinline__ WarpLoad(TempStorage &temp_storage)
: temp_storage(temp_storage.Alias())
, linear_tid(IS_ARCH_WARP ? LaneId() : (LaneId() % LOGICAL_WARP_THREADS))
{}
//! @} end member group
//! @name Data movement
//! @{
//! @rst
//! Load a linear segment of items from memory.
//!
//! @smemwarpreuse
//!
//! Snippet
//! +++++++
//!
//! .. code-block:: c++
//!
//! #include <cub/cub.cuh> // or equivalently <cub/warp/warp_load.cuh>
//!
//! __global__ void ExampleKernel(int *d_data, ...)
//! {
//! constexpr int warp_threads = 16;
//! constexpr int block_threads = 256;
//! constexpr int items_per_thread = 4;
//!
//! // Specialize WarpLoad for a warp of 16 threads owning 4 integer items each
//! using WarpLoadT = WarpLoad<int,
//! items_per_thread,
//! cub::WARP_LOAD_TRANSPOSE,
//! warp_threads>;
//!
//! constexpr int warps_in_block = block_threads / warp_threads;
//! constexpr int tile_size = items_per_thread * warp_threads;
//! const int warp_id = static_cast<int>(threadIdx.x) / warp_threads;
//!
//! // Allocate shared memory for WarpLoad
//! __shared__ typename WarpLoadT::TempStorage temp_storage[warps_in_block];
//!
//! // Load a segment of consecutive items that are blocked across threads
//! int thread_data[items_per_thread];
//! WarpLoadT(temp_storage[warp_id]).Load(d_data + warp_id * tile_size,
//! thread_data);
//!
//! Suppose the input ``d_data`` is ``0, 1, 2, 3, 4, 5, ...``,
//! The set of ``thread_data`` across the first logical warp of threads in those
//! threads will be: ``{ [0,1,2,3], [4,5,6,7], ..., [60,61,62,63] }``.
//! @endrst
//!
//! @param[in] block_itr The thread block's base input iterator for loading from
//! @param[out] items Data to load
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr, InputT (&items)[ITEMS_PER_THREAD])
{
InternalLoad(temp_storage, linear_tid).Load(block_itr, items);
}
//! @rst
//! Load a linear segment of items from memory, guarded by range.
//!
//! @smemwarpreuse
//!
//! Snippet
//! +++++++
//!
//! .. code-block:: c++
//!
//! #include <cub/cub.cuh> // or equivalently <cub/warp/warp_load.cuh>
//!
//! __global__ void ExampleKernel(int *d_data, int valid_items, ...)
//! {
//! constexpr int warp_threads = 16;
//! constexpr int block_threads = 256;
//! constexpr int items_per_thread = 4;
//!
//! // Specialize WarpLoad for a warp of 16 threads owning 4 integer items each
//! using WarpLoadT = WarpLoad<int,
//! items_per_thread,
//! cub::WARP_LOAD_TRANSPOSE,
//! warp_threads>;
//!
//! constexpr int warps_in_block = block_threads / warp_threads;
//! constexpr int tile_size = items_per_thread * warp_threads;
//! const int warp_id = static_cast<int>(threadIdx.x) / warp_threads;
//!
//! // Allocate shared memory for WarpLoad
//! __shared__ typename WarpLoadT::TempStorage temp_storage[warps_in_block];
//!
//! // Load a segment of consecutive items that are blocked across threads
//! int thread_data[items_per_thread];
//! WarpLoadT(temp_storage[warp_id]).Load(d_data + warp_id * tile_size,
//! thread_data,
//! valid_items);
//!
//! Suppose the input ``d_data`` is ``0, 1, 2, 3, 4, 5, ...`` and ``valid_items`` is ``5``.
//! The set of ``thread_data`` across the first logical warp of threads in those threads will be:
//! ``{ [0,1,2,3], [4,?,?,?], ..., [?,?,?,?] }`` with only the first two threads being unmasked to
//! load portions of valid data (and other items remaining unassigned).
//! @endrst
//!
//! @param[in] block_itr The thread block's base input iterator for loading from
//! @param[out] items Data to load
//! @param[in] valid_items Number of valid items to load
template <typename InputIteratorT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items)
{
InternalLoad(temp_storage, linear_tid).Load(block_itr, items, valid_items);
}
//! @rst
//! Load a linear segment of items from memory, guarded by range.
//!
//! @smemwarpreuse
//!
//! Snippet
//! +++++++
//!
//! .. code-block:: c++
//!
//! #include <cub/cub.cuh> // or equivalently <cub/warp/warp_load.cuh>
//!
//! __global__ void ExampleKernel(int *d_data, int valid_items, ...)
//! {
//! constexpr int warp_threads = 16;
//! constexpr int block_threads = 256;
//! constexpr int items_per_thread = 4;
//!
//! // Specialize WarpLoad for a warp of 16 threads owning 4 integer items each
//! using WarpLoadT = WarpLoad<int,
//! items_per_thread,
//! cub::WARP_LOAD_TRANSPOSE,
//! warp_threads>;
//!
//! constexpr int warps_in_block = block_threads / warp_threads;
//! constexpr int tile_size = items_per_thread * warp_threads;
//! const int warp_id = static_cast<int>(threadIdx.x) / warp_threads;
//!
//! // Allocate shared memory for WarpLoad
//! __shared__ typename WarpLoadT::TempStorage temp_storage[warps_in_block];
//!
//! // Load a segment of consecutive items that are blocked across threads
//! int thread_data[items_per_thread];
//! WarpLoadT(temp_storage[warp_id]).Load(d_data + warp_id * tile_size,
//! thread_data,
//! valid_items,
//! -1);
//!
//! Suppose the input ``d_data`` is ``0, 1, 2, 3, 4, 5, ...``, ``valid_items`` is ``5``, and the
//! out-of-bounds default is ``-1``. The set of ``thread_data`` across the first logical warp of
//! threads in those threads will be: ``{ [0,1,2,3], [4,-1,-1,-1], ..., [-1,-1,-1,-1] }`` with
//! only the first two threads being unmasked to load portions of valid data (and other items
//! are assigned ``-1``).
//! @endrst
//!
//! @param[in] block_itr The thread block's base input iterator for loading from
//! @param[out] items Data to load
//! @param[in] valid_items Number of valid items to load
//! @param[in] oob_default Default value to assign out-of-bound items
template <typename InputIteratorT, typename DefaultT>
__device__ __forceinline__ void Load(InputIteratorT block_itr,
InputT (&items)[ITEMS_PER_THREAD],
int valid_items,
DefaultT oob_default)
{
InternalLoad(temp_storage, linear_tid).Load(block_itr, items, valid_items, oob_default);
}
//! @} end member group
};
CUB_NAMESPACE_END
|