diff options
| author | Mark Stapp <mjs.ietf@gmail.com> | 2024-08-13 14:18:40 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-08-13 14:18:40 -0400 |
| commit | e03feca82fb9f1cc024fb47732066e9dae7db2fc (patch) | |
| tree | fcf086164af88549ed98a64ad901f58270f29887 | |
| parent | 90a50fd4af7e430a20db864b72e689bc8d9ca4f1 (diff) | |
| parent | 2de9d71a5cc93f04ed2abacd44d22ea6ccda4cfc (diff) | |
Merge pull request #16575 from donaldsharp/doc_address_sanitizer_stuff
doc: Add doc to show sysctl setting for Sanitizers
| -rw-r--r-- | doc/developer/topotests.rst | 8 | ||||
| -rw-r--r-- | doc/developer/workflow.rst | 8 |
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index 66946f6c37..52c0361a02 100644 --- a/doc/developer/topotests.rst +++ b/doc/developer/topotests.rst @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 166c96da33..a6bdec1e5b 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -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, |