3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
4 * 2000, 2001, 2002, by Larry Wall and others
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.
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
17 * This file contains various utilities for producing debugging output
18 * (mainly related to displaying the stack)
25 #if defined(PERL_IMPLICIT_CONTEXT)
27 Perl_deb_nocontext(const char *pat, ...)
35 #endif /* DEBUGGING */
40 Perl_deb(pTHX_ const char *pat, ...)
47 #endif /* DEBUGGING */
51 Perl_vdeb(pTHX_ const char *pat, va_list *args)
54 char* file = OutCopFILE(PL_curcop);
56 PerlIO_printf(Perl_debug_log, "(%s:%ld)\t", (file ? file : "<free>"),
57 (long)CopLINE(PL_curcop));
58 (void) PerlIO_vprintf(Perl_debug_log, pat, *args);
59 #endif /* DEBUGGING */
63 Perl_debstackptrs(pTHX)
66 PerlIO_printf(Perl_debug_log,
67 "%8"UVxf" %8"UVxf" %8"IVdf" %8"IVdf" %8"IVdf"\n",
68 PTR2UV(PL_curstack), PTR2UV(PL_stack_base),
69 (IV)*PL_markstack_ptr, (IV)(PL_stack_sp-PL_stack_base),
70 (IV)(PL_stack_max-PL_stack_base));
71 PerlIO_printf(Perl_debug_log,
72 "%8"UVxf" %8"UVxf" %8"UVuf" %8"UVuf" %8"UVuf"\n",
73 PTR2UV(PL_mainstack), PTR2UV(AvARRAY(PL_curstack)),
74 PTR2UV(PL_mainstack), PTR2UV(AvFILLp(PL_curstack)),
75 PTR2UV(AvMAX(PL_curstack)));
76 #endif /* DEBUGGING */
81 /* dump the contents of a particular stack
82 * Display stack_base[stack_min+1 .. stack_max],
83 * and display the marks whose offsets are contained in addresses
84 * PL_markstack[mark_min+1 .. mark_max] and whose values are in the range
85 * of the stack values being displayed
87 * Only displays top 30 max
91 S_deb_stack_n(pTHX_ SV** stack_base, I32 stack_min, I32 stack_max,
92 I32 mark_min, I32 mark_max)
95 register I32 i = stack_max - 30;
96 I32 *markscan = PL_markstack + mark_min;
100 while (++markscan <= PL_markstack + mark_max)
105 PerlIO_printf(Perl_debug_log, "... ");
107 if (stack_base[0] != &PL_sv_undef || stack_max < 0)
108 PerlIO_printf(Perl_debug_log, " [STACK UNDERFLOW!!!]\n");
111 if (markscan <= PL_markstack + mark_max && *markscan < i) {
114 PerlIO_putc(Perl_debug_log, '*');
116 while (markscan <= PL_markstack + mark_max && *markscan < i);
117 PerlIO_printf(Perl_debug_log, " ");
121 PerlIO_printf(Perl_debug_log, "%-4s ", SvPEEK(stack_base[i]));
124 PerlIO_printf(Perl_debug_log, "\n");
125 #endif /* DEBUGGING */
129 /* dump the current stack */
134 #ifndef SKIP_DEBUGGING
135 if (CopSTASH_eq(PL_curcop, PL_debstash) && !DEBUG_J_TEST_)
138 PerlIO_printf(Perl_debug_log, " => ");
139 deb_stack_n(PL_stack_base,
141 PL_stack_sp - PL_stack_base,
142 PL_curstackinfo->si_markoff,
143 PL_markstack_ptr - PL_markstack);
146 #endif /* SKIP_DEBUGGING */
152 static char * si_names[] = {
167 /* display all stacks */
171 Perl_deb_stack_all(pTHX)
178 /* rewind to start of chain */
179 si = PL_curstackinfo;
187 int si_name_ix = si->si_type+1; /* -1 is a valid index */
188 if (si_name_ix>= sizeof(si_names))
191 si_name = si_names[si_name_ix];
192 PerlIO_printf(Perl_debug_log, "STACK %"IVdf": %s\n",
195 for (ix=0; ix<=si->si_cxix; ix++) {
197 cx = &(si->si_cxstack[ix]);
198 PerlIO_printf(Perl_debug_log,
199 " CX %"IVdf": %-6s => ",
200 (IV)ix, PL_block_type[CxTYPE(cx)]
202 /* substitution contexts don't save stack pointers etc) */
203 if (CxTYPE(cx) == CXt_SUBST)
204 PerlIO_printf(Perl_debug_log, "\n");
207 /* Find the the current context's stack range by searching
208 * forward for any higher contexts using this stack; failing
209 * that, it will be equal to the size of the stack for old
210 * stacks, or PL_stack_sp for the current stack
213 I32 i, stack_min, stack_max, mark_min, mark_max;
218 cx_n = Null(PERL_CONTEXT*);
220 /* there's a separate stack per SI, so only search
223 for (i=ix+1; i<=si->si_cxix; i++) {
224 if (CxTYPE(cx) == CXt_SUBST)
226 cx_n = &(si->si_cxstack[i]);
230 stack_min = cx->blk_oldsp;
233 stack_max = cx_n->blk_oldsp;
235 else if (si == PL_curstackinfo) {
236 stack_max = PL_stack_sp - AvARRAY(si->si_stack);
239 stack_max = AvFILLp(si->si_stack);
242 /* for the other stack types, there's only one stack
243 * shared between all SIs */
247 cx_n = Null(PERL_CONTEXT*);
250 if (i > si_n->si_cxix) {
251 if (si_n == PL_curstackinfo)
254 si_n = si_n->si_next;
258 if (CxTYPE(&(si_n->si_cxstack[i])) == CXt_SUBST)
260 cx_n = &(si_n->si_cxstack[i]);
264 mark_min = cx->blk_oldmarksp;
266 mark_max = cx_n->blk_oldmarksp;
269 mark_max = PL_markstack_ptr - PL_markstack;
272 deb_stack_n(AvARRAY(si->si_stack),
273 stack_min, stack_max, mark_min, mark_max);
275 if (CxTYPE(cx) == CXt_EVAL || CxTYPE(cx) == CXt_SUB
276 || CxTYPE(cx) == CXt_FORMAT)
278 retop = (CxTYPE(cx) == CXt_EVAL)
279 ? cx->blk_eval.retop : cx->blk_sub.retop;
281 PerlIO_printf(Perl_debug_log, " retop=%s\n",
282 retop ? OP_NAME(retop) : "(null)"
289 if (si == PL_curstackinfo)
294 break; /* shouldn't happen, but just in case.. */
295 } /* next stackinfo */
297 PerlIO_printf(Perl_debug_log, "\n");
298 #endif /* DEBUGGING */