staticperl/perl/deb.c

/*    deb.c
 *
 *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
 *    2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

/*
 * "Didst thou think that the eyes of the White Tower were blind?  Nay, I
 * have seen more than thou knowest, Gray Fool."  --Denethor
 */

/*
 * This file contains various utilities for producing debugging output
 * (mainly related to displaying the stack)
 */

#include "EXTERN.h"
#define PERL_IN_DEB_C
#include "perl.h"

#if defined(PERL_IMPLICIT_CONTEXT)
void
Perl_deb_nocontext(const char *pat, ...)
{
#ifdef DEBUGGING
    dTHX;
    va_list args;
    va_start(args, pat);
    vdeb(pat, &args);
    va_end(args);
#endif /* DEBUGGING */
}
#endif

void
Perl_deb(pTHX_ const char *pat, ...)
{
#ifdef DEBUGGING
    va_list args;
    va_start(args, pat);
    vdeb(pat, &args);
    va_end(args);
#endif /* DEBUGGING */
}

void
Perl_vdeb(pTHX_ const char *pat, va_list *args)
{
#ifdef DEBUGGING
    char* file = OutCopFILE(PL_curcop);

#ifdef USE_5005THREADS
    PerlIO_printf(Perl_debug_log, "0x%"UVxf" (%s:%ld)\t",
                  PTR2UV(thr),
                  (file ? file : "<free>"),
                  (long)CopLINE(PL_curcop));
#else
    PerlIO_printf(Perl_debug_log, "(%s:%ld)\t", (file ? file : "<free>"),
                  (long)CopLINE(PL_curcop));
#endif /* USE_5005THREADS */
    (void) PerlIO_vprintf(Perl_debug_log, pat, *args);
#endif /* DEBUGGING */
}

I32
Perl_debstackptrs(pTHX)
{
#ifdef DEBUGGING
    PerlIO_printf(Perl_debug_log,
                  "%8"UVxf" %8"UVxf" %8"IVdf" %8"IVdf" %8"IVdf"\n",
                  PTR2UV(PL_curstack), PTR2UV(PL_stack_base),
                  (IV)*PL_markstack_ptr, (IV)(PL_stack_sp-PL_stack_base),
                  (IV)(PL_stack_max-PL_stack_base));
    PerlIO_printf(Perl_debug_log,
                  "%8"UVxf" %8"UVxf" %8"UVuf" %8"UVuf" %8"UVuf"\n",
                  PTR2UV(PL_mainstack), PTR2UV(AvARRAY(PL_curstack)),
                  PTR2UV(PL_mainstack), PTR2UV(AvFILLp(PL_curstack)),
                  PTR2UV(AvMAX(PL_curstack)));
#endif /* DEBUGGING */
    return 0;
}


/* dump the contents of a particular stack
 * Display stack_base[stack_min+1 .. stack_max],
 * and display the marks whose offsets are contained in addresses
 * PL_markstack[mark_min+1 .. mark_max] and whose values are in the range
 * of the stack values being displayed
 *
 * Only displays top 30 max
 */

STATIC void
S_deb_stack_n(pTHX_ SV** stack_base, I32 stack_min, I32 stack_max,
        I32 mark_min, I32 mark_max)
{
#ifdef DEBUGGING
    register I32 i = stack_max - 30;
    I32 *markscan = PL_markstack + mark_min;
    if (i < stack_min)
        i = stack_min;
    
    while (++markscan <= PL_markstack + mark_max)
        if (*markscan >= i)
            break;

    if (i > stack_min)
        PerlIO_printf(Perl_debug_log, "... ");

    if (stack_base[0] != &PL_sv_undef || stack_max < 0)
        PerlIO_printf(Perl_debug_log, " [STACK UNDERFLOW!!!]\n");
    do {
        ++i;
        if (markscan <= PL_markstack + mark_max && *markscan < i) {
            do {
                ++markscan;
                PerlIO_putc(Perl_debug_log, '*');
            }
            while (markscan <= PL_markstack + mark_max && *markscan < i);
            PerlIO_printf(Perl_debug_log, "  ");
        }
        if (i > stack_max)
            break;
        PerlIO_printf(Perl_debug_log, "%-4s  ", SvPEEK(stack_base[i]));
    }
    while (1);
    PerlIO_printf(Perl_debug_log, "\n");
#endif /* DEBUGGING */
}


/* dump the current stack */

I32
Perl_debstack(pTHX)
{
#ifndef SKIP_DEBUGGING
    if (CopSTASH_eq(PL_curcop, PL_debstash) && !DEBUG_J_TEST_)
        return 0;

    PerlIO_printf(Perl_debug_log, "    =>  ");
    deb_stack_n(PL_stack_base,
                0,
                PL_stack_sp - PL_stack_base,
                PL_curstackinfo->si_markoff,
                PL_markstack_ptr - PL_markstack);


#endif /* SKIP_DEBUGGING */
    return 0;
}


