| Message ID | 20241216-test-vsock-leaks-v2-3-55e1405742fc@rbox.co (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | vsock/test: Tests for memory leaks | expand |
On Mon, Dec 16, 2024 at 01:00:59PM +0100, Michal Luczaj wrote: >Document the suggested use of kmemleak for memory leak detection. > >Suggested-by: Stefano Garzarella <sgarzare@redhat.com> >Signed-off-by: Michal Luczaj <mhal@rbox.co> >--- > tools/testing/vsock/README | 15 +++++++++++++++ > 1 file changed, 15 insertions(+) Reviewed-by: Stefano Garzarella <sgarzare@redhat.com> > >diff --git a/tools/testing/vsock/README b/tools/testing/vsock/README >index 84ee217ba8eed8d18eebecc4dc81088934f76d8f..680ce666ceb56db986c8ad078573d774e6fecf18 100644 >--- a/tools/testing/vsock/README >+++ b/tools/testing/vsock/README >@@ -36,6 +36,21 @@ Invoke test binaries in both directions as follows: > --control-port=1234 \ > --peer-cid=3 > >+Some tests are designed to produce kernel memory leaks. Leaks detection, >+however, is deferred to Kernel Memory Leak Detector. It is recommended to enable >+kmemleak (CONFIG_DEBUG_KMEMLEAK=y) and explicitly trigger a scan after each test >+suite run, e.g. >+ >+ # echo clear > /sys/kernel/debug/kmemleak >+ # $TEST_BINARY ... >+ # echo "wait for any grace periods" && sleep 2 >+ # echo scan > /sys/kernel/debug/kmemleak >+ # echo "wait for kmemleak" && sleep 5 >+ # echo scan > /sys/kernel/debug/kmemleak >+ # cat /sys/kernel/debug/kmemleak >+ >+For more information see Documentation/dev-tools/kmemleak.rst. >+ > vsock_perf utility > ------------------- > 'vsock_perf' is a simple tool to measure vsock performance. It works in > >-- >2.47.1 >
diff --git a/tools/testing/vsock/README b/tools/testing/vsock/README index 84ee217ba8eed8d18eebecc4dc81088934f76d8f..680ce666ceb56db986c8ad078573d774e6fecf18 100644 --- a/tools/testing/vsock/README +++ b/tools/testing/vsock/README @@ -36,6 +36,21 @@ Invoke test binaries in both directions as follows: --control-port=1234 \ --peer-cid=3 +Some tests are designed to produce kernel memory leaks. Leaks detection, +however, is deferred to Kernel Memory Leak Detector. It is recommended to enable +kmemleak (CONFIG_DEBUG_KMEMLEAK=y) and explicitly trigger a scan after each test +suite run, e.g. + + # echo clear > /sys/kernel/debug/kmemleak + # $TEST_BINARY ... + # echo "wait for any grace periods" && sleep 2 + # echo scan > /sys/kernel/debug/kmemleak + # echo "wait for kmemleak" && sleep 5 + # echo scan > /sys/kernel/debug/kmemleak + # cat /sys/kernel/debug/kmemleak + +For more information see Documentation/dev-tools/kmemleak.rst. + vsock_perf utility ------------------- 'vsock_perf' is a simple tool to measure vsock performance. It works in
Document the suggested use of kmemleak for memory leak detection. Suggested-by: Stefano Garzarella <sgarzare@redhat.com> Signed-off-by: Michal Luczaj <mhal@rbox.co> --- tools/testing/vsock/README | 15 +++++++++++++++ 1 file changed, 15 insertions(+)