Skip to content

Commit

Permalink
doc: Document the usage of --enable-undefined-sanitizer
Browse files Browse the repository at this point in the history
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
  • Loading branch information
donaldsharp committed Jun 19, 2024
1 parent 64112ed commit 248bf31
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions doc/developer/workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 248bf31

Please sign in to comment.