#ifdef DEBUGGING
static char * si_names[] = {
    "UNKNOWN",
    "UNDEF",
    "MAIN",
    "MAGIC",
    "SORT",
    "SIGNAL",
    "OVERLOAD",
    "DESTROY",
    "WARNHOOK",
    "DIEHOOK",
    "REQUIRE"
};
#endif

/* display all stacks */


void
Perl_deb_stack_all(pTHX)
{
#ifdef DEBUGGING
    I32          ix, si_ix;
    PERL_SI      *si;
    PERL_CONTEXT *cx;

    /* rewind to start of chain */
    si = PL_curstackinfo;
    while (si->si_prev)
        si = si->si_prev;

    si_ix=0;
    for (;;)
    {
        char *si_name;
        int si_name_ix = si->si_type+1; /* -1 is a valid index */
        if (si_name_ix>= sizeof(si_names))
            si_name = "????";
        else
            si_name = si_names[si_name_ix];
        PerlIO_printf(Perl_debug_log, "STACK %"IVdf": %s\n",
                                                (IV)si_ix, si_name);

        for (ix=0; ix<=si->si_cxix; ix++) {

            cx = &(si->si_cxstack[ix]);
            PerlIO_printf(Perl_debug_log,
                    "  CX %"IVdf": %-6s => ",
                    (IV)ix, PL_block_type[CxTYPE(cx)]
            );
            /* substitution contexts don't save stack pointers etc) */
            if (CxTYPE(cx) == CXt_SUBST)
                PerlIO_printf(Perl_debug_log, "\n");
            else {

                /* Find the the current context's stack range by searching
                 * forward for any higher contexts using this stack; failing
                 * that, it will be equal to the size of the stack for old
                 * stacks, or PL_stack_sp for the current stack
                 */

                I32 i, stack_min, stack_max, mark_min, mark_max;
                I32 ret_min, ret_max;
                PERL_CONTEXT *cx_n;
                PERL_SI      *si_n;

                cx_n = Null(PERL_CONTEXT*);

                /* there's a separate stack per SI, so only search
                 * this one */

                for (i=ix+1; i<=si->si_cxix; i++) {
                    if (CxTYPE(cx) == CXt_SUBST)
                        continue;
                    cx_n = &(si->si_cxstack[i]);
                    break;
                }

                stack_min = cx->blk_oldsp;

                if (cx_n) {
                    stack_max = cx_n->blk_oldsp;
                }
                else if (si == PL_curstackinfo) {
                    stack_max = PL_stack_sp - AvARRAY(si->si_stack);
                }
                else {
                    stack_max = AvFILLp(si->si_stack);
                }

                /* for the other stack types, there's only one stack
                 * shared between all SIs */

                si_n = si;
                i = ix;
                cx_n = Null(PERL_CONTEXT*);
                for (;;) {
                    i++;
                    if (i > si_n->si_cxix) {
                        if (si_n == PL_curstackinfo)
                            break;
                        else {
                            si_n = si_n->si_next;
                            i = 0;
                        }
                    }
                    if (CxTYPE(&(si_n->si_cxstack[i])) == CXt_SUBST)
                        continue;
                    cx_n = &(si_n->si_cxstack[i]);
                    break;
                }

                mark_min  = cx->blk_oldmarksp;
                ret_min   = cx->blk_oldretsp;
                if (cx_n) {
                    mark_max  = cx_n->blk_oldmarksp;
                    ret_max   = cx_n->blk_oldretsp;
                }
                else {
                    mark_max = PL_markstack_ptr - PL_markstack;
                    ret_max  = PL_retstack_ix;
                }

                deb_stack_n(AvARRAY(si->si_stack),
                        stack_min, stack_max, mark_min, mark_max);

                if (ret_max > ret_min) {
                    PerlIO_printf(Perl_debug_log, "  retop=%s\n",
                            PL_retstack[ret_min]
                                ? OP_NAME(PL_retstack[ret_min])
                                : "(null)"
                    );
                }

            }
        } /* next context */


        if (si == PL_curstackinfo)
            break;
        si = si->si_next;
        si_ix++;
        if (!si)
            break; /* shouldn't happen, but just in case.. */
    } /* next stackinfo */

    PerlIO_printf(Perl_debug_log, "\n");
#endif /* DEBUGGING */
}


