This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Merge maint-5.004 branch (5.004_04) with mainline.
[perl5.git] / dump.c
CommitLineData
a0d0e21e 1/* dump.c
a687059c 2 *
9607fc9c 3 * Copyright (c) 1991-1997, Larry Wall
a687059c 4 *
6e21c824
LW
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
8d063cd8 7 *
a0d0e21e
LW
8 */
9
10/*
11 * "'You have talked long in your sleep, Frodo,' said Gandalf gently, 'and
12 * it has not been hard for me to read your mind and memory.'"
8d063cd8
LW
13 */
14
8d063cd8 15#include "EXTERN.h"
8d063cd8
LW
16#include "perl.h"
17
2304df62
AD
18#ifndef DEBUGGING
19void
20dump_all()
21{
22}
23#else /* Rest of file is for DEBUGGING */
8d063cd8 24
4db58590 25#ifdef I_STDARG
26static void dump(char *pat, ...);
27#else
8adcabd8 28static void dump();
4db58590 29#endif
8adcabd8
LW
30
31void
93a17b20 32dump_all()
79072805 33{
11343788 34 dTHR;
760ac839 35 PerlIO_setlinebuf(Perl_debug_log);
93a17b20
LW
36 if (main_root)
37 dump_op(main_root);
463ee0b2
LW
38 dump_packsubs(defstash);
39}
40
41void
42dump_packsubs(stash)
43HV* stash;
44{
11343788 45 dTHR;
a0d0e21e 46 I32 i;
463ee0b2
LW
47 HE *entry;
48
8990e307
LW
49 if (!HvARRAY(stash))
50 return;
a0d0e21e 51 for (i = 0; i <= (I32) HvMAX(stash); i++) {
4db58590 52 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
53 GV *gv = (GV*)HeVAL(entry);
463ee0b2 54 HV *hv;
8ebc5c01 55 if (GvCVu(gv))
463ee0b2 56 dump_sub(gv);
85e6fe83
LW
57 if (GvFORM(gv))
58 dump_form(gv);
4db58590 59 if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
a0d0e21e 60 (hv = GvHV(gv)) && HvNAME(hv) && hv != defstash)
463ee0b2
LW
61 dump_packsubs(hv); /* nested package */
62 }
79072805
LW
63 }
64}
65
66void
93a17b20
LW
67dump_sub(gv)
68GV* gv;
a687059c 69{
8990e307 70 SV *sv = sv_newmortal();
85e6fe83 71
f6aff53a 72 gv_fullname3(sv, gv, Nullch);
85e6fe83 73 dump("\nSUB %s = ", SvPVX(sv));
a0d0e21e 74 if (CvXSUB(GvCV(gv)))
85e6fe83 75 dump("(xsub 0x%x %d)\n",
a0d0e21e
LW
76 (long)CvXSUB(GvCV(gv)),
77 CvXSUBANY(GvCV(gv)).any_i32);
85e6fe83
LW
78 else if (CvROOT(GvCV(gv)))
79 dump_op(CvROOT(GvCV(gv)));
80 else
81 dump("<undef>\n");
82}
83
84void
85dump_form(gv)
86GV* gv;
87{
88 SV *sv = sv_newmortal();
89
f6aff53a 90 gv_fullname3(sv, gv, Nullch);
85e6fe83
LW
91 dump("\nFORMAT %s = ", SvPVX(sv));
92 if (CvROOT(GvFORM(gv)))
93 dump_op(CvROOT(GvFORM(gv)));
94 else
95 dump("<undef>\n");
a687059c
LW
96}
97
8adcabd8 98void
79072805 99dump_eval()
8d063cd8 100{
79072805
LW
101 dump_op(eval_root);
102}
103
104void
11343788
MB
105dump_op(o)
106register OP *o;
79072805 107{
79072805 108 dump("{\n");
11343788 109 if (o->op_seq)
5dc0d613 110 PerlIO_printf(Perl_debug_log, "%-4d", o->op_seq);
93a17b20 111 else
760ac839 112 PerlIO_printf(Perl_debug_log, " ");
11343788
MB
113 dump("TYPE = %s ===> ", op_name[o->op_type]);
114 if (o->op_next) {
115 if (o->op_seq)
5dc0d613 116 PerlIO_printf(Perl_debug_log, "%d\n", o->op_next->op_seq);
93a17b20 117 else
5dc0d613 118 PerlIO_printf(Perl_debug_log, "(%d)\n", o->op_next->op_seq);
93a17b20 119 }
79072805 120 else
760ac839 121 PerlIO_printf(Perl_debug_log, "DONE\n");
79072805 122 dumplvl++;
11343788
MB
123 if (o->op_targ) {
124 if (o->op_type == OP_NULL)
125 dump(" (was %s)\n", op_name[o->op_targ]);
8990e307 126 else
11343788 127 dump("TARG = %d\n", o->op_targ);
8990e307 128 }
748a9306 129#ifdef DUMPADDR
11343788 130 dump("ADDR = 0x%lx => 0x%lx\n",o, o->op_next);
79072805 131#endif
11343788 132 if (o->op_flags) {
46fc3d4c 133 SV *tmpsv = newSVpv("", 0);
5dc0d613 134 switch (o->op_flags & OPf_WANT) {
54310121 135 case OPf_WANT_VOID:
46fc3d4c 136 sv_catpv(tmpsv, ",VOID");
54310121 137 break;
138 case OPf_WANT_SCALAR:
46fc3d4c 139 sv_catpv(tmpsv, ",SCALAR");
54310121 140 break;
141 case OPf_WANT_LIST:
46fc3d4c 142 sv_catpv(tmpsv, ",LIST");
54310121 143 break;
144 default:
46fc3d4c 145 sv_catpv(tmpsv, ",UNKNOWN");
54310121 146 break;
147 }
11343788 148 if (o->op_flags & OPf_KIDS)
46fc3d4c 149 sv_catpv(tmpsv, ",KIDS");
11343788 150 if (o->op_flags & OPf_PARENS)
46fc3d4c 151 sv_catpv(tmpsv, ",PARENS");
11343788 152 if (o->op_flags & OPf_STACKED)
46fc3d4c 153 sv_catpv(tmpsv, ",STACKED");
11343788 154 if (o->op_flags & OPf_REF)
46fc3d4c 155 sv_catpv(tmpsv, ",REF");
11343788 156 if (o->op_flags & OPf_MOD)
46fc3d4c 157 sv_catpv(tmpsv, ",MOD");
11343788 158 if (o->op_flags & OPf_SPECIAL)
46fc3d4c 159 sv_catpv(tmpsv, ",SPECIAL");
160 dump("FLAGS = (%s)\n", SvCUR(tmpsv) ? SvPVX(tmpsv) + 1 : "");
161 SvREFCNT_dec(tmpsv);
79072805 162 }
11343788 163 if (o->op_private) {
46fc3d4c 164 SV *tmpsv = newSVpv("", 0);
11343788
MB
165 if (o->op_type == OP_AASSIGN) {
166 if (o->op_private & OPpASSIGN_COMMON)
46fc3d4c 167 sv_catpv(tmpsv, ",COMMON");
8d063cd8 168 }
11343788
MB
169 else if (o->op_type == OP_SASSIGN) {
170 if (o->op_private & OPpASSIGN_BACKWARDS)
46fc3d4c 171 sv_catpv(tmpsv, ",BACKWARDS");
a0d0e21e 172 }
11343788
MB
173 else if (o->op_type == OP_TRANS) {
174 if (o->op_private & OPpTRANS_SQUASH)
46fc3d4c 175 sv_catpv(tmpsv, ",SQUASH");
11343788 176 if (o->op_private & OPpTRANS_DELETE)
46fc3d4c 177 sv_catpv(tmpsv, ",DELETE");
11343788 178 if (o->op_private & OPpTRANS_COMPLEMENT)
46fc3d4c 179 sv_catpv(tmpsv, ",COMPLEMENT");
8d063cd8 180 }
11343788
MB
181 else if (o->op_type == OP_REPEAT) {
182 if (o->op_private & OPpREPEAT_DOLIST)
46fc3d4c 183 sv_catpv(tmpsv, ",DOLIST");
8d063cd8 184 }
11343788
MB
185 else if (o->op_type == OP_ENTERSUB ||
186 o->op_type == OP_RV2SV ||
187 o->op_type == OP_RV2AV ||
188 o->op_type == OP_RV2HV ||
189 o->op_type == OP_RV2GV ||
190 o->op_type == OP_AELEM ||
191 o->op_type == OP_HELEM )
85e6fe83 192 {
5dc0d613
MB
193 if (o->op_type == OP_ENTERSUB) {
194 if (o->op_private & OPpENTERSUB_AMPER)
46fc3d4c 195 sv_catpv(tmpsv, ",AMPER");
5dc0d613 196 if (o->op_private & OPpENTERSUB_DB)
46fc3d4c 197 sv_catpv(tmpsv, ",DB");
68dc0745 198 }
5dc0d613 199 switch (o->op_private & OPpDEREF) {
5f05dabc 200 case OPpDEREF_SV:
46fc3d4c 201 sv_catpv(tmpsv, ",SV");
5f05dabc 202 break;
203 case OPpDEREF_AV:
46fc3d4c 204 sv_catpv(tmpsv, ",AV");
5f05dabc 205 break;
206 case OPpDEREF_HV:
46fc3d4c 207 sv_catpv(tmpsv, ",HV");
5f05dabc 208 break;
209 }
5dc0d613
MB
210 if (o->op_type == OP_AELEM || o->op_type == OP_HELEM) {
211 if (o->op_private & OPpLVAL_DEFER)
46fc3d4c 212 sv_catpv(tmpsv, ",LVAL_DEFER");
68dc0745 213 }
214 else {
5dc0d613 215 if (o->op_private & HINT_STRICT_REFS)
46fc3d4c 216 sv_catpv(tmpsv, ",STRICT_REFS");
68dc0745 217 }
8d063cd8 218 }
11343788
MB
219 else if (o->op_type == OP_CONST) {
220 if (o->op_private & OPpCONST_BARE)
46fc3d4c 221 sv_catpv(tmpsv, ",BARE");
79072805 222 }
11343788
MB
223 else if (o->op_type == OP_FLIP) {
224 if (o->op_private & OPpFLIP_LINENUM)
46fc3d4c 225 sv_catpv(tmpsv, ",LINENUM");
79072805 226 }
11343788
MB
227 else if (o->op_type == OP_FLOP) {
228 if (o->op_private & OPpFLIP_LINENUM)
46fc3d4c 229 sv_catpv(tmpsv, ",LINENUM");
79072805 230 }
11343788 231 if (o->op_flags & OPf_MOD && o->op_private & OPpLVAL_INTRO)
46fc3d4c 232 sv_catpv(tmpsv, ",INTRO");
233 if (SvCUR(tmpsv))
234 dump("PRIVATE = (%s)\n", SvPVX(tmpsv) + 1);
235 SvREFCNT_dec(tmpsv);
8d063cd8 236 }
8d063cd8 237
11343788 238 switch (o->op_type) {
93a17b20 239 case OP_GVSV:
79072805 240 case OP_GV:
11343788 241 if (cGVOPo->op_gv) {
46fc3d4c 242 SV *tmpsv = NEWSV(0,0);
8990e307 243 ENTER;
8990e307 244 SAVEFREESV(tmpsv);
5dc0d613 245 gv_fullname3(tmpsv, cGVOPo->op_gv, Nullch);
463ee0b2 246 dump("GV = %s\n", SvPV(tmpsv, na));
8990e307 247 LEAVE;
378cc40b 248 }
79072805
LW
249 else
250 dump("GV = NULL\n");
251 break;
252 case OP_CONST:
11343788 253 dump("SV = %s\n", SvPEEK(cSVOPo->op_sv));
79072805 254 break;
93a17b20
LW
255 case OP_NEXTSTATE:
256 case OP_DBSTATE:
11343788
MB
257 if (cCOPo->cop_line)
258 dump("LINE = %d\n",cCOPo->cop_line);
259 if (cCOPo->cop_label)
260 dump("LABEL = \"%s\"\n",cCOPo->cop_label);
79072805
LW
261 break;
262 case OP_ENTERLOOP:
263 dump("REDO ===> ");
11343788 264 if (cLOOPo->op_redoop)
5dc0d613 265 PerlIO_printf(Perl_debug_log, "%d\n", cLOOPo->op_redoop->op_seq);
79072805 266 else
760ac839 267 PerlIO_printf(Perl_debug_log, "DONE\n");
79072805 268 dump("NEXT ===> ");
11343788 269 if (cLOOPo->op_nextop)
5dc0d613 270 PerlIO_printf(Perl_debug_log, "%d\n", cLOOPo->op_nextop->op_seq);
79072805 271 else
760ac839 272 PerlIO_printf(Perl_debug_log, "DONE\n");
79072805 273 dump("LAST ===> ");
11343788 274 if (cLOOPo->op_lastop)
5dc0d613 275 PerlIO_printf(Perl_debug_log, "%d\n", cLOOPo->op_lastop->op_seq);
79072805 276 else
760ac839 277 PerlIO_printf(Perl_debug_log, "DONE\n");
79072805
LW
278 break;
279 case OP_COND_EXPR:
280 dump("TRUE ===> ");
11343788 281 if (cCONDOPo->op_true)
5dc0d613 282 PerlIO_printf(Perl_debug_log, "%d\n", cCONDOPo->op_true->op_seq);
79072805 283 else
760ac839 284 PerlIO_printf(Perl_debug_log, "DONE\n");
79072805 285 dump("FALSE ===> ");
11343788 286 if (cCONDOPo->op_false)
5dc0d613 287 PerlIO_printf(Perl_debug_log, "%d\n", cCONDOPo->op_false->op_seq);
79072805 288 else
760ac839 289 PerlIO_printf(Perl_debug_log, "DONE\n");
79072805 290 break;
a0d0e21e 291 case OP_MAPWHILE:
79072805
LW
292 case OP_GREPWHILE:
293 case OP_OR:
294 case OP_AND:
79072805 295 dump("OTHER ===> ");
11343788 296 if (cLOGOPo->op_other)
5dc0d613 297 PerlIO_printf(Perl_debug_log, "%d\n", cLOGOPo->op_other->op_seq);
79072805 298 else
760ac839 299 PerlIO_printf(Perl_debug_log, "DONE\n");
79072805
LW
300 break;
301 case OP_PUSHRE:
302 case OP_MATCH:
303 case OP_SUBST:
11343788 304 dump_pm(cPMOPo);
79072805 305 break;
a0d0e21e
LW
306 default:
307 break;
79072805 308 }
11343788 309 if (o->op_flags & OPf_KIDS) {
79072805 310 OP *kid;
11343788 311 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling)
79072805 312 dump_op(kid);
8d063cd8
LW
313 }
314 dumplvl--;
315 dump("}\n");
316}
317
8adcabd8 318void
79072805
LW
319dump_gv(gv)
320register GV *gv;
378cc40b 321{
79072805 322 SV *sv;
378cc40b 323
79072805 324 if (!gv) {
760ac839 325 PerlIO_printf(Perl_debug_log, "{}\n");
378cc40b
LW
326 return;
327 }
8990e307 328 sv = sv_newmortal();
8d063cd8 329 dumplvl++;
760ac839 330 PerlIO_printf(Perl_debug_log, "{\n");
f6aff53a 331 gv_fullname3(sv, gv, Nullch);
463ee0b2 332 dump("GV_NAME = %s", SvPVX(sv));
79072805 333 if (gv != GvEGV(gv)) {
f6aff53a 334 gv_efullname3(sv, GvEGV(gv), Nullch);
463ee0b2 335 dump("-> %s", SvPVX(sv));
8adcabd8
LW
336 }
337 dump("\n");
8d063cd8
LW
338 dumplvl--;
339 dump("}\n");
340}
341
8adcabd8 342void
79072805
LW
343dump_pm(pm)
344register PMOP *pm;
8d063cd8
LW
345{
346 char ch;
347
79072805
LW
348 if (!pm) {
349 dump("{}\n");
378cc40b
LW
350 return;
351 }
79072805 352 dump("{\n");
8d063cd8 353 dumplvl++;
79072805
LW
354 if (pm->op_pmflags & PMf_ONCE)
355 ch = '?';
356 else
357 ch = '/';
358 if (pm->op_pmregexp)
c90c0ff4 359 dump("PMf_PRE %c%s%c%s\n",
360 ch, pm->op_pmregexp->precomp, ch,
361 (pm->op_private & OPpRUNTIME) ? " (RUNTIME)" : "");
362 else
363 dump("PMf_PRE (RUNTIME)\n");
79072805
LW
364 if (pm->op_type != OP_PUSHRE && pm->op_pmreplroot) {
365 dump("PMf_REPL = ");
366 dump_op(pm->op_pmreplroot);
8d063cd8 367 }
79072805
LW
368 if (pm->op_pmshort) {
369 dump("PMf_SHORT = %s\n",SvPEEK(pm->op_pmshort));
8d063cd8 370 }
79072805 371 if (pm->op_pmflags) {
46fc3d4c 372 SV *tmpsv = newSVpv("", 0);
79072805 373 if (pm->op_pmflags & PMf_USED)
46fc3d4c 374 sv_catpv(tmpsv, ",USED");
79072805 375 if (pm->op_pmflags & PMf_ONCE)
46fc3d4c 376 sv_catpv(tmpsv, ",ONCE");
79072805 377 if (pm->op_pmflags & PMf_SCANFIRST)
46fc3d4c 378 sv_catpv(tmpsv, ",SCANFIRST");
79072805 379 if (pm->op_pmflags & PMf_ALL)
46fc3d4c 380 sv_catpv(tmpsv, ",ALL");
79072805 381 if (pm->op_pmflags & PMf_SKIPWHITE)
46fc3d4c 382 sv_catpv(tmpsv, ",SKIPWHITE");
79072805 383 if (pm->op_pmflags & PMf_CONST)
46fc3d4c 384 sv_catpv(tmpsv, ",CONST");
79072805 385 if (pm->op_pmflags & PMf_KEEP)
46fc3d4c 386 sv_catpv(tmpsv, ",KEEP");
79072805 387 if (pm->op_pmflags & PMf_GLOBAL)
46fc3d4c 388 sv_catpv(tmpsv, ",GLOBAL");
c90c0ff4 389 if (pm->op_pmflags & PMf_CONTINUE)
390 sv_catpv(tmpsv, ",CONTINUE");
79072805 391 if (pm->op_pmflags & PMf_EVAL)
46fc3d4c 392 sv_catpv(tmpsv, ",EVAL");
393 dump("PMFLAGS = (%s)\n", SvCUR(tmpsv) ? SvPVX(tmpsv) + 1 : "");
394 SvREFCNT_dec(tmpsv);
378cc40b 395 }
79072805 396
8d063cd8
LW
397 dumplvl--;
398 dump("}\n");
399}
400
4db58590 401
402#if !defined(I_STDARG) && !defined(I_VARARGS)
378cc40b 403/* VARARGS1 */
8adcabd8 404static void dump(arg1,arg2,arg3,arg4,arg5)
378cc40b
LW
405char *arg1;
406long arg2, arg3, arg4, arg5;
8d063cd8 407{
79072805 408 I32 i;
8d063cd8
LW
409
410 for (i = dumplvl*4; i; i--)
760ac839
LW
411 (void)PerlIO_putc(Perl_debug_log,' ');
412 PerlIO_printf(Perl_debug_log, arg1, arg2, arg3, arg4, arg5);
4db58590 413}
414
415#else
416
417#ifdef I_STDARG
418static void
419dump(char *pat,...)
420#else
421/*VARARGS0*/
422static void
423dump(pat,va_alist)
424 char *pat;
425 va_dcl
426#endif
427{
428 I32 i;
429 va_list args;
4db58590 430
431#ifdef I_STDARG
432 va_start(args, pat);
433#else
434 va_start(args);
435#endif
436 for (i = dumplvl*4; i; i--)
760ac839
LW
437 (void)PerlIO_putc(Perl_debug_log,' ');
438 PerlIO_vprintf(Perl_debug_log,pat,args);
4db58590 439 va_end(args);
8d063cd8
LW
440}
441#endif
4db58590 442
443#endif