You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sycl/doc/SYCLEnvironmentVariables.md
+18-5Lines changed: 18 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,24 @@ This file describes environment variables that are having effect on SYCL compile
4
4
5
5
# Controlling SYCL RT
6
6
7
-
| Environment variable | Description |
8
-
| ----------- | ----------- |
9
-
| SYCL_PI_TRACE | If set forces tracing of PI calls to stdout. |
10
-
| SYCL_BE={PI_OPENCL,PI_OTHER} | When SYCL RT is built with PI this controls which plugin to use. |
11
-
| SYCL_PRINT_EXECUTION_GRAPH | Print execution graph to DOT text file. Options are described below. |
7
+
**Warning:** the environment variables described in this document are used for
8
+
development and debugging of SYCL runtime and compiler. Their semantics are
9
+
subject to change. Do not rely on these variables in production code.
10
+
11
+
| Environment variable | Values | Description |
12
+
| -------------------- | ------ | ----------- |
13
+
| SYCL_PI_TRACE | Any(*) | Force tracing of PI calls to stderr. |
14
+
| SYCL_BE | PI_OPENCL, PI_OTHER | When SYCL RT is built with PI this controls which plugin to use. Default value is PI_OPENCL. |
15
+
| SYCL_DEVICE_TYPE | One of: CPU, GPU, ACC, HOST | Force SYCL to use the specified device type. If unset, default selection rules are applied. If set to any unlisted value, this control has no effect. If the requested device type is not found, a `cl::sycl::runtime_error` exception is thrown. If a non-default device selector is used, a device must satisfy both the selector and this control to be chosen. This control only has effect on devices created with a selector. |
16
+
| SYCL_PROGRAM_BUILD_OPTIONS | String of valid OpenCL build options | Override build options for all programs. |
17
+
| SYCL_USE_KERNEL_SPV | Path to the SPIR-V binary | Load device image from the specified file. If runtime is unable to read the file, `cl::sycl::runtime_error` exception is thrown.|
18
+
| SYCL_DUMP_IMAGES | Any(*) | Dump device image binaries to file. Control has no effect if SYCL_USE_KERNEL_SPV is set. |
19
+
| SYCL_PRINT_EXECUTION_GRAPH | Described [below](#sycl_print_execution_graph-options)| Print execution graph to DOT text file. |
20
+
| SYCL_THROW_ON_BLOCK | Any(*) | Throw an exception on attempt to wait for a blocked command. |
21
+
22
+
`(*) Note: Any means this environment variable is effective when set to any non-null value.`
23
+
24
+
## SYCL_PRINT_EXECUTION_GRAPH Options
12
25
13
26
SYCL_PRINT_EXECUTION_GRAPH can accept one or more comma separated values from table below
0 commit comments