aligned.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2020-2025, NVIDIA CORPORATION.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 
6 #pragma once
7 
8 #include <rmm/detail/export.hpp>
9 
10 #include <cassert>
11 #include <cstddef>
12 
13 namespace RMM_EXPORT rmm {
14 
25 static constexpr std::size_t RMM_DEFAULT_HOST_ALIGNMENT{alignof(std::max_align_t)};
26 
31 static constexpr std::size_t CUDA_ALLOCATION_ALIGNMENT{256};
32 
40 [[nodiscard]] bool is_pow2(std::size_t value) noexcept;
41 
49 [[nodiscard]] bool is_supported_alignment(std::size_t alignment) noexcept;
50 
59 [[nodiscard]] std::size_t align_up(std::size_t value, std::size_t alignment) noexcept;
60 
69 [[nodiscard]] std::size_t align_down(std::size_t value, std::size_t alignment) noexcept;
70 
79 [[nodiscard]] bool is_aligned(std::size_t value, std::size_t alignment) noexcept;
80 
89 [[nodiscard]] bool is_pointer_aligned(void* ptr,
90  std::size_t alignment = CUDA_ALLOCATION_ALIGNMENT) noexcept;
91  // end of group
93 
94 } // namespace RMM_EXPORT rmm
static constexpr std::size_t CUDA_ALLOCATION_ALIGNMENT
Default alignment used for CUDA memory allocation.
Definition: aligned.hpp:31
std::size_t align_down(std::size_t value, std::size_t alignment) noexcept
Align down to the nearest multiple of specified power of 2.
bool is_supported_alignment(std::size_t alignment) noexcept
Returns whether or not alignment is a valid memory alignment.
bool is_pointer_aligned(void *ptr, std::size_t alignment=CUDA_ALLOCATION_ALIGNMENT) noexcept
Checks whether the provided pointer is aligned to a specified alignment.
static constexpr std::size_t RMM_DEFAULT_HOST_ALIGNMENT
Default alignment used for host memory allocated by RMM.
Definition: aligned.hpp:25
bool is_pow2(std::size_t value) noexcept
Returns whether or not value is a power of 2.
bool is_aligned(std::size_t value, std::size_t alignment) noexcept
Checks whether a value is aligned to a multiple of a specified power of 2.
std::size_t align_up(std::size_t value, std::size_t alignment) noexcept
Align up to nearest multiple of specified power of 2.