1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski #include "osl/diagnose.h"
25*b1cdbd2cSJim Jagielski #include "system.h"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #ifndef HAVE_DLFCN_H
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielski #if defined(LINUX) || defined(SOLARIS)
30*b1cdbd2cSJim Jagielski #define HAVE_DLFCN_H
31*b1cdbd2cSJim Jagielski #endif /* LINUX || SOLARIS */
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski #endif /* HAVE_DLFCN_H */
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski #ifdef HAVE_DLFCN_H
37*b1cdbd2cSJim Jagielski
38*b1cdbd2cSJim Jagielski #ifndef INCLUDED_DLFCN_H
39*b1cdbd2cSJim Jagielski #include <dlfcn.h>
40*b1cdbd2cSJim Jagielski #define INCLUDED_DLFCN_H
41*b1cdbd2cSJim Jagielski #endif
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski #endif /* HAVE_DLFCN_H */
44*b1cdbd2cSJim Jagielski #include "osl/thread.h"
45*b1cdbd2cSJim Jagielski
46*b1cdbd2cSJim Jagielski #ifndef INCLUDED_PTHREAD_H
47*b1cdbd2cSJim Jagielski #include <pthread.h>
48*b1cdbd2cSJim Jagielski #define INCLUDED_PTHREAD_H
49*b1cdbd2cSJim Jagielski #endif
50*b1cdbd2cSJim Jagielski
51*b1cdbd2cSJim Jagielski #ifndef INCLUDED_STDDEF_H
52*b1cdbd2cSJim Jagielski #include <stddef.h>
53*b1cdbd2cSJim Jagielski #define INCLUDED_STDDEF_H
54*b1cdbd2cSJim Jagielski #endif
55*b1cdbd2cSJim Jagielski
56*b1cdbd2cSJim Jagielski #include "printtrace.h"
57*b1cdbd2cSJim Jagielski
58*b1cdbd2cSJim Jagielski /************************************************************************/
59*b1cdbd2cSJim Jagielski /* Internal data structures and functions */
60*b1cdbd2cSJim Jagielski /************************************************************************/
61*b1cdbd2cSJim Jagielski
62*b1cdbd2cSJim Jagielski static pthread_mutex_t g_mutex = PTHREAD_MUTEX_INITIALIZER;
63*b1cdbd2cSJim Jagielski
64*b1cdbd2cSJim Jagielski typedef pfunc_osl_printDebugMessage oslDebugMessageFunc;
65*b1cdbd2cSJim Jagielski static oslDebugMessageFunc volatile g_pDebugMessageFunc = 0;
66*b1cdbd2cSJim Jagielski
67*b1cdbd2cSJim Jagielski typedef pfunc_osl_printDetailedDebugMessage oslDetailedDebugMessageFunc;
68*b1cdbd2cSJim Jagielski static oslDetailedDebugMessageFunc volatile g_pDetailedDebugMessageFunc = 0;
69*b1cdbd2cSJim Jagielski
70*b1cdbd2cSJim Jagielski static void osl_diagnose_backtrace_Impl (
71*b1cdbd2cSJim Jagielski oslDebugMessageFunc f);
72*b1cdbd2cSJim Jagielski
73*b1cdbd2cSJim Jagielski #define OSL_DIAGNOSE_OUTPUTMESSAGE(f, s) \
74*b1cdbd2cSJim Jagielski ((f != 0) ? (*(f))((s)) : (void)fprintf(stderr, "%s", (s)))
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski #if defined (LINUX) || defined (SOLARIS)
77*b1cdbd2cSJim Jagielski /************************************************************************/
78*b1cdbd2cSJim Jagielski /* osl_diagnose_frame_Impl */
79*b1cdbd2cSJim Jagielski /************************************************************************/
osl_diagnose_frame_Impl(oslDebugMessageFunc f,int depth,void * pc)80*b1cdbd2cSJim Jagielski static void osl_diagnose_frame_Impl (
81*b1cdbd2cSJim Jagielski oslDebugMessageFunc f,
82*b1cdbd2cSJim Jagielski int depth,
83*b1cdbd2cSJim Jagielski void * pc)
84*b1cdbd2cSJim Jagielski {
85*b1cdbd2cSJim Jagielski const char *fname = 0, *sname = 0;
86*b1cdbd2cSJim Jagielski void *fbase = 0, *saddr = 0;
87*b1cdbd2cSJim Jagielski ptrdiff_t offset;
88*b1cdbd2cSJim Jagielski char szMessage[1024];
89*b1cdbd2cSJim Jagielski
90*b1cdbd2cSJim Jagielski #ifdef INCLUDED_DLFCN_H
91*b1cdbd2cSJim Jagielski Dl_info dli;
92*b1cdbd2cSJim Jagielski if (dladdr (pc, &dli) != 0)
93*b1cdbd2cSJim Jagielski {
94*b1cdbd2cSJim Jagielski fname = dli.dli_fname;
95*b1cdbd2cSJim Jagielski fbase = dli.dli_fbase;
96*b1cdbd2cSJim Jagielski sname = dli.dli_sname;
97*b1cdbd2cSJim Jagielski saddr = dli.dli_saddr;
98*b1cdbd2cSJim Jagielski }
99*b1cdbd2cSJim Jagielski #endif /* INCLUDED_DLFCN_H */
100*b1cdbd2cSJim Jagielski
101*b1cdbd2cSJim Jagielski if (saddr)
102*b1cdbd2cSJim Jagielski offset = (ptrdiff_t)(pc) - (ptrdiff_t)(saddr);
103*b1cdbd2cSJim Jagielski else if (fbase)
104*b1cdbd2cSJim Jagielski offset = (ptrdiff_t)(pc) - (ptrdiff_t)(fbase);
105*b1cdbd2cSJim Jagielski else
106*b1cdbd2cSJim Jagielski offset = (ptrdiff_t)(pc);
107*b1cdbd2cSJim Jagielski
108*b1cdbd2cSJim Jagielski snprintf (szMessage, sizeof(szMessage),
109*b1cdbd2cSJim Jagielski "Backtrace: [%d] %s: %s+0x%" SAL_PRI_PTRDIFFT "x\n",
110*b1cdbd2cSJim Jagielski depth,
111*b1cdbd2cSJim Jagielski fname ? fname : "<unknown>",
112*b1cdbd2cSJim Jagielski sname ? sname : "???",
113*b1cdbd2cSJim Jagielski offset);
114*b1cdbd2cSJim Jagielski
115*b1cdbd2cSJim Jagielski OSL_DIAGNOSE_OUTPUTMESSAGE(f, szMessage);
116*b1cdbd2cSJim Jagielski }
117*b1cdbd2cSJim Jagielski #endif
118*b1cdbd2cSJim Jagielski
119*b1cdbd2cSJim Jagielski /************************************************************************/
120*b1cdbd2cSJim Jagielski /* osl_diagnose_backtrace_Impl */
121*b1cdbd2cSJim Jagielski /************************************************************************/
122*b1cdbd2cSJim Jagielski #if defined(LINUX)
123*b1cdbd2cSJim Jagielski
124*b1cdbd2cSJim Jagielski #include <execinfo.h>
125*b1cdbd2cSJim Jagielski
126*b1cdbd2cSJim Jagielski #define FRAME_COUNT 64
127*b1cdbd2cSJim Jagielski #define FRAME_OFFSET 1
128*b1cdbd2cSJim Jagielski
osl_diagnose_backtrace_Impl(oslDebugMessageFunc f)129*b1cdbd2cSJim Jagielski static void osl_diagnose_backtrace_Impl (oslDebugMessageFunc f)
130*b1cdbd2cSJim Jagielski {
131*b1cdbd2cSJim Jagielski void * ppFrames[FRAME_COUNT];
132*b1cdbd2cSJim Jagielski int i, n;
133*b1cdbd2cSJim Jagielski
134*b1cdbd2cSJim Jagielski n = backtrace (ppFrames, FRAME_COUNT);
135*b1cdbd2cSJim Jagielski for (i = FRAME_OFFSET; i < n; i++)
136*b1cdbd2cSJim Jagielski {
137*b1cdbd2cSJim Jagielski osl_diagnose_frame_Impl (f, (i - FRAME_OFFSET), ppFrames[i]);
138*b1cdbd2cSJim Jagielski }
139*b1cdbd2cSJim Jagielski }
140*b1cdbd2cSJim Jagielski
141*b1cdbd2cSJim Jagielski #elif defined(SOLARIS)
142*b1cdbd2cSJim Jagielski
143*b1cdbd2cSJim Jagielski #include <pthread.h>
144*b1cdbd2cSJim Jagielski #include <setjmp.h>
145*b1cdbd2cSJim Jagielski #include <sys/frame.h>
146*b1cdbd2cSJim Jagielski
147*b1cdbd2cSJim Jagielski #if defined(SPARC)
148*b1cdbd2cSJim Jagielski
149*b1cdbd2cSJim Jagielski #if defined IS_LP64
150*b1cdbd2cSJim Jagielski
151*b1cdbd2cSJim Jagielski #define FRAME_PTR_OFFSET 1
152*b1cdbd2cSJim Jagielski #define FRAME_OFFSET 0
153*b1cdbd2cSJim Jagielski #define STACK_BIAS 0x7ff
154*b1cdbd2cSJim Jagielski
155*b1cdbd2cSJim Jagielski #else
156*b1cdbd2cSJim Jagielski
157*b1cdbd2cSJim Jagielski #define FRAME_PTR_OFFSET 1
158*b1cdbd2cSJim Jagielski #define FRAME_OFFSET 0
159*b1cdbd2cSJim Jagielski #define STACK_BIAS 0
160*b1cdbd2cSJim Jagielski
161*b1cdbd2cSJim Jagielski #endif
162*b1cdbd2cSJim Jagielski
163*b1cdbd2cSJim Jagielski #elif defined(INTEL)
164*b1cdbd2cSJim Jagielski
165*b1cdbd2cSJim Jagielski #define FRAME_PTR_OFFSET 3
166*b1cdbd2cSJim Jagielski #define FRAME_OFFSET 0
167*b1cdbd2cSJim Jagielski #define STACK_BIAS 0
168*b1cdbd2cSJim Jagielski
169*b1cdbd2cSJim Jagielski #endif /* (SPARC || INTEL) */
170*b1cdbd2cSJim Jagielski
osl_diagnose_backtrace_Impl(oslDebugMessageFunc f)171*b1cdbd2cSJim Jagielski static void osl_diagnose_backtrace_Impl (oslDebugMessageFunc f)
172*b1cdbd2cSJim Jagielski {
173*b1cdbd2cSJim Jagielski jmp_buf ctx;
174*b1cdbd2cSJim Jagielski long fpval;
175*b1cdbd2cSJim Jagielski struct frame * fp;
176*b1cdbd2cSJim Jagielski int i;
177*b1cdbd2cSJim Jagielski
178*b1cdbd2cSJim Jagielski #if defined(SPARC)
179*b1cdbd2cSJim Jagielski asm("ta 3");
180*b1cdbd2cSJim Jagielski #endif /* SPARC */
181*b1cdbd2cSJim Jagielski setjmp (ctx);
182*b1cdbd2cSJim Jagielski
183*b1cdbd2cSJim Jagielski fpval = ((long*)(ctx))[FRAME_PTR_OFFSET];
184*b1cdbd2cSJim Jagielski fp = (struct frame*)((char*)(fpval) + STACK_BIAS);
185*b1cdbd2cSJim Jagielski
186*b1cdbd2cSJim Jagielski for (i = 0; (i < FRAME_OFFSET) && (fp != 0); i++)
187*b1cdbd2cSJim Jagielski fp = (struct frame*)((char*)(fp->fr_savfp) + STACK_BIAS);
188*b1cdbd2cSJim Jagielski
189*b1cdbd2cSJim Jagielski for (i = 0; (fp != 0) && (fp->fr_savpc != 0); i++)
190*b1cdbd2cSJim Jagielski {
191*b1cdbd2cSJim Jagielski struct frame * prev = (struct frame*)((char*)(fp->fr_savfp) + STACK_BIAS);
192*b1cdbd2cSJim Jagielski osl_diagnose_frame_Impl (f, i, (void*)(fp->fr_savpc));
193*b1cdbd2cSJim Jagielski fp = (prev > fp) ? prev : 0;
194*b1cdbd2cSJim Jagielski }
195*b1cdbd2cSJim Jagielski }
196*b1cdbd2cSJim Jagielski
197*b1cdbd2cSJim Jagielski #else /* (LINUX || SOLARIS) */
198*b1cdbd2cSJim Jagielski
osl_diagnose_backtrace_Impl(oslDebugMessageFunc f)199*b1cdbd2cSJim Jagielski static void osl_diagnose_backtrace_Impl (oslDebugMessageFunc f)
200*b1cdbd2cSJim Jagielski {
201*b1cdbd2cSJim Jagielski /* not yet implemented */
202*b1cdbd2cSJim Jagielski }
203*b1cdbd2cSJim Jagielski
204*b1cdbd2cSJim Jagielski #endif /* (LINUX || SOLARIS) */
205*b1cdbd2cSJim Jagielski
206*b1cdbd2cSJim Jagielski /************************************************************************/
207*b1cdbd2cSJim Jagielski /* osl_assertFailedLine */
208*b1cdbd2cSJim Jagielski /************************************************************************/
osl_assertFailedLine(const sal_Char * pszFileName,sal_Int32 nLine,const sal_Char * pszMessage)209*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL osl_assertFailedLine (
210*b1cdbd2cSJim Jagielski const sal_Char* pszFileName,
211*b1cdbd2cSJim Jagielski sal_Int32 nLine,
212*b1cdbd2cSJim Jagielski const sal_Char* pszMessage)
213*b1cdbd2cSJim Jagielski {
214*b1cdbd2cSJim Jagielski oslDebugMessageFunc f = g_pDebugMessageFunc;
215*b1cdbd2cSJim Jagielski char szMessage[1024];
216*b1cdbd2cSJim Jagielski
217*b1cdbd2cSJim Jagielski // after reporting the assertion, abort if told so by SAL_DIAGNOSE_ABORT, but *not* if
218*b1cdbd2cSJim Jagielski // assertions are routed to some external instance
219*b1cdbd2cSJim Jagielski char const * env = getenv( "SAL_DIAGNOSE_ABORT" );
220*b1cdbd2cSJim Jagielski sal_Bool const doAbort = ( ( env != NULL ) && ( *env != '\0' ) && ( f == NULL ) );
221*b1cdbd2cSJim Jagielski
222*b1cdbd2cSJim Jagielski /* If there's a callback for detailed messages, use it */
223*b1cdbd2cSJim Jagielski if ( g_pDetailedDebugMessageFunc != NULL )
224*b1cdbd2cSJim Jagielski {
225*b1cdbd2cSJim Jagielski g_pDetailedDebugMessageFunc( pszFileName, nLine, pszMessage );
226*b1cdbd2cSJim Jagielski return sal_False;
227*b1cdbd2cSJim Jagielski }
228*b1cdbd2cSJim Jagielski
229*b1cdbd2cSJim Jagielski /* if SAL assertions are disabled in general, stop here */
230*b1cdbd2cSJim Jagielski if ( getenv("DISABLE_SAL_DBGBOX") )
231*b1cdbd2cSJim Jagielski return doAbort;
232*b1cdbd2cSJim Jagielski
233*b1cdbd2cSJim Jagielski /* format message into buffer */
234*b1cdbd2cSJim Jagielski if (pszMessage != 0)
235*b1cdbd2cSJim Jagielski {
236*b1cdbd2cSJim Jagielski snprintf(szMessage, sizeof(szMessage),
237*b1cdbd2cSJim Jagielski "Error: File %s, Line %" SAL_PRIdINT32 ": %s\n",
238*b1cdbd2cSJim Jagielski pszFileName, nLine, pszMessage);
239*b1cdbd2cSJim Jagielski }
240*b1cdbd2cSJim Jagielski else
241*b1cdbd2cSJim Jagielski {
242*b1cdbd2cSJim Jagielski snprintf(szMessage, sizeof(szMessage),
243*b1cdbd2cSJim Jagielski "Error: File %s, Line %" SAL_PRIdINT32 "\n",
244*b1cdbd2cSJim Jagielski pszFileName, nLine);
245*b1cdbd2cSJim Jagielski }
246*b1cdbd2cSJim Jagielski
247*b1cdbd2cSJim Jagielski /* acquire lock to serialize output message(s) */
248*b1cdbd2cSJim Jagielski pthread_mutex_lock(&g_mutex);
249*b1cdbd2cSJim Jagielski
250*b1cdbd2cSJim Jagielski /* output message buffer */
251*b1cdbd2cSJim Jagielski OSL_DIAGNOSE_OUTPUTMESSAGE(f, szMessage);
252*b1cdbd2cSJim Jagielski
253*b1cdbd2cSJim Jagielski /* output backtrace */
254*b1cdbd2cSJim Jagielski osl_diagnose_backtrace_Impl(f);
255*b1cdbd2cSJim Jagielski
256*b1cdbd2cSJim Jagielski /* release lock and leave */
257*b1cdbd2cSJim Jagielski pthread_mutex_unlock(&g_mutex);
258*b1cdbd2cSJim Jagielski
259*b1cdbd2cSJim Jagielski return doAbort;
260*b1cdbd2cSJim Jagielski }
261*b1cdbd2cSJim Jagielski
262*b1cdbd2cSJim Jagielski /************************************************************************/
263*b1cdbd2cSJim Jagielski /* osl_breakDebug */
264*b1cdbd2cSJim Jagielski /************************************************************************/
osl_breakDebug()265*b1cdbd2cSJim Jagielski void SAL_CALL osl_breakDebug()
266*b1cdbd2cSJim Jagielski {
267*b1cdbd2cSJim Jagielski abort();
268*b1cdbd2cSJim Jagielski }
269*b1cdbd2cSJim Jagielski
270*b1cdbd2cSJim Jagielski /************************************************************************/
271*b1cdbd2cSJim Jagielski /* osl_reportError */
272*b1cdbd2cSJim Jagielski /************************************************************************/
osl_reportError(sal_uInt32 nType,const sal_Char * pszMessage)273*b1cdbd2cSJim Jagielski sal_Int32 SAL_CALL osl_reportError (
274*b1cdbd2cSJim Jagielski sal_uInt32 nType,
275*b1cdbd2cSJim Jagielski const sal_Char* pszMessage)
276*b1cdbd2cSJim Jagielski {
277*b1cdbd2cSJim Jagielski (void) nType; /* unused */
278*b1cdbd2cSJim Jagielski fputs(pszMessage, stderr);
279*b1cdbd2cSJim Jagielski return 0;
280*b1cdbd2cSJim Jagielski }
281*b1cdbd2cSJim Jagielski
282*b1cdbd2cSJim Jagielski /************************************************************************/
283*b1cdbd2cSJim Jagielski /* osl_setDebugMessageFunc */
284*b1cdbd2cSJim Jagielski /************************************************************************/
osl_setDebugMessageFunc(oslDebugMessageFunc pNewFunc)285*b1cdbd2cSJim Jagielski oslDebugMessageFunc SAL_CALL osl_setDebugMessageFunc (
286*b1cdbd2cSJim Jagielski oslDebugMessageFunc pNewFunc)
287*b1cdbd2cSJim Jagielski {
288*b1cdbd2cSJim Jagielski oslDebugMessageFunc pOldFunc = g_pDebugMessageFunc;
289*b1cdbd2cSJim Jagielski g_pDebugMessageFunc = pNewFunc;
290*b1cdbd2cSJim Jagielski return pOldFunc;
291*b1cdbd2cSJim Jagielski }
292*b1cdbd2cSJim Jagielski
293*b1cdbd2cSJim Jagielski /************************************************************************/
294*b1cdbd2cSJim Jagielski /* osl_setDetailedDebugMessageFunc */
295*b1cdbd2cSJim Jagielski /************************************************************************/
osl_setDetailedDebugMessageFunc(pfunc_osl_printDetailedDebugMessage pNewFunc)296*b1cdbd2cSJim Jagielski pfunc_osl_printDetailedDebugMessage SAL_CALL osl_setDetailedDebugMessageFunc (
297*b1cdbd2cSJim Jagielski pfunc_osl_printDetailedDebugMessage pNewFunc)
298*b1cdbd2cSJim Jagielski {
299*b1cdbd2cSJim Jagielski oslDetailedDebugMessageFunc pOldFunc = g_pDetailedDebugMessageFunc;
300*b1cdbd2cSJim Jagielski g_pDetailedDebugMessageFunc = pNewFunc;
301*b1cdbd2cSJim Jagielski return pOldFunc;
302*b1cdbd2cSJim Jagielski }
303*b1cdbd2cSJim Jagielski
304*b1cdbd2cSJim Jagielski /************************************************************************/
305*b1cdbd2cSJim Jagielski /* osl_trace */
306*b1cdbd2cSJim Jagielski /************************************************************************/
osl_trace(char const * pszFormat,...)307*b1cdbd2cSJim Jagielski void osl_trace(char const * pszFormat, ...) {
308*b1cdbd2cSJim Jagielski va_list args;
309*b1cdbd2cSJim Jagielski va_start(args, pszFormat);
310*b1cdbd2cSJim Jagielski printTrace((unsigned long) getpid(), pszFormat, args);
311*b1cdbd2cSJim Jagielski va_end(args);
312*b1cdbd2cSJim Jagielski }
313