dump.c

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