4 require Config; import Config;
5 if ($Config{'extensions'} !~ /\bDevel\/Peek\b/) {
6 print "1..0 # Skip: Devel::Peek was not built\n";
16 open(SAVERR, ">&STDERR") or die "Can't dup STDERR: $!";
18 # If I reference any lexicals in this, I get the entire outer subroutine (or
19 # MAIN) dumped too, which isn't really what I want, as it's a lot of faff to
30 my $repeat_todo = $_[4];
32 if (open(OUT,">peek$$")) {
33 open(STDERR, ">&OUT") or die "Can't dup OUT: $!";
35 print STDERR "*****\n";
36 Dump($_[1]); # second dump to compare with the first to make sure nothing changed.
37 open(STDERR, ">&SAVERR") or die "Can't restore STDERR: $!";
39 if (open(IN, "peek$$")) {
41 $pattern =~ s/\$ADDR/0x[[:xdigit:]]+/g;
42 $pattern =~ s/\$FLOAT/(?:\\d*\\.\\d+(?:e[-+]\\d+)?|\\d+)/g;
43 # handle DEBUG_LEAKING_SCALARS prefix
44 $pattern =~ s/^(\s*)(SV =.* at )/(?:$1ALLOCATED at .*?\n)?$1$2/mg;
46 # Need some clear generic mechanism to eliminate (or add) lines
47 # of dump output dependant on perl version. The (previous) use of
48 # things like $IVNV gave the illusion that the string passed in was
49 # a regexp into which variables were interpolated, but this wasn't
50 # actually true as those 'variables' actually also ate the
51 # whitespace on the line. So it seems better to mark lines that
52 # need to be eliminated. I considered (?# ... ) and (?{ ... }),
53 # but whilst embedded code or comment syntax would keep it as a
54 # legitimate regexp, it still isn't true. Seems easier and clearer
55 # things that look like comments.
57 my $version_condition = qr/\$] [<>]=? 5\.\d\d\d/;
58 # Could do this is in a s///mge but seems clearer like this:
59 $pattern = join '', map {
60 # If we identify the version condition, take *it* out whatever
61 s/\s*# ($version_condition(?: && $version_condition)?)$//
63 : $_ # Didn't match, so this line is in
64 } split /^/, $pattern;
66 $pattern =~ s/\$PADMY/
67 ($] < 5.009) ? 'PADBUSY,PADMY' : 'PADMY';
69 $pattern =~ s/\$PADTMP/
70 ($] < 5.009) ? 'PADBUSY,PADTMP' : 'PADTMP';
73 ($] < 5.011) ? 'RV' : 'IV';
76 print $pattern, "\n" if $DEBUG;
77 my ($dump, $dump2) = split m/\*\*\*\*\*\n/, scalar <IN>;
78 print $dump, "\n" if $DEBUG;
79 like( $dump, qr/\A$pattern\Z/ms, $_[0])
80 or note("line " . (caller)[2]);
82 local $TODO = $repeat_todo;
83 is($dump2, $dump, "$_[0] (unchanged by dump)")
84 or note("line " . (caller)[2]);
90 die "$0: failed to open peek$$: !\n";
93 die "$0: failed to create peek$$: $!\n";
103 1 while unlink("peek$$");
106 do_test('assignment of immediate constant (string)',
108 'SV = PV\\($ADDR\\) at $ADDR
110 FLAGS = \\(POK,pPOK\\)
116 do_test('immediate constant (string)',
118 'SV = PV\\($ADDR\\) at $ADDR
120 FLAGS = \\(.*POK,READONLY,pPOK\\)
125 do_test('assignment of immediate constant (integer)',
127 'SV = IV\\($ADDR\\) at $ADDR
129 FLAGS = \\(IOK,pIOK\\)
132 do_test('immediate constant (integer)',
134 'SV = IV\\($ADDR\\) at $ADDR
136 FLAGS = \\(.*IOK,READONLY,pIOK\\)
139 do_test('assignment of immediate constant (integer)',
141 'SV = IV\\($ADDR\\) at $ADDR
143 FLAGS = \\($PADMY,IOK,pIOK\\)
146 # If perl is built with PERL_PRESERVE_IVUV then maths is done as integers
147 # where possible and this scalar will be an IV. If NO_PERL_PRESERVE_IVUV then
148 # maths is done in floating point always, and this scalar will be an NV.
149 # ([NI]) captures the type, referred to by \1 in this regexp and $type for
150 # building subsequent regexps.
151 my $type = do_test('result of addition',
153 'SV = ([NI])V\\($ADDR\\) at $ADDR
155 FLAGS = \\(PADTMP,\1OK,p\1OK\\)
160 do_test('floating point value',
162 'SV = PVNV\\($ADDR\\) at $ADDR
164 FLAGS = \\(NOK,pNOK\\)
166 NV = 789\\.(?:1(?:000+\d+)?|0999+\d+)
171 do_test('integer constant',
173 'SV = IV\\($ADDR\\) at $ADDR
175 FLAGS = \\(.*IOK,READONLY,pIOK\\)
180 'SV = NULL\\(0x0\\) at $ADDR
184 do_test('reference to scalar',
186 'SV = $RV\\($ADDR\\) at $ADDR
190 SV = PV\\($ADDR\\) at $ADDR
192 FLAGS = \\(POK,pPOK\\)
200 SV = PVNV\\($ADDR\\) at $ADDR
202 FLAGS = \\(IOK,NOK,pIOK,pNOK\\)
208 SV = IV\\($ADDR\\) at $ADDR
210 FLAGS = \\(IOK,pIOK\\)
213 do_test('reference to array',
215 'SV = $RV\\($ADDR\\) at $ADDR
219 SV = PVAV\\($ADDR\\) at $ADDR
230 SV = IV\\($ADDR\\) at $ADDR
232 FLAGS = \\(IOK,pIOK\\)
234 Elt No. 1' . $c_pattern);
236 do_test('reference to hash',
238 'SV = $RV\\($ADDR\\) at $ADDR
242 SV = PVHV\\($ADDR\\) at $ADDR
244 FLAGS = \\(SHAREKEYS\\)
246 NV = $FLOAT # $] < 5.009
247 ARRAY = $ADDR \\(0:7, 1:1\\)
248 hash quality = 100.0%
254 Elt "123" HASH = $ADDR' . $c_pattern,
256 $] > 5.009 && 'The hash iterator used in dump.c sets the OOK flag');
258 do_test('reference to anon sub with empty prototype',
260 'SV = $RV\\($ADDR\\) at $ADDR
264 SV = PVCV\\($ADDR\\) at $ADDR
266 FLAGS = \\($PADMY,POK,pPOK,ANON,WEAKOUTSIDE,CVGV_RC\\)
270 COMP_STASH = $ADDR\\t"main"
271 START = $ADDR ===> \\d+
273 XSUB = 0x0 # $] < 5.009
274 XSUBANY = 0 # $] < 5.009
275 GVGV::GV = $ADDR\\t"main" :: "__ANON__[^"]*"
276 FILE = ".*\\b(?i:peek\\.t)"
280 FLAGS = 0x404 # $] < 5.009
281 FLAGS = 0x490 # $] >= 5.009
284 PADNAME = $ADDR\\($ADDR\\) PAD = $ADDR\\($ADDR\\)
285 OUTSIDE = $ADDR \\(MAIN\\)');
287 do_test('reference to named subroutine without prototype',
289 'SV = $RV\\($ADDR\\) at $ADDR
293 SV = PVCV\\($ADDR\\) at $ADDR
298 COMP_STASH = $ADDR\\t"main"
299 START = $ADDR ===> \\d+
301 XSUB = 0x0 # $] < 5.009
302 XSUBANY = 0 # $] < 5.009
303 GVGV::GV = $ADDR\\t"main" :: "do_test"
304 FILE = ".*\\b(?i:peek\\.t)"
311 PADNAME = $ADDR\\($ADDR\\) PAD = $ADDR\\($ADDR\\)
312 \\d+\\. $ADDR<\\d+> \\(\\d+,\\d+\\) "\\$todo"
313 \\d+\\. $ADDR<\\d+> \\(\\d+,\\d+\\) "\\$repeat_todo"
314 \\d+\\. $ADDR<\\d+> \\(\\d+,\\d+\\) "\\$pattern"
315 \\d+\\. $ADDR<\\d+> \\(\\d+,\\d+\\) "\\$version_condition"
316 \\d+\\. $ADDR<\\d+> FAKE "\\$DEBUG" # $] < 5.009
317 \\d+\\. $ADDR<\\d+> FAKE "\\$DEBUG" flags=0x0 index=0 # $] >= 5.009
318 \\d+\\. $ADDR<\\d+> \\(\\d+,\\d+\\) "\\$dump"
319 \\d+\\. $ADDR<\\d+> \\(\\d+,\\d+\\) "\\$dump2"
320 OUTSIDE = $ADDR \\(MAIN\\)');
323 do_test('reference to regexp',
325 'SV = $RV\\($ADDR\\) at $ADDR
329 SV = REGEXP\\($ADDR\\) at $ADDR
331 FLAGS = \\(OBJECT,POK,FAKE,pPOK\\)
332 PV = $ADDR "\\(\\?\\^:tic\\)"
335 STASH = $ADDR\\t"Regexp"'
338 EXTFLAGS = 0x680000 \(CHECK_ALL,USE_INTUIT_NOML,USE_INTUIT_ML\)
358 do_test('reference to regexp',
360 'SV = $RV\\($ADDR\\) at $ADDR
364 SV = PVMG\\($ADDR\\) at $ADDR
366 FLAGS = \\(OBJECT,SMG\\)
372 MG_TYPE = PERL_MAGIC_qr\(r\)
374 PAT = "\(\?^:tic\)" # $] >= 5.009
375 REFCNT = 2 # $] >= 5.009
376 STASH = $ADDR\\t"Regexp"');
379 do_test('reference to blessed hash',
381 'SV = $RV\\($ADDR\\) at $ADDR
385 SV = PVHV\\($ADDR\\) at $ADDR
387 FLAGS = \\(OBJECT,SHAREKEYS\\)
390 STASH = $ADDR\\t"Tac"
397 $] > 5.009 ? 'The hash iterator used in dump.c sets the OOK flag'
398 : "Something causes the HV's array to become allocated");
402 'SV = PVGV\\($ADDR\\) at $ADDR
404 FLAGS = \\(MULTI(?:,IN_PAD)?\\) # $] >= 5.009
405 FLAGS = \\(GMG,SMG,MULTI(?:,IN_PAD)?\\) # $] < 5.009
409 MAGIC = $ADDR # $] < 5.009
410 MG_VIRTUAL = &PL_vtbl_glob # $] < 5.009
411 MG_TYPE = PERL_MAGIC_glob\(\*\) # $] < 5.009
412 MG_OBJ = $ADDR # $] < 5.009
415 GvSTASH = $ADDR\\t"main"
425 GPFLAGS = 0x0 # $] < 5.009
427 FILE = ".*\\b(?i:peek\\.t)"
431 if (ord('A') == 193) {
432 do_test('string with Unicode',
433 chr(256).chr(0).chr(512),
434 'SV = PV\\($ADDR\\) at $ADDR
436 FLAGS = \\((?:$PADTMP,)?POK,READONLY,pPOK,UTF8\\)
437 PV = $ADDR "\\\214\\\101\\\0\\\235\\\101"\\\0 \[UTF8 "\\\x\{100\}\\\x\{0\}\\\x\{200\}"\]
441 do_test('string with Unicode',
442 chr(256).chr(0).chr(512),
443 'SV = PV\\($ADDR\\) at $ADDR
445 FLAGS = \\((?:$PADTMP,)?POK,READONLY,pPOK,UTF8\\)
446 PV = $ADDR "\\\304\\\200\\\0\\\310\\\200"\\\0 \[UTF8 "\\\x\{100\}\\\x\{0\}\\\x\{200\}"\]
451 if (ord('A') == 193) {
452 do_test('reference to hash containing Unicode',
453 {chr(256)=>chr(512)},
454 'SV = $RV\\($ADDR\\) at $ADDR
458 SV = PVHV\\($ADDR\\) at $ADDR
460 FLAGS = \\(SHAREKEYS,HASKFLAGS\\)
462 NV = $FLOAT # $] < 5.009
463 ARRAY = $ADDR \\(0:7, 1:1\\)
464 hash quality = 100.0%
470 Elt "\\\214\\\101" \[UTF8 "\\\x\{100\}"\] HASH = $ADDR
471 SV = PV\\($ADDR\\) at $ADDR
473 FLAGS = \\(POK,pPOK,UTF8\\)
474 PV = $ADDR "\\\235\\\101"\\\0 \[UTF8 "\\\x\{200\}"\]
477 $] > 5.009 ? 'The hash iterator used in dump.c sets the OOK flag'
478 : 'sv_length has been called on the element, and cached the result in MAGIC');
480 do_test('reference to hash containing Unicode',
481 {chr(256)=>chr(512)},
482 'SV = $RV\\($ADDR\\) at $ADDR
486 SV = PVHV\\($ADDR\\) at $ADDR
488 FLAGS = \\(SHAREKEYS,HASKFLAGS\\)
491 ARRAY = $ADDR \\(0:7, 1:1\\)
492 hash quality = 100.0%
498 Elt "\\\304\\\200" \[UTF8 "\\\x\{100\}"\] HASH = $ADDR
499 SV = PV\\($ADDR\\) at $ADDR
501 FLAGS = \\(POK,pPOK,UTF8\\)
502 PV = $ADDR "\\\310\\\200"\\\0 \[UTF8 "\\\x\{200\}"\]
505 $] > 5.009 ? 'The hash iterator used in dump.c sets the OOK flag'
506 : 'sv_length has been called on the element, and cached the result in MAGIC');
511 do_test('scalar with pos magic',
513 'SV = PVMG\\($ADDR\\) at $ADDR
515 FLAGS = \\($PADMY,SMG,POK,pPOK\\)
522 MG_VIRTUAL = &PL_vtbl_mglob
523 MG_TYPE = PERL_MAGIC_regex_global\\(g\\)
528 # TAINTEDDIR is not set on: OS2, AMIGAOS, WIN32, MSDOS
529 # environment variables may be invisibly case-forced, hence the (?i:PATH)
530 # C<scalar(@ARGV)> is turned into an IV on VMS hence the (?:IV)?
531 # VMS is setting FAKE and READONLY flags. What VMS uses for storing
532 # ENV hashes is also not always null terminated.
534 do_test('tainted value in %ENV',
535 $ENV{PATH}=@ARGV, # scalar(@ARGV) is a handy known tainted value
536 'SV = PVMG\\($ADDR\\) at $ADDR
538 FLAGS = \\(GMG,SMG,RMG,pIOK,pPOK\\)
545 MG_VIRTUAL = &PL_vtbl_envelem
546 MG_TYPE = PERL_MAGIC_envelem\\(e\\)
550 MG_PTR = $ADDR (?:"(?i:PATH)"|=> HEf_SVKEY
551 SV = PV(?:IV)?\\($ADDR\\) at $ADDR
553 FLAGS = \\(TEMP,POK,(?:FAKE,READONLY,)?pPOK\\)
555 )? PV = $ADDR "(?i:PATH)"(?:\\\0)?
559 MG_VIRTUAL = &PL_vtbl_taint
560 MG_TYPE = PERL_MAGIC_taint\\(t\\)');
562 do_test('blessed reference',
563 bless(\\undef, 'Foobar'),
564 'SV = $RV\\($ADDR\\) at $ADDR
568 SV = PVMG\\($ADDR\\) at $ADDR
570 FLAGS = \\(OBJECT,ROK\\)
574 SV = NULL\\(0x0\\) at $ADDR
576 FLAGS = \\(READONLY\\)
580 STASH = $ADDR\s+"Foobar"');
586 do_test('constant subroutine',
588 'SV = $RV\\($ADDR\\) at $ADDR
592 SV = PVCV\\($ADDR\\) at $ADDR
594 FLAGS = \\(POK,pPOK,CONST,ISXSUB\\)
599 ROOT = 0x0 # $] < 5.009
601 XSUBANY = $ADDR \\(CONST SV\\)
602 SV = PV\\($ADDR\\) at $ADDR
604 FLAGS = \\(.*POK,READONLY,pPOK\\)
605 PV = $ADDR "Perl rules"\\\0
608 GVGV::GV = $ADDR\\t"main" :: "const"
609 FILE = ".*\\b(?i:peek\\.t)"
613 FLAGS = 0x200 # $] < 5.009
614 FLAGS = 0xc00 # $] >= 5.009 && $] < 5.013
615 FLAGS = 0xc # $] >= 5.013
618 OUTSIDE = 0x0 \\(null\\)');
620 do_test('isUV should show on PVMG',
621 do { my $v = $1; $v = ~0; $v },
622 'SV = PVMG\\($ADDR\\) at $ADDR
624 FLAGS = \\(IOK,pIOK,IsUV\\)
631 'SV = $RV\\($ADDR\\) at $ADDR
635 SV = PVIO\\($ADDR\\) at $ADDR
640 STASH = $ADDR\s+"IO::File"
651 SUBPROCESS = 0 # $] < 5.009
657 'SV = $RV\\($ADDR\\) at $ADDR
661 SV = PVFM\\($ADDR\\) at $ADDR
668 START = $ADDR ===> \\d+
670 XSUB = 0x0 # $] < 5.009
671 XSUBANY = 0 # $] < 5.009
672 GVGV::GV = $ADDR\\t"main" :: "PIE"
673 FILE = ".*\\b(?i:peek\\.t)"
681 PADNAME = $ADDR\\($ADDR\\) PAD = $ADDR\\($ADDR\\)
682 OUTSIDE = $ADDR \\(MAIN\\)');
684 do_test('blessing to a class with embedded NUL characters',
685 (bless {}, "\0::foo::\n::baz::\t::\0"),
686 'SV = $RV\\($ADDR\\) at $ADDR
690 SV = PVHV\\($ADDR\\) at $ADDR
692 FLAGS = \\(OBJECT,SHAREKEYS\\)
695 STASH = $ADDR\\t"\\\\0::foo::\\\\n::baz::\\\\t::\\\\0"
702 $] > 5.009 ? 'The hash iterator used in dump.c sets the OOK flag'
703 : "Something causes the HV's array to become allocated");
705 do_test('ENAME on a stash',
707 'SV = $RV\\($ADDR\\) at $ADDR
711 SV = PVHV\\($ADDR\\) at $ADDR
713 FLAGS = \\(OOK,SHAREKEYS\\)
715 NV = $FLOAT # $] < 5.009
723 ENAME = "RWOM" # $] > 5.012
728 do_test('ENAMEs on a stash',
730 'SV = $RV\\($ADDR\\) at $ADDR
734 SV = PVHV\\($ADDR\\) at $ADDR
736 FLAGS = \\(OOK,SHAREKEYS\\)
738 NV = $FLOAT # $] < 5.009
746 NAMECOUNT = 2 # $] > 5.012
747 ENAME = "RWOM", "KLANK" # $] > 5.012
752 do_test('ENAMEs on a stash with no NAME',
754 'SV = $RV\\($ADDR\\) at $ADDR
758 SV = PVHV\\($ADDR\\) at $ADDR
760 FLAGS = \\(OOK,SHAREKEYS\\)
762 NV = $FLOAT # $] < 5.009
769 NAMECOUNT = -3 # $] > 5.012
770 ENAME = "RWOM", "KLANK" # $] > 5.012
774 skip "Not built with usemymalloc", 1
775 unless $Config{usemymalloc} eq 'y';
777 ok eval { fill_mstats($x); 1 }, 'fill_mstats on COW scalar'