1 package Test::Valgrind;
8 Test::Valgrind - Test Perl code through valgrind.
16 our $VERSION = '1.01';
20 # From the command-line
21 perl -MTest::Valgrind leaky.pl
23 # From the command-line, snippet style
24 perl -MTest::Valgrind -e 'leaky()'
28 eval 'use Test::Valgrind';
29 plan skip_all => 'Test::Valgrind is required to test your distribution with valgrind' if $@;
32 # In all the test files of a directory
33 prove --exec 'perl -Iblib/lib -Iblib/arch -MTest::Valgrind' t/*.t
37 This module is a front-end to the C<Test::Valgrind::*> API that lets you run Perl code through the C<memcheck> tool of the C<valgrind> memory debugger, to test it for memory errors and leaks.
38 If they aren't available yet, it will first generate suppressions for the current C<perl> interpreter and store them in the portable flavour of F<~/.perl/Test-Valgrind/suppressions/$VERSION>.
39 The actual run will then take place, and tests will be passed or failed according to the result of the analysis.
41 Due to the nature of perl's memory allocator, this module can't track leaks of Perl objects.
42 This includes non-mortalized scalars and memory cycles. However, it can track leaks of chunks of memory allocated in XS extensions with C<Newx> and friends or C<malloc>.
43 As such, it's complementary to the other very good leak detectors listed in the L</SEE ALSO> section.
47 =head2 C<analyse [ %options ]>
49 Run a C<valgrind> analysis configured by C<%options> :
55 C<< command => $command >>
57 The L<Test::Valgrind::Command> object (or class name) to use.
59 Defaults to L<Test::Valgrind::Command::PerlScript>.
65 The L<Test::Valgrind::Tool> object (or class name) to use.
67 Defaults to L<Test::Valgrind::Tool::memcheck>.
71 C<< action => $action >>
73 The L<Test::Valgrind::Action> object (or class name) to use.
75 Defaults to L<Test::Valgrind::Action::Test>.
81 The file name of the script to analyse.
83 Ignored if you supply your own custom C<command>, but mandatory otherwise.
87 C<< callers => $number >>
89 Specify the maximum stack depth studied when valgrind encounters an error.
90 Raising this number improves granularity.
92 Ignored if you supply your own custom C<tool>, otherwise defaults to C<12>.
98 If true, print the output of the test script as diagnostics.
100 Ignored if you supply your own custom C<action>, otherwise defaults to false.
104 C<< extra_supps => \@files >>
106 Also use suppressions from C<@files> besides C<perl>'s.
112 C<< no_def_supp => $bool >>
114 If true, do not use the default suppression file.
127 my $instanceof = sub {
128 require Scalar::Util;
129 Scalar::Util::blessed($_[0]) && $_[0]->isa($_[1]);
132 my $cmd = delete $args{command};
133 unless ($cmd->$instanceof('Test::Valgrind::Command')) {
134 require Test::Valgrind::Command;
135 $cmd = Test::Valgrind::Command->new(
136 command => $cmd || 'PerlScript',
137 file => delete $args{file},
138 args => [ '-MTest::Valgrind=run,1' ],
142 my $tool = delete $args{tool};
143 unless ($tool->$instanceof('Test::Valgrind::Tool')) {
144 require Test::Valgrind::Tool;
145 $tool = Test::Valgrind::Tool->new(
146 tool => $tool || 'memcheck',
147 callers => delete $args{callers},
151 my $action = delete $args{action};
152 unless ($action->$instanceof('Test::Valgrind::Action')) {
153 require Test::Valgrind::Action;
154 $action = Test::Valgrind::Action->new(
155 action => $action || 'Test',
156 diag => delete $args{diag},
160 require Test::Valgrind::Session;
162 Test::Valgrind::Session->new(
163 min_version => $tool->requires_version,
164 map { $_ => delete $args{$_} } qw/extra_supps no_def_supp/
168 $action->abort($sess, $@);
169 return $action->status($sess);
180 require Test::Valgrind::Report;
181 $action->report($sess, Test::Valgrind::Report->new_diag($@));
184 my $status = $sess->status;
185 $status = 255 unless defined $status;
190 =head2 C<import [ %options ]>
192 In the parent process, L</import> calls L</analyse> with the arguments it received itself - except that if no C<file> option was supplied, it tries to pick the highest caller context that looks like a script.
193 When the analyse finishes, it exists with the status that was returned.
195 In the child process, it just C<return>s so that the calling code is actually run under C<valgrind>.
199 # We use as little modules as possible in run mode so that they don't pollute
200 # the analysis. Hence all the requires.
206 $class = ref($class) || $class;
210 Carp::croak('Optional arguments must be passed as key => value pairs');
214 if (defined delete $args{run} or $run) {
215 require Perl::Destruct::Level;
216 Perl::Destruct::Level::set_destruct_level(3);
218 my $oldfh = select STDOUT;
226 my $file = delete $args{file};
227 unless (defined $file) {
228 my ($next, $last_pm);
229 for (my $l = 0; 1; ++$l) {
230 $next = (caller $l)[1];
231 last unless defined $next;
232 next if $next =~ /^\s*\(\s*eval\s*\d*\s*\)\s*$/;
233 if ($next =~ /\.pmc?$/) {
240 $file = $last_pm unless defined $file;
243 unless (defined $file) {
244 require Test::Builder;
245 Test::Builder->new->diag('Couldn\'t find a valid source file');
250 exit $class->analyse(
257 my $tmp = File::Temp->new;
259 require Filter::Util::Call;
260 Filter::Util::Call::filter_add(sub {
261 my $status = Filter::Util::Call::filter_read();
264 } elsif ($status == 0) {
266 my $code = $class->analyse(
267 file => $tmp->filename,
280 When set to true, all dynamic extensions that were loaded during the analysis will be unloaded at C<END> time by L<DynaLoader/dl_unload_file>.
282 Since this obfuscates error stack traces, it's disabled by default.
289 if ($dl_unload and $run and eval { require DynaLoader; 1 }) {
291 DynaLoader::dl_unload_file($_) or push @rest, $_ for @DynaLoader::dl_librefs;
292 @DynaLoader::dl_librefs = @rest;
298 Perl 5.8 is notorious for leaking like there's no tomorrow, so the suppressions are very likely not to be very accurate on it. Anyhow, results will most likely be better if your perl is built with debugging enabled. Using the latest C<valgrind> available will also help.
300 This module is not really secure. It's definitely not taint safe. That shouldn't be a problem for test files.
302 What your tests output to C<STDOUT> and C<STDERR> is eaten unless you pass the C<diag> option, in which case it will be reprinted as diagnostics.
306 Valgrind 3.1.0 (L<http://valgrind.org>).
308 L<XML::Twig>, L<version>, L<File::HomeDir>, L<Env::Sanctify>, L<Perl::Destruct::Level>.
312 All the C<Test::Valgrind::*> API, including L<Test::Valgrind::Command>, L<Test::Valgrind::Tool>, L<Test::Valgrind::Action> and L<Test::Valgrind::Session>.
316 L<Devel::Leak>, L<Devel::LeakTrace>, L<Devel::LeakTrace::Fast>.
320 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
322 You can contact me by mail or on C<irc.perl.org> (vincent).
326 Please report any bugs or feature requests to C<bug-test-valgrind at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>.
327 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
331 You can find documentation for this module with the perldoc command.
333 perldoc Test::Valgrind
335 =head1 ACKNOWLEDGEMENTS
337 Rafaƫl Garcia-Suarez, for writing and instructing me about the existence of L<Perl::Destruct::Level> (Elizabeth Mattijsen is a close second).
339 H.Merijn Brand, for daring to test this thing.
341 All you people that showed interest in this module, which motivated me into completely rewriting it.
343 =head1 COPYRIGHT & LICENSE
345 Copyright 2008-2009 Vincent Pit, all rights reserved.
347 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
351 1; # End of Test::Valgrind