Do memory checks

Slightly improve memory cleanup in Pl_DCT Make it easier to test with valgrind

Do memory checks
Slightly improve memory cleanup in Pl_DCT Make it easier to test with valgrind
Jay Berkenbilt
1 parent 85ef2cb6
Showing 5 changed files with 68 additions and 30 deletions
README.maintainer
libqpdf/Pl_DCT.cc
make/exec-z
make/libtool.mk
make/valgrind-wrap
@@ -21,34 +21,19 @@ Release Reminders
       LDFLAGS="-fsanitize=address" \
       --enable-werror --disable-shared
  
- * Consider running tests with latest gcc and/or valgrind.  To do
-   this, replace, build with debugging and without shared libraries.
-   In build, create z and move each executable into z.  Then create a
-   script called exec-z that contains:
-
-   #!/bin/sh
-   exec valgrind --suppressions=/tmp/a.supp -q \
-      `dirname $0`/z/`basename $0` ${1+"$@"}
-
-   Symlink exec-z to each executable.  /tmp/a.supp can be populated
-   with suppressions for libraries, for example:
-
-   {
-      zlib1
-      Memcheck:Cond
-      fun:inflateReset2
-      fun:inflateInit2_
-   }
-   {
-      index
-      Memcheck:Cond
-      fun:index
-      fun:expand_dynamic_string_token
-      fun:_dl_map_object
-      fun:map_doit
-   }
-
-   You can generate these by running valgrind with --gen-suppressions=yes.
+   As of gcc 6.3.0, this exposes some good things but appears to also
+   have some false positive leak reports. Valgrind is more reliable
+   but also may miss some things that this catches.
+
+ * Consider running tests with latest gcc and/or valgrind. To test
+   with valgrind:
+
+   ./configure --disable-shared
+   make -j8 -k VALGRIND=1
+   make -k check NO_REBUILD=1
+
+   This moves each binary into a subdirectory and replaces it with a
+   link to make/exec-z. See make/exec-z.
  
  * Check all open issues in the sourceforge trackers and on github.
  
@@ -107,6 +107,25 @@ Pl_DCT::finish()
     }
 }
  
+class Freer
+{
+  public:
+    Freer(unsigned char** p) :
+        p(p)
+    {
+    }
+    ~Freer()
+    {
+        if (*p)
+        {
+            free(*p);
+        }
+    }
+
+  private:
+    unsigned char** p;
+};
+
 void
 Pl_DCT::compress(void* cinfo_p, PointerHolder<Buffer> b)
 {
@@ -124,6 +143,7 @@ Pl_DCT::compress(void* cinfo_p, PointerHolder&lt;Buffer&gt; b)
 #       pragma GCC diagnostic pop
 #endif
     unsigned char* outbuffer = 0;
+    Freer freer(&outbuffer);
     unsigned long outsize = 0;
     jpeg_mem_dest(cinfo, &outbuffer, &outsize);
  
@@ -160,8 +180,6 @@ Pl_DCT::compress(void* cinfo_p, PointerHolder&lt;Buffer&gt; b)
     jpeg_finish_compress(cinfo);
     this->getNext()->write(outbuffer, outsize);
     this->getNext()->finish();
-
-    free(outbuffer);
 }
  
 void
+#!/bin/sh
+# This script is used for valgrind testing. See README.maintainer.
+
+# Create a suppressions file. This can be updated by running valgrind
+# with --gen-suppressions=yes.
+test -f /tmp/a.supp || cat > /tmp/a.supp <<EOF
+{
+   zlib1
+   Memcheck:Cond
+   fun:inflateReset2
+   fun:inflateInit2_
+}
+{
+   index
+   Memcheck:Cond
+   fun:index
+   fun:expand_dynamic_string_token
+   fun:_dl_map_object
+   fun:map_doit
+}
+EOF
+
+exec valgrind --suppressions=/tmp/a.supp -q \
+   `dirname $0`/z/`basename $0` ${1+"$@"}
@@ -102,6 +102,7 @@ endef
 # Usage: $(call makebin,objs,binary,ldflags,libs)
 define makebin
 	$(LIBTOOL) --mode=link $(CXX) $(CXXFLAGS) $(1) -o $(2) $(4) $(3)
+	if [ "$(VALGRIND)" = 1 ]; then make/valgrind-wrap $(2); fi
 endef
  
 # Install target
+#!/bin/sh
+set -e
+pwd
+dir=$(dirname $1)
+if [ ! -x $dir/exec-z ]; then
+    ln -f make/exec-z $dir/exec-z
+fi
+mkdir -p $dir/z
+mv $1 $dir/z
+ln -f $dir/exec-z $1