deb.c

   1 /*    deb.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 /*
  12  * "Didst thou think that the eyes of the White Tower were blind?  Nay, I
  13  * have seen more than thou knowest, Gray Fool."  --Denethor
  14  */
  15
  16 /*
  17  * This file contains various utilities for producing debugging output
  18  * (mainly related to displaying the stack)
  19  */
  20
  21 #include "EXTERN.h"
  22 #define PERL_IN_DEB_C
  23 #include "perl.h"
  24
  25 #if defined(PERL_IMPLICIT_CONTEXT)
  26 void
  27 Perl_deb_nocontext(const char *pat, ...)
  28 {
  29 #ifdef DEBUGGING
  30     dTHX;
  31     va_list args;
  32     va_start(args, pat);
  33     vdeb(pat, &args);
  34     va_end(args);
  35 #else
  36     PERL_UNUSED_ARG(pat);
  37 #endif /* DEBUGGING */
  38 }
  39 #endif
  40
  41 void
  42 Perl_deb(pTHX_ const char *pat, ...)
  43 {
  44 #ifdef DEBUGGING
  45     va_list args;
  46     va_start(args, pat);
  47     vdeb(pat, &args);
  48     va_end(args);
  49 #else
  50     PERL_UNUSED_ARG(pat);
  51 #endif /* DEBUGGING */
  52 }
  53
  54 void
  55 Perl_vdeb(pTHX_ const char *pat, va_list *args)
  56 {
  57 #ifdef DEBUGGING
  58     dVAR;
  59     const char* const file = OutCopFILE(PL_curcop);
  60
  61     PerlIO_printf(Perl_debug_log, "(%s:%ld)\t", (file ? file : "<free>"),
  62                   (long)CopLINE(PL_curcop));
  63     (void) PerlIO_vprintf(Perl_debug_log, pat, *args);
  64 #else
  65     PERL_UNUSED_ARG(pat);
  66     PERL_UNUSED_ARG(args);
  67 #endif /* DEBUGGING */
  68 }
  69
  70 I32
  71 Perl_debstackptrs(pTHX)
  72 {
  73 #ifdef DEBUGGING
  74     dVAR;
  75     PerlIO_printf(Perl_debug_log,
  76                   "%8"UVxf" %8"UVxf" %8"IVdf" %8"IVdf" %8"IVdf"\n",
  77                   PTR2UV(PL_curstack), PTR2UV(PL_stack_base),
  78                   (IV)*PL_markstack_ptr, (IV)(PL_stack_sp-PL_stack_base),
  79                   (IV)(PL_stack_max-PL_stack_base));
  80     PerlIO_printf(Perl_debug_log,
  81                   "%8"UVxf" %8"UVxf" %8"UVuf" %8"UVuf" %8"UVuf"\n",
  82                   PTR2UV(PL_mainstack), PTR2UV(AvARRAY(PL_curstack)),
  83                   PTR2UV(PL_mainstack), PTR2UV(AvFILLp(PL_curstack)),
  84                   PTR2UV(AvMAX(PL_curstack)));
  85 #endif /* DEBUGGING */
  86     return 0;
  87 }
  88
  89
  90 /* dump the contents of a particular stack
  91  * Display stack_base[stack_min+1 .. stack_max],
  92  * and display the marks whose offsets are contained in addresses
  93  * PL_markstack[mark_min+1 .. mark_max] and whose values are in the range
  94  * of the stack values being displayed
  95  *
  96  * Only displays top 30 max
  97  */
  98
  99 STATIC void
 100 S_deb_stack_n(pTHX_ SV** stack_base, I32 stack_min, I32 stack_max,
 101         I32 mark_min, I32 mark_max)
 102 {
 103 #ifdef DEBUGGING
 104     dVAR;
 105     register I32 i = stack_max - 30;
 106     const I32 *markscan = PL_markstack + mark_min;
 107     if (i < stack_min)
 108         i = stack_min;
 109
 110     while (++markscan <= PL_markstack + mark_max)
 111         if (*markscan >= i)
 112             break;
 113
 114     if (i > stack_min)
 115         PerlIO_printf(Perl_debug_log, "... ");
 116
 117     if (stack_base[0] != &PL_sv_undef || stack_max < 0)
 118         PerlIO_printf(Perl_debug_log, " [STACK UNDERFLOW!!!]\n");
 119     do {
 120         ++i;
 121         if (markscan <= PL_markstack + mark_max && *markscan < i) {
 122             do {
 123                 ++markscan;
 124                 PerlIO_putc(Perl_debug_log, '*');
 125             }
 126             while (markscan <= PL_markstack + mark_max && *markscan < i);
 127             PerlIO_printf(Perl_debug_log, "  ");
 128         }
 129         if (i > stack_max)
 130             break;
 131         PerlIO_printf(Perl_debug_log, "%-4s  ", SvPEEK(stack_base[i]));
 132     }
 133     while (1);
 134     PerlIO_printf(Perl_debug_log, "\n");
 135 #else
 136     PERL_UNUSED_ARG(stack_base);
 137     PERL_UNUSED_ARG(stack_min);
 138     PERL_UNUSED_ARG(stack_max);
 139     PERL_UNUSED_ARG(mark_min);
 140     PERL_UNUSED_ARG(mark_max);
 141 #endif /* DEBUGGING */
 142 }
 143
 144
 145 /* dump the current stack */
 146
 147 I32
 148 Perl_debstack(pTHX)
 149 {
 150 #ifndef SKIP_DEBUGGING
 151     dVAR;
 152     if (CopSTASH_eq(PL_curcop, PL_debstash) && !DEBUG_J_TEST_)
 153         return 0;
 154
 155     PerlIO_printf(Perl_debug_log, "    =>  ");
 156     deb_stack_n(PL_stack_base,
 157                 0,
 158                 PL_stack_sp - PL_stack_base,
 159                 PL_curstackinfo->si_markoff,
 160                 PL_markstack_ptr - PL_markstack);
 161
 162
 163 #endif /* SKIP_DEBUGGING */
 164     return 0;
 165 }
 166
 167
 168 #ifdef DEBUGGING
 169 static const char * const si_names[] = {
 170     "UNKNOWN",
 171     "UNDEF",
 172     "MAIN",
 173     "MAGIC",
 174     "SORT",
 175     "SIGNAL",
 176     "OVERLOAD",
 177     "DESTROY",
 178     "WARNHOOK",
 179     "DIEHOOK",
 180     "REQUIRE"
 181 };
 182 #endif
 183
 184 /* display all stacks */
 185
 186
 187 void
 188 Perl_deb_stack_all(pTHX)
 189 {
 190 #ifdef DEBUGGING
 191     dVAR;
 192     I32 si_ix;
 193     const PERL_SI *si;
 194
 195     /* rewind to start of chain */
 196     si = PL_curstackinfo;
 197     while (si->si_prev)
 198         si = si->si_prev;
 199
 200     si_ix=0;
 201     for (;;)
 202     {
 203         const int si_name_ix = si->si_type+1; /* -1 is a valid index */
 204         const char * const si_name = (si_name_ix>= sizeof(si_names)) ? "????" : si_names[si_name_ix];
 205         I32 ix;
 206         PerlIO_printf(Perl_debug_log, "STACK %"IVdf": %s\n",
 207                                                 (IV)si_ix, si_name);
 208
 209         for (ix=0; ix<=si->si_cxix; ix++) {
 210
 211             const PERL_CONTEXT * const cx = &(si->si_cxstack[ix]);
 212             PerlIO_printf(Perl_debug_log,
 213                     "  CX %"IVdf": %-6s => ",
 214                     (IV)ix, PL_block_type[CxTYPE(cx)]
 215             );
 216             /* substitution contexts don't save stack pointers etc) */
 217             if (CxTYPE(cx) == CXt_SUBST)
 218                 PerlIO_printf(Perl_debug_log, "\n");
 219             else {
 220
 221                 /* Find the the current context's stack range by searching
 222                  * forward for any higher contexts using this stack; failing
 223                  * that, it will be equal to the size of the stack for old
 224                  * stacks, or PL_stack_sp for the current stack
 225                  */
 226
 227                 I32 i, stack_min, stack_max, mark_min, mark_max;
 228                 const PERL_CONTEXT *cx_n = NULL;
 229                 const PERL_SI *si_n;
 230
 231                 /* there's a separate stack per SI, so only search
 232                  * this one */
 233
 234                 for (i=ix+1; i<=si->si_cxix; i++) {
 235                     if (CxTYPE(cx) == CXt_SUBST)
 236                         continue;
 237                     cx_n = &(si->si_cxstack[i]);
 238                     break;
 239                 }
 240
 241                 stack_min = cx->blk_oldsp;
 242
 243                 if (cx_n) {
 244                     stack_max = cx_n->blk_oldsp;
 245                 }
 246                 else if (si == PL_curstackinfo) {
 247                     stack_max = PL_stack_sp - AvARRAY(si->si_stack);
 248                 }
 249                 else {
 250                     stack_max = AvFILLp(si->si_stack);
 251                 }
 252
 253                 /* for the other stack types, there's only one stack
 254                  * shared between all SIs */
 255
 256                 si_n = si;
 257                 i = ix;
 258                 cx_n = NULL;
 259                 for (;;) {
 260                     i++;
 261                     if (i > si_n->si_cxix) {
 262                         if (si_n == PL_curstackinfo)
 263                             break;
 264                         else {
 265                             si_n = si_n->si_next;
 266                             i = 0;
 267                         }
 268                     }
 269                     if (CxTYPE(&(si_n->si_cxstack[i])) == CXt_SUBST)
 270                         continue;
 271                     cx_n = &(si_n->si_cxstack[i]);
 272                     break;
 273                 }
 274
 275                 mark_min  = cx->blk_oldmarksp;
 276                 if (cx_n) {
 277                     mark_max  = cx_n->blk_oldmarksp;
 278                 }
 279                 else {
 280                     mark_max = PL_markstack_ptr - PL_markstack;
 281                 }
 282
 283                 deb_stack_n(AvARRAY(si->si_stack),
 284                         stack_min, stack_max, mark_min, mark_max);
 285
 286                 if (CxTYPE(cx) == CXt_EVAL || CxTYPE(cx) == CXt_SUB
 287                         || CxTYPE(cx) == CXt_FORMAT)
 288                 {
 289                     const OP * const retop = (CxTYPE(cx) == CXt_EVAL)
 290                             ? cx->blk_eval.retop : cx->blk_sub.retop;
 291
 292                     PerlIO_printf(Perl_debug_log, "  retop=%s\n",
 293                             retop ? OP_NAME(retop) : "(null)"
 294                     );
 295                 }
 296             }
 297         } /* next context */
 298
 299
 300         if (si == PL_curstackinfo)
 301             break;
 302         si = si->si_next;
 303         si_ix++;
 304         if (!si)
 305             break; /* shouldn't happen, but just in case.. */
 306     } /* next stackinfo */
 307
 308     PerlIO_printf(Perl_debug_log, "\n");
 309 #endif /* DEBUGGING */
 310 }
 311
 312 /*
 313  * Local variables:
 314  * c-indentation-style: bsd
 315  * c-basic-offset: 4
 316  * indent-tabs-mode: t
 317  * End:
 318  *
 319  * ex: set ts=8 sts=4 sw=4 noet:
 320  */