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