Revision:	1.1
Committed:	Thu Jun 30 14:26:41 2005 UTC (21 years, 2 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	PERL-5-8-7, HEAD
Branch point for:	PERL
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	/* deb.c
2			*
3			* Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
4			* 2000, 2001, 2002, 2003, 2004, 2005, 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			#endif /* DEBUGGING */
36			}
37			#endif
38
39			void
40			Perl_deb(pTHX_ const char *pat, ...)
41			{
42			#ifdef DEBUGGING
43			va_list args;
44			va_start(args, pat);
45			vdeb(pat, &args);
46			va_end(args);
47			#endif /* DEBUGGING */
48			}
49
50			void
51			Perl_vdeb(pTHX_ const char pat, va_list args)
52			{
53			#ifdef DEBUGGING
54			char* file = OutCopFILE(PL_curcop);
55
56			#ifdef USE_5005THREADS
57			PerlIO_printf(Perl_debug_log, "0x%"UVxf" (%s:%ld)\t",
58			PTR2UV(thr),
59			(file ? file : "<free>"),
60			(long)CopLINE(PL_curcop));
61			#else
62			PerlIO_printf(Perl_debug_log, "(%s:%ld)\t", (file ? file : "<free>"),
63			(long)CopLINE(PL_curcop));
64			#endif /* USE_5005THREADS */
65			(void) PerlIO_vprintf(Perl_debug_log, pat, *args);
66			#endif /* DEBUGGING */
67			}
68
69			I32
70			Perl_debstackptrs(pTHX)
71			{
72			#ifdef DEBUGGING
73			PerlIO_printf(Perl_debug_log,
74			"%8"UVxf" %8"UVxf" %8"IVdf" %8"IVdf" %8"IVdf"\n",
75			PTR2UV(PL_curstack), PTR2UV(PL_stack_base),
76			(IV)*PL_markstack_ptr, (IV)(PL_stack_sp-PL_stack_base),
77			(IV)(PL_stack_max-PL_stack_base));
78			PerlIO_printf(Perl_debug_log,
79			"%8"UVxf" %8"UVxf" %8"UVuf" %8"UVuf" %8"UVuf"\n",
80			PTR2UV(PL_mainstack), PTR2UV(AvARRAY(PL_curstack)),
81			PTR2UV(PL_mainstack), PTR2UV(AvFILLp(PL_curstack)),
82			PTR2UV(AvMAX(PL_curstack)));
83			#endif /* DEBUGGING */
84			return 0;
85			}
86
87
88			/* dump the contents of a particular stack
89			* Display stack_base[stack_min+1 .. stack_max],
90			* and display the marks whose offsets are contained in addresses
91			* PL_markstack[mark_min+1 .. mark_max] and whose values are in the range
92			* of the stack values being displayed
93			*
94			* Only displays top 30 max
95			*/
96
97			STATIC void
98			S_deb_stack_n(pTHX_ SV** stack_base, I32 stack_min, I32 stack_max,
99			I32 mark_min, I32 mark_max)
100			{
101			#ifdef DEBUGGING
102			register I32 i = stack_max - 30;
103			I32 *markscan = PL_markstack + mark_min;
104			if (i < stack_min)
105			i = stack_min;
106
107			while (++markscan <= PL_markstack + mark_max)
108			if (*markscan >= i)
109			break;
110
111			if (i > stack_min)
112			PerlIO_printf(Perl_debug_log, "... ");
113
114			if (stack_base[0] != &PL_sv_undef \|\| stack_max < 0)
115			PerlIO_printf(Perl_debug_log, " [STACK UNDERFLOW!!!]\n");
116			do {
117			++i;
118			if (markscan <= PL_markstack + mark_max && *markscan < i) {
119			do {
120			++markscan;
121			PerlIO_putc(Perl_debug_log, '*');
122			}
123			while (markscan <= PL_markstack + mark_max && *markscan < i);
124			PerlIO_printf(Perl_debug_log, " ");
125			}
126			if (i > stack_max)
127			break;
128			PerlIO_printf(Perl_debug_log, "%-4s ", SvPEEK(stack_base[i]));
129			}
130			while (1);
131			PerlIO_printf(Perl_debug_log, "\n");
132			#endif /* DEBUGGING */
133			}
134
135
136			/* dump the current stack */
137
138			I32
139			Perl_debstack(pTHX)
140			{
141			#ifndef SKIP_DEBUGGING
142			if (CopSTASH_eq(PL_curcop, PL_debstash) && !DEBUG_J_TEST_)
143			return 0;
144
145			PerlIO_printf(Perl_debug_log, " => ");
146			deb_stack_n(PL_stack_base,
147			0,
148			PL_stack_sp - PL_stack_base,
149			PL_curstackinfo->si_markoff,
150			PL_markstack_ptr - PL_markstack);
151
152
153			#endif /* SKIP_DEBUGGING */
154			return 0;
155			}
156
157
158			#ifdef DEBUGGING
159			static char * si_names[] = {
160			"UNKNOWN",
161			"UNDEF",
162			"MAIN",
163			"MAGIC",
164			"SORT",
165			"SIGNAL",
166			"OVERLOAD",
167			"DESTROY",
168			"WARNHOOK",
169			"DIEHOOK",
170			"REQUIRE"
171			};
172			#endif
173
174			/* display all stacks */
175
176
177			void
178			Perl_deb_stack_all(pTHX)
179			{
180			#ifdef DEBUGGING
181			I32 ix, si_ix;
182			PERL_SI *si;
183			PERL_CONTEXT *cx;
184
185			/* rewind to start of chain */
186			si = PL_curstackinfo;
187			while (si->si_prev)
188			si = si->si_prev;
189
190			si_ix=0;
191			for (;;)
192			{
193			char *si_name;
194			int si_name_ix = si->si_type+1; /* -1 is a valid index */
195			if (si_name_ix>= sizeof(si_names))
196			si_name = "????";
197			else
198			si_name = si_names[si_name_ix];
199			PerlIO_printf(Perl_debug_log, "STACK %"IVdf": %s\n",
200			(IV)si_ix, si_name);
201
202			for (ix=0; ix<=si->si_cxix; ix++) {
203
204			cx = &(si->si_cxstack[ix]);
205			PerlIO_printf(Perl_debug_log,
206			" CX %"IVdf": %-6s => ",
207			(IV)ix, PL_block_type[CxTYPE(cx)]
208			);
209			/* substitution contexts don't save stack pointers etc) */
210			if (CxTYPE(cx) == CXt_SUBST)
211			PerlIO_printf(Perl_debug_log, "\n");
212			else {
213
214			/* Find the the current context's stack range by searching
215			* forward for any higher contexts using this stack; failing
216			* that, it will be equal to the size of the stack for old
217			* stacks, or PL_stack_sp for the current stack
218			*/
219
220			I32 i, stack_min, stack_max, mark_min, mark_max;
221			I32 ret_min, ret_max;
222			PERL_CONTEXT *cx_n;
223			PERL_SI *si_n;
224
225			cx_n = Null(PERL_CONTEXT*);
226
227			/* there's a separate stack per SI, so only search
228			* this one */
229
230			for (i=ix+1; i<=si->si_cxix; i++) {
231			if (CxTYPE(cx) == CXt_SUBST)
232			continue;
233			cx_n = &(si->si_cxstack[i]);
234			break;
235			}
236
237			stack_min = cx->blk_oldsp;
238
239			if (cx_n) {
240			stack_max = cx_n->blk_oldsp;
241			}
242			else if (si == PL_curstackinfo) {
243			stack_max = PL_stack_sp - AvARRAY(si->si_stack);
244			}
245			else {
246			stack_max = AvFILLp(si->si_stack);
247			}
248
249			/* for the other stack types, there's only one stack
250			* shared between all SIs */
251
252			si_n = si;
253			i = ix;
254			cx_n = Null(PERL_CONTEXT*);
255			for (;;) {
256			i++;
257			if (i > si_n->si_cxix) {
258			if (si_n == PL_curstackinfo)
259			break;
260			else {
261			si_n = si_n->si_next;
262			i = 0;
263			}
264			}
265			if (CxTYPE(&(si_n->si_cxstack[i])) == CXt_SUBST)
266			continue;
267			cx_n = &(si_n->si_cxstack[i]);
268			break;
269			}
270
271			mark_min = cx->blk_oldmarksp;
272			ret_min = cx->blk_oldretsp;
273			if (cx_n) {
274			mark_max = cx_n->blk_oldmarksp;
275			ret_max = cx_n->blk_oldretsp;
276			}
277			else {
278			mark_max = PL_markstack_ptr - PL_markstack;
279			ret_max = PL_retstack_ix;
280			}
281
282			deb_stack_n(AvARRAY(si->si_stack),
283			stack_min, stack_max, mark_min, mark_max);
284
285			if (ret_max > ret_min) {
286			PerlIO_printf(Perl_debug_log, " retop=%s\n",
287			PL_retstack[ret_min]
288			? OP_NAME(PL_retstack[ret_min])
289			: "(null)"
290			);
291			}
292
293			}
294			} /* next context */
295
296
297			if (si == PL_curstackinfo)
298			break;
299			si = si->si_next;
300			si_ix++;
301			if (!si)
302			break; /* shouldn't happen, but just in case.. */
303			} /* next stackinfo */
304
305			PerlIO_printf(Perl_debug_log, "\n");
306			#endif /* DEBUGGING */
307			}
308
309