This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
475baedcfa7a9538c48837494bf7ba91e399d87a
[perl5.git] / t / op / svleak.t
1 #!./perl
2
3 # A place to put some simple leak tests. Uses XS::APItest to make
4 # PL_sv_count available, allowing us to run a bit of code multiple times and
5 # see if the count increases.
6
7 BEGIN {
8     chdir 't';
9     @INC = '../lib';
10     require './test.pl';
11
12     eval { require XS::APItest; XS::APItest->import('sv_count'); 1 }
13         or skip_all("XS::APItest not available");
14 }
15
16 use Config;
17
18 plan tests => 107;
19
20 # run some code N times. If the number of SVs at the end of loop N is
21 # greater than (N-1)*delta at the end of loop 1, we've got a leak
22 #
23 sub leak {
24     my ($n, $delta, $code, @rest) = @_;
25     my $sv0 = 0;
26     my $sv1 = 0;
27     for my $i (1..$n) {
28         &$code();
29         $sv1 = sv_count();
30         $sv0 = $sv1 if $i == 1;
31     }
32     cmp_ok($sv1-$sv0, '<=', ($n-1)*$delta, @rest);
33 }
34
35 # Like leak, but run a string eval instead.
36 # The code is used instead of the test name
37 # if the name is absent.
38 sub eleak {
39     my ($n,$delta,$code,@rest) = @_;
40     leak $n, $delta, sub { eval $code },
41          @rest ? @rest : $code
42 }
43
44 # run some expression N times. The expr is concatenated N times and then
45 # evaled, ensuring that that there are no scope exits between executions.
46 # If the number of SVs at the end of expr N is greater than (N-1)*delta at
47 # the end of expr 1, we've got a leak
48 #
49 sub leak_expr {
50     my ($n, $delta, $expr, @rest) = @_;
51     my $sv0 = 0;
52     my $sv1 = 0;
53     my $true = 1; # avoid stuff being optimised away
54     my $code1 = "($expr || \$true)";
55     my $code = "$code1 && (\$sv0 = sv_count())" . ("&& $code1" x 4)
56                 . " && (\$sv1 = sv_count())";
57     if (eval $code) {
58         cmp_ok($sv1-$sv0, '<=', ($n-1)*$delta, @rest);
59     }
60     else {
61         fail("eval @rest: $@");
62     }
63 }
64
65
66 my @a;
67
68 leak(5, 0, sub {},                 "basic check 1 of leak test infrastructure");
69 leak(5, 0, sub {push @a,1;pop @a}, "basic check 2 of leak test infrastructure");
70 leak(5, 1, sub {push @a,1;},       "basic check 3 of leak test infrastructure");
71
72 # Fatal warnings
73 my $f = "use warnings FATAL =>";
74 my $all = "$f 'all';";
75 eleak(2, 0, "$f 'deprecated'; qq|\\c\{|", 'qq|\c{| with fatal warnings');
76 eleak(2, 0, "$f 'syntax'; qq|\\c`|", 'qq|\c`| with fatal warnings');
77 eleak(2, 0, "$all /\$\\ /", '/$\ / with fatal warnings');
78 eleak(2, 0, "$all s//\\1/", 's//\1/ with fatal warnings');
79 eleak(2, 0, "$all qq|\\i|", 'qq|\i| with fatal warnings');
80 eleak(2, 0, "$f 'digit'; qq|\\o{9}|", 'qq|\o{9}| with fatal warnings');
81 eleak(2, 0, "$f 'misc'; sub foo{} sub foo:lvalue",
82      'ignored :lvalue with fatal warnings');
83 eleak(2, 0, "no warnings; use feature ':all'; $f 'misc';
84              my sub foo{} sub foo:lvalue",
85      'ignored mysub :lvalue with fatal warnings');
86 eleak(2, 0, "no warnings; use feature ':all'; $all
87              my sub foo{} sub foo:lvalue{}",
88      'fatal mysub redef warning');
89 eleak(2, 0, "$all sub foo{} sub foo{}", 'fatal sub redef warning');
90 eleak(2, 0, "$all *x=sub {}",
91      'fatal sub redef warning with sub-to-glob assignment');
92 eleak(2, 0, "$all *x=sub() {1}",
93      'fatal const sub redef warning with sub-to-glob assignment');
94 eleak(2, 0, "$all XS::APItest::newCONSTSUB(\\%main::=>name=>0=>1)",
95      'newCONSTSUB sub redefinition with fatal warnings');
96 eleak(2, 0, "$f 'misc'; my\$a,my\$a", 'double my with fatal warnings');
97 eleak(2, 0, "$f 'misc'; our\$a,our\$a", 'double our with fatal warnings');
98 eleak(2, 0, "$f 'closure';
99              sub foo { my \$x; format=\n\@\n\$x\n.\n} write; ",
100      'format closing over unavailable var with fatal warnings');
101 eleak(2, 0, "$all /(?{})?/ ", '(?{})? with fatal warnings');
102 eleak(2, 0, "$all /(?{})+/ ", '(?{})+ with fatal warnings');
103 eleak(2, 0, "$all /[\\i]/ ", 'invalid charclass escape with fatal warns');
104 eleak(2, 0, "$all /[:foo:]/ ", '/[:foo:]/ with fatal warnings');
105 eleak(2, 0, "$all /[a-\\d]/ ", '[a-\d] char class with fatal warnings');
106 $::TODO = 'still leaks';
107 eleak(2, 0, "$all v111111111111111111111111111111111111111111111111",
108      'vstring num overflow with fatal warnings');
109 undef $::TODO;
110
111 eleak(2, 0, 'sub{<*>}');
112
113 eleak(2, 0, 'goto sub {}', 'goto &sub in eval');
114 eleak(2, 0, '() = sort { goto sub {} } 1,2', 'goto &sub in sort');
115 eleak(2, 0, '/(?{ goto sub {} })/', 'goto &sub in regexp');
116
117 sub TIEARRAY    { bless [], $_[0] }
118 sub FETCH       { $_[0]->[$_[1]] }
119 sub STORE       { $_[0]->[$_[1]] = $_[2] }
120
121 # local $tied_elem[..] leaks <20020502143736.N16831@dansat.data-plan.com>"
122 {
123     tie my @a, 'main';
124     leak(5, 0, sub {local $a[0]}, "local \$tied[0]");
125 }
126
127 # [perl #74484]  repeated tries leaked SVs on the tmps stack
128
129 leak_expr(5, 0, q{"YYYYYa" =~ /.+?(a(.+?)|b)/ }, "trie leak");
130
131 # [perl #48004] map/grep didn't free tmps till the end
132
133 {
134     # qr/1/ just creates tmps that are hopefully freed per iteration
135
136     my $s;
137     my @a;
138     my @count = (0) x 4; # pre-allocate
139
140     grep qr/1/ && ($count[$_] = sv_count()) && 99,  0..3;
141     is(@count[3] - @count[0], 0, "void   grep expr:  no new tmps per iter");
142     grep { qr/1/ && ($count[$_] = sv_count()) && 99 }  0..3;
143     is(@count[3] - @count[0], 0, "void   grep block: no new tmps per iter");
144
145     $s = grep qr/1/ && ($count[$_] = sv_count()) && 99,  0..3;
146     is(@count[3] - @count[0], 0, "scalar grep expr:  no new tmps per iter");
147     $s = grep { qr/1/ && ($count[$_] = sv_count()) && 99 }  0..3;
148     is(@count[3] - @count[0], 0, "scalar grep block: no new tmps per iter");
149
150     @a = grep qr/1/ && ($count[$_] = sv_count()) && 99,  0..3;
151     is(@count[3] - @count[0], 0, "list   grep expr:  no new tmps per iter");
152     @a = grep { qr/1/ && ($count[$_] = sv_count()) && 99 }  0..3;
153     is(@count[3] - @count[0], 0, "list   grep block: no new tmps per iter");
154
155
156     map qr/1/ && ($count[$_] = sv_count()) && 99,  0..3;
157     is(@count[3] - @count[0], 0, "void   map expr:  no new tmps per iter");
158     map { qr/1/ && ($count[$_] = sv_count()) && 99 }  0..3;
159     is(@count[3] - @count[0], 0, "void   map block: no new tmps per iter");
160
161     $s = map qr/1/ && ($count[$_] = sv_count()) && 99,  0..3;
162     is(@count[3] - @count[0], 0, "scalar map expr:  no new tmps per iter");
163     $s = map { qr/1/ && ($count[$_] = sv_count()) && 99 }  0..3;
164     is(@count[3] - @count[0], 0, "scalar map block: no new tmps per iter");
165
166     @a = map qr/1/ && ($count[$_] = sv_count()) && 99,  0..3;
167     is(@count[3] - @count[0], 3, "list   map expr:  one new tmp per iter");
168     @a = map { qr/1/ && ($count[$_] = sv_count()) && 99 }  0..3;
169     is(@count[3] - @count[0], 3, "list   map block: one new tmp per iter");
170
171 }
172
173 SKIP:
174 { # broken by 304474c3, fixed by cefd5c7c, but didn't seem to cause
175   # any other test failures
176   # base test case from ribasushi (Peter Rabbitson)
177   eval { require Scalar::Util; Scalar::Util->import("weaken"); 1; }
178     or skip "no weaken", 1;
179   my $weak;
180   {
181     $weak = my $in = {};
182     weaken($weak);
183     my $out = { in => $in, in => undef }
184   }
185   ok(!$weak, "hash referenced weakened SV released");
186 }
187
188 # prototype() errors
189 leak(2,0, sub { eval { prototype "CORE::fu" } }, 'prototype errors');
190
191 # RT #72246: rcatline memory leak on bad $/
192
193 leak(2, 0,
194     sub {
195         my $f;
196         open CATLINE, '<', \$f;
197         local $/ = "\x{262E}";
198         my $str = "\x{2622}";
199         eval { $str .= <CATLINE> };
200     },
201     "rcatline leak"
202 );
203
204 {
205     my $RE = qr/
206       (?:
207         <(?<tag>
208           \s*
209           [^>\s]+
210         )>
211       )??
212     /xis;
213
214     "<html><body></body></html>" =~ m/$RE/gcs;
215
216     leak(5, 0, sub {
217         my $tag = $+{tag};
218     }, "named regexp captures");
219 }
220
221 eleak(2,0,'/[:]/');
222 eleak(2,0,'/[\xdf]/i');
223 eleak(2,0,'s![^/]!!');
224 eleak(2,0,'/[pp]/');
225 eleak(2,0,'/[[:ascii:]]/');
226 eleak(2,0,'/[[.zog.]]/');
227 eleak(2,0,'/[.zog.]/');
228 eleak(2,0,'chr(0x100) =~ /[[:punct:]]/');
229 eleak(2,0,'chr(0x100) =~ /[[:^punct:]]/');
230 eleak(2,0,'chr(0x100) =~ /\P{Assigned}/');
231 leak(2,0,sub { /(??{})/ }, '/(??{})/');
232
233 leak(2,0,sub { !$^V }, '[perl #109762] version object in boolean context');
234
235
236 # [perl #114356] run-time rexexp with unchanging pattern got
237 # inflated refcounts
238 eleak(2, 0, q{ my $x = "x"; "abc" =~ /$x/ for 1..5 }, '#114356');
239
240 eleak(2, 0, 'sub', '"sub" with nothing following');
241 eleak(2, 0, '+sub:a{}', 'anon subs with invalid attributes');
242 eleak(2, 0, 'no warnings; sub a{1 1}', 'sub with syntax error');
243 eleak(2, 0, 'no warnings; sub {1 1}', 'anon sub with syntax error');
244 eleak(2, 0, 'no warnings; use feature ":all"; my sub a{1 1}',
245      'my sub with syntax error');
246
247 # Reification (or lack thereof)
248 leak(2, 0, sub { sub { local $_[0]; shift }->(1) },
249     'local $_[0] on surreal @_, followed by shift');
250 leak(2, 0, sub { sub { local $_[0]; \@_ }->(1) },
251     'local $_[0] on surreal @_, followed by reification');
252
253 # Syntax errors
254 eleak(2, 0, '"${<<END}"
255                  ', 'unterminated here-doc in quotes in multiline eval');
256 eleak(2, 0, '"${<<END
257                }"', 'unterminated here-doc in multiline quotes in eval');
258 leak(2, 0, sub { eval { do './op/svleak.pl' } },
259         'unterminated here-doc in file');
260 eleak(2, 0, 'tr/9-0//');
261 eleak(2, 0, 'tr/a-z-0//');
262 eleak(2, 0, 'no warnings; nonexistent_function 33838',
263         'bareword followed by number');
264 eleak(2, 0, '//dd;'x20, '"too many errors" when parsing m// flags');
265 eleak(2, 0, 's///dd;'x20, '"too many errors" when parsing s/// flags');
266 eleak(2, 0, 'no warnings; 2 2;BEGIN{}',
267       'BEGIN block after syntax error');
268 {
269     local %INC; # in case Errno is already loaded
270     eleak(2, 0, 'no warnings; 2@!{',
271                 'implicit "use Errno" after syntax error');
272 }
273 eleak(2, 0, "\"\$\0\356\"", 'qq containing $ <null> something');
274 eleak(2, 0, 'END OF TERMS AND CONDITIONS', 'END followed by words');
275 eleak(2, 0, "qq|\\c|;"x10,     '"too many errors" from qq"\c"');
276 $::TODO = 'still leaks';
277 eleak(2, 0, "qq|\\N{%}|"x10,   '"too many errors" from qq"\N{%}"');
278 undef $::TODO;
279 eleak(2, 0, "qq|\\o|;"x10,     '"too many errors" from qq"\o"');
280 eleak(2, 0, "qq|\\x{|;"x10,    '"too many errors" from qq"\x{"');
281 eleak(2, 0, "qq|\\N|;"x10,     '"too many errors" from qq"\N"');
282 eleak(2, 0, "qq|\\N{|;"x10,    '"too many errors" from qq"\N{"');
283 eleak(2, 0, "qq|\\N{U+GETG}|;"x10,'"too many errors" from qq"\N{U+JUNK}"');
284 $::TODO = 'still leaks';
285 eleak(2, 0, "qq|\\N{au}|;"x10, '"too many errors" from qq"\N{invalid}"');
286 undef $::TODO;
287
288
289 # [perl #114764] Attributes leak scalars
290 leak(2, 0, sub { eval 'my $x : shared' }, 'my $x :shared used to leak');
291
292 eleak(2, 0, 'ref: 1', 'labels');
293
294 # Tied hash iteration was leaking if the hash was freed before itera-
295 # tion was over.
296 package t {
297     sub TIEHASH { bless [] }
298     sub FIRSTKEY { 0 }
299 }
300 leak(2, 0, sub {
301     my $h = {};
302     tie %$h, t;
303     each %$h;
304     undef $h;
305 }, 'tied hash iteration does not leak');
306
307 package explosive_scalar {
308     sub TIESCALAR { my $self = shift; bless [undef, {@_}], $self  }
309     sub FETCH     { die 'FETCH' if $_[0][1]{FETCH}; $_[0][0] }
310     sub STORE     { die 'STORE' if $_[0][1]{STORE}; $_[0][0] = $_[1] }
311 }
312 tie my $die_on_fetch, 'explosive_scalar', FETCH => 1;
313
314 # List assignment was leaking when assigning explosive scalars to
315 # aggregates.
316 leak(2, 0, sub {
317     eval {%a = ($die_on_fetch, 0)}; # key
318     eval {%a = (0, $die_on_fetch)}; # value
319     eval {%a = ($die_on_fetch, $die_on_fetch)}; # both
320 }, 'hash assignment does not leak');
321 leak(2, 0, sub {
322     eval {@a = ($die_on_fetch)};
323     eval {($die_on_fetch, $b) = ($b, $die_on_fetch)};
324     # restore
325     tie $die_on_fetch, 'explosive_scalar', FETCH => 1;
326 }, 'array assignment does not leak');
327
328 # [perl #107000]
329 package hhtie {
330     sub TIEHASH { bless [] }
331     sub STORE    { $_[0][0]{$_[1]} = $_[2] }
332     sub FETCH    { die if $explosive; $_[0][0]{$_[1]} }
333     sub FIRSTKEY { keys %{$_[0][0]}; each %{$_[0][0]} }
334     sub NEXTKEY  { each %{$_[0][0]} }
335 }
336 leak(2, 0, sub {
337     eval q`
338         BEGIN {
339             $hhtie::explosive = 0;
340             tie %^H, hhtie;
341             $^H{foo} = bar;
342             $hhtie::explosive = 1;
343         }
344         { 1; }
345     `;
346 }, 'hint-hash copying does not leak');
347
348 package explosive_array {
349     sub TIEARRAY  { bless [[], {}], $_[0]  }
350     sub FETCH     { die if $_[0]->[1]{FETCH}; $_[0]->[0][$_[1]]  }
351     sub FETCHSIZE { die if $_[0]->[1]{FETCHSIZE}; scalar @{ $_[0]->[0]  }  }
352     sub STORE     { die if $_[0]->[1]{STORE}; $_[0]->[0][$_[1]] = $_[2]  }
353     sub CLEAR     { die if $_[0]->[1]{CLEAR}; @{$_[0]->[0]} = ()  }
354     sub EXTEND    { die if $_[0]->[1]{EXTEND}; return  }
355     sub explode   { my $self = shift; $self->[1] = {@_} }
356 }
357
358 leak(2, 0, sub {
359     tie my @a, 'explosive_array';
360     tied(@a)->explode( STORE => 1 );
361     my $x = 0;
362     eval { @a = ($x)  };
363 }, 'explosive array assignment does not leak');
364
365 leak(2, 0, sub {
366     my ($a, $b);
367     eval { warn $die_on_fetch };
368 }, 'explosive warn argument');
369
370 leak(2, 0, sub {
371     my $foo = sub { return $die_on_fetch };
372     my $res = eval { $foo->() };
373     my @res = eval { $foo->() };
374 }, 'function returning explosive does not leak');
375
376 leak(2, 0, sub {
377     my $res = eval { {$die_on_fetch, 0} };
378     $res = eval { {0, $die_on_fetch} };
379 }, 'building anon hash with explosives does not leak');
380
381 leak(2, 0, sub {
382     my $res = eval { [$die_on_fetch] };
383 }, 'building anon array with explosives does not leak');
384
385 leak(2, 0, sub {
386     my @a;
387     eval { push @a, $die_on_fetch };
388 }, 'pushing exploding scalar does not leak');
389
390 leak(2, 0, sub {
391     eval { push @-, '' };
392 }, 'pushing onto read-only array does not leak');
393
394
395 # Run-time regexp code blocks
396 {
397     use re 'eval';
398     my @tests = ('[(?{})]','(?{})');
399     for my $t (@tests) {
400         leak(2, 0, sub {
401             / $t/;
402         }, "/ \$x/ where \$x is $t does not leak");
403         leak(2, 0, sub {
404             /(?{})$t/;
405         }, "/(?{})\$x/ where \$x is $t does not leak");
406     }
407 }
408
409
410 {
411     use warnings FATAL => 'all';
412     leak(2, 0, sub {
413         no warnings 'once';
414         eval { printf uNopened 42 };
415     }, 'printfing to bad handle under fatal warnings does not leak');
416     open my $fh, ">", \my $buf;
417     leak(2, 0, sub {
418         eval { printf $fh chr 2455 };
419     }, 'wide fatal warning does not make printf leak');
420     close $fh or die $!;
421 }
422
423
424 leak(2,0,sub{eval{require untohunothu}}, 'requiring nonexistent module');