2 Test::Valgrind - Test Perl code through valgrind.
9 eval 'use Test::Valgrind';
10 plan skip_all => 'Test::Valgrind is required to test your distribution with valgrind' if $@;
12 # Code to inspect for memory leaks/errors.
15 This module lets you run some code through the valgrind memory debugger,
16 to test it for memory errors and leaks. Just add "use Test::Valgrind" at
17 the beginning of the code you want to test. Behind the hood,
18 "Test::Valgrind::import" forks so that the child can basically "exec
19 'valgrind', $^X, $0" (except that of course $0 isn't right there). The
20 parent then parses the report output by valgrind and pass or fail tests
23 You can also use it from the command-line to test a given script :
25 perl -MTest::Valgrind leaky.pl
27 Due to the nature of perl's memory allocator, this module can't track
28 leaks of Perl objects. This includes non-mortalized scalars and memory
29 cycles. However, it can track leaks of chunks of memory allocated in XS
30 extensions with "Newx" and friends or "malloc". As such, it's
31 complementary to the other very good leak detectors listed in the "SEE
35 You can pass parameters to "import" as a list of key / value pairs,
36 where valid keys are :
40 Also use suppressions from $file besides perl's.
44 If true, do not use any suppressions.
46 * "callers => $number"
48 Specify the maximum stack depth studied when valgrind encounters an
49 error. Raising this number improves granularity. Default is 12.
51 * "extra => [ @args ]"
53 Add @args to valgrind parameters.
57 If true, print the raw output of valgrind as diagnostics (may be
62 If true, do not actually output the plan and the tests results.
64 * "cb => sub { my ($val, $name) = @_; ...; return $passed }"
66 Specifies a subroutine to execute for each test instead of
67 "Test::More::is". It receives the number of bytes leaked in $_[0]
68 and the test name in $_[1], and is expected to return true if the
69 test passed and false otherwise. Defaults to
73 (defined $_[0] and $_[0] == 0) : 1 : 0
77 You can't use this module to test code given by the "-e" command-line
80 Perl 5.8 is notorious for leaking like there's no tomorrow, so the
81 suppressions are very likely not to be very accurate on it. Anyhow,
82 results will most likely be better if your perl is built with debugging
83 enabled. Using the latest valgrind available will also help.
85 This module is not really secure. It's definitely not taint safe. That
86 shouldn't be a problem for test files.
88 What your tests output to STDOUT is eaten unless you pass the "diag"
89 option, in which case it will be reprinted as diagnostics. STDERR is
93 Valgrind 3.1.0 (<http://valgrind.org>).
95 Carp, Fcntl, POSIX (core modules since perl 5) and Test::Builder (since
98 Perl::Destruct::Level.
101 Devel::Leak, Devel::LeakTrace, Devel::LeakTrace::Fast.
104 Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
106 You can contact me by mail or on #perl @ FreeNode (vincent or
110 Please report any bugs or feature requests to "bug-test-valgrind at
111 rt.cpan.org", or through the web interface at
112 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>. I will
113 be notified, and then you'll automatically be notified of progress on
114 your bug as I make changes.
117 You can find documentation for this module with the perldoc command.
119 perldoc Test::Valgrind
122 Rafaƫl Garcia-Suarez, for writing and instructing me about the
123 existence of Perl::Destruct::Level (Elizabeth Mattijsen is a close
126 H.Merijn Brand, for daring to test this thing.
129 Copyright 2008 Vincent Pit, all rights reserved.
131 This program is free software; you can redistribute it and/or modify it
132 under the same terms as Perl itself.