aligned.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2025, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <rmm/detail/export.hpp>
 
#include <cassert>
#include <cstddef>
#include <cstdint>
 
namespace RMM_EXPORT rmm {
 
static constexpr std::size_t RMM_DEFAULT_HOST_ALIGNMENT{alignof(std::max_align_t)};
 
static constexpr std::size_t CUDA_ALLOCATION_ALIGNMENT{256};
 
[[nodiscard]] bool is_pow2(std::size_t value) noexcept;
 
[[nodiscard]] bool is_supported_alignment(std::size_t alignment) noexcept;
 
[[nodiscard]] std::size_t align_up(std::size_t value, std::size_t alignment) noexcept;
 
[[nodiscard]] std::size_t align_down(std::size_t value, std::size_t alignment) noexcept;
 
[[nodiscard]] bool is_aligned(std::size_t value, std::size_t alignment) noexcept;
 
[[nodiscard]] bool is_pointer_aligned(void* ptr,
                                      std::size_t alignment = CUDA_ALLOCATION_ALIGNMENT) noexcept;
  // end of group
 
}  // namespace RMM_EXPORT rmm