Skip to content

Commit

Permalink
Add leak checking info to INTRO.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
kswiecicki committed Mar 14, 2023
1 parent 2f3fad8 commit dc1e1e2
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions scripts/core/INTRO.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Unified Runtime loader implements tracing support through the `XPTI framework <h
| **parent**: nullptr
| **event**: nullptr
| **instance**: Unique ID to allow the correlation of the `function_with_args_begin` event with the `function_with_args_end` event.
| **user_data**: A pointer to `function_with_args_t` object, that includes function ID, name, and arguments.
| **user_data**: A pointer to `function_with_args_t` object, that includes function ID, name, and arguments.
- None
* - `function_with_args_end`
- | **trace_type**: `xpti::trace_point_type_t::function_with_args_end` that marks the end of a function
Expand All @@ -210,7 +210,7 @@ All of these logging options can be set with **UR_LOG_LOADER** and **UR_LOG_NULL
Both of these environment variables have the same syntax for setting logger options::

"[level:debug|info|warning|error];[flush:<debug|info|warning|error>];[output:stdout|stderr|file,<path>]"

* level - a log level, meaning that only messages from this level and above are printed,
possible values, from the lowest level to the highest one: *debug*, *info*, *warning*, *error*,
* flush - a flush level, meaning that messages at this level and above are guaranteed to be flushed immediately,
Expand All @@ -220,7 +220,7 @@ Both of these environment variables have the same syntax for setting logger opti
when providing a *file* output option, a *<path>* is required

.. note::
For output to file, a path to the file have to be provided after a comma, like in the example above. The path has to exist, file will be created if not existing.
For output to file, a path to the file have to be provided after a comma, like in the example above. The path has to exist, file will be created if not existing.
All these three logger options are optional. The defaults are set when options are not provided in the environment variable.
Options have to be separated with `;`, option names, and their values with `:`. Additionally, when providing *file* output, the keyword *file* and a path to a file
have to be separated by `,`.
Expand Down Expand Up @@ -271,3 +271,13 @@ Specific environment variables can be set to control the behavior of unified run
.. note::

This environment variable should be used together with "UR_ENABLE_VALIDATION_LAYER".

.. envvar:: UR_ENABLE_LEAK_CHECKING

Holds the value '0' or '1'. By setting it to '1' you enable leak checking for Unified Runtime API calls involving
object creation/destruction. Leak checking depends on the logging mechanism.

.. note::

This environment variable should be used together with "UR_ENABLE_VALIDATION_LAYER" and "UR_LOG_VALIDATION".
See **Logging** section for details.

0 comments on commit dc1e1e2

Please sign in to comment.