Merge pull request #16243 from donaldsharp/ubsan_documentation

doc: Document the usage of --enable-undefined-sanitizer
FRRouting · Jun 20, 2024 · 550a3a8 · 550a3a8
2 parents 994792b + 248bf31
commit 550a3a8
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst
@@ -1306,6 +1306,16 @@ MemorySanitizer
 
    to ``configure``.
 
+UndefinedSanitizer
+   Similar to AddressSanitizer, this tool provides runtime instrumentation for
+   detecting use of undefined behavior in C.  Testing your own code with this
+   tool before submission is encouraged.  You can enable it by passing::
+
+      --enable-undefined-sanitizer
+
+    to ``configure``.  If you run FRR with this you will probably also have
+    to set ``sudo sysctl vm.mmap_rnd_bits=28``
+
 All of the above tools are available in the Clang/LLVM toolchain since 3.4.
 AddressSanitizer and ThreadSanitizer are available in recent versions of GCC,
 but are no longer actively maintained. MemorySanitizer is not available in GCC.