[SYCL] Add max work-group size kernel properties #14518

frasercrmck · 2024-07-10T14:41:55Z

This patch adds two kernel properties to allow users to specify the maximum work-group size that a kernel will be invoked with.

The max_work_group_size property corresponds to the intel::max_work_group_size function attribute, but can be specified with 1, 2, or 3 dimensions (unlike the attribute which accepts only 3).

The max_linear_work_group_size property is similar but is always a single value which denotes the combined linear (total) work-group size. This can be used when the user cannot guarantee a maximum bound in each of the dimensions they wish to run the kernel, but can guarantee a total. This acts similarly to CUDA's maxThreadsPerBlock launch bounds property.

This patch also wires up the 'max_work_group_size' property to the equivalent SPIR-V execution mode, which should hopefully improve certain use cases.

This patch adds two kernel properties to allow users to specify the maximum work-group size that a kernel will be invoked with. The `max_work_group_size` property corresponds to the `intel::max_work_group_size` function attribute, but can be specified with 1, 2, or 3 dimensions (unlike the attribute which accepts only 3). The `max_total_work_group_size` property is similar but is always a single value which denotes the combined total work-group size. This can be used when the user cannot guarantee a maximum bound in each of the dimensions they wish to run the kernel, but can guarantee a total. This acts similarly to CUDA's `maxThreadsPerBlock` launch bounds property. This patch also wires up the 'max_work_group_size' property to the equivalent SPIR-V execution mode, which should hopefully improve certain use cases.

frasercrmck · 2024-07-10T14:42:21Z

Split from #14448, @steffenlarsen and @gmlueck

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_properties.asciidoc

gmlueck

Spec changes LGTM. Just a minor formatting thing.

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_properties.asciidoc

…ties.asciidoc Co-authored-by: Greg Lueck <[email protected]>

premanandrao

Could you please add a CodeGen lit test to exercise the changes in NVPTX.cpp?

frasercrmck · 2024-07-15T08:19:35Z

Could you please add a CodeGen lit test to exercise the changes in NVPTX.cpp?

Sorry, do you mean a backend CodeGen LIT test, or a frontend CodeGen test?

There are separate (upstream) backend CodeGen tests already for the NVVM annotations, like this one.

This PR adds frontend "CodeGen" tests in sycl/test/check_device_code/extensions/properties, as that's where the LLVM IR codegen tests for the other properties takes place. I think this is the same discussion as in #14502.

…el-props

KseniyaTikhomirova

SYCL part looks ok to me.

AlexeySachkov

CompileTimePropertiesPass changes LGTM

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_properties.asciidoc

clang/lib/CodeGen/Targets/NVPTX.cpp

…el-props

…ding

…el-props

gmlueck

Spec changes LGTM

frasercrmck · 2024-08-27T16:12:16Z

ping @intel/dpcpp-spirv-reviewers, thanks

