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     PerlIO_setlinebuf(Perl_debug_log);
  35     if (main_root)
  36         dump_op(main_root);
  37     dump_packsubs(defstash);
  38 }
  39
  40 void
  41 dump_packsubs(stash)
  42 HV* stash;
  43 {
  44     I32 i;
  45     HE  *entry;
  46
  47     if (!HvARRAY(stash))
  48         return;
  49     for (i = 0; i <= (I32) HvMAX(stash); i++) {
  50         for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
  51             GV *gv = (GV*)HeVAL(entry);
  52             HV *hv;
  53             if (GvCVu(gv))
  54                 dump_sub(gv);
  55             if (GvFORM(gv))
  56                 dump_form(gv);
  57             if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
  58               (hv = GvHV(gv)) && HvNAME(hv) && hv != defstash)
  59                 dump_packsubs(hv);              /* nested package */
  60         }
  61     }
  62 }
  63
  64 void
  65 dump_sub(gv)
  66 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)
  84 GV* gv;
  85 {
  86     SV *sv = sv_newmortal();
  87
  88     gv_fullname3(sv, gv, Nullch);
  89     dump("\nFORMAT %s = ", SvPVX(sv));
  90     if (CvROOT(GvFORM(gv)))
  91         dump_op(CvROOT(GvFORM(gv)));
  92     else
  93         dump("<undef>\n");
  94 }
  95
  96 void
  97 dump_eval()
  98 {
  99     dump_op(eval_root);
 100 }
 101
 102 void
 103 dump_op(op)
 104 register OP *op;
 105 {
 106     SV *tmpsv;
 107
 108     dump("{\n");
 109     if (op->op_seq)
 110         PerlIO_printf(Perl_debug_log, "%-4d", op->op_seq);
 111     else
 112         PerlIO_printf(Perl_debug_log, "    ");
 113     dump("TYPE = %s  ===> ", op_name[op->op_type]);
 114     if (op->op_next) {
 115         if (op->op_seq)
 116             PerlIO_printf(Perl_debug_log, "%d\n", op->op_next->op_seq);
 117         else
 118             PerlIO_printf(Perl_debug_log, "(%d)\n", op->op_next->op_seq);
 119     }
 120     else
 121         PerlIO_printf(Perl_debug_log, "DONE\n");
 122     dumplvl++;
 123     if (op->op_targ) {
 124         if (op->op_type == OP_NULL)
 125             dump("  (was %s)\n", op_name[op->op_targ]);
 126         else
 127             dump("TARG = %d\n", op->op_targ);
 128     }
 129 #ifdef DUMPADDR
 130     dump("ADDR = 0x%lx => 0x%lx\n",op, op->op_next);
 131 #endif
 132     if (op->op_flags) {
 133         *buf = '\0';
 134         if (op->op_flags & OPf_KNOW) {
 135             if (op->op_flags & OPf_LIST)
 136                 (void)strcat(buf,"LIST,");
 137             else
 138                 (void)strcat(buf,"SCALAR,");
 139         }
 140         else
 141             (void)strcat(buf,"UNKNOWN,");
 142         if (op->op_flags & OPf_KIDS)
 143             (void)strcat(buf,"KIDS,");
 144         if (op->op_flags & OPf_PARENS)
 145             (void)strcat(buf,"PARENS,");
 146         if (op->op_flags & OPf_STACKED)
 147             (void)strcat(buf,"STACKED,");
 148         if (op->op_flags & OPf_REF)
 149             (void)strcat(buf,"REF,");
 150         if (op->op_flags & OPf_MOD)
 151             (void)strcat(buf,"MOD,");
 152         if (op->op_flags & OPf_SPECIAL)
 153             (void)strcat(buf,"SPECIAL,");
 154         if (*buf)
 155             buf[strlen(buf)-1] = '\0';
 156         dump("FLAGS = (%s)\n",buf);
 157     }
 158     if (op->op_private) {
 159         *buf = '\0';
 160         if (op->op_type == OP_AASSIGN) {
 161             if (op->op_private & OPpASSIGN_COMMON)
 162                 (void)strcat(buf,"COMMON,");
 163         }
 164         else if (op->op_type == OP_SASSIGN) {
 165             if (op->op_private & OPpASSIGN_BACKWARDS)
 166                 (void)strcat(buf,"BACKWARDS,");
 167         }
 168         else if (op->op_type == OP_TRANS) {
 169             if (op->op_private & OPpTRANS_SQUASH)
 170                 (void)strcat(buf,"SQUASH,");
 171             if (op->op_private & OPpTRANS_DELETE)
 172                 (void)strcat(buf,"DELETE,");
 173             if (op->op_private & OPpTRANS_COMPLEMENT)
 174                 (void)strcat(buf,"COMPLEMENT,");
 175         }
 176         else if (op->op_type == OP_REPEAT) {
 177             if (op->op_private & OPpREPEAT_DOLIST)
 178                 (void)strcat(buf,"DOLIST,");
 179         }
 180         else if (op->op_type == OP_ENTERSUB ||
 181                  op->op_type == OP_RV2SV ||
 182                  op->op_type == OP_RV2AV ||
 183                  op->op_type == OP_RV2HV ||
 184                  op->op_type == OP_RV2GV ||
 185                  op->op_type == OP_AELEM ||
 186                  op->op_type == OP_HELEM )
 187         {
 188             if (op->op_type == OP_ENTERSUB) {
 189                 if (op->op_private & OPpENTERSUB_AMPER)
 190                     (void)strcat(buf,"AMPER,");
 191                 if (op->op_private & OPpENTERSUB_DB)
 192                     (void)strcat(buf,"DB,");
 193             }
 194             switch (op->op_private & OPpDEREF) {
 195             case OPpDEREF_SV:
 196                 (void)strcat(buf, "SV,");
 197                 break;
 198             case OPpDEREF_AV:
 199                 (void)strcat(buf, "AV,");
 200                 break;
 201             case OPpDEREF_HV:
 202                 (void)strcat(buf, "HV,");
 203                 break;
 204             }
 205             if (op->op_type == OP_AELEM || op->op_type == OP_HELEM) {
 206                 if (op->op_private & OPpLVAL_DEFER)
 207                     (void)strcat(buf,"LVAL_DEFER,");
 208             }
 209             else {
 210                 if (op->op_private & HINT_STRICT_REFS)
 211                     (void)strcat(buf,"STRICT_REFS,");
 212             }
 213         }
 214         else if (op->op_type == OP_CONST) {
 215             if (op->op_private & OPpCONST_BARE)
 216                 (void)strcat(buf,"BARE,");
 217         }
 218         else if (op->op_type == OP_FLIP) {
 219             if (op->op_private & OPpFLIP_LINENUM)
 220                 (void)strcat(buf,"LINENUM,");
 221         }
 222         else if (op->op_type == OP_FLOP) {
 223             if (op->op_private & OPpFLIP_LINENUM)
 224                 (void)strcat(buf,"LINENUM,");
 225         }
 226         if (op->op_flags & OPf_MOD && op->op_private & OPpLVAL_INTRO)
 227             (void)strcat(buf,"INTRO,");
 228         if (*buf) {
 229             buf[strlen(buf)-1] = '\0';
 230             dump("PRIVATE = (%s)\n",buf);
 231         }
 232     }
 233
 234     switch (op->op_type) {
 235     case OP_GVSV:
 236     case OP_GV:
 237         if (cGVOP->op_gv) {
 238             ENTER;
 239             tmpsv = NEWSV(0,0);
 240             SAVEFREESV(tmpsv);
 241             gv_fullname3(tmpsv, cGVOP->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(cSVOP->op_sv));
 250         break;
 251     case OP_NEXTSTATE:
 252     case OP_DBSTATE:
 253         if (cCOP->cop_line)
 254             dump("LINE = %d\n",cCOP->cop_line);
 255         if (cCOP->cop_label)
 256             dump("LABEL = \"%s\"\n",cCOP->cop_label);
 257         break;
 258     case OP_ENTERLOOP:
 259         dump("REDO ===> ");
 260         if (cLOOP->op_redoop)
 261             PerlIO_printf(Perl_debug_log, "%d\n", cLOOP->op_redoop->op_seq);
 262         else
 263             PerlIO_printf(Perl_debug_log, "DONE\n");
 264         dump("NEXT ===> ");
 265         if (cLOOP->op_nextop)
 266             PerlIO_printf(Perl_debug_log, "%d\n", cLOOP->op_nextop->op_seq);
 267         else
 268             PerlIO_printf(Perl_debug_log, "DONE\n");
 269         dump("LAST ===> ");
 270         if (cLOOP->op_lastop)
 271             PerlIO_printf(Perl_debug_log, "%d\n", cLOOP->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 (cCONDOP->op_true)
 278             PerlIO_printf(Perl_debug_log, "%d\n", cCONDOP->op_true->op_seq);
 279         else
 280             PerlIO_printf(Perl_debug_log, "DONE\n");
 281         dump("FALSE ===> ");
 282         if (cCONDOP->op_false)
 283             PerlIO_printf(Perl_debug_log, "%d\n", cCONDOP->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 (cLOGOP->op_other)
 293             PerlIO_printf(Perl_debug_log, "%d\n", cLOGOP->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((PMOP*)op);
 301         break;
 302     default:
 303         break;
 304     }
 305     if (op->op_flags & OPf_KIDS) {
 306         OP *kid;
 307         for (kid = cUNOP->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)
 316 register GV *gv;
 317 {
 318     SV *sv;
 319
 320     if (!gv) {
 321         PerlIO_printf(Perl_debug_log, "{}\n");
 322         return;
 323     }
 324     sv = sv_newmortal();
 325     dumplvl++;
 326     PerlIO_printf(Perl_debug_log, "{\n");
 327     gv_fullname3(sv, gv, Nullch);
 328     dump("GV_NAME = %s", SvPVX(sv));
 329     if (gv != GvEGV(gv)) {
 330         gv_efullname3(sv, GvEGV(gv), Nullch);
 331         dump("-> %s", SvPVX(sv));
 332     }
 333     dump("\n");
 334     dumplvl--;
 335     dump("}\n");
 336 }
 337
 338 void
 339 dump_pm(pm)
 340 register 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\n",ch,pm->op_pmregexp->precomp,ch);
 356     if (pm->op_type != OP_PUSHRE && pm->op_pmreplroot) {
 357         dump("PMf_REPL = ");
 358         dump_op(pm->op_pmreplroot);
 359     }
 360     if (pm->op_pmshort) {
 361         dump("PMf_SHORT = %s\n",SvPEEK(pm->op_pmshort));
 362     }
 363     if (pm->op_pmflags) {
 364         *buf = '\0';
 365         if (pm->op_pmflags & PMf_USED)
 366             (void)strcat(buf,"USED,");
 367         if (pm->op_pmflags & PMf_ONCE)
 368             (void)strcat(buf,"ONCE,");
 369         if (pm->op_pmflags & PMf_SCANFIRST)
 370             (void)strcat(buf,"SCANFIRST,");
 371         if (pm->op_pmflags & PMf_ALL)
 372             (void)strcat(buf,"ALL,");
 373         if (pm->op_pmflags & PMf_SKIPWHITE)
 374             (void)strcat(buf,"SKIPWHITE,");
 375         if (pm->op_pmflags & PMf_CONST)
 376             (void)strcat(buf,"CONST,");
 377         if (pm->op_pmflags & PMf_KEEP)
 378             (void)strcat(buf,"KEEP,");
 379         if (pm->op_pmflags & PMf_GLOBAL)
 380             (void)strcat(buf,"GLOBAL,");
 381         if (pm->op_pmflags & PMf_RUNTIME)
 382             (void)strcat(buf,"RUNTIME,");
 383         if (pm->op_pmflags & PMf_EVAL)
 384             (void)strcat(buf,"EVAL,");
 385         if (*buf)
 386             buf[strlen(buf)-1] = '\0';
 387         dump("PMFLAGS = (%s)\n",buf);
 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