summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/troubleshooting/index.rst1
-rw-r--r--docs/troubleshooting/mem.rst3
2 files changed, 4 insertions, 0 deletions
diff --git a/docs/troubleshooting/index.rst b/docs/troubleshooting/index.rst
index f652f3f2184..5dee98a8029 100644
--- a/docs/troubleshooting/index.rst
+++ b/docs/troubleshooting/index.rst
@@ -12,3 +12,4 @@ problem with FD.io VPP implementations.
reportingissues/index.rst
cpuusage
sanitizer
+ mem
diff --git a/docs/troubleshooting/mem.rst b/docs/troubleshooting/mem.rst
index 5475051c085..207b2777c50 100644
--- a/docs/troubleshooting/mem.rst
+++ b/docs/troubleshooting/mem.rst
@@ -19,11 +19,13 @@ where memory leaks happen.
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 @@ main-heap.
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.