summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenoît Ganne <bganne@cisco.com>2020-05-11 15:53:54 +0200
committerDave Wallace <dwallacelf@gmail.com>2020-05-20 16:01:56 +0000
commitd6572034438a984a9d8cb2f74124d526041b93f3 (patch)
tree392547684a62f064d231418c0694565806b6a008
parent00b060a778a72c9e436b537a08ca6cb41094a3e2 (diff)
docs: asan: update doc to match current status
Type: docs Change-Id: I45265876c9c778f6b91d39f30eb6035f14d166ec Signed-off-by: Benoît Ganne <bganne@cisco.com> (cherry picked from commit ca86c95a3413214110a03b001d45d018385b92dc)
-rw-r--r--docs/troubleshooting/sanitizer.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/troubleshooting/sanitizer.rst b/docs/troubleshooting/sanitizer.rst
index a63720ffe42..cbe72bcc9f5 100644
--- a/docs/troubleshooting/sanitizer.rst
+++ b/docs/troubleshooting/sanitizer.rst
@@ -6,7 +6,7 @@ Google Sanitizers
VPP is instrumented to support `Google Sanitizers <https://github.com/google/sanitizers>`_.
As of today, only `AddressSanitizer <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_
-is supported and only for the heap.
+is supported, only for GCC and only for the heap.
AddressSanitizer
================
@@ -20,19 +20,19 @@ build option, so all VPP targets should be supported. For example:
.. code-block:: console
# build a debug image with ASan support:
- $ make rebuild VPP_EXTRA_CMAKE_ARGS=-DENABLE_SANITIZE_ADDR=ON
+ $ make rebuild VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON CC=gcc-8
....
# build a release image with ASan support:
- $ make rebuild-release VPP_EXTRA_CMAKE_ARGS=-DENABLE_SANITIZE_ADDR=ON
+ $ make rebuild-release VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON CC=gcc-8
....
# build packages in debug mode with ASan support:
- $ make pkg-deb-debug VPP_EXTRA_CMAKE_ARGS=-DENABLE_SANITIZE_ADDR=ON
+ $ make pkg-deb-debug VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON CC=gcc-8
....
# run GBP plugin tests in debug mode with ASan
- $ make test-debug TEST=test_gbp VPP_EXTRA_CMAKE_ARGS=-DENABLE_SANITIZE_ADDR=ON
+ $ make test-debug TEST=test_gbp VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON CC=gcc-8
....
Once VPP has been built with ASan support you can use it as usual including