Exported functions¶

"leaked_info { BLOCK }"

Executes BLOCK and returns a list of leaked SVs and places where the SVs come from, i.e. "[$ref, $file, $line]".

"leaked_refs { BLOCK }"

Executes BLOCK and returns a list of leaked SVs.

"leaked_count { BLOCK }"

Executes BLOCK and returns the number of leaked SVs.

"leaktrace { BLOCK } ?($mode | \&callback)"

Executes BLOCK and reports leaked SVs to *STDERR.

Defined $modes are:

-simple

Default. Reports the leaked SV identity (type and address), file name and line number.

-sv_dump

In addition to -simple, dumps the sv content using sv_dump(), which also implements Devel::Peek::Dump().

-lines

In addition to -simple, prints suspicious source lines.

-verbose

Both -sv_dump and -lines.

"no_leaks_ok { BLOCK } ?$description"

Tests that BLOCK does not leaks SVs. This is a test function using "Test::Builder".

Note that BLOCK is called more than once. This is because BLOCK might prepare caches which are not memory leaks.

"leaks_cmp_ok { BLOCK } $cmp_op, $number, ?$description"

Tests that BLOCK leaks a specific number of SVs. This is a test function using "Test::Builder".

Note that BLOCK is called more than once. This is because BLOCK might prepare caches which are not memory leaks.

count_sv()

Counts all the SVs in the arena.

Script interface¶

Like "Devel::LeakTrace" "Test::LeakTrace::Script" is provided for whole scripts.

The arguments of "use Test::LeakTrace::Script" directive is the same as leaktrace().

    $ TEST_LEAKTRACE=-sv_dump perl -MTest::LeakTrace::Script script.pl
    $ perl -MTest::LeakTrace::Script=-verbose script.pl
    #!perl
    # ...
    use Test::LeakTrace::Script sub{
        my($ref, $file, $line) = @_;
        # ...
    };
    # ...

Testing modules¶

Here is a test script template that checks memory leaks.

    #!perl -w
    use strict;
    use constant HAS_LEAKTRACE => eval{ require Test::LeakTrace };
    use Test::More HAS_LEAKTRACE ? (tests => 1) : (skip_all => 'require Test::LeakTrace');
    use Test::LeakTrace;
    use Some::Module;
    leaks_cmp_ok{
        my $o = Some::Module->new();
        $o->something();
        $o->something_else();
    } '<', 1;