docs: fix memory troubleshooting doc
Type: docs
Change-Id: Id9f8f6f13e4a41567adf7dc68e6c9be42dd82de7
Signed-off-by: Benoît Ganne <bganne@cisco.com>
diff --git a/docs/troubleshooting/index.rst b/docs/troubleshooting/index.rst
index f652f3f..5dee98a 100644
--- a/docs/troubleshooting/index.rst
+++ b/docs/troubleshooting/index.rst
@@ -12,3 +12,4 @@
reportingissues/index.rst
cpuusage
sanitizer
+ mem
diff --git a/docs/troubleshooting/mem.rst b/docs/troubleshooting/mem.rst
index 5475051..207b277 100644
--- a/docs/troubleshooting/mem.rst
+++ b/docs/troubleshooting/mem.rst
@@ -19,11 +19,13 @@
To enable memory traces on main-heap:
.. code-block:: console
+
$ vppctl memory-trace on main-heap
To dump memory traces for analysis:
.. code-block:: console
+
$ vppctl show memory-trace on main-heap
Thread 0 vpp_main
base 0x7fffb6422000, size 1g, locked, unmap-on-destroy, name 'main heap'
@@ -79,6 +81,7 @@
To use it, you need to use the `LD_PRELOAD` mechanism, eg.
.. code-block:: console
+
~# LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libvppmem_preload.so /usr/bin/vpp -c /etc/vpp/startup.conf
You can then use tools such as memory traces as usual.