These two properties allow the program to specify a maximum work-group size in various ways. They are intended to be targeted from languages such as SYCL (see intel/llvm#14518). This PR implements them for CUDA and Native CPU. It should also be able support them for HIP, in the same fashion. Other adapters using SPIR-V and/or Level Zero would require further changes to both of those specifications.

frasercrmck · 2024-09-09T08:54:42Z

ping @intel/dpcpp-spirv-reviewers

llvm-spirv/lib/SPIRV/PreprocessMetadata.cpp

These two properties allow the program to specify a maximum work-group size in various ways. They are intended to be targeted from languages such as SYCL (see intel/llvm#14518). This PR implements them for CUDA and Native CPU. It should also be able support them for HIP, in the same fashion. Other adapters using SPIR-V and/or Level Zero would require further changes to both of those specifications.

…el-props

sycl/cmake/modules/FetchUnifiedRuntime.cmake

…el-props

frasercrmck · 2024-09-25T11:14:25Z

Three E2E tests failing on linux:

Failed Tests (3):
  SYCL :: DeviceDependencies/free_function_kernels.cpp
  SYCL :: LLVMIntrinsicLowering/bitreverse.cpp
  SYCL :: LLVMIntrinsicLowering/sub_byte_bitreverse.cpp

All for the same reason:

clang++: error: option '-fno-sycl-allow-device-dependencies' is deprecated and will be removed in a future release

Looks like a pre-existing problem.

frasercrmck · 2024-09-25T12:35:55Z

Same on Windows:

********************
Failed Tests (2):
  SYCL :: DeviceDependencies/free_function_kernels.cpp
  SYCL :: LLVMIntrinsicLowering/bitreverse.cpp

frasercrmck · 2024-09-25T12:36:39Z

@intel/llvm-gatekeepers this is ready to merge, thanks. The failures are unrelated (see above).

frasercrmck requested review from a team as code owners July 10, 2024 14:41

frasercrmck requested a review from KseniyaTikhomirova July 10, 2024 14:41

frasercrmck had a problem deploying to WindowsCILock July 10, 2024 14:54 — with GitHub Actions Error

Pennycook reviewed Jul 10, 2024

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_properties.asciidoc Outdated Show resolved Hide resolved

feedback: total -> linear

b4d3bf1

frasercrmck temporarily deployed to WindowsCILock July 10, 2024 15:44 — with GitHub Actions Inactive

frasercrmck temporarily deployed to WindowsCILock July 10, 2024 17:58 — with GitHub Actions Inactive

gmlueck reviewed Jul 10, 2024

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_properties.asciidoc Outdated Show resolved Hide resolved

Update sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_proper…

a9b43f2

…ties.asciidoc Co-authored-by: Greg Lueck <[email protected]>

frasercrmck temporarily deployed to WindowsCILock July 11, 2024 09:36 — with GitHub Actions Inactive

frasercrmck temporarily deployed to WindowsCILock July 11, 2024 10:36 — with GitHub Actions Inactive

gmlueck approved these changes Jul 11, 2024

View reviewed changes

frasercrmck mentioned this pull request Jul 11, 2024

[SYCL] Add kernel properties for three function attributes #14448

Closed

premanandrao reviewed Jul 12, 2024

View reviewed changes

Merge remote-tracking branch 'origin/sycl' into sycl-max-wg-size-kern…

cea3495

…el-props

frasercrmck temporarily deployed to WindowsCILock July 15, 2024 16:40 — with GitHub Actions Inactive

frasercrmck had a problem deploying to WindowsCILock July 15, 2024 18:13 — with GitHub Actions Failure

frasercrmck temporarily deployed to WindowsCILock July 16, 2024 06:44 — with GitHub Actions Inactive

KseniyaTikhomirova approved these changes Jul 16, 2024

View reviewed changes

AlexeySachkov approved these changes Jul 16, 2024

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_properties.asciidoc Outdated Show resolved Hide resolved

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_properties.asciidoc Outdated Show resolved Hide resolved

clang/lib/CodeGen/Targets/NVPTX.cpp Outdated Show resolved Hide resolved

frasercrmck added 2 commits July 16, 2024 19:15

Merge remote-tracking branch 'origin/sycl' into sycl-max-wg-size-kern…

97cfa72

…el-props

feedback: maybe_unused; delete comment; update spec for exception wor…

f0ab74c

…ding

frasercrmck temporarily deployed to WindowsCILock July 16, 2024 19:00 — with GitHub Actions Inactive

bump

079948b

frasercrmck temporarily deployed to WindowsCILock August 22, 2024 15:06 — with GitHub Actions Inactive

frasercrmck temporarily deployed to WindowsCILock August 22, 2024 16:09 — with GitHub Actions Inactive

frasercrmck added 2 commits August 27, 2024 09:25

Merge remote-tracking branch 'origin/sycl' into sycl-max-wg-size-kern…

275c9ae

…el-props

update docs

1594d8c

frasercrmck temporarily deployed to WindowsCILock August 27, 2024 08:48 — with GitHub Actions Inactive

frasercrmck temporarily deployed to WindowsCILock August 27, 2024 09:48 — with GitHub Actions Inactive

gmlueck approved these changes Aug 27, 2024

View reviewed changes

AlexeySachkov reviewed Sep 9, 2024

View reviewed changes

llvm-spirv/lib/SPIRV/PreprocessMetadata.cpp Outdated Show resolved Hide resolved

Merge remote-tracking branch 'origin/sycl' into sycl-max-wg-size-kern…

bb55883

…el-props

frasercrmck temporarily deployed to WindowsCILock September 24, 2024 15:32 — with GitHub Actions Inactive

frasercrmck had a problem deploying to WindowsCILock September 24, 2024 17:13 — with GitHub Actions Failure

frasercrmck temporarily deployed to WindowsCILock September 25, 2024 08:41 — with GitHub Actions Inactive

aarongreig reviewed Sep 25, 2024

View reviewed changes

sycl/cmake/modules/FetchUnifiedRuntime.cmake Outdated Show resolved Hide resolved

Merge remote-tracking branch 'origin/sycl' into sycl-max-wg-size-kern…

4a40d12

…el-props

frasercrmck temporarily deployed to WindowsCILock September 25, 2024 10:21 — with GitHub Actions Inactive

aarongreig approved these changes Sep 25, 2024

View reviewed changes

frasercrmck had a problem deploying to WindowsCILock September 25, 2024 11:21 — with GitHub Actions Failure

ldrumm merged commit af8361c into intel:sycl Sep 25, 2024
11 of 13 checks passed

frasercrmck deleted the sycl-max-wg-size-kernel-props branch September 25, 2024 12:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SYCL] Add max work-group size kernel properties #14518

[SYCL] Add max work-group size kernel properties #14518

frasercrmck commented Jul 10, 2024 •

edited

Loading

frasercrmck commented Jul 10, 2024

gmlueck left a comment

premanandrao left a comment

frasercrmck commented Jul 15, 2024

KseniyaTikhomirova left a comment

AlexeySachkov left a comment

gmlueck left a comment

frasercrmck commented Aug 27, 2024

frasercrmck commented Sep 9, 2024

frasercrmck commented Sep 25, 2024

frasercrmck commented Sep 25, 2024

frasercrmck commented Sep 25, 2024

[SYCL] Add max work-group size kernel properties #14518

[SYCL] Add max work-group size kernel properties #14518

Conversation

frasercrmck commented Jul 10, 2024 • edited Loading

frasercrmck commented Jul 10, 2024

gmlueck left a comment

Choose a reason for hiding this comment

premanandrao left a comment

Choose a reason for hiding this comment

frasercrmck commented Jul 15, 2024

KseniyaTikhomirova left a comment

Choose a reason for hiding this comment

AlexeySachkov left a comment

Choose a reason for hiding this comment

gmlueck left a comment

Choose a reason for hiding this comment

frasercrmck commented Aug 27, 2024

frasercrmck commented Sep 9, 2024

frasercrmck commented Sep 25, 2024

frasercrmck commented Sep 25, 2024

frasercrmck commented Sep 25, 2024

frasercrmck commented Jul 10, 2024 •

edited

Loading