-
Notifications
You must be signed in to change notification settings - Fork 375
cuda::is_trivially_copyable
#8265
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
fbusato
wants to merge
24
commits into
NVIDIA:main
Choose a base branch
from
fbusato:relaxed-type-traits
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 22 commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
ea3f956
is_trivially_copyable_relaxed
fbusato 9dd60db
add documentation
fbusato 179a81b
describe custom specialization
fbusato 2c33c2e
move to internal function
fbusato fbade34
address padding
fbusato deb622c
fix clang
fbusato a553bb6
do not handle volatile
fbusato de42a45
unused-local-typedef
fbusato 4e7873d
fix clang pragma
fbusato 6e5021f
simplify conditions
fbusato 8ff54f4
improve documentation
fbusato c4c1504
fix operator==
fbusato e603a96
Update docs/libcudacxx/extended_api/type_traits/is_trivially_copyable…
fbusato cde3d1e
Update docs/libcudacxx/extended_api/type_traits/is_trivially_copyable…
fbusato c20fb89
add recursive struct check
fbusato 35f9d15
add comment
fbusato 4db130a
Merge branch 'relaxed-type-traits' of github.com:fbusato/cccl into re…
fbusato 1f6254c
fix nvrtc
fbusato ab184ff
rename to cuda::is_trivially_copyable
fbusato 6c5f19e
update documentation
fbusato 79f4310
test nvfp only in CUDA >= 12.3
fbusato 4506e40
update bit_cast implementation
fbusato 80b09fa
add documentation
fbusato cd776c9
fix compile warnings/errors
fbusato File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
docs/libcudacxx/extended_api/type_traits/is_trivially_copyable.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| .. _libcudacxx-extended-api-type_traits-is_trivially_copyable: | ||
|
|
||
| ``cuda::is_trivially_copyable`` | ||
| ======================================= | ||
|
|
||
| Defined in the ``<cuda/type_traits>`` header. | ||
|
|
||
| .. code:: cuda | ||
|
|
||
| namespace cuda { | ||
|
|
||
| template <typename T> | ||
| constexpr bool is_trivially_copyable_v = /* see below */; | ||
|
|
||
| template <typename T> | ||
| using is_trivially_copyable = cuda::std::bool_constant<is_trivially_copyable_v<T>>; | ||
|
|
||
| } // namespace cuda | ||
|
|
||
| ``cuda::is_trivially_copyable_v<T>`` is a variable template that extends ``cuda::std::is_trivially_copyable`` to also recognize CUDA extended floating-point scalar and vector types as trivially copyable. | ||
|
|
||
| A type ``T`` satisfies ``cuda::is_trivially_copyable`` if any of the following holds: | ||
|
|
||
| - ``T`` is trivially copyable. | ||
| - ``T`` is an extended floating-point scalar type (e.g. ``__half``, ``__nv_bfloat16``, ``__nv_fp8_e4m3``). | ||
| - ``T`` is an extended floating-point vector type (e.g. ``__half2``, ``__nv_bfloat162``, ``__nv_fp8x2_e4m3``). | ||
|
|
||
| The trait also propagates through composite types: | ||
|
|
||
| - C-style arrays: ``T[N]`` and ``T[]`` are trivially copyable when ``T`` is. | ||
| - ``cuda::std::array<T, N>``: trivially copyable when ``T`` is also trivially copyable. | ||
| - ``cuda::std::pair<T1, T2>``: trivially copyable when both ``T1`` and ``T2`` are. | ||
| - ``cuda::std::tuple<Ts...>``: trivially copyable when all ``Ts...`` are. | ||
| - Aggregates: trivially copyable when all members are. | ||
|
|
||
| ``const`` qualification is handled transparently, while ``volatile`` is compiler dependent. | ||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| .. code:: cuda | ||
|
|
||
| #include <cuda/type_traits> | ||
| #include <cuda/std/array> | ||
| #include <cuda/std/tuple> | ||
| #include <cuda/std/utility> | ||
|
|
||
| #include <cuda_fp16.h> | ||
|
|
||
| // Standard trivially copyable types | ||
| static_assert(cuda::is_trivially_copyable_v<int>); | ||
| static_assert(cuda::is_trivially_copyable_v<float>); | ||
|
|
||
| // Extended floating-point types | ||
| static_assert(cuda::is_trivially_copyable_v<__half>); | ||
| static_assert(cuda::is_trivially_copyable_v<__nv_bfloat16>); | ||
| static_assert(cuda::is_trivially_copyable_v<__half2>); | ||
|
|
||
| // Composite types containing extended floating-point types | ||
| static_assert(cuda::is_trivially_copyable_v<__half[4]>); | ||
| static_assert(cuda::is_trivially_copyable_v<cuda::std::array<__half, 4>>); | ||
| static_assert(cuda::is_trivially_copyable_v<cuda::std::pair<__half, __half>>); | ||
| static_assert(cuda::is_trivially_copyable_v<cuda::std::tuple<__half, __half>>); | ||
| static_assert(cuda::is_trivially_copyable_v<cuda::std::pair<__half, int>>); |
84 changes: 84 additions & 0 deletions
84
libcudacxx/include/cuda/__type_traits/is_trivially_copyable.h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | ||
| // See https://llvm.org/LICENSE.txt for license information. | ||
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
| // SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #ifndef __CUDA__TYPE_TRAITS_IS_TRIVIALLY_COPYABLE_H | ||
| #define __CUDA__TYPE_TRAITS_IS_TRIVIALLY_COPYABLE_H | ||
|
|
||
| #include <cuda/std/detail/__config> | ||
|
|
||
| #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 <cuda/__type_traits/is_vector_type.h> | ||
| #include <cuda/std/__cstddef/types.h> | ||
| #include <cuda/std/__fwd/array.h> | ||
| #include <cuda/std/__fwd/pair.h> | ||
| #include <cuda/std/__fwd/tuple.h> | ||
| #include <cuda/std/__type_traits/aggregate_members.h> | ||
| #include <cuda/std/__type_traits/enable_if.h> | ||
| #include <cuda/std/__type_traits/integral_constant.h> | ||
| #include <cuda/std/__type_traits/is_extended_floating_point.h> | ||
| #include <cuda/std/__type_traits/is_trivially_copyable.h> | ||
| #include <cuda/std/__type_traits/remove_const.h> | ||
|
|
||
| #include <cuda/std/__cccl/prologue.h> | ||
|
|
||
| _CCCL_BEGIN_NAMESPACE_CUDA | ||
|
|
||
| template <typename _Tp, typename = void> | ||
| constexpr bool __is_aggregate_trivially_copyable_v = false; | ||
|
|
||
| //! Users are allowed to specialize this variable template for their own types | ||
| template <typename _Tp> | ||
| constexpr bool is_trivially_copyable_v = | ||
| ::cuda::std::is_trivially_copyable_v<::cuda::std::remove_const_t<_Tp>> | ||
| || ::cuda::std::__is_extended_floating_point_v<::cuda::std::remove_const_t<_Tp>> | ||
| #if _CCCL_HAS_CTK() | ||
| || ::cuda::is_extended_fp_vector_type_v<::cuda::std::remove_const_t<_Tp>> | ||
| #endif // _CCCL_HAS_CTK() | ||
| || __is_aggregate_trivially_copyable_v<::cuda::std::remove_const_t<_Tp>>; | ||
|
|
||
| template <typename _Tp> | ||
| constexpr bool is_trivially_copyable_v<_Tp[]> = is_trivially_copyable_v<_Tp>; | ||
|
|
||
| template <typename _Tp, ::cuda::std::size_t _Size> | ||
| constexpr bool is_trivially_copyable_v<_Tp[_Size]> = is_trivially_copyable_v<_Tp>; | ||
|
|
||
| template <typename _Tp, ::cuda::std::size_t _Size> | ||
| constexpr bool is_trivially_copyable_v<::cuda::std::array<_Tp, _Size>> = is_trivially_copyable_v<_Tp>; | ||
|
|
||
| template <typename _T1, typename _T2> | ||
| constexpr bool is_trivially_copyable_v<::cuda::std::pair<_T1, _T2>> = | ||
| is_trivially_copyable_v<_T1> && is_trivially_copyable_v<_T2>; | ||
|
|
||
| template <typename... _Ts> | ||
| constexpr bool is_trivially_copyable_v<::cuda::std::tuple<_Ts...>> = (is_trivially_copyable_v<_Ts> && ...); | ||
|
|
||
| // if all the previous conditions fail, check if the type is an aggregate and all its members are trivially copyable | ||
| template <typename _Tp> | ||
| using __is_trivially_copyable_callable = ::cuda::std::bool_constant<is_trivially_copyable_v<_Tp>>; | ||
|
|
||
| template <typename _Tp> | ||
| constexpr bool __is_aggregate_trivially_copyable_v<_Tp, ::cuda::std::enable_if_t<::cuda::std::is_aggregate_v<_Tp>>> = | ||
| ::cuda::std::__aggregate_all_of<__is_trivially_copyable_callable, _Tp>::value; | ||
|
|
||
| // defined as alias so users cannot specialize it (they should specialize the variable template instead) | ||
| template <typename _Tp> | ||
| using is_trivially_copyable = ::cuda::std::bool_constant<is_trivially_copyable_v<_Tp>>; | ||
|
|
||
| _CCCL_END_NAMESPACE_CUDA | ||
|
|
||
| #include <cuda/std/__cccl/epilogue.h> | ||
|
|
||
| #endif // __CUDA__TYPE_TRAITS_IS_TRIVIALLY_COPYABLE_H | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ | |
| // under the Apache License v2.0 with LLVM Exceptions. | ||
| // See https://llvm.org/LICENSE.txt for license information. | ||
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
| // SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. | ||
| // SPDX-FileCopyrightText: Copyright (c) 2024-26 NVIDIA CORPORATION & AFFILIATES. | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
|
|
@@ -21,9 +21,8 @@ | |
| # pragma system_header | ||
| #endif // no system header | ||
|
|
||
| #include <cuda/std/__type_traits/enable_if.h> | ||
| #include <cuda/std/__type_traits/is_extended_floating_point.h> | ||
| #include <cuda/std/__type_traits/is_trivially_copyable.h> | ||
| #include <cuda/__type_traits/is_trivially_copyable.h> | ||
| #include <cuda/std/__concepts/concept_macros.h> | ||
| #include <cuda/std/__type_traits/is_trivially_default_constructible.h> | ||
| #include <cuda/std/cstring> | ||
|
|
||
|
|
@@ -42,37 +41,45 @@ _CCCL_BEGIN_NAMESPACE_CUDA_STD | |
| #else // ^^^ _CCCL_BUILTIN_BIT_CAST ^^^ / vvv !_CCCL_BUILTIN_BIT_CAST vvv | ||
| # define _CCCL_CONSTEXPR_BIT_CAST | ||
| # define _CCCL_HAS_CONSTEXPR_BIT_CAST() 0 | ||
| # if _CCCL_COMPILER(GCC, >=, 8) | ||
| // GCC starting with GCC8 warns about our extended floating point types having protected data members | ||
| #endif // !_CCCL_BUILTIN_BIT_CAST | ||
|
|
||
| #if _CCCL_COMPILER(GCC, >=, 8) | ||
| _CCCL_DIAG_PUSH | ||
| _CCCL_DIAG_SUPPRESS_GCC("-Wclass-memaccess") | ||
| # endif // _CCCL_COMPILER(GCC, >=, 8) | ||
| #endif // !_CCCL_BUILTIN_BIT_CAST | ||
| #endif // _CCCL_COMPILER(GCC, >=, 8) | ||
|
|
||
| template <class _To, | ||
| class _From, | ||
| enable_if_t<(sizeof(_To) == sizeof(_From)), int> = 0, | ||
| enable_if_t<is_trivially_copyable_v<_To> || __is_extended_floating_point_v<_To>, int> = 0, | ||
| enable_if_t<is_trivially_copyable_v<_From> || __is_extended_floating_point_v<_From>, int> = 0> | ||
| [[nodiscard]] _CCCL_API inline _CCCL_CONSTEXPR_BIT_CAST _To bit_cast(const _From& __from) noexcept | ||
| template <class _To, class _From> | ||
| [[nodiscard]] _CCCL_API inline _To __bit_cast_memcpy(const _From& __from) noexcept | ||
| { | ||
| #if defined(_CCCL_BUILTIN_BIT_CAST) | ||
| return _CCCL_BUILTIN_BIT_CAST(_To, __from); | ||
| #else // ^^^ _CCCL_BUILTIN_BIT_CAST ^^^ / vvv !_CCCL_BUILTIN_BIT_CAST vvv | ||
| static_assert(is_trivially_default_constructible_v<_To>, | ||
| "The compiler does not support __builtin_bit_cast, so bit_cast additionally requires the destination " | ||
| "type to be trivially constructible"); | ||
| static_assert(::cuda::std::is_trivially_default_constructible_v<_To>, | ||
| "bit_cast requires the destination type to be trivially constructible"); | ||
| _To __temp; | ||
| ::cuda::std::memcpy(&__temp, &__from, sizeof(_To)); | ||
| return __temp; | ||
| #endif // !_CCCL_BUILTIN_BIT_CAST | ||
| } | ||
|
|
||
| #if !defined(_CCCL_BUILTIN_BIT_CAST) | ||
| # if _CCCL_COMPILER(GCC, >=, 8) | ||
| #if _CCCL_COMPILER(GCC, >=, 8) | ||
| _CCCL_DIAG_POP | ||
| # endif // _CCCL_COMPILER(GCC, >=, 8) | ||
| #endif // _CCCL_COMPILER(GCC, >=, 8) | ||
|
|
||
| _CCCL_TEMPLATE(class _To, class _From) | ||
| _CCCL_REQUIRES((sizeof(_To) == sizeof(_From)) _CCCL_AND(::cuda::is_trivially_copyable_v<_To>) | ||
| _CCCL_AND(::cuda::is_trivially_copyable_v<_From>)) | ||
| [[nodiscard]] _CCCL_API inline _CCCL_CONSTEXPR_BIT_CAST _To bit_cast(const _From& __from) noexcept | ||
| { | ||
| #if defined(_CCCL_BUILTIN_BIT_CAST) | ||
| if constexpr (::cuda::std::is_trivially_copyable_v<_To> && ::cuda::std::is_trivially_copyable_v<_From>) | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. here the trick. We know that |
||
| { | ||
| return _CCCL_BUILTIN_BIT_CAST(_To, __from); | ||
| } | ||
| else | ||
| { | ||
| return ::cuda::std::__bit_cast_memcpy<_To>(__from); | ||
| } | ||
| #else // ^^^ _CCCL_BUILTIN_BIT_CAST ^^^ / vvv !_CCCL_BUILTIN_BIT_CAST vvv | ||
| return ::cuda::std::__bit_cast_memcpy<_To>(__from); | ||
| #endif // !_CCCL_BUILTIN_BIT_CAST | ||
| } | ||
|
|
||
| _CCCL_END_NAMESPACE_CUDA_STD | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.