[SYCL] Report an error message when "sycl::program::create_program_with_source" is used with Level-Zero #3212

rbegam · 2021-02-12T21:11:29Z

Level-Zero backend does not support create_program_with_source. This is to report an error message from SYCL RT if that is requested.

Signed-off-by: rbegam [email protected]

…th_source" is used with Level-Zero backend. Signed-off-by: rbegam <[email protected]>

Signed-off-by: rbegam <[email protected]>

smaslov-intel · 2021-02-13T00:28:42Z

sycl/source/detail/program_impl.cpp

+  if (Plugin.getBackend() == cl::sycl::backend::level_zero &&
+      Err == PI_INVALID_OPERATION) {
+    throw feature_not_supported(
+        "piclProgramCreateWithSource is not supported in Level Zero",


Suggested change

"piclProgramCreateWithSource is not supported in Level Zero",

"program::compile_with_source is not supported with Level Zero backend.",

We must not tell end users about PI interfaces. Also I think it would be good to redirect to the library that can be used to build OpenCL kernel for Level-Zero. @v-klochkov , which one is this?

Shouldn't this error be emitted from Level Zero plug-in, rather than from DPC++ runtime?

Plugins are C API. In order to throw a consistent error message this is better suited for SYCL RT, I think.

In order to throw a consistent error message this is better suited for SYCL RT, I think.

Right, but BE specific error detection logic must be located in corresponding plug-in. DPC++ runtime is designed to keep device specific logic in plug-ins and logic common for all back-ends in "runtime" library.
To follow this design we can separate error detection logic (device specific) from error reporting/conversion logic (common for all plug-ins).
E.g. plug-in can return an error code when "compile with source" feature is not supported (PI_INVALID_OPERATION? or some other error code) and DPC++ runtime can report this error via exception - "program::compile_with_source is not supported with" + Plugin.getBackend().to_string()" - this is a pseudo code to demonstrate the idea, not a real C++ program.

Basically code like this:

if (Plugin.getBackend() == cl::sycl::backend::<some_backend>) { ... }

is a red flag signaling that most likely it should be implemented in corresponding plug-in.

That's right. We don't need to check the backend here in SYCL RT, every backend would return PI_INVALID_OPERATION of compilation is not supported, and the error message would be common for all such backends. @rbegam , please also change CUDA plugin to do the same, i.e. return an error:

llvm/sycl/plugins/cuda/pi_cuda.cpp

Line 2653 in eab4791

return {};

Also I think it would be good to redirect to the library that can be used to build OpenCL kernel for Level-Zero. @v-klochkov , which one is this?

The class sycl::INTEL::online_compiler can generate IL/SPIR-V for a source program.

Signed-off-by: rbegam <[email protected]>

smaslov-intel · 2021-02-16T20:26:21Z

sycl/plugins/cuda/pi_cuda.cpp

@@ -2650,7 +2650,7 @@ pi_result cuda_piclProgramCreateWithSource(pi_context context, pi_uint32 count,
                                           const size_t *lengths,
                                           pi_program *program) {
  cl::sycl::detail::pi::die("cuda_piclProgramCreateWithSource not implemented");


remove the die, since it makes the return unreachable

right, will do that. should I enable printing the error msg here (like level_zero) before returning? There are some more cases in the cuda plugin where die() is called before a return stmt with an error code. might be a good idea to fix those too.

should I enable printing the error msg here (like level_zero) before returning?

Why not, if they have the ways to print logs.

There are some more cases in the cuda plugin where die() is called before a return stmt with an error code. might be a good idea to fix those too.

Let's not remove any "die"-s without making sure they (error return codes) are handled properly in SYCL RT.

Why not, if they have the ways to print

there is no way right now just for printing error msg.

smaslov-intel · 2021-02-16T20:29:18Z

sycl/source/detail/program_impl.cpp

@@ -26,6 +27,21 @@ __SYCL_INLINE_NAMESPACE(cl) {
 namespace sycl {
 namespace detail {

+inline const std::string GetBackendString(cl::sycl::backend backend) {


if you really wanted to name the backend in the error message (I don't feel this is necessary) then you'd employ the existing

llvm/sycl/include/CL/sycl/backend_types.hpp

Line 31 in cc3d095

inline std::ostream &operator<<(std::ostream &Out, backend be) {

I'll skip this if not necessary.

vladimirlaz

@rbegam, could you please fix the clang-format issue

Signed-off-by: rbegam <[email protected]>

smaslov-intel · 2021-02-17T20:19:14Z

sycl/source/detail/program_impl.cpp

+          MContext->getHandleRef(), 1, &Src, &Size, &MProgram);
+
+  if (Err == PI_INVALID_OPERATION) {
+    throw feature_not_supported("program::compile_with_source is not supported",


Suggested change

throw feature_not_supported("program::compile_with_source is not supported",

throw feature_not_supported("program::compile_with_source is not supported by the selected backend",

Signed-off-by: rbegam <[email protected]>

smaslov-intel

LGTM

Signed-off-by: rbegam <[email protected]>

[SYCL] Report an error message when "sycl::program::create_program_wi…

6b3b41d

…th_source" is used with Level-Zero backend. Signed-off-by: rbegam <[email protected]>

rbegam requested a review from a team as a code owner February 12, 2021 21:11

rbegam requested a review from vladimirlaz February 12, 2021 21:11

clang formatted.

18fccab

Signed-off-by: rbegam <[email protected]>

rbegam requested a review from smaslov-intel February 12, 2021 21:47

smaslov-intel suggested changes Feb 13, 2021

View reviewed changes

fix error message.

b8445a0

Signed-off-by: rbegam <[email protected]>

rbegam requested a review from a team as a code owner February 16, 2021 19:44

clang formatted.

3dc592a

Signed-off-by: rbegam <[email protected]>

smaslov-intel suggested changes Feb 16, 2021

View reviewed changes

vladimirlaz suggested changes Feb 17, 2021

View reviewed changes

rbegam added 3 commits February 17, 2021 11:17

few modifications.

db68c4d

Signed-off-by: rbegam <[email protected]>

clang formatted.

7fd2078

Signed-off-by: rbegam <[email protected]>

clang formatted.

2ff4db5

Signed-off-by: rbegam <[email protected]>

smaslov-intel reviewed Feb 17, 2021

View reviewed changes

smaslov-intel previously approved these changes Feb 17, 2021

View reviewed changes

fixed error message.

96464da

Signed-off-by: rbegam <[email protected]>

rbegam dismissed smaslov-intel’s stale review via 96464da February 17, 2021 21:25

smaslov-intel previously approved these changes Feb 17, 2021

View reviewed changes

clang formatted.

0c9e0cf

Signed-off-by: rbegam <[email protected]>

rbegam dismissed smaslov-intel’s stale review via 0c9e0cf February 17, 2021 21:35

smaslov-intel approved these changes Feb 17, 2021

View reviewed changes

vladimirlaz approved these changes Feb 18, 2021

View reviewed changes

bader merged commit ba77e3a into intel:sycl Feb 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[SYCL] Report an error message when "sycl::program::create_program_with_source" is used with Level-Zero #3212

[SYCL] Report an error message when "sycl::program::create_program_with_source" is used with Level-Zero #3212

Uh oh!

rbegam commented Feb 12, 2021

Uh oh!

smaslov-intel Feb 13, 2021

Uh oh!

bader Feb 13, 2021

Uh oh!

smaslov-intel Feb 13, 2021

Uh oh!

bader Feb 14, 2021

Uh oh!

smaslov-intel Feb 14, 2021

Uh oh!

v-klochkov Feb 16, 2021

Uh oh!

smaslov-intel Feb 16, 2021

Uh oh!

rbegam Feb 16, 2021

Uh oh!

smaslov-intel Feb 16, 2021

Uh oh!

rbegam Feb 17, 2021

Uh oh!

smaslov-intel Feb 16, 2021

Uh oh!

rbegam Feb 17, 2021

Uh oh!

vladimirlaz left a comment •

edited

Loading

Uh oh!

smaslov-intel Feb 17, 2021

Uh oh!

smaslov-intel left a comment

Uh oh!

Uh oh!

	"piclProgramCreateWithSource is not supported in Level Zero",
	"program::compile_with_source is not supported with Level Zero backend.",

	throw feature_not_supported("program::compile_with_source is not supported",
	throw feature_not_supported("program::compile_with_source is not supported by the selected backend",

[SYCL] Report an error message when "sycl::program::create_program_with_source" is used with Level-Zero #3212

[SYCL] Report an error message when "sycl::program::create_program_with_source" is used with Level-Zero #3212

Uh oh!

Conversation

rbegam commented Feb 12, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vladimirlaz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smaslov-intel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vladimirlaz left a comment •

edited

Loading