3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 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,
13 * I have seen more than thou knowest, Grey Fool.' --Denethor
15 * [p.853 of _The Lord of the Rings_, V/vii: "The Pyre of Denethor"]
19 * This file contains various utilities for producing debugging output
20 * (mainly related to displaying the stack)
27 #if defined(PERL_IMPLICIT_CONTEXT)
29 Perl_deb_nocontext(const char *pat, ...)
34 PERL_ARGS_ASSERT_DEB_NOCONTEXT;
40 #endif /* DEBUGGING */
45 Perl_deb(pTHX_ const char *pat, ...)
54 #endif /* DEBUGGING */
59 Perl_vdeb(pTHX_ const char *pat, va_list *args)
62 const char* const file = PL_curcop ? OutCopFILE(PL_curcop) : "<null>";
63 const char* const display_file = file ? file : "<free>";
64 const long line = PL_curcop ? (long)CopLINE(PL_curcop) : 0;
66 PERL_ARGS_ASSERT_VDEB;
69 PerlIO_printf(Perl_debug_log, "(%ld:%s:%ld)\t",
70 (long)PerlProc_getpid(), display_file, line);
72 PerlIO_printf(Perl_debug_log, "(%s:%ld)\t", display_file, line);
73 (void) PerlIO_vprintf(Perl_debug_log, pat, *args);
77 PERL_UNUSED_ARG(args);
78 #endif /* DEBUGGING */
82 Perl_debstackptrs(pTHX)
85 PerlIO_printf(Perl_debug_log,
86 "%8" UVxf " %8" UVxf " %8" IVdf " %8" IVdf " %8" IVdf "\n",
87 PTR2UV(PL_curstack), PTR2UV(PL_stack_base),
88 (IV)*PL_markstack_ptr, (IV)(PL_stack_sp-PL_stack_base),
89 (IV)(PL_stack_max-PL_stack_base));
90 PerlIO_printf(Perl_debug_log,
91 "%8" UVxf " %8" UVxf " %8" UVuf " %8" UVuf " %8" UVuf "\n",
92 PTR2UV(PL_mainstack), PTR2UV(AvARRAY(PL_curstack)),
93 PTR2UV(PL_mainstack), PTR2UV(AvFILLp(PL_curstack)),
94 PTR2UV(AvMAX(PL_curstack)));
97 #endif /* DEBUGGING */
102 /* dump the contents of a particular stack
103 * Display stack_base[stack_min+1 .. stack_max],
104 * and display the marks whose offsets are contained in addresses
105 * PL_markstack[mark_min+1 .. mark_max] and whose values are in the range
106 * of the stack values being displayed
108 * Only displays top 30 max
112 S_deb_stack_n(pTHX_ SV** stack_base, I32 stack_min, I32 stack_max,
113 I32 mark_min, I32 mark_max)
116 I32 i = stack_max - 30;
117 const I32 *markscan = PL_markstack + mark_min;
119 PERL_ARGS_ASSERT_DEB_STACK_N;
124 while (++markscan <= PL_markstack + mark_max)
129 PerlIO_printf(Perl_debug_log, "... ");
131 if (stack_base[0] != &PL_sv_undef || stack_max < 0)
132 PerlIO_printf(Perl_debug_log, " [STACK UNDERFLOW!!!]\n");
135 if (markscan <= PL_markstack + mark_max && *markscan < i) {
138 (void)PerlIO_putc(Perl_debug_log, '*');
140 while (markscan <= PL_markstack + mark_max && *markscan < i);
141 PerlIO_printf(Perl_debug_log, " ");
145 PerlIO_printf(Perl_debug_log, "%-4s ", SvPEEK(stack_base[i]));
148 PerlIO_printf(Perl_debug_log, "\n");
151 PERL_UNUSED_ARG(stack_base);
152 PERL_UNUSED_ARG(stack_min);
153 PERL_UNUSED_ARG(stack_max);
154 PERL_UNUSED_ARG(mark_min);
155 PERL_UNUSED_ARG(mark_max);
156 #endif /* DEBUGGING */
160 /* dump the current stack */
165 #ifndef SKIP_DEBUGGING
166 if (CopSTASH_eq(PL_curcop, PL_debstash) && !DEBUG_J_TEST_)
169 PerlIO_printf(Perl_debug_log, " => ");
170 deb_stack_n(PL_stack_base,
172 PL_stack_sp - PL_stack_base,
173 PL_curstackinfo->si_markoff,
174 PL_markstack_ptr - PL_markstack);
177 #endif /* SKIP_DEBUGGING */
183 static const char * const si_names[] = {
199 /* display all stacks */
203 Perl_deb_stack_all(pTHX)
209 /* rewind to start of chain */
210 si = PL_curstackinfo;
217 const size_t si_name_ix = si->si_type+1; /* -1 is a valid index */
218 const char * const si_name =
219 si_name_ix < C_ARRAY_LENGTH(si_names) ?
220 si_names[si_name_ix] : "????";
222 PerlIO_printf(Perl_debug_log, "STACK %" IVdf ": %s\n",
225 for (ix=0; ix<=si->si_cxix; ix++) {
227 const PERL_CONTEXT * const cx = &(si->si_cxstack[ix]);
228 PerlIO_printf(Perl_debug_log,
229 " CX %" IVdf ": %-6s => ",
230 (IV)ix, PL_block_type[CxTYPE(cx)]
232 /* substitution contexts don't save stack pointers etc) */
233 if (CxTYPE(cx) == CXt_SUBST)
234 PerlIO_printf(Perl_debug_log, "\n");
237 /* Find the current context's stack range by searching
238 * forward for any higher contexts using this stack; failing
239 * that, it will be equal to the size of the stack for old
240 * stacks, or PL_stack_sp for the current stack
243 I32 i, stack_min, stack_max, mark_min, mark_max;
244 const PERL_CONTEXT *cx_n = NULL;
247 /* there's a separate argument stack per SI, so only
250 for (i=ix+1; i<=si->si_cxix; i++) {
251 const PERL_CONTEXT *this_cx = &(si->si_cxstack[i]);
252 if (CxTYPE(this_cx) == CXt_SUBST)
258 stack_min = cx->blk_oldsp;
261 stack_max = cx_n->blk_oldsp;
263 else if (si == PL_curstackinfo) {
264 stack_max = PL_stack_sp - AvARRAY(si->si_stack);
267 stack_max = AvFILLp(si->si_stack);
270 /* for the markstack, there's only one stack shared
278 if (i > si_n->si_cxix) {
279 if (si_n == PL_curstackinfo)
282 si_n = si_n->si_next;
286 if (CxTYPE(&(si_n->si_cxstack[i])) == CXt_SUBST)
288 cx_n = &(si_n->si_cxstack[i]);
292 mark_min = cx->blk_oldmarksp;
294 mark_max = cx_n->blk_oldmarksp;
297 mark_max = PL_markstack_ptr - PL_markstack;
300 deb_stack_n(AvARRAY(si->si_stack),
301 stack_min, stack_max, mark_min, mark_max);
303 if (CxTYPE(cx) == CXt_EVAL || CxTYPE(cx) == CXt_SUB
304 || CxTYPE(cx) == CXt_FORMAT)
306 const OP * const retop = cx->blk_sub.retop;
308 PerlIO_printf(Perl_debug_log, " retop=%s\n",
309 retop ? OP_NAME(retop) : "(null)"
316 if (si == PL_curstackinfo)
321 break; /* shouldn't happen, but just in case.. */
322 } /* next stackinfo */
324 PerlIO_printf(Perl_debug_log, "\n");
327 #endif /* DEBUGGING */
331 * ex: set ts=8 sts=4 sw=4 et: