Skip to content

[SYCL][Bindless][Exp] Add default constructors to image handle structs #12210

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

Merged
merged 1 commit into from
Jan 5, 2024
Merged

[SYCL][Bindless][Exp] Add default constructors to image handle structs #12210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion sycl/doc/extensions/experimental/sycl_ext_oneapi_bindless_images.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,6 +506,7 @@ namespace sycl::ext::oneapi::experimental {
struct unsampled_image_handle {
using raw_image_handle_type = /* Implementation defined */;

unsampled_image_handle();
unsampled_image_handle(raw_image_handle_type raw_handle);

raw_image_handle_type raw_handle;
Expand All @@ -515,6 +516,7 @@ struct unsampled_image_handle {
struct sampled_image_handle {
using raw_image_handle_type = /* Implementation defined */;

sampled_image_handle();
sampled_image_handle(raw_image_handle_type raw_image_handle);

raw_image_handle_type raw_handle;
Expand Down Expand Up @@ -618,7 +620,10 @@ If the creation of an image fails, `create_image` will throw a `sycl::exception`
with error code `sycl::errc::runtime`.

The `unsampled_image_handle` and `sampled_image_handle` types shall be
default-constructible, copy-constructible, and device-copyable.
default-constructible, copy-constructible, and device-copyable. When default
constructed, image handles are not valid until a user manually assigns a valid
`raw_image_handle_type` to the `raw_handle` field of the handle struct. The
default value of the `raw_handle` is implementation defined.

The `unsampled_image_handle` and `sampled_image_handle` types have a
constructor to allow creation of the types from a `raw_image_handle_type`
Expand Down
4 changes: 4 additions & 0 deletions sycl/include/sycl/ext/oneapi/bindless_images.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ namespace ext::oneapi::experimental {
struct unsampled_image_handle {
using raw_image_handle_type = pi_uint64;

unsampled_image_handle() : raw_handle(~0) {}

unsampled_image_handle(raw_image_handle_type raw_image_handle)
: raw_handle(raw_image_handle) {}

Expand All @@ -42,6 +44,8 @@ struct unsampled_image_handle {
struct sampled_image_handle {
using raw_image_handle_type = pi_uint64;

sampled_image_handle() : raw_handle(~0) {}

sampled_image_handle(raw_image_handle_type raw_image_handle)
: raw_handle(raw_image_handle) {}

Expand Down
9 changes: 8 additions & 1 deletion sycl/test-e2e/bindless_images/read_1D.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,21 @@ int main() {
assert(imgMem0MoveAssign != imgMem1CopyAssign);
assert(imgMem1 == imgMem1CopyAssign);

// We can default construct image handles
sycl::ext::oneapi::experimental::unsampled_image_handle imgHandle1;

// Extension: create the image and return the handle
sycl::ext::oneapi::experimental::unsampled_image_handle imgHandle1 =
sycl::ext::oneapi::experimental::unsampled_image_handle tmpHandle =
sycl::ext::oneapi::experimental::create_image(imgMem0MoveAssign, desc,
dev, ctxt);
sycl::ext::oneapi::experimental::unsampled_image_handle imgHandle2 =
sycl::ext::oneapi::experimental::create_image(imgMem1CopyAssign, desc,
dev, ctxt);

// Default constructed image handles are not valid until we assign a valid
// raw handle to the struct
imgHandle1.raw_handle = tmpHandle.raw_handle;

// Extension: copy over data to device
q.ext_oneapi_copy(dataIn1.data(), imgMem0MoveAssign.get_handle(), desc);
q.ext_oneapi_copy(dataIn2.data(), imgMem1CopyAssign.get_handle(), desc);
Expand Down