dolfin team mailing list archive

[Dag Lindbo <dag@xxxxxxxxxx>]

Hello!

I attach a script that runs Valgrind (memcheck) on all C++ demos (based
on the one that just runs all demos). My suggestion is that this be
included in the testing procedure.

At present (on my machine) 17 of 31 demos result in a memory leak (!)
None of the demos produce a memory error.

Note that most, but not all, leaks are due to XML parsing. Are these
really leaks? It is impossible for vg to understand memory pools and
other exotic memory management that are not explicitly freed. Glib does
this in the GTS interface. Maybe libxml2 does something similar. In that
case, I can easily provide a suppression for xml2.

/Dag

"""Run Valgrind on all demos."""

__author__ = "Ilmar Wilbers (ilmarw@xxxxxxxxx)"
__date__ = "2008-04-08 -- 2008-04-09"
__copyright__ = "Copyright (C) 2008 Ilmar Wilbers"
__license__  = "GNU LGPL Version 2.1"

# Modified by Anders Logg 2008
# Modified by Dag Lindbo 2008

import sys, os, re
from commands import getstatusoutput

# Demos to run
cppdemos = []
for dpath, dnames, fnames in os.walk(os.path.join(os.curdir, "..", "..", "demo")):
    if os.path.basename(dpath) == 'cpp':
        if os.path.isfile(os.path.join(dpath, 'SConstruct')):
            cppdemos.append(dpath)
    
# Set non-interactive
os.putenv('DOLFIN_NOPLOT', '1')

# Helpful env vars
os.putenv('G_SLICE','always-malloc')
os.putenv('GLIBCXX_FORCE_NEW','1')
os.putenv('G_DEBUG','gc-friendly')

print "Running Valgrind on all demos (non-interactively)"
print ""
print "Found %d C++ demos" % len(cppdemos)
print ""

# Demos that need command line arguments are treated seperately
cppdemos.remove('./../../demo/quadrature/cpp')
cppdemos.remove('./../../demo/ode/method-weights/cpp')
cppdemos.remove('./../../demo/ode/stiff/cpp')

# Demos that are too time consuming to Valgrind
cppdemos.remove('./../../demo/nls/cahn-hilliard/cpp')

failed = []

vg_comm = 'valgrind --error-exitcode=9 --tool=memcheck --leak-check=full --show-reachable=yes'

# Run C++ demos
for demo in cppdemos:
    print "----------------------------------------------------------------------"
    print "Running Valgrind on C++ demo %s" % demo
    print ""
    if os.path.isfile(os.path.join(demo, 'demo')):
        output = getstatusoutput("cd %s && %s ./demo" % (demo, vg_comm) )
        noleak = re.findall('All heap blocks were freed',output[1])
        success = output[0] != 9 and len(noleak) == 1
        if success:
            print "OK"
        else:
            failed += [(demo, "C++", output[1])]
            if output[0] == 9:
                print "*** FAILED: Memory error"
            elif len(noleak) != 1:
                print "*** FAILED: Memory leak"
    else:
        print "*** Warning: missing demo"

# Print output for failed tests
print ""
if len(failed) > 0:
    print "%d demo(s) failed memcheck, see memcheck.log for details." % len(failed)
    file = open("memcheck.log", "w")
    for (test, interface, output) in failed:
        file.write("----------------------------------------------------------------------\n")
        file.write("%s (%s)\n" % (test, interface))
        file.write("\n")
        file.write(output)
        file.write("\n")
        file.write("\n")
else:
    print "All demos checked for memory leaks and errors: OK"

# Return error code if tests failed
sys.exit(len(failed) != 0)