Skip to content

[SYCL][LIT] Check POD-ness for types crossing ABI boundary #21229

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.

Sign up for GitHub

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
uditagarwal97 wants to merge 3 commits into
base: sycl
Choose a base branch
from
Open

[SYCL][LIT] Check POD-ness for types crossing ABI boundary #21229

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d1ec5d
[SYCL][LIT] Check POD-ness for types crossing ABI boundary
uditagarwal97 Feb 5, 2026
ec90585
clang format
uditagarwal97 Feb 5, 2026
2b561f2
Don't print type
uditagarwal97 Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 144 additions & 0 deletions sycl/test/abi/abi_crossing_type_traits.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
// Test to check type traits of SYCL types when crossing ABI boundaries.
// Type traits, like POD, trivially copyable, standard layout, etc if changed
// outside the ABI breaking window can break the ABI and cause UB.

// RUN: %clangxx -fsycl -o %t.out %s
// RUN: %t.out 2>&1 | FileCheck %s

#include <iostream>
#include <sycl/detail/common.hpp>
#include <sycl/detail/kernel_launch_helper.hpp>
#include <sycl/sycl.hpp>
#include <type_traits>

using namespace sycl;

// For a type to be POD, it has to be trivial and standard layout.
// For a type to be trivial, it has to be trivially copyable and
// trivially default constructible.
// Don't use std::is_pod as it is deprecated in C++20 or std::is_trivial
// as it will be deprecated in C++26.
template <typename T> void check_type_traits() {
std::cout << "Trivially copyable: "
<< std::is_trivially_copyable_v<T> << "\n";
std::cout << "Trivially default constructible: "
<< std::is_trivially_default_constructible_v<T> << "\n";
std::cout << "Standard layout: " << std::is_standard_layout_v<T> << "\n";
}
Comment on lines +22 to +27
Copy link
Contributor

@againull againull Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should change cout/FileCheck to static_assert checks, i.e. something like:

template <typename T, bool IsTriviallyCopyable,
            bool IsTriviallyDefaultConstructible,
            bool IsStandardLayout>
  void check_type_traits() {
    static_assert(std::is_trivially_copyable_v<T> == IsTriviallyCopyable,
                  "Trivially copyable trait changed");
...

It will also allow to easier differentiate between msvc/gcc if any differences:

  #ifdef ..
    check_type_traits<some_type, false, false, false>();  // MSVC
  #else
    check_type_traits<some_type, false, false, true>();   // GCC
  #endif


int main() {
Copy link
Contributor Author

@uditagarwal97 uditagarwal97 Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is not exhaustive and I only considered types for which we already have abi layout tests.


// CHECK: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<device>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<buffer<int, 1>>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<
accessor<int, 1, access::mode::read_write, access::target::device>>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<local_accessor<int, 1>>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<id<3>>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<range<3>>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<item<3>>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<nd_item<3>>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<nd_range<3>>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<
detail::compile_time_kernel_info_v1::CompileTimeKernelInfoTy>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<exception>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<handler>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<detail::HostKernelRefBase>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<image<1>>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<detail::nd_range_view_v1::nd_range_view>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<detail::KernelPropertyHolderStructTy>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 1
check_type_traits<span<int, 4>>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<detail::tls_code_loc_t>();

// CHECK-NEXT: Trivially copyable: 1
// CHECK-NEXT: Trivially default constructible: 1
// CHECK-NEXT: Standard layout: 1
check_type_traits<vec<int, 4>>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<detail::PropertyWithDataBase>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<detail::SYCLMemObjAllocator>();

// CHECK-NEXT: Trivially copyable: 0
// CHECK-NEXT: Trivially default constructible: 0
// CHECK-NEXT: Standard layout: 0
check_type_traits<device_selector>();

return 0;
}
Loading