summaryrefslogtreecommitdiff
path: root/doc/developer
diff options
context:
space:
mode:
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/topotests.rst8
-rw-r--r--doc/developer/workflow.rst8
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,