proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-05-25 10:08:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Add doc to show sysctl setting for Sanitizers

Browse Source 
In order to run the XXXX Sanitizers over the code as a developer
modern linux distro's require a specific sysctl.  Let's document
that so that people are aware of it.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
This commit is contained in:
Donald Sharp 2024-08-13 08:58:29 -04:00
parent cc0fdd3b1d
commit 2de9d71a5c
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/developer/topotests.rst
View File

@ -411,6 +411,14 @@ for ``master`` branch:
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^

8
doc/developer/workflow.rst
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
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
This is a GCC plugin provided with FRR that does extended type checks for
``%pFX``-style printfrr extensions. To use this plugin,