Skip to content
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

Allow passing a non-trivially-copyable comparator to sort #1932

Merged
merged 3 commits into from
Nov 6, 2024

Conversation

dmitriy-sobolev
Copy link
Contributor

Fixes #1924.

danhoeflinger
danhoeflinger previously approved these changes Nov 4, 2024
Copy link
Contributor

@danhoeflinger danhoeflinger left a comment

Choose a reason for hiding this comment

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

LGTM, this should fix the issue.
Thanks

We really need to push for the change to SYCL to make this sort of type intrinsically device copyable. Its a really frustrating maintenance problem.

Edit: added a comment which should be addressed before merging, in my opinion.

@danhoeflinger danhoeflinger self-requested a review November 4, 2024 20:48
@@ -190,6 +190,11 @@ test_device_copyable()
oneapi::dpl::__par_backend_hetero::__early_exit_find_or<policy_non_device_copyable, noop_device_copyable>>,
"__early_exit_find_or is not device copyable with device copyable types");

static_assert(
sycl::is_device_copyable_v<oneapi::dpl::__par_backend_hetero::__leaf_sorter<noop_device_copyable,
Copy link
Contributor

@danhoeflinger danhoeflinger Nov 4, 2024

Choose a reason for hiding this comment

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

I'm not sure if this actually causes any problems for the compilation of the test, but we should probably create a utility range_device_copyable and a range_non_device_copyable which implement operator[], size(), begin(), end(), and provide a value and difference type in test/support/utils_device_copyable.h.
Use those types here instead of the noop functors.

Copy link
Contributor Author

@dmitriy-sobolev dmitriy-sobolev Nov 5, 2024

Choose a reason for hiding this comment

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

It successfully compiles with the current approach. Let me investigate why, what I should have done initially.

If it is proven to be reliable, we can avoid adding extra code in the test. If I cannot prove it, I will reuse an existing range type (if possible), and add divice_copyable/non_device_copyable comparators (it is easier).

Copy link
Contributor

Choose a reason for hiding this comment

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

I think its not fully instantiating the type in the compile time check, so it doesn't run into the issues in the type if it were created with those types. https://godbolt.org/z/d87x6eo1s

I'm a bit torn, as we could probably delete all but a simple device_copyable_type and non_device_copyable_type in our tests, but we wouldn't be checking types which are actually able to be instantiated.

I guess I'm OK with either direction we want to go. So far, we have created types to match, but wouldnt push hard against cleaning this up and relying only on a couple simple types if it works and compiles reliably for our testing purposes on our full compiler matrix.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you very much for the example and description. I have a more tailored example here: https://godbolt.org/z/3WqGT68x6. Indeed, it does not instantiate the type entirely.

It seems there is no need for the compiler to instantiate the tested class entirely in that expression, so we can get away with noop classes. The standard (c++17) says the following about it:

Unless a class template specialization has been explicitly instantiated (17.8.2) or explicitly specialized (17.8.3),
the class template specialization is implicitly instantiated when the specialization is referenced in a context
that requires a completely-defined object type or when the completeness of the class type affects the semantics
of the program.

In my understanding the note implies that a class must be instantiated when it is needed in that particular context.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, thanks for finding the relevant section in the specification. I think technically we will generally be OK with just the simple noop classes.

I'm still undecided which I prefer really. I think the more realized types are a bit better to document what we are doing (I always look at tests documentation, at least in part). This is a big stretch here because we are really testing internals in an obscure and specific fashion. However, it may be more confusing to future readers with less realistic non-instantiable types.

I'm OK with merging as it is if that is what you would like to do. If we want to clean up the types to remove all but a pair of simple types in a separate PR, we can do that. We can probably add some comment explaining why this works and the goal of these specific tests, if it is not already clear.

@danhoeflinger danhoeflinger dismissed their stale review November 4, 2024 20:58

found something which needs addressing

Signed-off-by: Dmitriy Sobolev <[email protected]>
@dmitriy-sobolev dmitriy-sobolev force-pushed the dev/dmitriy-sobolev/sort-leaf-device branch from b4b5ecf to 1fa7438 Compare November 5, 2024 13:50
danhoeflinger
danhoeflinger previously approved these changes Nov 5, 2024
@dmitriy-sobolev dmitriy-sobolev merged commit a037165 into main Nov 6, 2024
22 checks passed
@dmitriy-sobolev dmitriy-sobolev deleted the dev/dmitriy-sobolev/sort-leaf-device branch November 6, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

non-trivially-copyable comparators aren't supported for sort/sort_by_key
2 participants