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