diff options
author | Soby Mathew <soby.mathew@arm.com> | 2019-09-12 11:14:21 +0000 |
---|---|---|
committer | TrustedFirmware Code Review <review@review.trustedfirmware.org> | 2019-09-12 11:14:21 +0000 |
commit | 684b3a02053badb12f6643f7feeae6e0aa394560 (patch) | |
tree | 13c16eb11133d47322253a2a0e141774fcff8c32 /docs | |
parent | f38e5182f7e60d8c193cbf7712982c0ed7f47cdb (diff) | |
parent | 1f4619796af5baf4b41b5723bbf708355f8597fa (diff) |
Merge "Add UBSAN support and handlers" into integration
Diffstat (limited to 'docs')
-rw-r--r-- | docs/getting_started/user-guide.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/getting_started/user-guide.rst b/docs/getting_started/user-guide.rst index b447f149..1cfd4c73 100644 --- a/docs/getting_started/user-guide.rst +++ b/docs/getting_started/user-guide.rst @@ -684,6 +684,21 @@ Common build options file that contains the ROT private key in PEM format. If ``SAVE_KEYS=1``, this file name will be used to save the key. +- ``SANITIZE_UB``: This option enables the Undefined Behaviour sanitizer. It + can take 3 values: 'off' (default), 'on' and 'trap'. When using 'trap', + gcc and clang will insert calls to ``__builtin_trap`` on detected + undefined behaviour, which defaults to a ``brk`` instruction. When using + 'on', undefined behaviour is translated to a call to special handlers which + prints the exact location of the problem and its cause and then panics. + + .. note:: + Because of the space penalty of the Undefined Behaviour sanitizer, + this option will increase the size of the binary. Depending on the + memory constraints of the target platform, it may not be possible to + enable the sanitizer for all images (BL1 and BL2 are especially + likely to be memory constrained). We recommend that the + sanitizer is enabled only in debug builds. + - ``SAVE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the certificate generation tool to save the keys used to establish the Chain of Trust. Allowed options are '0' or '1'. Default is '0' (do not save). |