Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
vsock/test: Add README blurb about kmemleak usage
Document the suggested use of kmemleak for memory leak detection.
Suggested-by: Stefano Garzarella <sgarzare@redhat.com>
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
Signed-off-by: Michal Luczaj <mhal@rbox.co>
Link: https://patch.msgid.link/20241219-test-vsock-leaks-v4-3-a416e554d9d7@rbox.co
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
authored by
Michal Luczaj
and committed by
Jakub Kicinski
50f94344
ef8bd18f
+15
+15
tools/testing/vsock/README
+15
tools/testing/vsock/README
···
36
36
--control-port=1234 \
37
37
--peer-cid=3
38
38
39
+
Some tests are designed to produce kernel memory leaks. Leaks detection,
40
+
however, is deferred to Kernel Memory Leak Detector. It is recommended to enable
41
+
kmemleak (CONFIG_DEBUG_KMEMLEAK=y) and explicitly trigger a scan after each test
42
+
suite run, e.g.
43
+
44
+
# echo clear > /sys/kernel/debug/kmemleak
45
+
# $TEST_BINARY ...
46
+
# echo "wait for any grace periods" && sleep 2
47
+
# echo scan > /sys/kernel/debug/kmemleak
48
+
# echo "wait for kmemleak" && sleep 5
49
+
# echo scan > /sys/kernel/debug/kmemleak
50
+
# cat /sys/kernel/debug/kmemleak
51
+
52
+
For more information see Documentation/dev-tools/kmemleak.rst.
53
+
39
54
vsock_perf utility
40
55
-------------------
41
56
'vsock_perf' is a simple tool to measure vsock performance. It works in