[src/trunk]: src/tests/net tests: explain how rump_server_check_memleaks works

[ozaki-r <ozaki-r%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/ad272ce1887e
branches:  trunk
changeset: 964996:ad272ce1887e
user:      ozaki-r <ozaki-r%NetBSD.org@localhost>
date:      Mon Aug 26 04:50:32 2019 +0000

description:
tests: explain how rump_server_check_memleaks works

diffstat:

 tests/net/net_common.sh |  10 ++++++++--
 1 files changed, 8 insertions(+), 2 deletions(-)

diffs (24 lines):

diff -r effbda1941f4 -r ad272ce1887e tests/net/net_common.sh
--- a/tests/net/net_common.sh   Mon Aug 26 04:50:03 2019 +0000
+++ b/tests/net/net_common.sh   Mon Aug 26 04:50:32 2019 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: net_common.sh,v 1.36 2019/08/26 04:50:03 ozaki-r Exp $
+#      $NetBSD: net_common.sh,v 1.37 2019/08/26 04:50:32 ozaki-r Exp $
 #
 # Copyright (c) 2016 Internet Initiative Japan Inc.
 # All rights reserved.
@@ -351,7 +351,13 @@
        atf_check_equal '$target$reqs' '$target$rels'
 }
 
-
+#
+# rump_server_check_memleaks detects memory leaks.  It can detect leaks of pool
+# objects that are guaranteed to be all deallocated at this point, i.e., all
+# created interfaces are destroyed.  Currently only llentpl satisfies this
+# constraint.  This mechanism can't be applied to objects allocated through
+# pool_cache(9) because it doesn't track released objects explicitly.
+#
 rump_server_check_memleaks()
 {