aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2015-12-25 23:15:41 -0800
committerGuy Harris <guy@alum.mit.edu>2015-12-25 23:15:41 -0800
commitcb6149759d90f3aabbd34ef0d24b42db8ac52dc8 (patch)
treed379195cb3665cdeeef0d35a1ee580f9cfd3f138
parentf7e9e615b2d2be354b4b3e78689effa9f253f74c (diff)
Explain what valgrindtest does.
-rw-r--r--tests/valgrindtest.c24
1 files changed, 24 insertions, 0 deletions
diff --git a/tests/valgrindtest.c b/tests/valgrindtest.c
index ac493139..011fe117 100644
--- a/tests/valgrindtest.c
+++ b/tests/valgrindtest.c
@@ -19,6 +19,30 @@
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
*/
+/*
+ * This doesn't actually test libpcap itself; it tests whether
+ * valgrind properly handles the APIs libpcap uses. If it doesn't,
+ * we end up getting patches submitted to "fix" references that
+ * valgrind claims are being made to uninitialized data, when, in
+ * fact, the OS isn't making any such references - or we get
+ * valgrind *not* detecting *actual* incorrect references.
+ *
+ * Both BPF and Linux socket filters aren't handled correctly
+ * by some versions of valgrind. See valgrind bug 318203 for
+ * Linux:
+ *
+ * https://bugs.kde.org/show_bug.cgi?id=318203
+ *
+ * and valgrind bug 312989 for OS X:
+ *
+ * https://bugs.kde.org/show_bug.cgi?id=312989
+ *
+ * The fixes for both of those are checked into the official valgrind
+ * repository.
+ *
+ * The unofficial FreeBSD port has similar issues to the official OS X
+ * port, for similar reasons.
+ */
#ifndef lint
static const char copyright[] _U_ =
"@(#) Copyright (c) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 2000\n\