This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
improve hash related documentation in perlfunc and perlsec to reflect new hash random...
[perl5.git] / dump.c
CommitLineData
a0d0e21e 1/* dump.c
a687059c 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
a687059c 5 *
6e21c824
LW
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8d063cd8 8 *
a0d0e21e
LW
9 */
10
11/*
4ac71550
TC
12 * 'You have talked long in your sleep, Frodo,' said Gandalf gently, 'and
13 * it has not been hard for me to read your mind and memory.'
14 *
15 * [p.220 of _The Lord of the Rings_, II/i: "Many Meetings"]
8d063cd8
LW
16 */
17
166f8a29 18/* This file contains utility routines to dump the contents of SV and OP
61296642 19 * structures, as used by command-line options like -Dt and -Dx, and
166f8a29
DM
20 * by Devel::Peek.
21 *
22 * It also holds the debugging version of the runops function.
23 */
24
8d063cd8 25#include "EXTERN.h"
864dbfa3 26#define PERL_IN_DUMP_C
8d063cd8 27#include "perl.h"
f722798b 28#include "regcomp.h"
0bd48802 29
8d063cd8 30
5357ca29
NC
31static const char* const svtypenames[SVt_LAST] = {
32 "NULL",
1cb9cd50 33 "BIND",
5357ca29 34 "IV",
b53eecb4 35 "NV",
5357ca29
NC
36 "PV",
37 "PVIV",
38 "PVNV",
39 "PVMG",
5c35adbb 40 "REGEXP",
5357ca29
NC
41 "PVGV",
42 "PVLV",
43 "PVAV",
44 "PVHV",
45 "PVCV",
46 "PVFM",
47 "PVIO"
48};
49
50
51static const char* const svshorttypenames[SVt_LAST] = {
52 "UNDEF",
1cb9cd50 53 "BIND",
5357ca29 54 "IV",
b53eecb4 55 "NV",
5357ca29
NC
56 "PV",
57 "PVIV",
58 "PVNV",
59 "PVMG",
5c35adbb 60 "REGEXP",
5357ca29
NC
61 "GV",
62 "PVLV",
63 "AV",
64 "HV",
65 "CV",
66 "FM",
67 "IO"
68};
69
a0c2f4dd
NC
70struct flag_to_name {
71 U32 flag;
72 const char *name;
73};
74
75static void
76S_append_flags(pTHX_ SV *sv, U32 flags, const struct flag_to_name *start,
77 const struct flag_to_name *const end)
78{
79 do {
80 if (flags & start->flag)
81 sv_catpv(sv, start->name);
82 } while (++start < end);
83}
84
85#define append_flags(sv, f, flags) \
cd431fde 86 S_append_flags(aTHX_ (sv), (f), (flags), C_ARRAY_END(flags))
a0c2f4dd 87
17605be7
DM
88
89
3967c732 90void
864dbfa3 91Perl_dump_indent(pTHX_ I32 level, PerlIO *file, const char* pat, ...)
3967c732 92{
3967c732 93 va_list args;
7918f24d 94 PERL_ARGS_ASSERT_DUMP_INDENT;
3967c732 95 va_start(args, pat);
c5be433b 96 dump_vindent(level, file, pat, &args);
3967c732
JD
97 va_end(args);
98}
8adcabd8
LW
99
100void
c5be433b
GS
101Perl_dump_vindent(pTHX_ I32 level, PerlIO *file, const char* pat, va_list *args)
102{
97aff369 103 dVAR;
7918f24d 104 PERL_ARGS_ASSERT_DUMP_VINDENT;
c8db6e60 105 PerlIO_printf(file, "%*s", (int)(level*PL_dumpindent), "");
c5be433b
GS
106 PerlIO_vprintf(file, pat, *args);
107}
108
109void
864dbfa3 110Perl_dump_all(pTHX)
79072805 111{
712a6fe4 112 dump_all_perl(FALSE);
f0e3f042
CS
113}
114
115void
116Perl_dump_all_perl(pTHX_ bool justperl)
117{
118
97aff369 119 dVAR;
760ac839 120 PerlIO_setlinebuf(Perl_debug_log);
3280af22 121 if (PL_main_root)
3967c732 122 op_dump(PL_main_root);
f0e3f042 123 dump_packsubs_perl(PL_defstash, justperl);
463ee0b2
LW
124}
125
126void
e1ec3a88 127Perl_dump_packsubs(pTHX_ const HV *stash)
463ee0b2 128{
28eb953d 129 PERL_ARGS_ASSERT_DUMP_PACKSUBS;
f0e3f042
CS
130 dump_packsubs_perl(stash, FALSE);
131}
132
133void
134Perl_dump_packsubs_perl(pTHX_ const HV *stash, bool justperl)
135{
97aff369 136 dVAR;
a0d0e21e 137 I32 i;
463ee0b2 138
28eb953d 139 PERL_ARGS_ASSERT_DUMP_PACKSUBS_PERL;
7918f24d 140
8990e307
LW
141 if (!HvARRAY(stash))
142 return;
a0d0e21e 143 for (i = 0; i <= (I32) HvMAX(stash); i++) {
e1ec3a88 144 const HE *entry;
4db58590 145 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
159b6efe 146 const GV * const gv = (const GV *)HeVAL(entry);
e29cdcb3
GS
147 if (SvTYPE(gv) != SVt_PVGV || !GvGP(gv))
148 continue;
8ebc5c01 149 if (GvCVu(gv))
f0e3f042 150 dump_sub_perl(gv, justperl);
85e6fe83
LW
151 if (GvFORM(gv))
152 dump_form(gv);
61f9802b
AL
153 if (HeKEY(entry)[HeKLEN(entry)-1] == ':') {
154 const HV * const hv = GvHV(gv);
155 if (hv && (hv != PL_defstash))
f0e3f042 156 dump_packsubs_perl(hv, justperl); /* nested package */
61f9802b 157 }
463ee0b2 158 }
79072805
LW
159 }
160}
161
162void
e1ec3a88 163Perl_dump_sub(pTHX_ const GV *gv)
a687059c 164{
28eb953d 165 PERL_ARGS_ASSERT_DUMP_SUB;
f0e3f042
CS
166 dump_sub_perl(gv, FALSE);
167}
168
169void
170Perl_dump_sub_perl(pTHX_ const GV *gv, bool justperl)
171{
172 SV * sv;
85e6fe83 173
28eb953d 174 PERL_ARGS_ASSERT_DUMP_SUB_PERL;
7918f24d 175
f0e3f042
CS
176 if (justperl && (CvISXSUB(GvCV(gv)) || !CvROOT(GvCV(gv))))
177 return;
178
179 sv = sv_newmortal();
bd61b366 180 gv_fullname3(sv, gv, NULL);
b15aece3 181 Perl_dump_indent(aTHX_ 0, Perl_debug_log, "\nSUB %s = ", SvPVX_const(sv));
aed2304a 182 if (CvISXSUB(GvCV(gv)))
91f3b821
GS
183 Perl_dump_indent(aTHX_ 0, Perl_debug_log, "(xsub 0x%"UVxf" %d)\n",
184 PTR2UV(CvXSUB(GvCV(gv))),
894356b3 185 (int)CvXSUBANY(GvCV(gv)).any_i32);
85e6fe83 186 else if (CvROOT(GvCV(gv)))
3967c732 187 op_dump(CvROOT(GvCV(gv)));
85e6fe83 188 else
cea2e8a9 189 Perl_dump_indent(aTHX_ 0, Perl_debug_log, "<undef>\n");
85e6fe83
LW
190}
191
192void
e1ec3a88 193Perl_dump_form(pTHX_ const GV *gv)
85e6fe83 194{
b464bac0 195 SV * const sv = sv_newmortal();
85e6fe83 196
7918f24d
NC
197 PERL_ARGS_ASSERT_DUMP_FORM;
198
bd61b366 199 gv_fullname3(sv, gv, NULL);
b15aece3 200 Perl_dump_indent(aTHX_ 0, Perl_debug_log, "\nFORMAT %s = ", SvPVX_const(sv));
85e6fe83 201 if (CvROOT(GvFORM(gv)))
3967c732 202 op_dump(CvROOT(GvFORM(gv)));
85e6fe83 203 else
cea2e8a9 204 Perl_dump_indent(aTHX_ 0, Perl_debug_log, "<undef>\n");
a687059c
LW
205}
206
8adcabd8 207void
864dbfa3 208Perl_dump_eval(pTHX)
8d063cd8 209{
97aff369 210 dVAR;
3967c732
JD
211 op_dump(PL_eval_root);
212}
213
3df15adc
YO
214
215/*
87cea99e 216=for apidoc pv_escape
3df15adc
YO
217
218Escapes at most the first "count" chars of pv and puts the results into
ab3bbdeb 219dsv such that the size of the escaped string will not exceed "max" chars
3df15adc
YO
220and will not contain any incomplete escape sequences.
221
ab3bbdeb
YO
222If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
223will also be escaped.
3df15adc
YO
224
225Normally the SV will be cleared before the escaped string is prepared,
ab3bbdeb
YO
226but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
227
38a44b82 228If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
ab3bbdeb 229if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
38a44b82 230using C<is_utf8_string()> to determine if it is Unicode.
ab3bbdeb
YO
231
232If PERL_PV_ESCAPE_ALL is set then all input chars will be output
681f01c2
KW
233using C<\x01F1> style escapes, otherwise if PERL_PV_ESCAPE_NONASCII is set, only
234chars above 127 will be escaped using this style; otherwise, only chars above
235255 will be so escaped; other non printable chars will use octal or
236common escaped patterns like C<\n>. Otherwise, if PERL_PV_ESCAPE_NOBACKSLASH
237then all chars below 255 will be treated as printable and
ab3bbdeb
YO
238will be output as literals.
239
240If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
c8536afa
KW
241string will be escaped, regardless of max. If the output is to be in hex,
242then it will be returned as a plain hex
243sequence. Thus the output will either be a single char,
244an octal escape sequence, a special escape like C<\n> or a hex value.
3df15adc 245
44a2ac75
YO
246If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
247not a '\\'. This is because regexes very often contain backslashed
248sequences, whereas '%' is not a particularly common character in patterns.
249
ab3bbdeb 250Returns a pointer to the escaped text as held by dsv.
3df15adc
YO
251
252=cut
253*/
ab3bbdeb 254#define PV_ESCAPE_OCTBUFSIZE 32
ddc5bc0f 255
3967c732 256char *
ddc5bc0f 257Perl_pv_escape( pTHX_ SV *dsv, char const * const str,
ab3bbdeb
YO
258 const STRLEN count, const STRLEN max,
259 STRLEN * const escaped, const U32 flags )
260{
61f9802b
AL
261 const char esc = (flags & PERL_PV_ESCAPE_RE) ? '%' : '\\';
262 const char dq = (flags & PERL_PV_ESCAPE_QUOTE) ? '"' : esc;
44a2ac75 263 char octbuf[PV_ESCAPE_OCTBUFSIZE] = "%123456789ABCDF";
ab3bbdeb
YO
264 STRLEN wrote = 0; /* chars written so far */
265 STRLEN chsize = 0; /* size of data to be written */
266 STRLEN readsize = 1; /* size of data just read */
38a44b82 267 bool isuni= flags & PERL_PV_ESCAPE_UNI ? 1 : 0; /* is this Unicode */
ddc5bc0f 268 const char *pv = str;
61f9802b 269 const char * const end = pv + count; /* end of string */
44a2ac75 270 octbuf[0] = esc;
ab3bbdeb 271
7918f24d
NC
272 PERL_ARGS_ASSERT_PV_ESCAPE;
273
9ed8b5e5 274 if (!(flags & PERL_PV_ESCAPE_NOCLEAR)) {
7fddd944 275 /* This won't alter the UTF-8 flag */
76f68e9b 276 sv_setpvs(dsv, "");
7fddd944 277 }
ab3bbdeb 278
ddc5bc0f 279 if ((flags & PERL_PV_ESCAPE_UNI_DETECT) && is_utf8_string((U8*)pv, count))
ab3bbdeb
YO
280 isuni = 1;
281
282 for ( ; (pv < end && (!max || (wrote < max))) ; pv += readsize ) {
4b88fb76 283 const UV u= (isuni) ? utf8_to_uvchr_buf((U8*)pv, (U8*) end, &readsize) : (U8)*pv;
ab3bbdeb
YO
284 const U8 c = (U8)u & 0xFF;
285
681f01c2
KW
286 if ( ( u > 255 )
287 || (flags & PERL_PV_ESCAPE_ALL)
288 || (( u > 127 ) && (flags & PERL_PV_ESCAPE_NONASCII)))
289 {
ab3bbdeb
YO
290 if (flags & PERL_PV_ESCAPE_FIRSTCHAR)
291 chsize = my_snprintf( octbuf, PV_ESCAPE_OCTBUFSIZE,
292 "%"UVxf, u);
293 else
294 chsize = my_snprintf( octbuf, PV_ESCAPE_OCTBUFSIZE,
44a2ac75 295 "%cx{%"UVxf"}", esc, u);
ab3bbdeb
YO
296 } else if (flags & PERL_PV_ESCAPE_NOBACKSLASH) {
297 chsize = 1;
298 } else {
44a2ac75
YO
299 if ( (c == dq) || (c == esc) || !isPRINT(c) ) {
300 chsize = 2;
ab3bbdeb 301 switch (c) {
44a2ac75
YO
302
303 case '\\' : /* fallthrough */
304 case '%' : if ( c == esc ) {
305 octbuf[1] = esc;
306 } else {
307 chsize = 1;
308 }
309 break;
3df15adc
YO
310 case '\v' : octbuf[1] = 'v'; break;
311 case '\t' : octbuf[1] = 't'; break;
312 case '\r' : octbuf[1] = 'r'; break;
313 case '\n' : octbuf[1] = 'n'; break;
314 case '\f' : octbuf[1] = 'f'; break;
44a2ac75 315 case '"' :
ab3bbdeb 316 if ( dq == '"' )
3df15adc 317 octbuf[1] = '"';
ab3bbdeb
YO
318 else
319 chsize = 1;
44a2ac75 320 break;
3df15adc 321 default:
bbae360a 322 if ( (pv+readsize < end) && isDIGIT((U8)*(pv+readsize)) )
ab3bbdeb 323 chsize = my_snprintf( octbuf, PV_ESCAPE_OCTBUFSIZE,
44a2ac75
YO
324 "%c%03o", esc, c);
325 else
ab3bbdeb 326 chsize = my_snprintf( octbuf, PV_ESCAPE_OCTBUFSIZE,
44a2ac75 327 "%c%o", esc, c);
ab3bbdeb
YO
328 }
329 } else {
44a2ac75 330 chsize = 1;
ab3bbdeb 331 }
44a2ac75
YO
332 }
333 if ( max && (wrote + chsize > max) ) {
334 break;
ab3bbdeb 335 } else if (chsize > 1) {
44a2ac75
YO
336 sv_catpvn(dsv, octbuf, chsize);
337 wrote += chsize;
3df15adc 338 } else {
7fddd944
NC
339 /* If PERL_PV_ESCAPE_NOBACKSLASH is set then bytes in the range
340 128-255 can be appended raw to the dsv. If dsv happens to be
341 UTF-8 then we need catpvf to upgrade them for us.
342 Or add a new API call sv_catpvc(). Think about that name, and
343 how to keep it clear that it's unlike the s of catpvs, which is
344 really an array octets, not a string. */
345 Perl_sv_catpvf( aTHX_ dsv, "%c", c);
3df15adc
YO
346 wrote++;
347 }
ab3bbdeb
YO
348 if ( flags & PERL_PV_ESCAPE_FIRSTCHAR )
349 break;
3967c732 350 }
ab3bbdeb
YO
351 if (escaped != NULL)
352 *escaped= pv - str;
353 return SvPVX(dsv);
354}
355/*
87cea99e 356=for apidoc pv_pretty
ab3bbdeb
YO
357
358Converts a string into something presentable, handling escaping via
95b611b0 359pv_escape() and supporting quoting and ellipses.
ab3bbdeb
YO
360
361If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
362double quoted with any double quotes in the string escaped. Otherwise
363if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
364angle brackets.
6cba11c8 365
95b611b0
RGS
366If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
367string were output then an ellipsis C<...> will be appended to the
ab3bbdeb 368string. Note that this happens AFTER it has been quoted.
6cba11c8 369
ab3bbdeb
YO
370If start_color is non-null then it will be inserted after the opening
371quote (if there is one) but before the escaped text. If end_color
372is non-null then it will be inserted after the escaped text but before
95b611b0 373any quotes or ellipses.
ab3bbdeb
YO
374
375Returns a pointer to the prettified text as held by dsv.
6cba11c8 376
ab3bbdeb
YO
377=cut
378*/
379
380char *
ddc5bc0f
YO
381Perl_pv_pretty( pTHX_ SV *dsv, char const * const str, const STRLEN count,
382 const STRLEN max, char const * const start_color, char const * const end_color,
ab3bbdeb
YO
383 const U32 flags )
384{
61f9802b 385 const U8 dq = (flags & PERL_PV_PRETTY_QUOTE) ? '"' : '%';
ab3bbdeb 386 STRLEN escaped;
7918f24d
NC
387
388 PERL_ARGS_ASSERT_PV_PRETTY;
389
881a015e
NC
390 if (!(flags & PERL_PV_PRETTY_NOCLEAR)) {
391 /* This won't alter the UTF-8 flag */
76f68e9b 392 sv_setpvs(dsv, "");
881a015e
NC
393 }
394
ab3bbdeb 395 if ( dq == '"' )
76f68e9b 396 sv_catpvs(dsv, "\"");
ab3bbdeb 397 else if ( flags & PERL_PV_PRETTY_LTGT )
76f68e9b 398 sv_catpvs(dsv, "<");
ab3bbdeb
YO
399
400 if ( start_color != NULL )
76f68e9b 401 sv_catpv(dsv, start_color);
ab3bbdeb
YO
402
403 pv_escape( dsv, str, count, max, &escaped, flags | PERL_PV_ESCAPE_NOCLEAR );
404
405 if ( end_color != NULL )
76f68e9b 406 sv_catpv(dsv, end_color);
ab3bbdeb
YO
407
408 if ( dq == '"' )
76f68e9b 409 sv_catpvs( dsv, "\"");
ab3bbdeb 410 else if ( flags & PERL_PV_PRETTY_LTGT )
76f68e9b 411 sv_catpvs(dsv, ">");
ab3bbdeb 412
95b611b0 413 if ( (flags & PERL_PV_PRETTY_ELLIPSES) && ( escaped < count ) )
76f68e9b 414 sv_catpvs(dsv, "...");
ab3bbdeb 415
3df15adc
YO
416 return SvPVX(dsv);
417}
418
419/*
420=for apidoc pv_display
421
3df15adc 422Similar to
3967c732 423
3df15adc
YO
424 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
425
426except that an additional "\0" will be appended to the string when
427len > cur and pv[cur] is "\0".
428
429Note that the final string may be up to 7 chars longer than pvlim.
430
431=cut
432*/
433
434char *
435Perl_pv_display(pTHX_ SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
436{
7918f24d
NC
437 PERL_ARGS_ASSERT_PV_DISPLAY;
438
ddc5bc0f 439 pv_pretty( dsv, pv, cur, pvlim, NULL, NULL, PERL_PV_PRETTY_DUMP);
3df15adc 440 if (len > cur && pv[cur] == '\0')
76f68e9b 441 sv_catpvs( dsv, "\\0");
e6abe6d8
JH
442 return SvPVX(dsv);
443}
444
445char *
864dbfa3 446Perl_sv_peek(pTHX_ SV *sv)
3967c732 447{
27da23d5 448 dVAR;
aec46f14 449 SV * const t = sv_newmortal();
3967c732 450 int unref = 0;
5357ca29 451 U32 type;
3967c732 452
76f68e9b 453 sv_setpvs(t, "");
3967c732
JD
454 retry:
455 if (!sv) {
456 sv_catpv(t, "VOID");
457 goto finish;
458 }
8ee91b45
YO
459 else if (sv == (const SV *)0x55555555 || ((char)SvTYPE(sv)) == 'U') {
460 /* detect data corruption under memory poisoning */
3967c732
JD
461 sv_catpv(t, "WILD");
462 goto finish;
463 }
7996736c 464 else if (sv == &PL_sv_undef || sv == &PL_sv_no || sv == &PL_sv_yes || sv == &PL_sv_placeholder) {
3967c732
JD
465 if (sv == &PL_sv_undef) {
466 sv_catpv(t, "SV_UNDEF");
467 if (!(SvFLAGS(sv) & (SVf_OK|SVf_OOK|SVs_OBJECT|
468 SVs_GMG|SVs_SMG|SVs_RMG)) &&
469 SvREADONLY(sv))
470 goto finish;
471 }
472 else if (sv == &PL_sv_no) {
473 sv_catpv(t, "SV_NO");
474 if (!(SvFLAGS(sv) & (SVf_ROK|SVf_OOK|SVs_OBJECT|
475 SVs_GMG|SVs_SMG|SVs_RMG)) &&
476 !(~SvFLAGS(sv) & (SVf_POK|SVf_NOK|SVf_READONLY|
477 SVp_POK|SVp_NOK)) &&
478 SvCUR(sv) == 0 &&
479 SvNVX(sv) == 0.0)
480 goto finish;
481 }
7996736c 482 else if (sv == &PL_sv_yes) {
3967c732
JD
483 sv_catpv(t, "SV_YES");
484 if (!(SvFLAGS(sv) & (SVf_ROK|SVf_OOK|SVs_OBJECT|
485 SVs_GMG|SVs_SMG|SVs_RMG)) &&
486 !(~SvFLAGS(sv) & (SVf_POK|SVf_NOK|SVf_READONLY|
487 SVp_POK|SVp_NOK)) &&
488 SvCUR(sv) == 1 &&
b15aece3 489 SvPVX_const(sv) && *SvPVX_const(sv) == '1' &&
3967c732
JD
490 SvNVX(sv) == 1.0)
491 goto finish;
7996736c
MHM
492 }
493 else {
494 sv_catpv(t, "SV_PLACEHOLDER");
495 if (!(SvFLAGS(sv) & (SVf_OK|SVf_OOK|SVs_OBJECT|
496 SVs_GMG|SVs_SMG|SVs_RMG)) &&
497 SvREADONLY(sv))
498 goto finish;
3967c732
JD
499 }
500 sv_catpv(t, ":");
501 }
502 else if (SvREFCNT(sv) == 0) {
503 sv_catpv(t, "(");
504 unref++;
505 }
a3b4c9c6
DM
506 else if (DEBUG_R_TEST_) {
507 int is_tmp = 0;
508 I32 ix;
509 /* is this SV on the tmps stack? */
510 for (ix=PL_tmps_ix; ix>=0; ix--) {
511 if (PL_tmps_stack[ix] == sv) {
512 is_tmp = 1;
513 break;
514 }
515 }
516 if (SvREFCNT(sv) > 1)
517 Perl_sv_catpvf(aTHX_ t, "<%"UVuf"%s>", (UV)SvREFCNT(sv),
518 is_tmp ? "T" : "");
519 else if (is_tmp)
520 sv_catpv(t, "<T>");
04932ac8
DM
521 }
522
3967c732
JD
523 if (SvROK(sv)) {
524 sv_catpv(t, "\\");
525 if (SvCUR(t) + unref > 10) {
b162af07 526 SvCUR_set(t, unref + 3);
3967c732
JD
527 *SvEND(t) = '\0';
528 sv_catpv(t, "...");
529 goto finish;
530 }
ad64d0ec 531 sv = SvRV(sv);
3967c732
JD
532 goto retry;
533 }
5357ca29
NC
534 type = SvTYPE(sv);
535 if (type == SVt_PVCV) {
17605be7 536 Perl_sv_catpvf(aTHX_ t, "CV(%s)", CvGV(sv) ? GvNAME(CvGV(sv)) : "");
3967c732 537 goto finish;
5357ca29
NC
538 } else if (type < SVt_LAST) {
539 sv_catpv(t, svshorttypenames[type]);
3967c732 540
5357ca29
NC
541 if (type == SVt_NULL)
542 goto finish;
543 } else {
544 sv_catpv(t, "FREED");
3967c732 545 goto finish;
3967c732
JD
546 }
547
548 if (SvPOKp(sv)) {
b15aece3 549 if (!SvPVX_const(sv))
3967c732
JD
550 sv_catpv(t, "(null)");
551 else {
17605be7 552 SV * const tmp = newSVpvs("");
3967c732 553 sv_catpv(t, "(");
5115136b
DM
554 if (SvOOK(sv)) {
555 STRLEN delta;
556 SvOOK_offset(sv, delta);
557 Perl_sv_catpvf(aTHX_ t, "[%s]", pv_display(tmp, SvPVX_const(sv)-delta, delta, 0, 127));
558 }
b15aece3 559 Perl_sv_catpvf(aTHX_ t, "%s)", pv_display(tmp, SvPVX_const(sv), SvCUR(sv), SvLEN(sv), 127));
32639b87 560 if (SvUTF8(sv))
b2ff9928 561 Perl_sv_catpvf(aTHX_ t, " [UTF8 \"%s\"]",
e9569a7a 562 sv_uni_display(tmp, sv, 6 * SvCUR(sv),
c728cb41 563 UNI_DISPLAY_QQ));
17605be7 564 SvREFCNT_dec_NN(tmp);
3967c732
JD
565 }
566 }
567 else if (SvNOKp(sv)) {
e54dc35b 568 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 569 Perl_sv_catpvf(aTHX_ t, "(%"NVgf")",SvNVX(sv));
e54dc35b 570 RESTORE_NUMERIC_LOCAL();
3967c732 571 }
57def98f 572 else if (SvIOKp(sv)) {
cf2093f6 573 if (SvIsUV(sv))
57def98f 574 Perl_sv_catpvf(aTHX_ t, "(%"UVuf")", (UV)SvUVX(sv));
cf2093f6 575 else
57def98f 576 Perl_sv_catpvf(aTHX_ t, "(%"IVdf")", (IV)SvIVX(sv));
25da4f38 577 }
3967c732
JD
578 else
579 sv_catpv(t, "()");
2ef28da1 580
3967c732 581 finish:
61f9802b
AL
582 while (unref--)
583 sv_catpv(t, ")");
284167a5 584 if (TAINTING_get && SvTAINTED(sv))
59b714e2 585 sv_catpv(t, " [tainted]");
8b6b16e7 586 return SvPV_nolen(t);
3967c732
JD
587}
588
589void
6867be6d 590Perl_do_pmop_dump(pTHX_ I32 level, PerlIO *file, const PMOP *pm)
3967c732
JD
591{
592 char ch;
593
7918f24d
NC
594 PERL_ARGS_ASSERT_DO_PMOP_DUMP;
595
3967c732 596 if (!pm) {
cea2e8a9 597 Perl_dump_indent(aTHX_ level, file, "{}\n");
3967c732
JD
598 return;
599 }
cea2e8a9 600 Perl_dump_indent(aTHX_ level, file, "{\n");
3967c732
JD
601 level++;
602 if (pm->op_pmflags & PMf_ONCE)
603 ch = '?';
604 else
605 ch = '/';
aaa362c4 606 if (PM_GETRE(pm))
cea2e8a9 607 Perl_dump_indent(aTHX_ level, file, "PMf_PRE %c%s%c%s\n",
220fc49f 608 ch, RX_PRECOMP(PM_GETRE(pm)), ch,
3967c732
JD
609 (pm->op_private & OPpRUNTIME) ? " (RUNTIME)" : "");
610 else
cea2e8a9 611 Perl_dump_indent(aTHX_ level, file, "PMf_PRE (RUNTIME)\n");
20e98b0f 612 if (pm->op_type != OP_PUSHRE && pm->op_pmreplrootu.op_pmreplroot) {
cea2e8a9 613 Perl_dump_indent(aTHX_ level, file, "PMf_REPL = ");
20e98b0f 614 op_dump(pm->op_pmreplrootu.op_pmreplroot);
3967c732 615 }
68e2671b 616 if (pm->op_code_list) {
867940b8
DM
617 if (pm->op_pmflags & PMf_CODELIST_PRIVATE) {
618 Perl_dump_indent(aTHX_ level, file, "CODE_LIST =\n");
619 do_op_dump(level, file, pm->op_code_list);
620 }
621 else
622 Perl_dump_indent(aTHX_ level, file, "CODE_LIST = 0x%"UVxf"\n",
623 PTR2UV(pm->op_code_list));
68e2671b 624 }
07bc277f 625 if (pm->op_pmflags || (PM_GETRE(pm) && RX_CHECK_SUBSTR(PM_GETRE(pm)))) {
4199688e 626 SV * const tmpsv = pm_description(pm);
b15aece3 627 Perl_dump_indent(aTHX_ level, file, "PMFLAGS = (%s)\n", SvCUR(tmpsv) ? SvPVX_const(tmpsv) + 1 : "");
5f954473 628 SvREFCNT_dec_NN(tmpsv);
3967c732
JD
629 }
630
cea2e8a9 631 Perl_dump_indent(aTHX_ level-1, file, "}\n");
3967c732
JD
632}
633
a0c2f4dd
NC
634const struct flag_to_name pmflags_flags_names[] = {
635 {PMf_CONST, ",CONST"},
636 {PMf_KEEP, ",KEEP"},
637 {PMf_GLOBAL, ",GLOBAL"},
638 {PMf_CONTINUE, ",CONTINUE"},
639 {PMf_RETAINT, ",RETAINT"},
640 {PMf_EVAL, ",EVAL"},
641 {PMf_NONDESTRUCT, ",NONDESTRUCT"},
d63c20f2 642 {PMf_HAS_CV, ",HAS_CV"},
2a92a973
DM
643 {PMf_CODELIST_PRIVATE, ",CODELIST_PRIVATE"},
644 {PMf_IS_QR, ",IS_QR"}
a0c2f4dd
NC
645};
646
b9ac451d 647static SV *
4199688e
AL
648S_pm_description(pTHX_ const PMOP *pm)
649{
650 SV * const desc = newSVpvs("");
61f9802b 651 const REGEXP * const regex = PM_GETRE(pm);
4199688e
AL
652 const U32 pmflags = pm->op_pmflags;
653
7918f24d
NC
654 PERL_ARGS_ASSERT_PM_DESCRIPTION;
655
4199688e
AL
656 if (pmflags & PMf_ONCE)
657 sv_catpv(desc, ",ONCE");
c737faaf
YO
658#ifdef USE_ITHREADS
659 if (SvREADONLY(PL_regex_pad[pm->op_pmoffset]))
660 sv_catpv(desc, ":USED");
661#else
662 if (pmflags & PMf_USED)
663 sv_catpv(desc, ":USED");
664#endif
c737faaf 665
68d4833d 666 if (regex) {
284167a5 667 if (RX_ISTAINTED(regex))
68d4833d 668 sv_catpv(desc, ",TAINTED");
07bc277f
NC
669 if (RX_CHECK_SUBSTR(regex)) {
670 if (!(RX_EXTFLAGS(regex) & RXf_NOSCAN))
68d4833d 671 sv_catpv(desc, ",SCANFIRST");
07bc277f 672 if (RX_EXTFLAGS(regex) & RXf_CHECK_ALL)
68d4833d
AB
673 sv_catpv(desc, ",ALL");
674 }
dbc200c5
YO
675 if (RX_EXTFLAGS(regex) & RXf_SKIPWHITE)
676 sv_catpv(desc, ",SKIPWHITE");
4199688e 677 }
68d4833d 678
a0c2f4dd 679 append_flags(desc, pmflags, pmflags_flags_names);
4199688e
AL
680 return desc;
681}
682
3967c732 683void
864dbfa3 684Perl_pmop_dump(pTHX_ PMOP *pm)
3967c732
JD
685{
686 do_pmop_dump(0, Perl_debug_log, pm);
79072805
LW
687}
688
b6f05621
DM
689/* Return a unique integer to represent the address of op o.
690 * If it already exists in PL_op_sequence, just return it;
691 * otherwise add it.
692 * *** Note that this isn't thread-safe */
294b3b39 693
2814eb74 694STATIC UV
0bd48802 695S_sequence_num(pTHX_ const OP *o)
2814eb74 696{
27da23d5 697 dVAR;
2814eb74
PJ
698 SV *op,
699 **seq;
93524f2b 700 const char *key;
2814eb74 701 STRLEN len;
b6f05621
DM
702 if (!o)
703 return 0;
c0fd1b42 704 op = newSVuv(PTR2UV(o));
b6f05621 705 sv_2mortal(op);
93524f2b 706 key = SvPV_const(op, len);
b6f05621
DM
707 if (!PL_op_sequence)
708 PL_op_sequence = newHV();
709 seq = hv_fetch(PL_op_sequence, key, len, 0);
710 if (seq)
711 return SvUV(*seq);
712 (void)hv_store(PL_op_sequence, key, len, newSVuv(++PL_op_seq), 0);
713 return PL_op_seq;
2814eb74
PJ
714}
715
a0c2f4dd
NC
716const struct flag_to_name op_flags_names[] = {
717 {OPf_KIDS, ",KIDS"},
718 {OPf_PARENS, ",PARENS"},
a0c2f4dd
NC
719 {OPf_REF, ",REF"},
720 {OPf_MOD, ",MOD"},
65cccc5e 721 {OPf_STACKED, ",STACKED"},
a0c2f4dd
NC
722 {OPf_SPECIAL, ",SPECIAL"}
723};
724
ea9ad1f2 725const struct flag_to_name op_trans_names[] = {
65cccc5e
VP
726 {OPpTRANS_FROM_UTF, ",FROM_UTF"},
727 {OPpTRANS_TO_UTF, ",TO_UTF"},
728 {OPpTRANS_IDENTICAL, ",IDENTICAL"},
ea9ad1f2 729 {OPpTRANS_SQUASH, ",SQUASH"},
ea9ad1f2 730 {OPpTRANS_COMPLEMENT, ",COMPLEMENT"},
65cccc5e
VP
731 {OPpTRANS_GROWS, ",GROWS"},
732 {OPpTRANS_DELETE, ",DELETE"}
ea9ad1f2
NC
733};
734
735const struct flag_to_name op_entersub_names[] = {
ea9ad1f2
NC
736 {OPpENTERSUB_DB, ",DB"},
737 {OPpENTERSUB_HASTARG, ",HASTARG"},
65cccc5e 738 {OPpENTERSUB_AMPER, ",AMPER"},
ea9ad1f2 739 {OPpENTERSUB_NOPAREN, ",NOPAREN"},
65cccc5e 740 {OPpENTERSUB_INARGS, ",INARGS"}
ea9ad1f2
NC
741};
742
743const struct flag_to_name op_const_names[] = {
65cccc5e
VP
744 {OPpCONST_NOVER, ",NOVER"},
745 {OPpCONST_SHORTCIRCUIT, ",SHORTCIRCUIT"},
ea9ad1f2 746 {OPpCONST_STRICT, ",STRICT"},
65cccc5e 747 {OPpCONST_ENTERED, ",ENTERED"},
cc2ebcd7 748 {OPpCONST_FOLDED, ",FOLDED"},
63e0918d 749 {OPpCONST_BARE, ",BARE"}
ea9ad1f2
NC
750};
751
752const struct flag_to_name op_sort_names[] = {
753 {OPpSORT_NUMERIC, ",NUMERIC"},
754 {OPpSORT_INTEGER, ",INTEGER"},
65cccc5e
VP
755 {OPpSORT_REVERSE, ",REVERSE"},
756 {OPpSORT_INPLACE, ",INPLACE"},
757 {OPpSORT_DESCEND, ",DESCEND"},
758 {OPpSORT_QSORT, ",QSORT"},
759 {OPpSORT_STABLE, ",STABLE"}
ea9ad1f2
NC
760};
761
762const struct flag_to_name op_open_names[] = {
763 {OPpOPEN_IN_RAW, ",IN_RAW"},
764 {OPpOPEN_IN_CRLF, ",IN_CRLF"},
765 {OPpOPEN_OUT_RAW, ",OUT_RAW"},
766 {OPpOPEN_OUT_CRLF, ",OUT_CRLF"}
767};
768
261c990e
NC
769const struct flag_to_name op_exit_names[] = {
770 {OPpEXIT_VMSISH, ",EXIT_VMSISH"},
771 {OPpHUSH_VMSISH, ",HUSH_VMSISH"}
772};
773
75a6ad4a
RU
774const struct flag_to_name op_sassign_names[] = {
775 {OPpASSIGN_BACKWARDS, ",BACKWARDS"},
776 {OPpASSIGN_CV_TO_GV, ",CV2GV"}
777};
778
261c990e
NC
779#define OP_PRIVATE_ONCE(op, flag, name) \
780 const struct flag_to_name CAT2(op, _names)[] = { \
781 {(flag), (name)} \
f58883a1 782 }
261c990e 783
261c990e 784OP_PRIVATE_ONCE(op_leavesub, OPpREFCOUNTED, ",REFCOUNTED");
261c990e 785OP_PRIVATE_ONCE(op_repeat, OPpREPEAT_DOLIST, ",DOLIST");
65cccc5e 786OP_PRIVATE_ONCE(op_reverse, OPpREVERSE_INPLACE, ",INPLACE");
261c990e
NC
787OP_PRIVATE_ONCE(op_rv2cv, OPpLVAL_INTRO, ",INTRO");
788OP_PRIVATE_ONCE(op_flip, OPpFLIP_LINENUM, ",LINENUM");
789OP_PRIVATE_ONCE(op_gv, OPpEARLY_CV, ",EARLY_CV");
790OP_PRIVATE_ONCE(op_list, OPpLIST_GUESSED, ",GUESSED");
791OP_PRIVATE_ONCE(op_delete, OPpSLICE, ",SLICE");
792OP_PRIVATE_ONCE(op_exists, OPpEXISTS_SUB, ",EXISTS_SUB");
793OP_PRIVATE_ONCE(op_die, OPpHUSH_VMSISH, ",HUSH_VMSISH");
794
1fe3abee
NC
795struct op_private_by_op {
796 U16 op_type;
797 U16 len;
798 const struct flag_to_name *start;
799};
800
801const struct op_private_by_op op_private_names[] = {
261c990e
NC
802 {OP_LEAVESUB, C_ARRAY_LENGTH(op_leavesub_names), op_leavesub_names },
803 {OP_LEAVE, C_ARRAY_LENGTH(op_leavesub_names), op_leavesub_names },
804 {OP_LEAVESUBLV, C_ARRAY_LENGTH(op_leavesub_names), op_leavesub_names },
805 {OP_LEAVEWRITE, C_ARRAY_LENGTH(op_leavesub_names), op_leavesub_names },
261c990e
NC
806 {OP_DIE, C_ARRAY_LENGTH(op_die_names), op_die_names },
807 {OP_DELETE, C_ARRAY_LENGTH(op_delete_names), op_delete_names },
808 {OP_EXISTS, C_ARRAY_LENGTH(op_exists_names), op_exists_names },
809 {OP_EXIT, C_ARRAY_LENGTH(op_exit_names), op_exit_names },
810 {OP_FLIP, C_ARRAY_LENGTH(op_flip_names), op_flip_names },
811 {OP_FLOP, C_ARRAY_LENGTH(op_flip_names), op_flip_names },
812 {OP_GV, C_ARRAY_LENGTH(op_gv_names), op_gv_names },
813 {OP_LIST, C_ARRAY_LENGTH(op_list_names), op_list_names },
814 {OP_SASSIGN, C_ARRAY_LENGTH(op_sassign_names), op_sassign_names },
815 {OP_REPEAT, C_ARRAY_LENGTH(op_repeat_names), op_repeat_names },
816 {OP_RV2CV, C_ARRAY_LENGTH(op_rv2cv_names), op_rv2cv_names },
1fe3abee
NC
817 {OP_TRANS, C_ARRAY_LENGTH(op_trans_names), op_trans_names },
818 {OP_CONST, C_ARRAY_LENGTH(op_const_names), op_const_names },
819 {OP_SORT, C_ARRAY_LENGTH(op_sort_names), op_sort_names },
820 {OP_OPEN, C_ARRAY_LENGTH(op_open_names), op_open_names },
821 {OP_BACKTICK, C_ARRAY_LENGTH(op_open_names), op_open_names }
822};
823
824static bool
825S_op_private_to_names(pTHX_ SV *tmpsv, U32 optype, U32 op_private) {
826 const struct op_private_by_op *start = op_private_names;
827 const struct op_private_by_op *const end
828 = op_private_names + C_ARRAY_LENGTH(op_private_names);
829
830 /* This is a linear search, but no worse than the code that it replaced.
831 It's debugging code - size is more important than speed. */
832 do {
833 if (optype == start->op_type) {
834 S_append_flags(aTHX_ tmpsv, op_private, start->start,
835 start->start + start->len);
836 return TRUE;
837 }
838 } while (++start < end);
839 return FALSE;
840}
841
75a6ad4a
RU
842#define DUMP_OP_FLAGS(o,xml,level,file) \
843 if (o->op_flags || o->op_slabbed || o->op_savefree || o->op_static) { \
17605be7 844 SV * const tmpsv = newSVpvs(""); \
75a6ad4a
RU
845 switch (o->op_flags & OPf_WANT) { \
846 case OPf_WANT_VOID: \
847 sv_catpv(tmpsv, ",VOID"); \
848 break; \
849 case OPf_WANT_SCALAR: \
850 sv_catpv(tmpsv, ",SCALAR"); \
851 break; \
852 case OPf_WANT_LIST: \
853 sv_catpv(tmpsv, ",LIST"); \
854 break; \
855 default: \
856 sv_catpv(tmpsv, ",UNKNOWN"); \
857 break; \
858 } \
859 append_flags(tmpsv, o->op_flags, op_flags_names); \
860 if (o->op_slabbed) sv_catpvs(tmpsv, ",SLABBED"); \
861 if (o->op_savefree) sv_catpvs(tmpsv, ",SAVEFREE"); \
862 if (o->op_static) sv_catpvs(tmpsv, ",STATIC"); \
863 if (!xml) \
864 Perl_dump_indent(aTHX_ level, file, "FLAGS = (%s)\n", \
865 SvCUR(tmpsv) ? SvPVX_const(tmpsv) + 1 : "");\
866 else \
867 PerlIO_printf(file, " flags=\"%s\"", \
868 SvCUR(tmpsv) ? SvPVX(tmpsv) + 1 : ""); \
5f954473 869 SvREFCNT_dec_NN(tmpsv); \
75a6ad4a
RU
870 }
871
872#if !defined(PERL_MAD)
09c75956
FC
873# define xmldump_attr1(level, file, pat, arg)
874#else
875# define xmldump_attr1(level, file, pat, arg) \
876 S_xmldump_attr(aTHX_ level, file, pat, arg)
75a6ad4a
RU
877#endif
878
879#define DUMP_OP_PRIVATE(o,xml,level,file) \
880 if (o->op_private) { \
881 U32 optype = o->op_type; \
882 U32 oppriv = o->op_private; \
17605be7 883 SV * const tmpsv = newSVpvs(""); \
75a6ad4a
RU
884 if (PL_opargs[optype] & OA_TARGLEX) { \
885 if (oppriv & OPpTARGET_MY) \
886 sv_catpv(tmpsv, ",TARGET_MY"); \
887 } \
888 else if (optype == OP_ENTERSUB || \
889 optype == OP_RV2SV || \
890 optype == OP_GVSV || \
891 optype == OP_RV2AV || \
892 optype == OP_RV2HV || \
893 optype == OP_RV2GV || \
894 optype == OP_AELEM || \
895 optype == OP_HELEM ) \
896 { \
897 if (optype == OP_ENTERSUB) { \
898 append_flags(tmpsv, oppriv, op_entersub_names); \
899 } \
900 else { \
901 switch (oppriv & OPpDEREF) { \
902 case OPpDEREF_SV: \
903 sv_catpv(tmpsv, ",SV"); \
904 break; \
905 case OPpDEREF_AV: \
906 sv_catpv(tmpsv, ",AV"); \
907 break; \
908 case OPpDEREF_HV: \
909 sv_catpv(tmpsv, ",HV"); \
910 break; \
911 } \
912 if (oppriv & OPpMAYBE_LVSUB) \
913 sv_catpv(tmpsv, ",MAYBE_LVSUB"); \
914 } \
915 if (optype == OP_AELEM || optype == OP_HELEM) { \
916 if (oppriv & OPpLVAL_DEFER) \
917 sv_catpv(tmpsv, ",LVAL_DEFER"); \
918 } \
919 else if (optype == OP_RV2HV || optype == OP_PADHV) { \
920 if (oppriv & OPpMAYBE_TRUEBOOL) \
921 sv_catpvs(tmpsv, ",OPpMAYBE_TRUEBOOL"); \
922 if (oppriv & OPpTRUEBOOL) \
923 sv_catpvs(tmpsv, ",OPpTRUEBOOL"); \
924 } \
925 else { \
926 if (oppriv & HINT_STRICT_REFS) \
927 sv_catpv(tmpsv, ",STRICT_REFS"); \
928 if (oppriv & OPpOUR_INTRO) \
929 sv_catpv(tmpsv, ",OUR_INTRO"); \
930 } \
931 } \
932 else if (S_op_private_to_names(aTHX_ tmpsv, optype, oppriv)) { \
933 } \
934 else if (OP_IS_FILETEST(o->op_type)) { \
935 if (oppriv & OPpFT_ACCESS) \
936 sv_catpv(tmpsv, ",FT_ACCESS"); \
937 if (oppriv & OPpFT_STACKED) \
938 sv_catpv(tmpsv, ",FT_STACKED"); \
939 if (oppriv & OPpFT_STACKING) \
940 sv_catpv(tmpsv, ",FT_STACKING"); \
941 if (oppriv & OPpFT_AFTER_t) \
942 sv_catpv(tmpsv, ",AFTER_t"); \
943 } \
631dbaa2
FC
944 else if (o->op_type == OP_AASSIGN) { \
945 if (oppriv & OPpASSIGN_COMMON) \
946 sv_catpvs(tmpsv, ",COMMON"); \
947 if (oppriv & OPpMAYBE_LVSUB) \
948 sv_catpvs(tmpsv, ",MAYBE_LVSUB"); \
949 } \
75a6ad4a
RU
950 if (o->op_flags & OPf_MOD && oppriv & OPpLVAL_INTRO) \
951 sv_catpv(tmpsv, ",INTRO"); \
952 if (o->op_type == OP_PADRANGE) \
953 Perl_sv_catpvf(aTHX_ tmpsv, ",COUNT=%"UVuf, \
954 (UV)(oppriv & OPpPADRANGE_COUNTMASK)); \
955 if (SvCUR(tmpsv)) { \
956 if (xml) \
09c75956 957 xmldump_attr1(level+1, file, "private=\"%s\"", SvPVX(tmpsv)+1); \
75a6ad4a
RU
958 else \
959 Perl_dump_indent(aTHX_ level, file, "PRIVATE = (%s)\n", SvPVX_const(tmpsv) + 1); \
960 } else if (!xml) \
961 Perl_dump_indent(aTHX_ level, file, "PRIVATE = (0x%"UVxf")\n", \
962 (UV)oppriv); \
5f954473 963 SvREFCNT_dec_NN(tmpsv); \
75a6ad4a
RU
964 }
965
966
79072805 967void
6867be6d 968Perl_do_op_dump(pTHX_ I32 level, PerlIO *file, const OP *o)
79072805 969{
27da23d5 970 dVAR;
2814eb74 971 UV seq;
e15d5972
AL
972 const OPCODE optype = o->op_type;
973
7918f24d
NC
974 PERL_ARGS_ASSERT_DO_OP_DUMP;
975
cea2e8a9 976 Perl_dump_indent(aTHX_ level, file, "{\n");
3967c732 977 level++;
0bd48802 978 seq = sequence_num(o);
2814eb74 979 if (seq)
f5992bc4 980 PerlIO_printf(file, "%-4"UVuf, seq);
93a17b20 981 else
b6f05621 982 PerlIO_printf(file, "????");
c8db6e60
JH
983 PerlIO_printf(file,
984 "%*sTYPE = %s ===> ",
53e06cf0 985 (int)(PL_dumpindent*level-4), "", OP_NAME(o));
2814eb74 986 if (o->op_next)
b6f05621
DM
987 PerlIO_printf(file,
988 o->op_type == OP_NULL ? "(%"UVuf")\n" : "%"UVuf"\n",
666ea192 989 sequence_num(o->op_next));
79072805 990 else
e75ab6ad 991 PerlIO_printf(file, "NULL\n");
11343788 992 if (o->op_targ) {
e15d5972 993 if (optype == OP_NULL) {
cea2e8a9 994 Perl_dump_indent(aTHX_ level, file, " (was %s)\n", PL_op_name[o->op_targ]);
e15d5972 995 if (o->op_targ == OP_NEXTSTATE) {
ae7d165c 996 if (CopLINE(cCOPo))
f5992bc4 997 Perl_dump_indent(aTHX_ level, file, "LINE = %"UVuf"\n",
9d98dee5 998 (UV)CopLINE(cCOPo));
ae7d165c
PJ
999 if (CopSTASHPV(cCOPo))
1000 Perl_dump_indent(aTHX_ level, file, "PACKAGE = \"%s\"\n",
1001 CopSTASHPV(cCOPo));
4b65a919 1002 if (CopLABEL(cCOPo))
ae7d165c 1003 Perl_dump_indent(aTHX_ level, file, "LABEL = \"%s\"\n",
4b65a919 1004 CopLABEL(cCOPo));
ae7d165c
PJ
1005 }
1006 }
8990e307 1007 else
894356b3 1008 Perl_dump_indent(aTHX_ level, file, "TARG = %ld\n", (long)o->op_targ);
8990e307 1009 }
748a9306 1010#ifdef DUMPADDR
57def98f 1011 Perl_dump_indent(aTHX_ level, file, "ADDR = 0x%"UVxf" => 0x%"UVxf"\n", (UV)o, (UV)o->op_next);
79072805 1012#endif
a7fd8ef6 1013
75a6ad4a
RU
1014 DUMP_OP_FLAGS(o,0,level,file);
1015 DUMP_OP_PRIVATE(o,0,level,file);
8d063cd8 1016
3b721df9
NC
1017#ifdef PERL_MAD
1018 if (PL_madskills && o->op_madprop) {
17605be7 1019 SV * const tmpsv = newSVpvs("");
3b721df9
NC
1020 MADPROP* mp = o->op_madprop;
1021 Perl_dump_indent(aTHX_ level, file, "MADPROPS = {\n");
1022 level++;
1023 while (mp) {
61f9802b 1024 const char tmp = mp->mad_key;
76f68e9b 1025 sv_setpvs(tmpsv,"'");
3b721df9
NC
1026 if (tmp)
1027 sv_catpvn(tmpsv, &tmp, 1);
1028 sv_catpv(tmpsv, "'=");
1029 switch (mp->mad_type) {
1030 case MAD_NULL:
1031 sv_catpv(tmpsv, "NULL");
1032 Perl_dump_indent(aTHX_ level, file, "%s\n", SvPVX(tmpsv));
1033 break;
1034 case MAD_PV:
1035 sv_catpv(tmpsv, "<");
1036 sv_catpvn(tmpsv, (char*)mp->mad_val, mp->mad_vlen);
1037 sv_catpv(tmpsv, ">");
1038 Perl_dump_indent(aTHX_ level, file, "%s\n", SvPVX(tmpsv));
1039 break;
1040 case MAD_OP:
1041 if ((OP*)mp->mad_val) {
1042 Perl_dump_indent(aTHX_ level, file, "%s\n", SvPVX(tmpsv));
1043 do_op_dump(level, file, (OP*)mp->mad_val);
1044 }
1045 break;
1046 default:
1047 sv_catpv(tmpsv, "(UNK)");
1048 Perl_dump_indent(aTHX_ level, file, "%s\n", SvPVX(tmpsv));
1049 break;
1050 }
1051 mp = mp->mad_next;
1052 }
1053 level--;
1054 Perl_dump_indent(aTHX_ level, file, "}\n");
1055
5f954473 1056 SvREFCNT_dec_NN(tmpsv);
3b721df9
NC
1057 }
1058#endif
1059
e15d5972 1060 switch (optype) {
971a9dd3 1061 case OP_AELEMFAST:
93a17b20 1062 case OP_GVSV:
79072805 1063 case OP_GV:
971a9dd3 1064#ifdef USE_ITHREADS
c803eecc 1065 Perl_dump_indent(aTHX_ level, file, "PADIX = %" IVdf "\n", (IV)cPADOPo->op_padix);
971a9dd3 1066#else
1640e9f0 1067 if ( ! (o->op_flags & OPf_SPECIAL)) { /* not lexical */
38c076c7 1068 if (cSVOPo->op_sv) {
d4c19fe8 1069 SV * const tmpsv = newSV(0);
38c076c7
DM
1070 ENTER;
1071 SAVEFREESV(tmpsv);
3b721df9 1072#ifdef PERL_MAD
84021b46 1073 /* FIXME - is this making unwarranted assumptions about the
3b721df9
NC
1074 UTF-8 cleanliness of the dump file handle? */
1075 SvUTF8_on(tmpsv);
1076#endif
159b6efe 1077 gv_fullname3(tmpsv, MUTABLE_GV(cSVOPo->op_sv), NULL);
8b6b16e7 1078 Perl_dump_indent(aTHX_ level, file, "GV = %s\n",
17605be7 1079 SvPV_nolen_const(tmpsv));
38c076c7
DM
1080 LEAVE;
1081 }
1082 else
1083 Perl_dump_indent(aTHX_ level, file, "GV = NULL\n");
378cc40b 1084 }
971a9dd3 1085#endif
79072805
LW
1086 break;
1087 case OP_CONST:
996c9baa 1088 case OP_HINTSEVAL:
f5d5a27c 1089 case OP_METHOD_NAMED:
b6a15bc5
DM
1090#ifndef USE_ITHREADS
1091 /* with ITHREADS, consts are stored in the pad, and the right pad
1092 * may not be active here, so skip */
3848b962 1093 Perl_dump_indent(aTHX_ level, file, "SV = %s\n", SvPEEK(cSVOPo_sv));
b6a15bc5 1094#endif
79072805 1095 break;
93a17b20
LW
1096 case OP_NEXTSTATE:
1097 case OP_DBSTATE:
57843af0 1098 if (CopLINE(cCOPo))
f5992bc4 1099 Perl_dump_indent(aTHX_ level, file, "LINE = %"UVuf"\n",
9d98dee5 1100 (UV)CopLINE(cCOPo));
ed094faf
GS
1101 if (CopSTASHPV(cCOPo))
1102 Perl_dump_indent(aTHX_ level, file, "PACKAGE = \"%s\"\n",
1103 CopSTASHPV(cCOPo));
4b65a919 1104 if (CopLABEL(cCOPo))
ed094faf 1105 Perl_dump_indent(aTHX_ level, file, "LABEL = \"%s\"\n",
4b65a919 1106 CopLABEL(cCOPo));
79072805
LW
1107 break;
1108 case OP_ENTERLOOP:
cea2e8a9 1109 Perl_dump_indent(aTHX_ level, file, "REDO ===> ");
11343788 1110 if (cLOOPo->op_redoop)
f5992bc4 1111 PerlIO_printf(file, "%"UVuf"\n", sequence_num(cLOOPo->op_redoop));
79072805 1112 else
3967c732 1113 PerlIO_printf(file, "DONE\n");
cea2e8a9 1114 Perl_dump_indent(aTHX_ level, file, "NEXT ===> ");
11343788 1115 if (cLOOPo->op_nextop)
f5992bc4 1116 PerlIO_printf(file, "%"UVuf"\n", sequence_num(cLOOPo->op_nextop));
79072805 1117 else
3967c732 1118 PerlIO_printf(file, "DONE\n");
cea2e8a9 1119 Perl_dump_indent(aTHX_ level, file, "LAST ===> ");
11343788 1120 if (cLOOPo->op_lastop)
f5992bc4 1121 PerlIO_printf(file, "%"UVuf"\n", sequence_num(cLOOPo->op_lastop));
79072805 1122 else
3967c732 1123 PerlIO_printf(file, "DONE\n");
79072805
LW
1124 break;
1125 case OP_COND_EXPR:
1a67a97c 1126 case OP_RANGE:
a0d0e21e 1127 case OP_MAPWHILE:
79072805
LW
1128 case OP_GREPWHILE:
1129 case OP_OR:
1130 case OP_AND:
cea2e8a9 1131 Perl_dump_indent(aTHX_ level, file, "OTHER ===> ");
11343788 1132 if (cLOGOPo->op_other)
f5992bc4 1133 PerlIO_printf(file, "%"UVuf"\n", sequence_num(cLOGOPo->op_other));
79072805 1134 else
3967c732 1135 PerlIO_printf(file, "DONE\n");
79072805
LW
1136 break;
1137 case OP_PUSHRE:
1138 case OP_MATCH:
8782bef2 1139 case OP_QR:
79072805 1140 case OP_SUBST:
3967c732 1141 do_pmop_dump(level, file, cPMOPo);
79072805 1142 break;
7934575e
GS
1143 case OP_LEAVE:
1144 case OP_LEAVEEVAL:
1145 case OP_LEAVESUB:
1146 case OP_LEAVESUBLV:
1147 case OP_LEAVEWRITE:
1148 case OP_SCOPE:
1149 if (o->op_private & OPpREFCOUNTED)
1150 Perl_dump_indent(aTHX_ level, file, "REFCNT = %"UVuf"\n", (UV)o->op_targ);
1151 break;
a0d0e21e
LW
1152 default:
1153 break;
79072805 1154 }
11343788 1155 if (o->op_flags & OPf_KIDS) {
79072805 1156 OP *kid;
11343788 1157 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling)
3967c732 1158 do_op_dump(level, file, kid);
8d063cd8 1159 }
cea2e8a9 1160 Perl_dump_indent(aTHX_ level-1, file, "}\n");
3967c732
JD
1161}
1162
1163void
6867be6d 1164Perl_op_dump(pTHX_ const OP *o)
3967c732 1165{
7918f24d 1166 PERL_ARGS_ASSERT_OP_DUMP;
3967c732 1167 do_op_dump(0, Perl_debug_log, o);
8d063cd8
LW
1168}
1169
8adcabd8 1170void
864dbfa3 1171Perl_gv_dump(pTHX_ GV *gv)
378cc40b 1172{
17605be7 1173 SV *sv;
378cc40b 1174
7918f24d
NC
1175 PERL_ARGS_ASSERT_GV_DUMP;
1176
79072805 1177 if (!gv) {
760ac839 1178 PerlIO_printf(Perl_debug_log, "{}\n");
378cc40b
LW
1179 return;
1180 }
8990e307 1181 sv = sv_newmortal();
760ac839 1182 PerlIO_printf(Perl_debug_log, "{\n");
bd61b366 1183 gv_fullname3(sv, gv, NULL);
17605be7 1184 Perl_dump_indent(aTHX_ 1, Perl_debug_log, "GV_NAME = %s", SvPVX_const(sv));
79072805 1185 if (gv != GvEGV(gv)) {
bd61b366 1186 gv_efullname3(sv, GvEGV(gv), NULL);
17605be7 1187 Perl_dump_indent(aTHX_ 1, Perl_debug_log, "-> %s", SvPVX_const(sv));
8adcabd8 1188 }
3967c732 1189 PerlIO_putc(Perl_debug_log, '\n');
cea2e8a9 1190 Perl_dump_indent(aTHX_ 0, Perl_debug_log, "}\n");
8d063cd8
LW
1191}
1192
14befaf4 1193
afe38520 1194/* map magic types to the symbolic names
14befaf4
DM
1195 * (with the PERL_MAGIC_ prefixed stripped)
1196 */
1197
27da23d5 1198static const struct { const char type; const char *name; } magic_names[] = {
52f49505 1199#include "mg_names.c"
516a5887 1200 /* this null string terminates the list */
b9ac451d 1201 { 0, NULL },
14befaf4
DM
1202};
1203
8adcabd8 1204void
6867be6d 1205Perl_do_magic_dump(pTHX_ I32 level, PerlIO *file, const MAGIC *mg, I32 nest, I32 maxnest, bool dumpops, STRLEN pvlim)
8d063cd8 1206{
7918f24d
NC
1207 PERL_ARGS_ASSERT_DO_MAGIC_DUMP;
1208
3967c732 1209 for (; mg; mg = mg->mg_moremagic) {
b900a521
JH
1210 Perl_dump_indent(aTHX_ level, file,
1211 " MAGIC = 0x%"UVxf"\n", PTR2UV(mg));
3967c732 1212 if (mg->mg_virtual) {
bfed75c6 1213 const MGVTBL * const v = mg->mg_virtual;
2d1f1fe5
NC
1214 if (v >= PL_magic_vtables
1215 && v < PL_magic_vtables + magic_vtable_max) {
1216 const U32 i = v - PL_magic_vtables;
1217 Perl_dump_indent(aTHX_ level, file, " MG_VIRTUAL = &PL_vtbl_%s\n", PL_magic_vtable_names[i]);
1218 }
3967c732 1219 else
b900a521 1220 Perl_dump_indent(aTHX_ level, file, " MG_VIRTUAL = 0x%"UVxf"\n", PTR2UV(v));
3967c732
JD
1221 }
1222 else
cea2e8a9 1223 Perl_dump_indent(aTHX_ level, file, " MG_VIRTUAL = 0\n");
8d063cd8 1224
3967c732 1225 if (mg->mg_private)
cea2e8a9 1226 Perl_dump_indent(aTHX_ level, file, " MG_PRIVATE = %d\n", mg->mg_private);
3967c732 1227
14befaf4
DM
1228 {
1229 int n;
c445ea15 1230 const char *name = NULL;
27da23d5 1231 for (n = 0; magic_names[n].name; n++) {
14befaf4
DM
1232 if (mg->mg_type == magic_names[n].type) {
1233 name = magic_names[n].name;
1234 break;
1235 }
1236 }
1237 if (name)
1238 Perl_dump_indent(aTHX_ level, file,
1239 " MG_TYPE = PERL_MAGIC_%s\n", name);
1240 else
1241 Perl_dump_indent(aTHX_ level, file,
1242 " MG_TYPE = UNKNOWN(\\%o)\n", mg->mg_type);
1243 }
3967c732
JD
1244
1245 if (mg->mg_flags) {
cea2e8a9 1246 Perl_dump_indent(aTHX_ level, file, " MG_FLAGS = 0x%02X\n", mg->mg_flags);
cb50f42d
YST
1247 if (mg->mg_type == PERL_MAGIC_envelem &&
1248 mg->mg_flags & MGf_TAINTEDDIR)
cea2e8a9 1249 Perl_dump_indent(aTHX_ level, file, " TAINTEDDIR\n");
4c02285a
FR
1250 if (mg->mg_type == PERL_MAGIC_regex_global &&
1251 mg->mg_flags & MGf_MINMATCH)
1252 Perl_dump_indent(aTHX_ level, file, " MINMATCH\n");
3967c732 1253 if (mg->mg_flags & MGf_REFCOUNTED)
cea2e8a9 1254 Perl_dump_indent(aTHX_ level, file, " REFCOUNTED\n");
3967c732 1255 if (mg->mg_flags & MGf_GSKIP)
cea2e8a9 1256 Perl_dump_indent(aTHX_ level, file, " GSKIP\n");
4c02285a
FR
1257 if (mg->mg_flags & MGf_COPY)
1258 Perl_dump_indent(aTHX_ level, file, " COPY\n");
1259 if (mg->mg_flags & MGf_DUP)
1260 Perl_dump_indent(aTHX_ level, file, " DUP\n");
1261 if (mg->mg_flags & MGf_LOCAL)
1262 Perl_dump_indent(aTHX_ level, file, " LOCAL\n");
3967c732
JD
1263 }
1264 if (mg->mg_obj) {
4c02285a 1265 Perl_dump_indent(aTHX_ level, file, " MG_OBJ = 0x%"UVxf"\n",
28d8d7f4
YO
1266 PTR2UV(mg->mg_obj));
1267 if (mg->mg_type == PERL_MAGIC_qr) {
07bc277f 1268 REGEXP* const re = (REGEXP *)mg->mg_obj;
61f9802b 1269 SV * const dsv = sv_newmortal();
866c78d1 1270 const char * const s
4c02285a 1271 = pv_pretty(dsv, RX_WRAPPED(re), RX_WRAPLEN(re),
28d8d7f4 1272 60, NULL, NULL,
95b611b0 1273 ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_PRETTY_ELLIPSES |
3c8556c3 1274 (RX_UTF8(re) ? PERL_PV_ESCAPE_UNI : 0))
28d8d7f4 1275 );
6483fb35
RGS
1276 Perl_dump_indent(aTHX_ level+1, file, " PAT = %s\n", s);
1277 Perl_dump_indent(aTHX_ level+1, file, " REFCNT = %"IVdf"\n",
07bc277f 1278 (IV)RX_REFCNT(re));
28d8d7f4
YO
1279 }
1280 if (mg->mg_flags & MGf_REFCOUNTED)
3967c732
JD
1281 do_sv_dump(level+2, file, mg->mg_obj, nest+1, maxnest, dumpops, pvlim); /* MG is already +1 */
1282 }
1283 if (mg->mg_len)
894356b3 1284 Perl_dump_indent(aTHX_ level, file, " MG_LEN = %ld\n", (long)mg->mg_len);
3967c732 1285 if (mg->mg_ptr) {
b900a521 1286 Perl_dump_indent(aTHX_ level, file, " MG_PTR = 0x%"UVxf, PTR2UV(mg->mg_ptr));
3967c732 1287 if (mg->mg_len >= 0) {
7e8c5dac 1288 if (mg->mg_type != PERL_MAGIC_utf8) {
17605be7 1289 SV * const sv = newSVpvs("");
7e8c5dac 1290 PerlIO_printf(file, " %s", pv_display(sv, mg->mg_ptr, mg->mg_len, 0, pvlim));
17605be7 1291 SvREFCNT_dec_NN(sv);
7e8c5dac 1292 }
3967c732
JD
1293 }
1294 else if (mg->mg_len == HEf_SVKEY) {
1295 PerlIO_puts(file, " => HEf_SVKEY\n");
ad64d0ec
NC
1296 do_sv_dump(level+2, file, MUTABLE_SV(((mg)->mg_ptr)), nest+1,
1297 maxnest, dumpops, pvlim); /* MG is already +1 */
3967c732
JD
1298 continue;
1299 }
866f9d6c 1300 else if (mg->mg_len == -1 && mg->mg_type == PERL_MAGIC_utf8);
3967c732 1301 else
866f9d6c
FC
1302 PerlIO_puts(
1303 file,
1304 " ???? - " __FILE__
1305 " does not know how to handle this MG_LEN"
1306 );
3967c732
JD
1307 PerlIO_putc(file, '\n');
1308 }
7e8c5dac 1309 if (mg->mg_type == PERL_MAGIC_utf8) {
61f9802b 1310 const STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7e8c5dac
HS
1311 if (cache) {
1312 IV i;
1313 for (i = 0; i < PERL_MAGIC_UTF8_CACHESIZE; i++)
1314 Perl_dump_indent(aTHX_ level, file,
1315 " %2"IVdf": %"UVuf" -> %"UVuf"\n",
1316 i,
1317 (UV)cache[i * 2],
1318 (UV)cache[i * 2 + 1]);
1319 }
1320 }
378cc40b 1321 }
3967c732
JD
1322}
1323
1324void
6867be6d 1325Perl_magic_dump(pTHX_ const MAGIC *mg)
3967c732 1326{
b9ac451d 1327 do_magic_dump(0, Perl_debug_log, mg, 0, 0, FALSE, 0);
3967c732
JD
1328}
1329
1330void
e1ec3a88 1331Perl_do_hv_dump(pTHX_ I32 level, PerlIO *file, const char *name, HV *sv)
3967c732 1332{
bfcb3514 1333 const char *hvname;
7918f24d
NC
1334
1335 PERL_ARGS_ASSERT_DO_HV_DUMP;
1336
b900a521 1337 Perl_dump_indent(aTHX_ level, file, "%s = 0x%"UVxf, name, PTR2UV(sv));
bfcb3514 1338 if (sv && (hvname = HvNAME_get(sv)))
d7d51f4b
YO
1339 {
1340 /* we have to use pv_display and HvNAMELEN_get() so that we display the real package
1341 name which quite legally could contain insane things like tabs, newlines, nulls or
1342 other scary crap - this should produce sane results - except maybe for unicode package
1343 names - but we will wait for someone to file a bug on that - demerphq */
17605be7 1344 SV * const tmpsv = newSVpvs("");
d7d51f4b
YO
1345 PerlIO_printf(file, "\t%s\n", pv_display(tmpsv, hvname, HvNAMELEN_get(sv), 0, 1024));
1346 }
79072805 1347 else
3967c732
JD
1348 PerlIO_putc(file, '\n');
1349}
1350
1351void
e1ec3a88 1352Perl_do_gv_dump(pTHX_ I32 level, PerlIO *file, const char *name, GV *sv)
3967c732 1353{
7918f24d
NC
1354 PERL_ARGS_ASSERT_DO_GV_DUMP;
1355
b900a521 1356 Perl_dump_indent(aTHX_ level, file, "%s = 0x%"UVxf, name, PTR2UV(sv));
3967c732
JD
1357 if (sv && GvNAME(sv))
1358 PerlIO_printf(file, "\t\"%s\"\n", GvNAME(sv));
c90c0ff4 1359 else
3967c732
JD
1360 PerlIO_putc(file, '\n');
1361}
1362
1363void
e1ec3a88 1364Perl_do_gvgv_dump(pTHX_ I32 level, PerlIO *file, const char *name, GV *sv)
3967c732 1365{
7918f24d
NC
1366 PERL_ARGS_ASSERT_DO_GVGV_DUMP;
1367
b900a521 1368 Perl_dump_indent(aTHX_ level, file, "%s = 0x%"UVxf, name, PTR2UV(sv));
3967c732 1369 if (sv && GvNAME(sv)) {
bfcb3514 1370 const char *hvname;
17605be7
DM
1371 PerlIO_printf(file, "\t\"");
1372 if (GvSTASH(sv) && (hvname = HvNAME_get(GvSTASH(sv))))
1373 PerlIO_printf(file, "%s\" :: \"", hvname);
1374 PerlIO_printf(file, "%s\"\n", GvNAME(sv));
8d063cd8 1375 }
3967c732
JD
1376 else
1377 PerlIO_putc(file, '\n');
1378}
1379
a0c2f4dd
NC
1380const struct flag_to_name first_sv_flags_names[] = {
1381 {SVs_TEMP, "TEMP,"},
1382 {SVs_OBJECT, "OBJECT,"},
1383 {SVs_GMG, "GMG,"},
1384 {SVs_SMG, "SMG,"},
1385 {SVs_RMG, "RMG,"},
1386 {SVf_IOK, "IOK,"},
1387 {SVf_NOK, "NOK,"},
1388 {SVf_POK, "POK,"}
1389};
1390
1391const struct flag_to_name second_sv_flags_names[] = {
1392 {SVf_OOK, "OOK,"},
1393 {SVf_FAKE, "FAKE,"},
1394 {SVf_READONLY, "READONLY,"},
e3918bb7 1395 {SVf_IsCOW, "IsCOW,"},
a0c2f4dd
NC
1396 {SVf_BREAK, "BREAK,"},
1397 {SVf_AMAGIC, "OVERLOAD,"},
1398 {SVp_IOK, "pIOK,"},
1399 {SVp_NOK, "pNOK,"},
1400 {SVp_POK, "pPOK,"}
1401};
1402
ae1f06a1
NC
1403const struct flag_to_name cv_flags_names[] = {
1404 {CVf_ANON, "ANON,"},
1405 {CVf_UNIQUE, "UNIQUE,"},
1406 {CVf_CLONE, "CLONE,"},
1407 {CVf_CLONED, "CLONED,"},
1408 {CVf_CONST, "CONST,"},
1409 {CVf_NODEBUG, "NODEBUG,"},
1410 {CVf_LVALUE, "LVALUE,"},
1411 {CVf_METHOD, "METHOD,"},
cfc1e951 1412 {CVf_WEAKOUTSIDE, "WEAKOUTSIDE,"},
31d45e0c 1413 {CVf_CVGV_RC, "CVGV_RC,"},
bad4ae38 1414 {CVf_DYNFILE, "DYNFILE,"},
8fa6a409 1415 {CVf_AUTOLOAD, "AUTOLOAD,"},
55f7f8ab 1416 {CVf_HASEVAL, "HASEVAL"},
bfbc3ad9 1417 {CVf_SLABBED, "SLABBED,"},
31d45e0c 1418 {CVf_ISXSUB, "ISXSUB,"}
ae1f06a1
NC
1419};
1420
1421const struct flag_to_name hv_flags_names[] = {
1422 {SVphv_SHAREKEYS, "SHAREKEYS,"},
1423 {SVphv_LAZYDEL, "LAZYDEL,"},
1424 {SVphv_HASKFLAGS, "HASKFLAGS,"},
ae1f06a1
NC
1425 {SVphv_CLONEABLE, "CLONEABLE,"}
1426};
1427
1428const struct flag_to_name gp_flags_names[] = {
1429 {GVf_INTRO, "INTRO,"},
1430 {GVf_MULTI, "MULTI,"},
1431 {GVf_ASSUMECV, "ASSUMECV,"},
1432 {GVf_IN_PAD, "IN_PAD,"}
1433};
1434
1435const struct flag_to_name gp_flags_imported_names[] = {
1436 {GVf_IMPORTED_SV, " SV"},
1437 {GVf_IMPORTED_AV, " AV"},
1438 {GVf_IMPORTED_HV, " HV"},
1439 {GVf_IMPORTED_CV, " CV"},
1440};
1441
d63e6659
DM
1442const struct flag_to_name regexp_flags_names[] = {
1443 {RXf_PMf_MULTILINE, "PMf_MULTILINE,"},
1444 {RXf_PMf_SINGLELINE, "PMf_SINGLELINE,"},
1445 {RXf_PMf_FOLD, "PMf_FOLD,"},
1446 {RXf_PMf_EXTENDED, "PMf_EXTENDED,"},
1447 {RXf_PMf_KEEPCOPY, "PMf_KEEPCOPY,"},
1448 {RXf_ANCH_BOL, "ANCH_BOL,"},
1449 {RXf_ANCH_MBOL, "ANCH_MBOL,"},
1450 {RXf_ANCH_SBOL, "ANCH_SBOL,"},
1451 {RXf_ANCH_GPOS, "ANCH_GPOS,"},
1452 {RXf_GPOS_SEEN, "GPOS_SEEN,"},
1453 {RXf_GPOS_FLOAT, "GPOS_FLOAT,"},
dbc200c5 1454 {RXf_NO_INPLACE_SUBST, "NO_INPLACE_SUBST,"},
d63e6659
DM
1455 {RXf_EVAL_SEEN, "EVAL_SEEN,"},
1456 {RXf_CANY_SEEN, "CANY_SEEN,"},
1457 {RXf_NOSCAN, "NOSCAN,"},
1458 {RXf_CHECK_ALL, "CHECK_ALL,"},
1459 {RXf_MATCH_UTF8, "MATCH_UTF8,"},
1460 {RXf_USE_INTUIT_NOML, "USE_INTUIT_NOML,"},
1461 {RXf_USE_INTUIT_ML, "USE_INTUIT_ML,"},
1462 {RXf_INTUIT_TAIL, "INTUIT_TAIL,"},
dbc200c5 1463 {RXf_SPLIT, "SPLIT,"},
d63e6659
DM
1464 {RXf_COPY_DONE, "COPY_DONE,"},
1465 {RXf_TAINTED_SEEN, "TAINTED_SEEN,"},
1466 {RXf_TAINTED, "TAINTED,"},
1467 {RXf_START_ONLY, "START_ONLY,"},
dbc200c5 1468 {RXf_SKIPWHITE, "SKIPWHITE,"},
d63e6659
DM
1469 {RXf_WHITE, "WHITE,"},
1470 {RXf_NULL, "NULL,"},
1471};
1472
3967c732 1473void
864dbfa3 1474Perl_do_sv_dump(pTHX_ I32 level, PerlIO *file, SV *sv, I32 nest, I32 maxnest, bool dumpops, STRLEN pvlim)
3967c732 1475{
97aff369 1476 dVAR;
cea89e20 1477 SV *d;
e1ec3a88 1478 const char *s;
3967c732
JD
1479 U32 flags;
1480 U32 type;
1481
7918f24d
NC
1482 PERL_ARGS_ASSERT_DO_SV_DUMP;
1483
3967c732 1484 if (!sv) {
cea2e8a9 1485 Perl_dump_indent(aTHX_ level, file, "SV = 0\n");
3967c732 1486 return;
378cc40b 1487 }
2ef28da1 1488
3967c732
JD
1489 flags = SvFLAGS(sv);
1490 type = SvTYPE(sv);
79072805 1491
e0bbf362
DM
1492 /* process general SV flags */
1493
cea89e20 1494 d = Perl_newSVpvf(aTHX_
57def98f 1495 "(0x%"UVxf") at 0x%"UVxf"\n%*s REFCNT = %"IVdf"\n%*s FLAGS = (",
56431972 1496 PTR2UV(SvANY(sv)), PTR2UV(sv),
894356b3
GS
1497 (int)(PL_dumpindent*level), "", (IV)SvREFCNT(sv),
1498 (int)(PL_dumpindent*level), "");
8d063cd8 1499
1979170b
NC
1500 if (!((flags & SVpad_NAME) == SVpad_NAME
1501 && (type == SVt_PVMG || type == SVt_PVNV))) {
9a214eec
DM
1502 if ((flags & SVs_PADMY) && (flags & SVs_PADSTALE))
1503 sv_catpv(d, "PADSTALE,");
e604303a 1504 }
1979170b 1505 if (!((flags & SVpad_NAME) == SVpad_NAME && type == SVt_PVMG)) {
9a214eec
DM
1506 if (!(flags & SVs_PADMY) && (flags & SVs_PADTMP))
1507 sv_catpv(d, "PADTMP,");
e604303a
NC
1508 if (flags & SVs_PADMY) sv_catpv(d, "PADMY,");
1509 }
a0c2f4dd 1510 append_flags(d, flags, first_sv_flags_names);
810b8aa5
GS
1511 if (flags & SVf_ROK) {
1512 sv_catpv(d, "ROK,");
1513 if (SvWEAKREF(sv)) sv_catpv(d, "WEAKREF,");
1514 }
a0c2f4dd 1515 append_flags(d, flags, second_sv_flags_names);
1ccdb730
NC
1516 if (flags & SVp_SCREAM && type != SVt_PVHV && !isGV_with_GP(sv)) {
1517 if (SvPCS_IMPORTED(sv))
1518 sv_catpv(d, "PCS_IMPORTED,");
1519 else
9660f481 1520 sv_catpv(d, "SCREAM,");
1ccdb730 1521 }
3967c732 1522
e0bbf362
DM
1523 /* process type-specific SV flags */
1524
3967c732
JD
1525 switch (type) {
1526 case SVt_PVCV:
1527 case SVt_PVFM:
ae1f06a1 1528 append_flags(d, CvFLAGS(sv), cv_flags_names);
3967c732
JD
1529 break;
1530 case SVt_PVHV:
ae1f06a1 1531 append_flags(d, flags, hv_flags_names);
3967c732 1532 break;
926fc7b6
DM
1533 case SVt_PVGV:
1534 case SVt_PVLV:
1535 if (isGV_with_GP(sv)) {
ae1f06a1 1536 append_flags(d, GvFLAGS(sv), gp_flags_names);
926fc7b6 1537 }
926fc7b6 1538 if (isGV_with_GP(sv) && GvIMPORTED(sv)) {
3967c732
JD
1539 sv_catpv(d, "IMPORT");
1540 if (GvIMPORTED(sv) == GVf_IMPORTED)
1541 sv_catpv(d, "ALL,");
1542 else {
1543 sv_catpv(d, "(");
ae1f06a1 1544 append_flags(d, GvFLAGS(sv), gp_flags_imported_names);
3967c732
JD
1545 sv_catpv(d, " ),");
1546 }
1547 }
addd1794 1548 /* FALL THROUGH */
25da4f38 1549 default:
e604303a 1550 evaled_or_uv:
25da4f38 1551 if (SvEVALED(sv)) sv_catpv(d, "EVALED,");
69c678eb 1552 if (SvIsUV(sv) && !(flags & SVf_ROK)) sv_catpv(d, "IsUV,");
25da4f38 1553 break;
addd1794 1554 case SVt_PVMG:
c13a5c80
NC
1555 if (SvTAIL(sv)) sv_catpv(d, "TAIL,");
1556 if (SvVALID(sv)) sv_catpv(d, "VALID,");
00b1698f 1557 if (SvPAD_TYPED(sv)) sv_catpv(d, "TYPED,");
e604303a 1558 if (SvPAD_OUR(sv)) sv_catpv(d, "OUR,");
2e94196c 1559 /* FALL THROUGH */
e604303a
NC
1560 case SVt_PVNV:
1561 if (SvPAD_STATE(sv)) sv_catpv(d, "STATE,");
1562 goto evaled_or_uv;
11ca45c0
NC
1563 case SVt_PVAV:
1564 break;
3967c732 1565 }
86f0d186
NC
1566 /* SVphv_SHAREKEYS is also 0x20000000 */
1567 if ((type != SVt_PVHV) && SvUTF8(sv))
9fe74ede 1568 sv_catpv(d, "UTF8");
3967c732 1569
b162af07
SP
1570 if (*(SvEND(d) - 1) == ',') {
1571 SvCUR_set(d, SvCUR(d) - 1);
1572 SvPVX(d)[SvCUR(d)] = '\0';
1573 }
3967c732 1574 sv_catpv(d, ")");
b15aece3 1575 s = SvPVX_const(d);
3967c732 1576
e0bbf362
DM
1577 /* dump initial SV details */
1578
fd0854ff 1579#ifdef DEBUG_LEAKING_SCALARS
cbe56f1d 1580 Perl_dump_indent(aTHX_ level, file,
cd676548 1581 "ALLOCATED at %s:%d %s %s (parent 0x%"UVxf"); serial %"UVuf"\n",
fd0854ff
DM
1582 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1583 sv->sv_debug_line,
1584 sv->sv_debug_inpad ? "for" : "by",
1585 sv->sv_debug_optype ? PL_op_name[sv->sv_debug_optype]: "(none)",
cd676548 1586 PTR2UV(sv->sv_debug_parent),
cbe56f1d
DM
1587 sv->sv_debug_serial
1588 );
fd0854ff 1589#endif
cea2e8a9 1590 Perl_dump_indent(aTHX_ level, file, "SV = ");
e0bbf362
DM
1591
1592 /* Dump SV type */
1593
5357ca29
NC
1594 if (type < SVt_LAST) {
1595 PerlIO_printf(file, "%s%s\n", svtypenames[type], s);
1596
1597 if (type == SVt_NULL) {
5f954473 1598 SvREFCNT_dec_NN(d);
5357ca29
NC
1599 return;
1600 }
1601 } else {
faccc32b 1602 PerlIO_printf(file, "UNKNOWN(0x%"UVxf") %s\n", (UV)type, s);
5f954473 1603 SvREFCNT_dec_NN(d);
3967c732
JD
1604 return;
1605 }
e0bbf362
DM
1606
1607 /* Dump general SV fields */
1608
27bd069f 1609 if ((type >= SVt_PVIV && type != SVt_PVAV && type != SVt_PVHV
0a0c4b76
NC
1610 && type != SVt_PVCV && type != SVt_PVFM && type != SVt_PVIO
1611 && type != SVt_REGEXP && !isGV_with_GP(sv) && !SvVALID(sv))
4df7f6af 1612 || (type == SVt_IV && !SvROK(sv))) {
765f542d 1613 if (SvIsUV(sv)
f8c7b90f 1614#ifdef PERL_OLD_COPY_ON_WRITE
765f542d
NC
1615 || SvIsCOW(sv)
1616#endif
1617 )
57def98f 1618 Perl_dump_indent(aTHX_ level, file, " UV = %"UVuf, (UV)SvUVX(sv));
cf2093f6 1619 else
57def98f 1620 Perl_dump_indent(aTHX_ level, file, " IV = %"IVdf, (IV)SvIVX(sv));
f8c7b90f 1621#ifdef PERL_OLD_COPY_ON_WRITE
765f542d
NC
1622 if (SvIsCOW_shared_hash(sv))
1623 PerlIO_printf(file, " (HASH)");
1624 else if (SvIsCOW_normal(sv))
1625 PerlIO_printf(file, " (COW from 0x%"UVxf")", (UV)SvUVX(sv));
1626#endif
3967c732
JD
1627 PerlIO_putc(file, '\n');
1628 }
e0bbf362 1629
1979170b
NC
1630 if ((type == SVt_PVNV || type == SVt_PVMG)
1631 && (SvFLAGS(sv) & SVpad_NAME) == SVpad_NAME) {
0e4c4423
NC
1632 Perl_dump_indent(aTHX_ level, file, " COP_LOW = %"UVuf"\n",
1633 (UV) COP_SEQ_RANGE_LOW(sv));
1634 Perl_dump_indent(aTHX_ level, file, " COP_HIGH = %"UVuf"\n",
1635 (UV) COP_SEQ_RANGE_HIGH(sv));
1636 } else if ((type >= SVt_PVNV && type != SVt_PVAV && type != SVt_PVHV
08e44740 1637 && type != SVt_PVCV && type != SVt_PVFM && type != SVt_REGEXP
c0a413d1 1638 && type != SVt_PVIO && !isGV_with_GP(sv) && !SvVALID(sv))
0e4c4423 1639 || type == SVt_NV) {
e54dc35b 1640 STORE_NUMERIC_LOCAL_SET_STANDARD();
57def98f 1641 /* %Vg doesn't work? --jhi */
cf2093f6 1642#ifdef USE_LONG_DOUBLE
2d4389e4 1643 Perl_dump_indent(aTHX_ level, file, " NV = %.*" PERL_PRIgldbl "\n", LDBL_DIG, SvNVX(sv));
cf2093f6 1644#else
cea2e8a9 1645 Perl_dump_indent(aTHX_ level, file, " NV = %.*g\n", DBL_DIG, SvNVX(sv));
cf2093f6 1646#endif
e54dc35b 1647 RESTORE_NUMERIC_LOCAL();
3967c732 1648 }
e0bbf362 1649
3967c732 1650 if (SvROK(sv)) {
57def98f 1651 Perl_dump_indent(aTHX_ level, file, " RV = 0x%"UVxf"\n", PTR2UV(SvRV(sv)));
3967c732
JD
1652 if (nest < maxnest)
1653 do_sv_dump(level+1, file, SvRV(sv), nest+1, maxnest, dumpops, pvlim);
3967c732 1654 }
e0bbf362 1655
cea89e20 1656 if (type < SVt_PV) {
5f954473 1657 SvREFCNT_dec_NN(d);
3967c732 1658 return;
cea89e20 1659 }
e0bbf362 1660
dea823b3 1661 if (type <= SVt_PVLV && !isGV_with_GP(sv)) {
8d919b0a
FC
1662 const bool re = isREGEXP(sv);
1663 const char * const ptr =
1664 re ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
1665 if (ptr) {
69240efd 1666 STRLEN delta;
7a4bba22 1667 if (SvOOK(sv)) {
69240efd 1668 SvOOK_offset(sv, delta);
7a4bba22 1669 Perl_dump_indent(aTHX_ level, file," OFFSET = %"UVuf"\n",
5186cc12 1670 (UV) delta);
69240efd
NC
1671 } else {
1672 delta = 0;
7a4bba22 1673 }
8d919b0a 1674 Perl_dump_indent(aTHX_ level, file," PV = 0x%"UVxf" ", PTR2UV(ptr));
7a4bba22
NC
1675 if (SvOOK(sv)) {
1676 PerlIO_printf(file, "( %s . ) ",
8d919b0a 1677 pv_display(d, ptr - delta, delta, 0,
7a4bba22
NC
1678 pvlim));
1679 }
8d919b0a
FC
1680 PerlIO_printf(file, "%s", pv_display(d, ptr, SvCUR(sv),
1681 re ? 0 : SvLEN(sv),
1682 pvlim));
e9569a7a
GG
1683 if (SvUTF8(sv)) /* the 6? \x{....} */
1684 PerlIO_printf(file, " [UTF8 \"%s\"]", sv_uni_display(d, sv, 6 * SvCUR(sv), UNI_DISPLAY_QQ));
e6abe6d8 1685 PerlIO_printf(file, "\n");
57def98f 1686 Perl_dump_indent(aTHX_ level, file, " CUR = %"IVdf"\n", (IV)SvCUR(sv));
8d919b0a
FC
1687 if (!re)
1688 Perl_dump_indent(aTHX_ level, file, " LEN = %"IVdf"\n",
1689 (IV)SvLEN(sv));
db2c6cb3
FC
1690#ifdef PERL_NEW_COPY_ON_WRITE
1691 if (SvIsCOW(sv) && SvLEN(sv))
1692 Perl_dump_indent(aTHX_ level, file, " COW_REFCNT = %d\n",
1693 CowREFCNT(sv));
1694#endif
3967c732
JD
1695 }
1696 else
cea2e8a9 1697 Perl_dump_indent(aTHX_ level, file, " PV = 0\n");
3967c732 1698 }
e0bbf362 1699
3967c732 1700 if (type >= SVt_PVMG) {
0e4c4423 1701 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
61f9802b 1702 HV * const ost = SvOURSTASH(sv);
38cbaf55
RGS
1703 if (ost)
1704 do_hv_dump(level, file, " OURSTASH", ost);
0e4c4423
NC
1705 } else {
1706 if (SvMAGIC(sv))
8530ff28 1707 do_magic_dump(level, file, SvMAGIC(sv), nest+1, maxnest, dumpops, pvlim);
0e4c4423 1708 }
3967c732
JD
1709 if (SvSTASH(sv))
1710 do_hv_dump(level, file, " STASH", SvSTASH(sv));
c13a5c80
NC
1711
1712 if ((type == SVt_PVMG || type == SVt_PVLV) && SvVALID(sv)) {
1713 Perl_dump_indent(aTHX_ level, file, " RARE = %u\n", (U8)BmRARE(sv));
1714 Perl_dump_indent(aTHX_ level, file, " PREVIOUS = %"UVuf"\n", (UV)BmPREVIOUS(sv));
1715 Perl_dump_indent(aTHX_ level, file, " USEFUL = %"IVdf"\n", (IV)BmUSEFUL(sv));
1716 }
3967c732 1717 }
e0bbf362
DM
1718
1719 /* Dump type-specific SV fields */
1720
3967c732 1721 switch (type) {
3967c732 1722 case SVt_PVAV:
57def98f 1723 Perl_dump_indent(aTHX_ level, file, " ARRAY = 0x%"UVxf, PTR2UV(AvARRAY(sv)));
3967c732 1724 if (AvARRAY(sv) != AvALLOC(sv)) {
57def98f
JH
1725 PerlIO_printf(file, " (offset=%"IVdf")\n", (IV)(AvARRAY(sv) - AvALLOC(sv)));
1726 Perl_dump_indent(aTHX_ level, file, " ALLOC = 0x%"UVxf"\n", PTR2UV(AvALLOC(sv)));
3967c732
JD
1727 }
1728 else
1729 PerlIO_putc(file, '\n');
57def98f
JH
1730 Perl_dump_indent(aTHX_ level, file, " FILL = %"IVdf"\n", (IV)AvFILLp(sv));
1731 Perl_dump_indent(aTHX_ level, file, " MAX = %"IVdf"\n", (IV)AvMAX(sv));
a3874608 1732 Perl_dump_indent(aTHX_ level, file, " ARYLEN = 0x%"UVxf"\n", SvMAGIC(sv) ? PTR2UV(AvARYLEN(sv)) : 0);
76f68e9b 1733 sv_setpvs(d, "");
11ca45c0
NC
1734 if (AvREAL(sv)) sv_catpv(d, ",REAL");
1735 if (AvREIFY(sv)) sv_catpv(d, ",REIFY");
b15aece3
SP
1736 Perl_dump_indent(aTHX_ level, file, " FLAGS = (%s)\n",
1737 SvCUR(d) ? SvPVX_const(d) + 1 : "");
502c6561 1738 if (nest < maxnest && av_len(MUTABLE_AV(sv)) >= 0) {
3967c732 1739 int count;
502c6561
NC
1740 for (count = 0; count <= av_len(MUTABLE_AV(sv)) && count < maxnest; count++) {
1741 SV** const elt = av_fetch(MUTABLE_AV(sv),count,0);
3967c732 1742
57def98f 1743 Perl_dump_indent(aTHX_ level + 1, file, "Elt No. %"IVdf"\n", (IV)count);
2ef28da1 1744 if (elt)
3967c732
JD
1745 do_sv_dump(level+1, file, *elt, nest+1, maxnest, dumpops, pvlim);
1746 }
1747 }
1748 break;
1749 case SVt_PVHV:
57def98f 1750 Perl_dump_indent(aTHX_ level, file, " ARRAY = 0x%"UVxf, PTR2UV(HvARRAY(sv)));
1b95d04f 1751 if (HvARRAY(sv) && HvUSEDKEYS(sv)) {
3967c732
JD
1752 /* Show distribution of HEs in the ARRAY */
1753 int freq[200];
bb7a0f54 1754#define FREQ_MAX ((int)(sizeof freq / sizeof freq[0] - 1))
3967c732
JD
1755 int i;
1756 int max = 0;
1b95d04f 1757 U32 pow2 = 2, keys = HvUSEDKEYS(sv);
65202027 1758 NV theoret, sum = 0;
3967c732
JD
1759
1760 PerlIO_printf(file, " (");
1761 Zero(freq, FREQ_MAX + 1, int);
eb160463 1762 for (i = 0; (STRLEN)i <= HvMAX(sv); i++) {
c445ea15
AL
1763 HE* h;
1764 int count = 0;
3967c732
JD
1765 for (h = HvARRAY(sv)[i]; h; h = HeNEXT(h))
1766 count++;
1767 if (count > FREQ_MAX)
1768 count = FREQ_MAX;
1769 freq[count]++;
1770 if (max < count)
1771 max = count;
1772 }
1773 for (i = 0; i <= max; i++) {
1774 if (freq[i]) {
1775 PerlIO_printf(file, "%d%s:%d", i,
1776 (i == FREQ_MAX) ? "+" : "",
1777 freq[i]);
1778 if (i != max)
1779 PerlIO_printf(file, ", ");
1780 }
1781 }
1782 PerlIO_putc(file, ')');
b8fa94d8
MG
1783 /* The "quality" of a hash is defined as the total number of
1784 comparisons needed to access every element once, relative
1785 to the expected number needed for a random hash.
1786
1787 The total number of comparisons is equal to the sum of
e76cd0fa
AMS
1788 the squares of the number of entries in each bucket.
1789 For a random hash of n keys into k buckets, the expected
b8fa94d8
MG
1790 value is
1791 n + n(n-1)/2k
1792 */
1793
3967c732
JD
1794 for (i = max; i > 0; i--) { /* Precision: count down. */
1795 sum += freq[i] * i * i;
1796 }
155aba94 1797 while ((keys = keys >> 1))
3967c732 1798 pow2 = pow2 << 1;
1b95d04f 1799 theoret = HvUSEDKEYS(sv);
b8fa94d8 1800 theoret += theoret * (theoret-1)/pow2;
3967c732 1801 PerlIO_putc(file, '\n');
6b4667fc 1802 Perl_dump_indent(aTHX_ level, file, " hash quality = %.1"NVff"%%", theoret/sum*100);
3967c732
JD
1803 }
1804 PerlIO_putc(file, '\n');
1b95d04f 1805 Perl_dump_indent(aTHX_ level, file, " KEYS = %"IVdf"\n", (IV)HvUSEDKEYS(sv));
57def98f
JH
1806 Perl_dump_indent(aTHX_ level, file, " FILL = %"IVdf"\n", (IV)HvFILL(sv));
1807 Perl_dump_indent(aTHX_ level, file, " MAX = %"IVdf"\n", (IV)HvMAX(sv));
e1a7ec8d
YO
1808 if (SvOOK(sv)) {
1809 Perl_dump_indent(aTHX_ level, file, " RITER = %"IVdf"\n", (IV)HvRITER_get(sv));
1810 Perl_dump_indent(aTHX_ level, file, " EITER = 0x%"UVxf"\n", PTR2UV(HvEITER_get(sv)));
1811 Perl_dump_indent(aTHX_ level, file, " RAND = 0x%"UVxf, (UV)HvRAND_get(sv));
1812 if (HvRAND_get(sv) != HvLASTRAND_get(sv) && HvRITER_get(sv) != -1 ) {
1813 PerlIO_printf(file, " (LAST = 0x%"UVxf")\n", (UV)HvLASTRAND_get(sv));
1814 } else {
1815 PerlIO_putc(file, '\n');
1816 }
1817 }
8d2f4536 1818 {
b9ac451d 1819 MAGIC * const mg = mg_find(sv, PERL_MAGIC_symtab);
8d2f4536
NC
1820 if (mg && mg->mg_obj) {
1821 Perl_dump_indent(aTHX_ level, file, " PMROOT = 0x%"UVxf"\n", PTR2UV(mg->mg_obj));
1822 }
1823 }
bfcb3514 1824 {
b9ac451d 1825 const char * const hvname = HvNAME_get(sv);
17605be7
DM
1826 if (hvname)
1827 Perl_dump_indent(aTHX_ level, file, " NAME = \"%s\"\n", hvname);
bfcb3514 1828 }
86f55936 1829 if (SvOOK(sv)) {
ad64d0ec 1830 AV * const backrefs
85fbaab2 1831 = *Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(sv));
7d88e6c4 1832 struct mro_meta * const meta = HvAUX(sv)->xhv_mro_meta;
67e04715
FC
1833 if (HvAUX(sv)->xhv_name_count)
1834 Perl_dump_indent(aTHX_
7afc2217
FC
1835 level, file, " NAMECOUNT = %"IVdf"\n",
1836 (IV)HvAUX(sv)->xhv_name_count
67e04715 1837 );
15d9236d 1838 if (HvAUX(sv)->xhv_name_u.xhvnameu_name && HvENAME_HEK_NN(sv)) {
ec3405c8
NC
1839 const I32 count = HvAUX(sv)->xhv_name_count;
1840 if (count) {
1841 SV * const names = newSVpvs_flags("", SVs_TEMP);
1842 /* The starting point is the first element if count is
1843 positive and the second element if count is negative. */
1844 HEK *const *hekp = HvAUX(sv)->xhv_name_u.xhvnameu_names
1845 + (count < 0 ? 1 : 0);
1846 HEK *const *const endp = HvAUX(sv)->xhv_name_u.xhvnameu_names
1847 + (count < 0 ? -count : count);
1848 while (hekp < endp) {
17605be7
DM
1849 if (*hekp) {
1850 sv_catpvs(names, ", \"");
1851 sv_catpvn(names, HEK_KEY(*hekp), HEK_LEN(*hekp));
1852 sv_catpvs(names, "\"");
ec3405c8
NC
1853 } else {
1854 /* This should never happen. */
1855 sv_catpvs(names, ", (null)");
67e04715 1856 }
ec3405c8
NC
1857 ++hekp;
1858 }
67e04715
FC
1859 Perl_dump_indent(aTHX_
1860 level, file, " ENAME = %s\n", SvPV_nolen(names)+2
1861 );
1862 }
17605be7 1863 else
67e04715 1864 Perl_dump_indent(aTHX_
17605be7
DM
1865 level, file, " ENAME = \"%s\"\n", HvENAME_get(sv)
1866 );
67e04715 1867 }
86f55936
NC
1868 if (backrefs) {
1869 Perl_dump_indent(aTHX_ level, file, " BACKREFS = 0x%"UVxf"\n",
1870 PTR2UV(backrefs));
ad64d0ec 1871 do_sv_dump(level+1, file, MUTABLE_SV(backrefs), nest+1, maxnest,
86f55936
NC
1872 dumpops, pvlim);
1873 }
7d88e6c4
NC
1874 if (meta) {
1875 /* FIXME - mro_algs kflags can signal a UTF-8 name. */
1876 Perl_dump_indent(aTHX_ level, file, " MRO_WHICH = \"%.*s\" (0x%"UVxf")\n",
1877 (int)meta->mro_which->length,
1878 meta->mro_which->name,
1879 PTR2UV(meta->mro_which));
1880 Perl_dump_indent(aTHX_ level, file, " CACHE_GEN = 0x%"UVxf"\n",
1881 (UV)meta->cache_gen);
1882 Perl_dump_indent(aTHX_ level, file, " PKG_GEN = 0x%"UVxf"\n",
1883 (UV)meta->pkg_gen);
1884 if (meta->mro_linear_all) {
1885 Perl_dump_indent(aTHX_ level, file, " MRO_LINEAR_ALL = 0x%"UVxf"\n",
1886 PTR2UV(meta->mro_linear_all));
1887 do_sv_dump(level+1, file, MUTABLE_SV(meta->mro_linear_all), nest+1, maxnest,
1888 dumpops, pvlim);
1889 }
1890 if (meta->mro_linear_current) {
1891 Perl_dump_indent(aTHX_ level, file, " MRO_LINEAR_CURRENT = 0x%"UVxf"\n",
1892 PTR2UV(meta->mro_linear_current));
1893 do_sv_dump(level+1, file, MUTABLE_SV(meta->mro_linear_current), nest+1, maxnest,
1894 dumpops, pvlim);
1895 }
1896 if (meta->mro_nextmethod) {
1897 Perl_dump_indent(aTHX_ level, file, " MRO_NEXTMETHOD = 0x%"UVxf"\n",
1898 PTR2UV(meta->mro_nextmethod));
1899 do_sv_dump(level+1, file, MUTABLE_SV(meta->mro_nextmethod), nest+1, maxnest,
1900 dumpops, pvlim);
1901 }
1902 if (meta->isa) {
1903 Perl_dump_indent(aTHX_ level, file, " ISA = 0x%"UVxf"\n",
1904 PTR2UV(meta->isa));
1905 do_sv_dump(level+1, file, MUTABLE_SV(meta->isa), nest+1, maxnest,
1906 dumpops, pvlim);
1907 }
1908 }
86f55936 1909 }
b5698553 1910 if (nest < maxnest) {
cbab3169 1911 HV * const hv = MUTABLE_HV(sv);
b5698553
TH
1912 STRLEN i;
1913 HE *he;
cbab3169 1914
b5698553
TH
1915 if (HvARRAY(hv)) {
1916 int count = maxnest - nest;
1917 for (i=0; i <= HvMAX(hv); i++) {
1918 for (he = HvARRAY(hv)[i]; he; he = HeNEXT(he)) {
1919 U32 hash;
1920 SV * keysv;
1921 const char * keypv;
1922 SV * elt;
7dc86639 1923 STRLEN len;
b5698553
TH
1924
1925 if (count-- <= 0) goto DONEHV;
1926
1927 hash = HeHASH(he);
1928 keysv = hv_iterkeysv(he);
1929 keypv = SvPV_const(keysv, len);
1930 elt = HeVAL(he);
cbab3169 1931
7dc86639
YO
1932 Perl_dump_indent(aTHX_ level+1, file, "Elt %s ", pv_display(d, keypv, len, 0, pvlim));
1933 if (SvUTF8(keysv))
1934 PerlIO_printf(file, "[UTF8 \"%s\"] ", sv_uni_display(d, keysv, 6 * SvCUR(keysv), UNI_DISPLAY_QQ));
b5698553
TH
1935 if (HvEITER_get(hv) == he)
1936 PerlIO_printf(file, "[CURRENT] ");
7dc86639
YO
1937 PerlIO_printf(file, "HASH = 0x%"UVxf"\n", (UV) hash);
1938 do_sv_dump(level+1, file, elt, nest+1, maxnest, dumpops, pvlim);
1939 }
b5698553
TH
1940 }
1941 DONEHV:;
1942 }
3967c732
JD
1943 }
1944 break;
e0bbf362 1945
3967c732 1946 case SVt_PVCV:
8fa6a409 1947 if (CvAUTOLOAD(sv)) {
cbf82dd0 1948 STRLEN len;
8fa6a409
FC
1949 const char *const name = SvPV_const(sv, len);
1950 Perl_dump_indent(aTHX_ level, file, " AUTOLOAD = \"%.*s\"\n",
1951 (int) len, name);
1952 }
1953 if (SvPOK(sv)) {
cbf82dd0 1954 Perl_dump_indent(aTHX_ level, file, " PROTOTYPE = \"%.*s\"\n",
8fa6a409 1955 (int) CvPROTOLEN(sv), CvPROTO(sv));
cbf82dd0 1956 }
3967c732
JD
1957 /* FALL THROUGH */
1958 case SVt_PVFM:
1959 do_hv_dump(level, file, " COMP_STASH", CvSTASH(sv));
d04ba589
NC
1960 if (!CvISXSUB(sv)) {
1961 if (CvSTART(sv)) {
1962 Perl_dump_indent(aTHX_ level, file,
1963 " START = 0x%"UVxf" ===> %"IVdf"\n",
1964 PTR2UV(CvSTART(sv)),
1965 (IV)sequence_num(CvSTART(sv)));
1966 }
1967 Perl_dump_indent(aTHX_ level, file, " ROOT = 0x%"UVxf"\n",
1968 PTR2UV(CvROOT(sv)));
1969 if (CvROOT(sv) && dumpops) {
1970 do_op_dump(level+1, file, CvROOT(sv));
1971 }
1972 } else {
126f53f3 1973 SV * const constant = cv_const_sv((const CV *)sv);
b1886099 1974
d04ba589 1975 Perl_dump_indent(aTHX_ level, file, " XSUB = 0x%"UVxf"\n", PTR2UV(CvXSUB(sv)));
b1886099
NC
1976
1977 if (constant) {
1978 Perl_dump_indent(aTHX_ level, file, " XSUBANY = 0x%"UVxf
1979 " (CONST SV)\n",
1980 PTR2UV(CvXSUBANY(sv).any_ptr));
1981 do_sv_dump(level+1, file, constant, nest+1, maxnest, dumpops,
1982 pvlim);
1983 } else {
1984 Perl_dump_indent(aTHX_ level, file, " XSUBANY = %"IVdf"\n",
1985 (IV)CvXSUBANY(sv).any_i32);
1986 }
1987 }
3610c89f
FC
1988 if (CvNAMED(sv))
1989 Perl_dump_indent(aTHX_ level, file, " NAME = \"%s\"\n",
1990 HEK_KEY(CvNAME_HEK((CV *)sv)));
1991 else do_gvgv_dump(level, file, " GVGV::GV", CvGV(sv));
57843af0 1992 Perl_dump_indent(aTHX_ level, file, " FILE = \"%s\"\n", CvFILE(sv));
bb02a38f 1993 Perl_dump_indent(aTHX_ level, file, " DEPTH = %"IVdf"\n", (IV)CvDEPTH(sv));
894356b3 1994 Perl_dump_indent(aTHX_ level, file, " FLAGS = 0x%"UVxf"\n", (UV)CvFLAGS(sv));
a3985cdc 1995 Perl_dump_indent(aTHX_ level, file, " OUTSIDE_SEQ = %"UVuf"\n", (UV)CvOUTSIDE_SEQ(sv));
57def98f 1996 Perl_dump_indent(aTHX_ level, file, " PADLIST = 0x%"UVxf"\n", PTR2UV(CvPADLIST(sv)));
dd2155a4
DM
1997 if (nest < maxnest) {
1998 do_dump_pad(level+1, file, CvPADLIST(sv), 0);
3967c732
JD
1999 }
2000 {
b9ac451d 2001 const CV * const outside = CvOUTSIDE(sv);
2ef28da1 2002 Perl_dump_indent(aTHX_ level, file, " OUTSIDE = 0x%"UVxf" (%s)\n",
57def98f 2003 PTR2UV(outside),
cf2093f6
JH
2004 (!outside ? "null"
2005 : CvANON(outside) ? "ANON"
2006 : (outside == PL_main_cv) ? "MAIN"
2007 : CvUNIQUE(outside) ? "UNIQUE"
2008 : CvGV(outside) ? GvNAME(CvGV(outside)) : "UNDEFINED"));
3967c732
JD
2009 }
2010 if (nest < maxnest && (CvCLONE(sv) || CvCLONED(sv)))
ad64d0ec 2011 do_sv_dump(level+1, file, MUTABLE_SV(CvOUTSIDE(sv)), nest+1, maxnest, dumpops, pvlim);
3967c732 2012 break;
e0bbf362 2013
926fc7b6
DM
2014 case SVt_PVGV:
2015 case SVt_PVLV:
b9ac451d
AL
2016 if (type == SVt_PVLV) {
2017 Perl_dump_indent(aTHX_ level, file, " TYPE = %c\n", LvTYPE(sv));
2018 Perl_dump_indent(aTHX_ level, file, " TARGOFF = %"IVdf"\n", (IV)LvTARGOFF(sv));
2019 Perl_dump_indent(aTHX_ level, file, " TARGLEN = %"IVdf"\n", (IV)LvTARGLEN(sv));
2020 Perl_dump_indent(aTHX_ level, file, " TARG = 0x%"UVxf"\n", PTR2UV(LvTARG(sv)));
83f78d1a 2021 Perl_dump_indent(aTHX_ level, file, " FLAGS = %"IVdf"\n", (IV)LvFLAGS(sv));
b9ac451d
AL
2022 if (LvTYPE(sv) != 't' && LvTYPE(sv) != 'T')
2023 do_sv_dump(level+1, file, LvTARG(sv), nest+1, maxnest,
2024 dumpops, pvlim);
2025 }
8d919b0a 2026 if (isREGEXP(sv)) goto dumpregexp;
926fc7b6
DM
2027 if (!isGV_with_GP(sv))
2028 break;
cea2e8a9 2029 Perl_dump_indent(aTHX_ level, file, " NAME = \"%s\"\n", GvNAME(sv));
57def98f 2030 Perl_dump_indent(aTHX_ level, file, " NAMELEN = %"IVdf"\n", (IV)GvNAMELEN(sv));
3967c732 2031 do_hv_dump (level, file, " GvSTASH", GvSTASH(sv));
57def98f 2032 Perl_dump_indent(aTHX_ level, file, " GP = 0x%"UVxf"\n", PTR2UV(GvGP(sv)));
f472eb5c
GS
2033 if (!GvGP(sv))
2034 break;
57def98f
JH
2035 Perl_dump_indent(aTHX_ level, file, " SV = 0x%"UVxf"\n", PTR2UV(GvSV(sv)));
2036 Perl_dump_indent(aTHX_ level, file, " REFCNT = %"IVdf"\n", (IV)GvREFCNT(sv));
2037 Perl_dump_indent(aTHX_ level, file, " IO = 0x%"UVxf"\n", PTR2UV(GvIOp(sv)));
2038 Perl_dump_indent(aTHX_ level, file, " FORM = 0x%"UVxf" \n", PTR2UV(GvFORM(sv)));
2039 Perl_dump_indent(aTHX_ level, file, " AV = 0x%"UVxf"\n", PTR2UV(GvAV(sv)));
2040 Perl_dump_indent(aTHX_ level, file, " HV = 0x%"UVxf"\n", PTR2UV(GvHV(sv)));
2041 Perl_dump_indent(aTHX_ level, file, " CV = 0x%"UVxf"\n", PTR2UV(GvCV(sv)));
2042 Perl_dump_indent(aTHX_ level, file, " CVGEN = 0x%"UVxf"\n", (UV)GvCVGEN(sv));
57def98f 2043 Perl_dump_indent(aTHX_ level, file, " LINE = %"IVdf"\n", (IV)GvLINE(sv));
b195d487 2044 Perl_dump_indent(aTHX_ level, file, " FILE = \"%s\"\n", GvFILE(sv));
e39917cc 2045 Perl_dump_indent(aTHX_ level, file, " FLAGS = 0x%"UVxf"\n", (UV)GvFLAGS(sv));
3967c732
JD
2046 do_gv_dump (level, file, " EGV", GvEGV(sv));
2047 break;
2048 case SVt_PVIO:
57def98f
JH
2049 Perl_dump_indent(aTHX_ level, file, " IFP = 0x%"UVxf"\n", PTR2UV(IoIFP(sv)));
2050 Perl_dump_indent(aTHX_ level, file, " OFP = 0x%"UVxf"\n", PTR2UV(IoOFP(sv)));
2051 Perl_dump_indent(aTHX_ level, file, " DIRP = 0x%"UVxf"\n", PTR2UV(IoDIRP(sv)));
2052 Perl_dump_indent(aTHX_ level, file, " LINES = %"IVdf"\n", (IV)IoLINES(sv));
2053 Perl_dump_indent(aTHX_ level, file, " PAGE = %"IVdf"\n", (IV)IoPAGE(sv));
2054 Perl_dump_indent(aTHX_ level, file, " PAGE_LEN = %"IVdf"\n", (IV)IoPAGE_LEN(sv));
2055 Perl_dump_indent(aTHX_ level, file, " LINES_LEFT = %"IVdf"\n", (IV)IoLINES_LEFT(sv));
27533608 2056 if (IoTOP_NAME(sv))
cea2e8a9 2057 Perl_dump_indent(aTHX_ level, file, " TOP_NAME = \"%s\"\n", IoTOP_NAME(sv));
9ba1f565
NC
2058 if (!IoTOP_GV(sv) || SvTYPE(IoTOP_GV(sv)) == SVt_PVGV)
2059 do_gv_dump (level, file, " TOP_GV", IoTOP_GV(sv));
2060 else {
2061 Perl_dump_indent(aTHX_ level, file, " TOP_GV = 0x%"UVxf"\n",
2062 PTR2UV(IoTOP_GV(sv)));
ad64d0ec
NC
2063 do_sv_dump (level+1, file, MUTABLE_SV(IoTOP_GV(sv)), nest+1,
2064 maxnest, dumpops, pvlim);
9ba1f565
NC
2065 }
2066 /* Source filters hide things that are not GVs in these three, so let's
2067 be careful out there. */
27533608 2068 if (IoFMT_NAME(sv))
cea2e8a9 2069 Perl_dump_indent(aTHX_ level, file, " FMT_NAME = \"%s\"\n", IoFMT_NAME(sv));
9ba1f565
NC
2070 if (!IoFMT_GV(sv) || SvTYPE(IoFMT_GV(sv)) == SVt_PVGV)
2071 do_gv_dump (level, file, " FMT_GV", IoFMT_GV(sv));
2072 else {
2073 Perl_dump_indent(aTHX_ level, file, " FMT_GV = 0x%"UVxf"\n",
2074 PTR2UV(IoFMT_GV(sv)));
ad64d0ec
NC
2075 do_sv_dump (level+1, file, MUTABLE_SV(IoFMT_GV(sv)), nest+1,
2076 maxnest, dumpops, pvlim);
9ba1f565 2077 }
27533608 2078 if (IoBOTTOM_NAME(sv))
cea2e8a9 2079 Perl_dump_indent(aTHX_ level, file, " BOTTOM_NAME = \"%s\"\n", IoBOTTOM_NAME(sv));
9ba1f565
NC
2080 if (!IoBOTTOM_GV(sv) || SvTYPE(IoBOTTOM_GV(sv)) == SVt_PVGV)
2081 do_gv_dump (level, file, " BOTTOM_GV", IoBOTTOM_GV(sv));
2082 else {
2083 Perl_dump_indent(aTHX_ level, file, " BOTTOM_GV = 0x%"UVxf"\n",
2084 PTR2UV(IoBOTTOM_GV(sv)));
ad64d0ec
NC
2085 do_sv_dump (level+1, file, MUTABLE_SV(IoBOTTOM_GV(sv)), nest+1,
2086 maxnest, dumpops, pvlim);
9ba1f565 2087 }
27533608 2088 if (isPRINT(IoTYPE(sv)))
cea2e8a9 2089 Perl_dump_indent(aTHX_ level, file, " TYPE = '%c'\n", IoTYPE(sv));
27533608 2090 else
cea2e8a9 2091 Perl_dump_indent(aTHX_ level, file, " TYPE = '\\%o'\n", IoTYPE(sv));
57def98f 2092 Perl_dump_indent(aTHX_ level, file, " FLAGS = 0x%"UVxf"\n", (UV)IoFLAGS(sv));
3967c732 2093 break;
206ee256 2094 case SVt_REGEXP:
8d919b0a 2095 dumpregexp:
d63e6659 2096 {
8d919b0a 2097 struct regexp * const r = ReANY((REGEXP*)sv);
ec16d31f
YO
2098#define SV_SET_STRINGIFY_REGEXP_FLAGS(d,flags) STMT_START { \
2099 sv_setpv(d,""); \
2100 append_flags(d, flags, regexp_flags_names); \
2101 if (SvCUR(d) > 0 && *(SvEND(d) - 1) == ',') { \
2102 SvCUR_set(d, SvCUR(d) - 1); \
2103 SvPVX(d)[SvCUR(d)] = '\0'; \
2104 } \
2105} STMT_END
2106 SV_SET_STRINGIFY_REGEXP_FLAGS(d,r->compflags);
dbc200c5
YO
2107 Perl_dump_indent(aTHX_ level, file, " COMPFLAGS = 0x%"UVxf" (%s)\n",
2108 (UV)(r->compflags), SvPVX_const(d));
2109
ec16d31f 2110 SV_SET_STRINGIFY_REGEXP_FLAGS(d,r->extflags);
d63e6659 2111 Perl_dump_indent(aTHX_ level, file, " EXTFLAGS = 0x%"UVxf" (%s)\n",
dbc200c5 2112 (UV)(r->extflags), SvPVX_const(d));
ec16d31f 2113#undef SV_SET_STRINGIFY_REGEXP_FLAGS
dbc200c5 2114
d63e6659
DM
2115 Perl_dump_indent(aTHX_ level, file, " INTFLAGS = 0x%"UVxf"\n",
2116 (UV)(r->intflags));
2117 Perl_dump_indent(aTHX_ level, file, " NPARENS = %"UVuf"\n",
2118 (UV)(r->nparens));
2119 Perl_dump_indent(aTHX_ level, file, " LASTPAREN = %"UVuf"\n",
2120 (UV)(r->lastparen));
2121 Perl_dump_indent(aTHX_ level, file, " LASTCLOSEPAREN = %"UVuf"\n",
2122 (UV)(r->lastcloseparen));
2123 Perl_dump_indent(aTHX_ level, file, " MINLEN = %"IVdf"\n",
2124 (IV)(r->minlen));
2125 Perl_dump_indent(aTHX_ level, file, " MINLENRET = %"IVdf"\n",
2126 (IV)(r->minlenret));
2127 Perl_dump_indent(aTHX_ level, file, " GOFS = %"UVuf"\n",
2128 (UV)(r->gofs));
2129 Perl_dump_indent(aTHX_ level, file, " PRE_PREFIX = %"UVuf"\n",
2130 (UV)(r->pre_prefix));
d63e6659
DM
2131 Perl_dump_indent(aTHX_ level, file, " SUBLEN = %"IVdf"\n",
2132 (IV)(r->sublen));
6502e081
DM
2133 Perl_dump_indent(aTHX_ level, file, " SUBOFFSET = %"IVdf"\n",
2134 (IV)(r->suboffset));
2135 Perl_dump_indent(aTHX_ level, file, " SUBCOFFSET = %"IVdf"\n",
2136 (IV)(r->subcoffset));
d63e6659
DM
2137 if (r->subbeg)
2138 Perl_dump_indent(aTHX_ level, file, " SUBBEG = 0x%"UVxf" %s\n",
2139 PTR2UV(r->subbeg),
2140 pv_display(d, r->subbeg, r->sublen, 50, pvlim));
2141 else
2142 Perl_dump_indent(aTHX_ level, file, " SUBBEG = 0x0\n");
2143 Perl_dump_indent(aTHX_ level, file, " ENGINE = 0x%"UVxf"\n",
2144 PTR2UV(r->engine));
2145 Perl_dump_indent(aTHX_ level, file, " MOTHER_RE = 0x%"UVxf"\n",
2146 PTR2UV(r->mother_re));
2147 Perl_dump_indent(aTHX_ level, file, " PAREN_NAMES = 0x%"UVxf"\n",
2148 PTR2UV(r->paren_names));
2149 Perl_dump_indent(aTHX_ level, file, " SUBSTRS = 0x%"UVxf"\n",
2150 PTR2UV(r->substrs));
2151 Perl_dump_indent(aTHX_ level, file, " PPRIVATE = 0x%"UVxf"\n",
2152 PTR2UV(r->pprivate));
2153 Perl_dump_indent(aTHX_ level, file, " OFFS = 0x%"UVxf"\n",
2154 PTR2UV(r->offs));
d63c20f2
DM
2155 Perl_dump_indent(aTHX_ level, file, " QR_ANONCV = 0x%"UVxf"\n",
2156 PTR2UV(r->qr_anoncv));
db2c6cb3 2157#ifdef PERL_ANY_COW
d63e6659
DM
2158 Perl_dump_indent(aTHX_ level, file, " SAVED_COPY = 0x%"UVxf"\n",
2159 PTR2UV(r->saved_copy));
2160#endif
2161 }
206ee256 2162 break;
3967c732 2163 }
5f954473 2164 SvREFCNT_dec_NN(d);
3967c732
JD
2165}
2166
2167void
864dbfa3 2168Perl_sv_dump(pTHX_ SV *sv)
3967c732 2169{
97aff369 2170 dVAR;
7918f24d
NC
2171
2172 PERL_ARGS_ASSERT_SV_DUMP;
2173
d1029faa
JP
2174 if (SvROK(sv))
2175 do_sv_dump(0, Perl_debug_log, sv, 0, 4, 0, 0);
2176 else
2177 do_sv_dump(0, Perl_debug_log, sv, 0, 0, 0, 0);
8d063cd8 2178}
bd16a5f0
IZ
2179
2180int
2181Perl_runops_debug(pTHX)
2182{
97aff369 2183 dVAR;
bd16a5f0 2184 if (!PL_op) {
9b387841 2185 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING), "NULL OP IN RUN");
bd16a5f0
IZ
2186 return 0;
2187 }
2188
9f3673fb 2189 DEBUG_l(Perl_deb(aTHX_ "Entering new RUNOPS level\n"));
bd16a5f0 2190 do {
bd16a5f0 2191 if (PL_debug) {
b9ac451d 2192 if (PL_watchaddr && (*PL_watchaddr != PL_watchok))
bd16a5f0
IZ
2193 PerlIO_printf(Perl_debug_log,
2194 "WARNING: %"UVxf" changed from %"UVxf" to %"UVxf"\n",
2195 PTR2UV(PL_watchaddr), PTR2UV(PL_watchok),
2196 PTR2UV(*PL_watchaddr));
d6721266
DM
2197 if (DEBUG_s_TEST_) {
2198 if (DEBUG_v_TEST_) {
2199 PerlIO_printf(Perl_debug_log, "\n");
2200 deb_stack_all();
2201 }
2202 else
2203 debstack();
2204 }
2205
2206
bd16a5f0
IZ
2207 if (DEBUG_t_TEST_) debop(PL_op);
2208 if (DEBUG_P_TEST_) debprof(PL_op);
2209 }
fe83c362
SM
2210
2211 OP_ENTRY_PROBE(OP_NAME(PL_op));
16c91539 2212 } while ((PL_op = PL_op->op_ppaddr(aTHX)));
9f3673fb 2213 DEBUG_l(Perl_deb(aTHX_ "leaving RUNOPS level\n"));
bd16a5f0
IZ
2214
2215 TAINT_NOT;
2216 return 0;
2217}
2218
2219I32
6867be6d 2220Perl_debop(pTHX_ const OP *o)
bd16a5f0 2221{
97aff369 2222 dVAR;
7918f24d
NC
2223
2224 PERL_ARGS_ASSERT_DEBOP;
2225
1045810a
IZ
2226 if (CopSTASH_eq(PL_curcop, PL_debstash) && !DEBUG_J_TEST_)
2227 return 0;
2228
bd16a5f0
IZ
2229 Perl_deb(aTHX_ "%s", OP_NAME(o));
2230 switch (o->op_type) {
2231 case OP_CONST:
996c9baa 2232 case OP_HINTSEVAL:
6cefa69e 2233 /* With ITHREADS, consts are stored in the pad, and the right pad
7367e658 2234 * may not be active here, so check.
6cefa69e 2235 * Looks like only during compiling the pads are illegal.
7367e658 2236 */
6cefa69e
RU
2237#ifdef USE_ITHREADS
2238 if ((((SVOP*)o)->op_sv) || !IN_PERL_COMPILETIME)
2239#endif
7367e658 2240 PerlIO_printf(Perl_debug_log, "(%s)", SvPEEK(cSVOPo_sv));
bd16a5f0
IZ
2241 break;
2242 case OP_GVSV:
2243 case OP_GV:
2244 if (cGVOPo_gv) {
b9ac451d 2245 SV * const sv = newSV(0);
3b721df9 2246#ifdef PERL_MAD
84021b46 2247 /* FIXME - is this making unwarranted assumptions about the
3b721df9
NC
2248 UTF-8 cleanliness of the dump file handle? */
2249 SvUTF8_on(sv);
2250#endif
bd61b366 2251 gv_fullname3(sv, cGVOPo_gv, NULL);
93524f2b 2252 PerlIO_printf(Perl_debug_log, "(%s)", SvPV_nolen_const(sv));
5f954473 2253 SvREFCNT_dec_NN(sv);
bd16a5f0
IZ
2254 }
2255 else
2256 PerlIO_printf(Perl_debug_log, "(NULL)");
2257 break;
a7fd8ef6
DM
2258
2259 {
2260 int count;
2261
bd16a5f0
IZ
2262 case OP_PADSV:
2263 case OP_PADAV:
2264 case OP_PADHV:
a7fd8ef6
DM
2265 count = 1;
2266 goto dump_padop;
2267 case OP_PADRANGE:
2268 count = o->op_private & OPpPADRANGE_COUNTMASK;
2269 dump_padop:
bd16a5f0 2270 /* print the lexical's name */
a7fd8ef6
DM
2271 {
2272 CV * const cv = deb_curcv(cxstack_ix);
2273 SV *sv;
2274 PAD * comppad = NULL;
2275 int i;
2276
2277 if (cv) {
2278 PADLIST * const padlist = CvPADLIST(cv);
2279 comppad = *PadlistARRAY(padlist);
2280 }
2281 PerlIO_printf(Perl_debug_log, "(");
2282 for (i = 0; i < count; i++) {
2283 if (comppad &&
2284 (sv = *av_fetch(comppad, o->op_targ + i, FALSE)))
2285 PerlIO_printf(Perl_debug_log, "%s", SvPV_nolen_const(sv));
2286 else
2287 PerlIO_printf(Perl_debug_log, "[%"UVuf"]",
2288 (UV)o->op_targ+i);
2289 if (i < count-1)
2290 PerlIO_printf(Perl_debug_log, ",");
2291 }
2292 PerlIO_printf(Perl_debug_log, ")");
2293 }
bd16a5f0 2294 break;
a7fd8ef6
DM
2295 }
2296
bd16a5f0 2297 default:
091ab601 2298 break;
bd16a5f0
IZ
2299 }
2300 PerlIO_printf(Perl_debug_log, "\n");
2301 return 0;
2302}
2303
2304STATIC CV*
61f9802b 2305S_deb_curcv(pTHX_ const I32 ix)
bd16a5f0 2306{
97aff369 2307 dVAR;
b9ac451d 2308 const PERL_CONTEXT * const cx = &cxstack[ix];
bd16a5f0
IZ
2309 if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)
2310 return cx->blk_sub.cv;
2311 else if (CxTYPE(cx) == CXt_EVAL && !CxTRYBLOCK(cx))
676a678a 2312 return cx->blk_eval.cv;
bd16a5f0
IZ
2313 else if (ix == 0 && PL_curstackinfo->si_type == PERLSI_MAIN)
2314 return PL_main_cv;
2315 else if (ix <= 0)
601f1833 2316 return NULL;
bd16a5f0
IZ
2317 else
2318 return deb_curcv(ix - 1);
2319}
2320
2321void
2322Perl_watch(pTHX_ char **addr)
2323{
97aff369 2324 dVAR;
7918f24d
NC
2325
2326 PERL_ARGS_ASSERT_WATCH;
2327
bd16a5f0
IZ
2328 PL_watchaddr = addr;
2329 PL_watchok = *addr;
2330 PerlIO_printf(Perl_debug_log, "WATCHING, %"UVxf" is currently %"UVxf"\n",
2331 PTR2UV(PL_watchaddr), PTR2UV(PL_watchok));
2332}
2333
2334STATIC void
e1ec3a88 2335S_debprof(pTHX_ const OP *o)
bd16a5f0 2336{
97aff369 2337 dVAR;
7918f24d
NC
2338
2339 PERL_ARGS_ASSERT_DEBPROF;
2340
61f9802b 2341 if (!DEBUG_J_TEST_ && CopSTASH_eq(PL_curcop, PL_debstash))
1045810a 2342 return;
bd16a5f0 2343 if (!PL_profiledata)
a02a5408 2344 Newxz(PL_profiledata, MAXO, U32);
bd16a5f0
IZ
2345 ++PL_profiledata[o->op_type];
2346}
2347
2348void
2349Perl_debprofdump(pTHX)
2350{
97aff369 2351 dVAR;
bd16a5f0
IZ
2352 unsigned i;
2353 if (!PL_profiledata)
2354 return;
2355 for (i = 0; i < MAXO; i++) {
2356 if (PL_profiledata[i])
2357 PerlIO_printf(Perl_debug_log,
2358 "%5lu %s\n", (unsigned long)PL_profiledata[i],
2359 PL_op_name[i]);
2360 }
2361}
66610fdd 2362
3b721df9
NC
2363#ifdef PERL_MAD
2364/*
2365 * XML variants of most of the above routines
2366 */
2367
4136a0f7 2368STATIC void
3b721df9
NC
2369S_xmldump_attr(pTHX_ I32 level, PerlIO *file, const char* pat, ...)
2370{
2371 va_list args;
7918f24d
NC
2372
2373 PERL_ARGS_ASSERT_XMLDUMP_ATTR;
2374
3b721df9
NC
2375 PerlIO_printf(file, "\n ");
2376 va_start(args, pat);
2377 xmldump_vindent(level, file, pat, &args);
2378 va_end(args);
2379}
2380
2381
2382void
2383Perl_xmldump_indent(pTHX_ I32 level, PerlIO *file, const char* pat, ...)
2384{
2385 va_list args;
7918f24d 2386 PERL_ARGS_ASSERT_XMLDUMP_INDENT;
3b721df9
NC
2387 va_start(args, pat);
2388 xmldump_vindent(level, file, pat, &args);
2389 va_end(args);
2390}
2391
2392void
2393Perl_xmldump_vindent(pTHX_ I32 level, PerlIO *file, const char* pat, va_list *args)
2394{
7918f24d
NC
2395 PERL_ARGS_ASSERT_XMLDUMP_VINDENT;
2396
3b721df9
NC
2397 PerlIO_printf(file, "%*s", (int)(level*PL_dumpindent), "");
2398 PerlIO_vprintf(file, pat, *args);
2399}
2400
2401void
2402Perl_xmldump_all(pTHX)
2403{
f0e3f042
CS
2404 xmldump_all_perl(FALSE);
2405}
2406
2407void
0190d5ef 2408Perl_xmldump_all_perl(pTHX_ bool justperl PERL_UNUSED_DECL)
f0e3f042 2409{
3b721df9
NC
2410 PerlIO_setlinebuf(PL_xmlfp);
2411 if (PL_main_root)
2412 op_xmldump(PL_main_root);
0190d5ef
CS
2413 /* someday we might call this, when it outputs XML: */
2414 /* xmldump_packsubs_perl(PL_defstash, justperl); */
3b721df9
NC
2415 if (PL_xmlfp != (PerlIO*)PerlIO_stdout())
2416 PerlIO_close(PL_xmlfp);
2417 PL_xmlfp = 0;
2418}
2419
2420void
2421Perl_xmldump_packsubs(pTHX_ const HV *stash)
2422{
28eb953d 2423 PERL_ARGS_ASSERT_XMLDUMP_PACKSUBS;
3ab0c9fa
NC
2424 xmldump_packsubs_perl(stash, FALSE);
2425}
2426
2427void
2428Perl_xmldump_packsubs_perl(pTHX_ const HV *stash, bool justperl)
2429{
3b721df9
NC
2430 I32 i;
2431 HE *entry;
2432
28eb953d 2433 PERL_ARGS_ASSERT_XMLDUMP_PACKSUBS_PERL;
7918f24d 2434
3b721df9
NC
2435 if (!HvARRAY(stash))
2436 return;
2437 for (i = 0; i <= (I32) HvMAX(stash); i++) {
2438 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
159b6efe 2439 GV *gv = MUTABLE_GV(HeVAL(entry));
3b721df9
NC
2440 HV *hv;
2441 if (SvTYPE(gv) != SVt_PVGV || !GvGP(gv))
2442 continue;
2443 if (GvCVu(gv))
3ab0c9fa 2444 xmldump_sub_perl(gv, justperl);
3b721df9
NC
2445 if (GvFORM(gv))
2446 xmldump_form(gv);
2447 if (HeKEY(entry)[HeKLEN(entry)-1] == ':'
2448 && (hv = GvHV(gv)) && hv != PL_defstash)
3ab0c9fa 2449 xmldump_packsubs_perl(hv, justperl); /* nested package */
3b721df9
NC
2450 }
2451 }
2452}
2453
2454void
2455Perl_xmldump_sub(pTHX_ const GV *gv)
2456{
28eb953d 2457 PERL_ARGS_ASSERT_XMLDUMP_SUB;
f0e3f042
CS
2458 xmldump_sub_perl(gv, FALSE);
2459}
2460
2461void
2462Perl_xmldump_sub_perl(pTHX_ const GV *gv, bool justperl)
2463{
2464 SV * sv;
3b721df9 2465
28eb953d 2466 PERL_ARGS_ASSERT_XMLDUMP_SUB_PERL;
7918f24d 2467
f0e3f042
CS
2468 if (justperl && (CvISXSUB(GvCV(gv)) || !CvROOT(GvCV(gv))))
2469 return;
2470
2471 sv = sv_newmortal();
1a9a51d4 2472 gv_fullname3(sv, gv, NULL);
3b721df9
NC
2473 Perl_xmldump_indent(aTHX_ 0, PL_xmlfp, "\nSUB %s = ", SvPVX(sv));
2474 if (CvXSUB(GvCV(gv)))
2475 Perl_xmldump_indent(aTHX_ 0, PL_xmlfp, "(xsub 0x%"UVxf" %d)\n",
2476 PTR2UV(CvXSUB(GvCV(gv))),
2477 (int)CvXSUBANY(GvCV(gv)).any_i32);
2478 else if (CvROOT(GvCV(gv)))
2479 op_xmldump(CvROOT(GvCV(gv)));
2480 else
2481 Perl_xmldump_indent(aTHX_ 0, PL_xmlfp, "<undef>\n");
2482}
2483
2484void
2485Perl_xmldump_form(pTHX_ const GV *gv)
2486{
61f9802b 2487 SV * const sv = sv_newmortal();
3b721df9 2488
7918f24d
NC
2489 PERL_ARGS_ASSERT_XMLDUMP_FORM;
2490
1a9a51d4 2491 gv_fullname3(sv, gv, NULL);
3b721df9
NC
2492 Perl_xmldump_indent(aTHX_ 0, PL_xmlfp, "\nFORMAT %s = ", SvPVX(sv));
2493 if (CvROOT(GvFORM(gv)))
2494 op_xmldump(CvROOT(GvFORM(gv)));
2495 else
2496 Perl_xmldump_indent(aTHX_ 0, PL_xmlfp, "<undef>\n");
2497}
2498
2499void
2500Perl_xmldump_eval(pTHX)
2501{
2502 op_xmldump(PL_eval_root);
2503}
2504
2505char *
2506Perl_sv_catxmlsv(pTHX_ SV *dsv, SV *ssv)
2507{
7918f24d 2508 PERL_ARGS_ASSERT_SV_CATXMLSV;
3b721df9
NC
2509 return sv_catxmlpvn(dsv, SvPVX(ssv), SvCUR(ssv), SvUTF8(ssv));
2510}
2511
2512char *
9dcc53ea
Z
2513Perl_sv_catxmlpv(pTHX_ SV *dsv, const char *pv, int utf8)
2514{
2515 PERL_ARGS_ASSERT_SV_CATXMLPV;
2516 return sv_catxmlpvn(dsv, pv, strlen(pv), utf8);
2517}
2518
2519char *
20f84293 2520Perl_sv_catxmlpvn(pTHX_ SV *dsv, const char *pv, STRLEN len, int utf8)
3b721df9
NC
2521{
2522 unsigned int c;
61f9802b 2523 const char * const e = pv + len;
20f84293 2524 const char * const start = pv;
3b721df9
NC
2525 STRLEN dsvcur;
2526 STRLEN cl;
2527
7918f24d
NC
2528 PERL_ARGS_ASSERT_SV_CATXMLPVN;
2529
76f68e9b 2530 sv_catpvs(dsv,"");
3b721df9
NC
2531 dsvcur = SvCUR(dsv); /* in case we have to restart */
2532
2533 retry:
2534 while (pv < e) {
2535 if (utf8) {
4b88fb76 2536 c = utf8_to_uvchr_buf((U8*)pv, (U8*)e, &cl);
3b721df9
NC
2537 if (cl == 0) {
2538 SvCUR(dsv) = dsvcur;
2539 pv = start;
2540 utf8 = 0;
2541 goto retry;
2542 }
2543 }
2544 else
2545 c = (*pv & 255);
2546
2547 switch (c) {
2548 case 0x00:
2549 case 0x01:
2550 case 0x02:
2551 case 0x03:
2552 case 0x04:
2553 case 0x05:
2554 case 0x06:
2555 case 0x07:
2556 case 0x08:
2557 case 0x0b:
2558 case 0x0c:
2559 case 0x0e:
2560 case 0x0f:
2561 case 0x10:
2562 case 0x11:
2563 case 0x12:
2564 case 0x13:
2565 case 0x14:
2566 case 0x15:
2567 case 0x16:
2568 case 0x17:
2569 case 0x18:
2570 case 0x19:
2571 case 0x1a:
2572 case 0x1b:
2573 case 0x1c:
2574 case 0x1d:
2575 case 0x1e:
2576 case 0x1f:
2577 case 0x7f:
2578 case 0x80:
2579 case 0x81:
2580 case 0x82:
2581 case 0x83:
2582 case 0x84:
2583 case 0x86:
2584 case 0x87:
2585 case 0x88:
2586 case 0x89:
2587 case 0x90:
2588 case 0x91:
2589 case 0x92:
2590 case 0x93:
2591 case 0x94:
2592 case 0x95:
2593 case 0x96:
2594 case 0x97:
2595 case 0x98:
2596 case 0x99:
2597 case 0x9a:
2598 case 0x9b:
2599 case 0x9c:
2600 case 0x9d:
2601 case 0x9e:
2602 case 0x9f:
2603 Perl_sv_catpvf(aTHX_ dsv, "STUPIDXML(#x%X)", c);
2604 break;
2605 case '<':
f3a2811a 2606 sv_catpvs(dsv, "&lt;");
3b721df9
NC
2607 break;
2608 case '>':
f3a2811a 2609 sv_catpvs(dsv, "&gt;");
3b721df9
NC
2610 break;
2611 case '&':
f3a2811a 2612 sv_catpvs(dsv, "&amp;");
3b721df9
NC
2613 break;
2614 case '"':
49de0815 2615 sv_catpvs(dsv, "&#34;");
3b721df9
NC
2616 break;
2617 default:
2618 if (c < 0xD800) {
2619 if (c < 32 || c > 127) {
2620 Perl_sv_catpvf(aTHX_ dsv, "&#x%X;", c);
2621 }
2622 else {
5e7aa789
NC
2623 const char string = (char) c;
2624 sv_catpvn(dsv, &string, 1);
3b721df9
NC
2625 }
2626 break;
2627 }
2628 if ((c >= 0xD800 && c <= 0xDB7F) ||
2629 (c >= 0xDC00 && c <= 0xDFFF) ||
2630 (c >= 0xFFF0 && c <= 0xFFFF) ||
2631 c > 0x10ffff)
2632 Perl_sv_catpvf(aTHX_ dsv, "STUPIDXML(#x%X)", c);
2633 else
2634 Perl_sv_catpvf(aTHX_ dsv, "&#x%X;", c);
2635 }
2636
2637 if (utf8)
2638 pv += UTF8SKIP(pv);
2639 else
2640 pv++;
2641 }
2642
2643 return SvPVX(dsv);
2644}
2645
2646char *
2647Perl_sv_xmlpeek(pTHX_ SV *sv)
2648{
61f9802b 2649 SV * const t = sv_newmortal();
3b721df9
NC
2650 STRLEN n_a;
2651 int unref = 0;
2652
7918f24d
NC
2653 PERL_ARGS_ASSERT_SV_XMLPEEK;
2654
3b721df9 2655 sv_utf8_upgrade(t);
76f68e9b 2656 sv_setpvs(t, "");
3b721df9
NC
2657 /* retry: */
2658 if (!sv) {
2659 sv_catpv(t, "VOID=\"\"");
2660 goto finish;
2661 }
ad64d0ec 2662 else if (sv == (const SV *)0x55555555 || SvTYPE(sv) == 'U') {
3b721df9
NC
2663 sv_catpv(t, "WILD=\"\"");
2664 goto finish;
2665 }
2666 else if (sv == &PL_sv_undef || sv == &PL_sv_no || sv == &PL_sv_yes || sv == &PL_sv_placeholder) {
2667 if (sv == &PL_sv_undef) {
2668 sv_catpv(t, "SV_UNDEF=\"1\"");
2669 if (!(SvFLAGS(sv) & (SVf_OK|SVf_OOK|SVs_OBJECT|
2670 SVs_GMG|SVs_SMG|SVs_RMG)) &&
2671 SvREADONLY(sv))
2672 goto finish;
2673 }
2674 else if (sv == &PL_sv_no) {
2675 sv_catpv(t, "SV_NO=\"1\"");
2676 if (!(SvFLAGS(sv) & (SVf_ROK|SVf_OOK|SVs_OBJECT|
2677 SVs_GMG|SVs_SMG|SVs_RMG)) &&
2678 !(~SvFLAGS(sv) & (SVf_POK|SVf_NOK|SVf_READONLY|
2679 SVp_POK|SVp_NOK)) &&
2680 SvCUR(sv) == 0 &&
2681 SvNVX(sv) == 0.0)
2682 goto finish;
2683 }
2684 else if (sv == &PL_sv_yes) {
2685 sv_catpv(t, "SV_YES=\"1\"");
2686 if (!(SvFLAGS(sv) & (SVf_ROK|SVf_OOK|SVs_OBJECT|
2687 SVs_GMG|SVs_SMG|SVs_RMG)) &&
2688 !(~SvFLAGS(sv) & (SVf_POK|SVf_NOK|SVf_READONLY|
2689 SVp_POK|SVp_NOK)) &&
2690 SvCUR(sv) == 1 &&
2691 SvPVX(sv) && *SvPVX(sv) == '1' &&
2692 SvNVX(sv) == 1.0)
2693 goto finish;
2694 }
2695 else {
2696 sv_catpv(t, "SV_PLACEHOLDER=\"1\"");
2697 if (!(SvFLAGS(sv) & (SVf_OK|SVf_OOK|SVs_OBJECT|
2698 SVs_GMG|SVs_SMG|SVs_RMG)) &&
2699 SvREADONLY(sv))
2700 goto finish;
2701 }
2702 sv_catpv(t, " XXX=\"\" ");
2703 }
2704 else if (SvREFCNT(sv) == 0) {
2705 sv_catpv(t, " refcnt=\"0\"");
2706 unref++;
2707 }
2708 else if (DEBUG_R_TEST_) {
2709 int is_tmp = 0;
2710 I32 ix;
2711 /* is this SV on the tmps stack? */
2712 for (ix=PL_tmps_ix; ix>=0; ix--) {
2713 if (PL_tmps_stack[ix] == sv) {
2714 is_tmp = 1;
2715 break;
2716 }
2717 }
2718 if (SvREFCNT(sv) > 1)
2719 Perl_sv_catpvf(aTHX_ t, " DRT=\"<%"UVuf"%s>\"", (UV)SvREFCNT(sv),
2720 is_tmp ? "T" : "");
2721 else if (is_tmp)
2722 sv_catpv(t, " DRT=\"<T>\"");
2723 }
2724
2725 if (SvROK(sv)) {
2726 sv_catpv(t, " ROK=\"\"");
2727 }
2728 switch (SvTYPE(sv)) {
2729 default:
2730 sv_catpv(t, " FREED=\"1\"");
2731 goto finish;
2732
2733 case SVt_NULL:
2734 sv_catpv(t, " UNDEF=\"1\"");
2735 goto finish;
2736 case SVt_IV:
2737 sv_catpv(t, " IV=\"");
2738 break;
2739 case SVt_NV:
2740 sv_catpv(t, " NV=\"");
2741 break;
3b721df9
NC
2742 case SVt_PV:
2743 sv_catpv(t, " PV=\"");
2744 break;
2745 case SVt_PVIV:
2746 sv_catpv(t, " PVIV=\"");
2747 break;
2748 case SVt_PVNV:
2749 sv_catpv(t, " PVNV=\"");
2750 break;
2751 case SVt_PVMG:
2752 sv_catpv(t, " PVMG=\"");
2753 break;
2754 case SVt_PVLV:
2755 sv_catpv(t, " PVLV=\"");
2756 break;
2757 case SVt_PVAV:
2758 sv_catpv(t, " AV=\"");
2759 break;
2760 case SVt_PVHV:
2761 sv_catpv(t, " HV=\"");
2762 break;
2763 case SVt_PVCV:
2764 if (CvGV(sv))
2765 Perl_sv_catpvf(aTHX_ t, " CV=\"(%s)\"", GvNAME(CvGV(sv)));
2766 else
2767 sv_catpv(t, " CV=\"()\"");
2768 goto finish;
2769 case SVt_PVGV:
2770 sv_catpv(t, " GV=\"");
2771 break;
cecf5685
NC
2772 case SVt_BIND:
2773 sv_catpv(t, " BIND=\"");
3b721df9 2774 break;
d914baab 2775 case SVt_REGEXP:
8619e557 2776 sv_catpv(t, " REGEXP=\"");
4df7f6af 2777 break;
3b721df9
NC
2778 case SVt_PVFM:
2779 sv_catpv(t, " FM=\"");
2780 break;
2781 case SVt_PVIO:
2782 sv_catpv(t, " IO=\"");
2783 break;
2784 }
2785
2786 if (SvPOKp(sv)) {
2787 if (SvPVX(sv)) {
2788 sv_catxmlsv(t, sv);
2789 }
2790 }
2791 else if (SvNOKp(sv)) {
2792 STORE_NUMERIC_LOCAL_SET_STANDARD();
2793 Perl_sv_catpvf(aTHX_ t, "%"NVgf"",SvNVX(sv));
2794 RESTORE_NUMERIC_LOCAL();
2795 }
2796 else if (SvIOKp(sv)) {
2797 if (SvIsUV(sv))
2798 Perl_sv_catpvf(aTHX_ t, "%"UVuf"", (UV)SvUVX(sv));
2799 else
2800 Perl_sv_catpvf(aTHX_ t, "%"IVdf"", (IV)SvIVX(sv));
2801 }
2802 else
2803 sv_catpv(t, "");
2804 sv_catpv(t, "\"");
2805
2806 finish:
61f9802b
AL
2807 while (unref--)
2808 sv_catpv(t, ")");
3b721df9
NC
2809 return SvPV(t, n_a);
2810}
2811
2812void
2813Perl_do_pmop_xmldump(pTHX_ I32 level, PerlIO *file, const PMOP *pm)
2814{
7918f24d
NC
2815 PERL_ARGS_ASSERT_DO_PMOP_XMLDUMP;
2816
3b721df9
NC
2817 if (!pm) {
2818 Perl_xmldump_indent(aTHX_ level, file, "<pmop/>\n");
2819 return;
2820 }
2821 Perl_xmldump_indent(aTHX_ level, file, "<pmop \n");
2822 level++;
2823 if (PM_GETRE(pm)) {
d914baab 2824 REGEXP *const r = PM_GETRE(pm);
643e696a 2825 SV * const tmpsv = newSVpvn_utf8("", 0, TRUE);
ad64d0ec 2826 sv_catxmlsv(tmpsv, MUTABLE_SV(r));
3b721df9
NC
2827 Perl_xmldump_indent(aTHX_ level, file, "pre=\"%s\"\n",
2828 SvPVX(tmpsv));
5f954473 2829 SvREFCNT_dec_NN(tmpsv);
3b721df9
NC
2830 Perl_xmldump_indent(aTHX_ level, file, "when=\"%s\"\n",
2831 (pm->op_private & OPpRUNTIME) ? "RUN" : "COMP");
2832 }
2833 else
2834 Perl_xmldump_indent(aTHX_ level, file, "pre=\"\" when=\"RUN\"\n");
d914baab 2835 if (pm->op_pmflags || (PM_GETRE(pm) && RX_CHECK_SUBSTR(PM_GETRE(pm)))) {
3df43ef7 2836 SV * const tmpsv = pm_description(pm);
3b721df9 2837 Perl_xmldump_indent(aTHX_ level, file, "pmflags=\"%s\"\n", SvCUR(tmpsv) ? SvPVX(tmpsv) + 1 : "");
5f954473 2838 SvREFCNT_dec_NN(tmpsv);
3b721df9
NC
2839 }
2840
2841 level--;
20e98b0f 2842 if (pm->op_type != OP_PUSHRE && pm->op_pmreplrootu.op_pmreplroot) {
3b721df9
NC
2843 Perl_xmldump_indent(aTHX_ level, file, ">\n");
2844 Perl_xmldump_indent(aTHX_ level+1, file, "<pm_repl>\n");
20e98b0f 2845 do_op_xmldump(level+2, file, pm->op_pmreplrootu.op_pmreplroot);
3b721df9
NC
2846 Perl_xmldump_indent(aTHX_ level+1, file, "</pm_repl>\n");
2847 Perl_xmldump_indent(aTHX_ level, file, "</pmop>\n");
2848 }
2849 else
2850 Perl_xmldump_indent(aTHX_ level, file, "/>\n");
2851}
2852
2853void
2854Perl_pmop_xmldump(pTHX_ const PMOP *pm)
2855{
2856 do_pmop_xmldump(0, PL_xmlfp, pm);
2857}
2858
2859void
2860Perl_do_op_xmldump(pTHX_ I32 level, PerlIO *file, const OP *o)
2861{
2862 UV seq;
2863 int contents = 0;
75a6ad4a 2864 const OPCODE optype = o->op_type;
7918f24d
NC
2865
2866 PERL_ARGS_ASSERT_DO_OP_XMLDUMP;
2867
3b721df9
NC
2868 if (!o)
2869 return;
3b721df9
NC
2870 seq = sequence_num(o);
2871 Perl_xmldump_indent(aTHX_ level, file,
2872 "<op_%s seq=\"%"UVuf" -> ",
2873 OP_NAME(o),
2874 seq);
2875 level++;
2876 if (o->op_next)
2877 PerlIO_printf(file, seq ? "%"UVuf"\"" : "(%"UVuf")\"",
2878 sequence_num(o->op_next));
2879 else
2880 PerlIO_printf(file, "DONE\"");
2881
2882 if (o->op_targ) {
75a6ad4a 2883 if (optype == OP_NULL)
3b721df9
NC
2884 {
2885 PerlIO_printf(file, " was=\"%s\"", PL_op_name[o->op_targ]);
2886 if (o->op_targ == OP_NEXTSTATE)
2887 {
2888 if (CopLINE(cCOPo))
f5992bc4 2889 PerlIO_printf(file, " line=\"%"UVuf"\"",
3b721df9
NC
2890 (UV)CopLINE(cCOPo));
2891 if (CopSTASHPV(cCOPo))
2892 PerlIO_printf(file, " package=\"%s\"",
2893 CopSTASHPV(cCOPo));
4b65a919 2894 if (CopLABEL(cCOPo))
3b721df9 2895 PerlIO_printf(file, " label=\"%s\"",
4b65a919 2896 CopLABEL(cCOPo));
3b721df9
NC
2897 }
2898 }
2899 else
2900 PerlIO_printf(file, " targ=\"%ld\"", (long)o->op_targ);
2901 }
2902#ifdef DUMPADDR
2903 PerlIO_printf(file, " addr=\"0x%"UVxf" => 0x%"UVxf"\"", (UV)o, (UV)o->op_next);
2904#endif
3b721df9 2905
75a6ad4a
RU
2906 DUMP_OP_FLAGS(o,1,0,file);
2907 DUMP_OP_PRIVATE(o,1,0,file);
2908
2909 switch (optype) {
3b721df9
NC
2910 case OP_AELEMFAST:
2911 if (o->op_flags & OPf_SPECIAL) {
2912 break;
2913 }
2914 case OP_GVSV:
2915 case OP_GV:
2916#ifdef USE_ITHREADS
2917 S_xmldump_attr(aTHX_ level, file, "padix=\"%" IVdf "\"", (IV)cPADOPo->op_padix);
2918#else
2919 if (cSVOPo->op_sv) {
d914baab
NC
2920 SV * const tmpsv1 = newSVpvn_utf8(NULL, 0, TRUE);
2921 SV * const tmpsv2 = newSVpvn_utf8("", 0, TRUE);
3b721df9
NC
2922 char *s;
2923 STRLEN len;
2924 ENTER;
2925 SAVEFREESV(tmpsv1);
2926 SAVEFREESV(tmpsv2);
159b6efe 2927 gv_fullname3(tmpsv1, MUTABLE_GV(cSVOPo->op_sv), NULL);
3b721df9
NC
2928 s = SvPV(tmpsv1,len);
2929 sv_catxmlpvn(tmpsv2, s, len, 1);
2930 S_xmldump_attr(aTHX_ level, file, "gv=\"%s\"", SvPV(tmpsv2, len));
2931 LEAVE;
2932 }
2933 else
2934 S_xmldump_attr(aTHX_ level, file, "gv=\"NULL\"");
2935#endif
2936 break;
2937 case OP_CONST:
996c9baa 2938 case OP_HINTSEVAL:
3b721df9
NC
2939 case OP_METHOD_NAMED:
2940#ifndef USE_ITHREADS
2941 /* with ITHREADS, consts are stored in the pad, and the right pad
2942 * may not be active here, so skip */
2943 S_xmldump_attr(aTHX_ level, file, "%s", sv_xmlpeek(cSVOPo_sv));
2944#endif
2945 break;
2946 case OP_ANONCODE:
2947 if (!contents) {
2948 contents = 1;
2949 PerlIO_printf(file, ">\n");
2950 }
2951 do_op_xmldump(level+1, file, CvROOT(cSVOPo_sv));
2952 break;
3b721df9
NC
2953 case OP_NEXTSTATE:
2954 case OP_DBSTATE:
2955 if (CopLINE(cCOPo))
f5992bc4 2956 S_xmldump_attr(aTHX_ level, file, "line=\"%"UVuf"\"",
3b721df9
NC
2957 (UV)CopLINE(cCOPo));
2958 if (CopSTASHPV(cCOPo))
2959 S_xmldump_attr(aTHX_ level, file, "package=\"%s\"",
2960 CopSTASHPV(cCOPo));
4b65a919 2961 if (CopLABEL(cCOPo))
3b721df9 2962 S_xmldump_attr(aTHX_ level, file, "label=\"%s\"",
4b65a919 2963 CopLABEL(cCOPo));
3b721df9
NC
2964 break;
2965 case OP_ENTERLOOP:
2966 S_xmldump_attr(aTHX_ level, file, "redo=\"");
2967 if (cLOOPo->op_redoop)
2968 PerlIO_printf(file, "%"UVuf"\"", sequence_num(cLOOPo->op_redoop));
2969 else
2970 PerlIO_printf(file, "DONE\"");
2971 S_xmldump_attr(aTHX_ level, file, "next=\"");
2972 if (cLOOPo->op_nextop)
2973 PerlIO_printf(file, "%"UVuf"\"", sequence_num(cLOOPo->op_nextop));
2974 else
2975 PerlIO_printf(file, "DONE\"");
2976 S_xmldump_attr(aTHX_ level, file, "last=\"");
2977 if (cLOOPo->op_lastop)
2978 PerlIO_printf(file, "%"UVuf"\"", sequence_num(cLOOPo->op_lastop));
2979 else
2980 PerlIO_printf(file, "DONE\"");
2981 break;
2982 case OP_COND_EXPR:
2983 case OP_RANGE:
2984 case OP_MAPWHILE:
2985 case OP_GREPWHILE:
2986 case OP_OR:
2987 case OP_AND:
2988 S_xmldump_attr(aTHX_ level, file, "other=\"");
2989 if (cLOGOPo->op_other)
2990 PerlIO_printf(file, "%"UVuf"\"", sequence_num(cLOGOPo->op_other));
2991 else
2992 PerlIO_printf(file, "DONE\"");
2993 break;
2994 case OP_LEAVE:
2995 case OP_LEAVEEVAL:
2996 case OP_LEAVESUB:
2997 case OP_LEAVESUBLV:
2998 case OP_LEAVEWRITE:
2999 case OP_SCOPE:
3000 if (o->op_private & OPpREFCOUNTED)
3001 S_xmldump_attr(aTHX_ level, file, "refcnt=\"%"UVuf"\"", (UV)o->op_targ);
3002 break;
3003 default:
3004 break;
3005 }
3006
3007 if (PL_madskills && o->op_madprop) {
fb2b694a 3008 char prevkey = '\0';
d914baab 3009 SV * const tmpsv = newSVpvn_utf8("", 0, TRUE);
20f84293 3010 const MADPROP* mp = o->op_madprop;
61f9802b 3011
3b721df9
NC
3012 if (!contents) {
3013 contents = 1;
3014 PerlIO_printf(file, ">\n");
3015 }
3016 Perl_xmldump_indent(aTHX_ level, file, "<madprops>\n");
3017 level++;
3018 while (mp) {
3019 char tmp = mp->mad_key;
76f68e9b 3020 sv_setpvs(tmpsv,"\"");
3b721df9
NC
3021 if (tmp)
3022 sv_catxmlpvn(tmpsv, &tmp, 1, 0);
fb2b694a
GG
3023 if ((tmp == '_') || (tmp == '#')) /* '_' '#' whitespace belong to the previous token. */
3024 sv_catxmlpvn(tmpsv, &prevkey, 1, 0);
3025 else
3026 prevkey = tmp;
3b721df9
NC
3027 sv_catpv(tmpsv, "\"");
3028 switch (mp->mad_type) {
3029 case MAD_NULL:
3030 sv_catpv(tmpsv, "NULL");
3031 Perl_xmldump_indent(aTHX_ level, file, "<mad_null key=%s/>\n", SvPVX(tmpsv));
3032 break;
3033 case MAD_PV:
3034 sv_catpv(tmpsv, " val=\"");
3035 sv_catxmlpvn(tmpsv, (char*)mp->mad_val, mp->mad_vlen,1);
3036 sv_catpv(tmpsv, "\"");
3037 Perl_xmldump_indent(aTHX_ level, file, "<mad_pv key=%s/>\n", SvPVX(tmpsv));
3038 break;
3039 case MAD_SV:
3040 sv_catpv(tmpsv, " val=\"");
ad64d0ec 3041 sv_catxmlsv(tmpsv, MUTABLE_SV(mp->mad_val));
3b721df9
NC
3042 sv_catpv(tmpsv, "\"");
3043 Perl_xmldump_indent(aTHX_ level, file, "<mad_sv key=%s/>\n", SvPVX(tmpsv));
3044 break;
3045 case MAD_OP:
3046 if ((OP*)mp->mad_val) {
3047 Perl_xmldump_indent(aTHX_ level, file, "<mad_op key=%s>\n", SvPVX(tmpsv));
3048 do_op_xmldump(level+1, file, (OP*)mp->mad_val);
3049 Perl_xmldump_indent(aTHX_ level, file, "</mad_op>\n");
3050 }
3051 break;
3052 default:
3053 Perl_xmldump_indent(aTHX_ level, file, "<mad_unk key=%s/>\n", SvPVX(tmpsv));
3054 break;
3055 }
3056 mp = mp->mad_next;
3057 }
3058 level--;
3059 Perl_xmldump_indent(aTHX_ level, file, "</madprops>\n");
3060
5f954473 3061 SvREFCNT_dec_NN(tmpsv);
3b721df9
NC
3062 }
3063
75a6ad4a 3064 switch (optype) {
3b721df9
NC
3065 case OP_PUSHRE:
3066 case OP_MATCH:
3067 case OP_QR:
3068 case OP_SUBST:
3069 if (!contents) {
3070 contents = 1;
3071 PerlIO_printf(file, ">\n");
3072 }
3073 do_pmop_xmldump(level, file, cPMOPo);
3074 break;
3075 default:
3076 break;
3077 }
3078
3079 if (o->op_flags & OPf_KIDS) {
3080 OP *kid;
3081 if (!contents) {
3082 contents = 1;
3083 PerlIO_printf(file, ">\n");
3084 }
3085 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling)
3086 do_op_xmldump(level, file, kid);
3087 }
3088
3089 if (contents)
3090 Perl_xmldump_indent(aTHX_ level-1, file, "</op_%s>\n", OP_NAME(o));
3091 else
3092 PerlIO_printf(file, " />\n");
3093}
3094
3095void
3096Perl_op_xmldump(pTHX_ const OP *o)
3097{
7918f24d
NC
3098 PERL_ARGS_ASSERT_OP_XMLDUMP;
3099
3b721df9
NC
3100 do_op_xmldump(0, PL_xmlfp, o);
3101}
3102#endif
3103
66610fdd
RGS
3104/*
3105 * Local variables:
3106 * c-indentation-style: bsd
3107 * c-basic-offset: 4
14d04a33 3108 * indent-tabs-mode: nil
66610fdd
RGS
3109 * End:
3110 *
14d04a33 3111 * ex: set ts=8 sts=4 sw=4 et:
37442d52 3112 */