Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add doc to show sysctl setting for Sanitizers #16575

Merged
merged 1 commit into from
Aug 13, 2024
Merged

doc: Add doc to show sysctl setting for Sanitizers #16575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/developer/topotests.rst
View file
Open in desktop
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
View file
Open in desktop
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
Loading