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