Skip to content

Commit

Permalink
doc: Add doc to show sysctl setting for Sanitizers
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
donaldsharp committed Aug 13, 2024
1 parent cc0fdd3 commit 2de9d71
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/developer/topotests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
8 changes: 8 additions & 0 deletions doc/developer/workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 2de9d71

Please sign in to comment.