Merge pull request #16575 from donaldsharp/doc_address_sanitizer_stuff

doc: Add doc to show sysctl setting for Sanitizers
This commit is contained in:
Mark Stapp 2024-08-13 14:18:40 -04:00 committed by GitHub
commit e03feca82f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 16 additions and 0 deletions

View File

@ -411,6 +411,14 @@ for ``master`` branch:
and create ``frr`` user and ``frrvty`` group as shown above. and create ``frr`` user and ``frrvty`` group as shown above.
Newer versions of Address Sanitizers require a sysctl to be changed
to allow for the tests to be successfully run. This is also true
for Undefined behavior Sanitizers as well as Memory Sanitizer.
.. code:: shell
sysctl vm.mmap_rnd_bits=28
Debugging Topotest Failures Debugging Topotest Failures
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -1325,6 +1325,14 @@ but are no longer actively maintained. MemorySanitizer is not available in GCC.
The different Sanitizers are mostly incompatible with each other. Please The different Sanitizers are mostly incompatible with each other. Please
refer to GCC/LLVM documentation for details. refer to GCC/LLVM documentation for details.
.. note::
The different sanitizers also require setting
sysctl vm.mmap_rnd_bits=28
in order to work properly.
frr-format plugin frr-format plugin
This is a GCC plugin provided with FRR that does extended type checks for This is a GCC plugin provided with FRR that does extended type checks for
``%pFX``-style printfrr extensions. To use this plugin, ``%pFX``-style printfrr extensions. To use this plugin,