Skip to content

Commit 542d3dd

Browse files
committed
task: add more env var documentation
1 parent b4e0dca commit 542d3dd

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

docs/doc_sources/user_guides/environment_variables.rst

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,61 @@ The value of the variable is a bit-mask, with the following supported values:
5050
- Enables tracing of PI calls
5151
* - ``-1``
5252
- Enables all levels of tracing
53+
54+
Variable ``ZE_FLAT_DEVICE_HIERARCHY``
55+
--------------------------
56+
Allows users to define the device hierarchy model exposed by Level Zero driver implementation.
57+
58+
.. list-table::
59+
:header-rows: 1
60+
61+
* - Value
62+
- Description
63+
* - ``COMBINED``
64+
- Enables all levels of tracing
65+
* - ``COMPOSITE``
66+
- Returns all devices that do not have a root-device.
67+
* - ``FLAT``
68+
- Returns all devices without sub-devices in a flat hierarchy. Enabled by default.
69+
70+
Read more `here <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#device-hierarchy>` and `here <https://www.intel.com/content/www/us/en/developer/articles/technical/flattening-gpu-tile-hierarchy.html>`.
71+
72+
Variable ``ZE_AFFINITY_MASK``
73+
-------------------------------
74+
Allows users to mask specific devices from being used by SYCL applications.
75+
If we have ZE_FLAT_DEVICE_HIERARCHY set to COMPOSITE, we can have an AFFINITY of “1” for our application to only see device #1 - making system devices 0, and 2+, invisible. Etc.
76+
77+
Read more `here <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#affinity-mask>`.
78+
79+
Variable ``ZE_ENABLE_PCI_ID_DEVICE_ORDER``
80+
-------------------------------
81+
Forces driver to report devices from lowest to highest PCI bus ID.
82+
83+
.. list-table::
84+
:header-rows: 1
85+
86+
* - Value
87+
- Description
88+
* - ``0``
89+
- Disabled. Default value.
90+
* - ``1``
91+
- Enabled.
92+
93+
Variable ``ZE_SHARED_FORCE_DEVICE_ALLOC``
94+
-------------------------------
95+
Forces all shared allocations into device memory
96+
97+
.. list-table::
98+
:header-rows: 1
99+
100+
* - Value
101+
- Description
102+
* - ``0``
103+
- Disabled. Default value.
104+
* - ``1``
105+
- Enabled.
106+
107+
-------------------------------
108+
Other relevant environment variables can be found here:
109+
- `Level Zero <https://intel.github.io/llvm/EnvironmentVariables.html>`
110+
- `OneAPI <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#environment-variables>`

0 commit comments

Comments
 (0)