sal/osl/unx/diagnose.c

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #include "osl/diagnose.h"
  30 #include "system.h"
  31
  32 #ifndef HAVE_DLFCN_H
  33
  34 #if defined(LINUX) || defined(SOLARIS)
  35 #define HAVE_DLFCN_H
  36 #endif  /* LINUX || SOLARIS */
  37
  38 #endif  /* HAVE_DLFCN_H */
  39
  40
  41 #ifdef  HAVE_DLFCN_H
  42
  43 #ifndef INCLUDED_DLFCN_H
  44 #include <dlfcn.h>
  45 #define INCLUDED_DLFCN_H
  46 #endif
  47
  48 #endif  /* HAVE_DLFCN_H */
  49
  50 #ifndef INCLUDED_PTHREAD_H
  51 #include <pthread.h>
  52 #define INCLUDED_PTHREAD_H
  53 #endif
  54
  55 #ifndef INCLUDED_STDDEF_H
  56 #include <stddef.h>
  57 #define INCLUDED_STDDEF_H
  58 #endif
  59
  60 /************************************************************************/
  61 /* Internal data structures and functions */
  62 /************************************************************************/
  63
  64 static pthread_mutex_t g_mutex = PTHREAD_MUTEX_INITIALIZER;
  65
  66 typedef pfunc_osl_printDebugMessage oslDebugMessageFunc;
  67 static oslDebugMessageFunc volatile g_pDebugMessageFunc = 0;
  68
  69 typedef pfunc_osl_printDetailedDebugMessage oslDetailedDebugMessageFunc;
  70 static oslDetailedDebugMessageFunc volatile g_pDetailedDebugMessageFunc = 0;
  71
  72 static void osl_diagnose_backtrace_Impl (
  73     oslDebugMessageFunc f);
  74
  75 #define OSL_DIAGNOSE_OUTPUTMESSAGE(f, s) \
  76 ((f != 0) ? (*(f))((s)) : (void)fprintf(stderr, "%s", (s)))
  77
  78 #if defined (LINUX) || defined (SOLARIS)
  79 /************************************************************************/
  80 /* osl_diagnose_frame_Impl */
  81 /************************************************************************/
  82 static void osl_diagnose_frame_Impl (
  83     oslDebugMessageFunc f,
  84     int                 depth,
  85     void *              pc)
  86 {
  87     const char *fname = 0, *sname = 0;
  88     void       *fbase = 0, *saddr = 0;
  89     ptrdiff_t   offset;
  90     char        szMessage[1024];
  91
  92 #ifdef INCLUDED_DLFCN_H
  93     Dl_info dli;
  94     if (dladdr (pc, &dli) != 0)
  95     {
  96         fname = dli.dli_fname;
  97         fbase = dli.dli_fbase;
  98         sname = dli.dli_sname;
  99         saddr = dli.dli_saddr;
 100     }
 101 #endif /* INCLUDED_DLFCN_H */
 102
 103     if (saddr)
 104         offset = (ptrdiff_t)(pc) - (ptrdiff_t)(saddr);
 105     else if (fbase)
 106         offset = (ptrdiff_t)(pc) - (ptrdiff_t)(fbase);
 107     else
 108         offset = (ptrdiff_t)(pc);
 109
 110     snprintf (szMessage, sizeof(szMessage),
 111               "Backtrace: [%d] %s: %s+0x%" SAL_PRI_PTRDIFFT "x\n",
 112               depth,
 113               fname ? fname : "<unknown>",
 114               sname ? sname : "???",
 115               offset);
 116
 117     OSL_DIAGNOSE_OUTPUTMESSAGE(f, szMessage);
 118 }
 119 #endif
 120
 121 /************************************************************************/
 122 /* osl_diagnose_backtrace_Impl */
 123 /************************************************************************/
 124 #if defined(LINUX)
 125
 126 #include <execinfo.h>
 127
 128 #define FRAME_COUNT 64
 129 #define FRAME_OFFSET 1
 130
 131 static void osl_diagnose_backtrace_Impl (oslDebugMessageFunc f)
 132 {
 133     void * ppFrames[FRAME_COUNT];
 134     int    i, n;
 135
 136     n = backtrace (ppFrames, FRAME_COUNT);
 137     for (i = FRAME_OFFSET; i < n; i++)
 138     {
 139         osl_diagnose_frame_Impl (f, (i - FRAME_OFFSET), ppFrames[i]);
 140     }
 141 }
 142
 143 #elif defined(SOLARIS)
 144
 145 #include <pthread.h>
 146 #include <setjmp.h>
 147 #include <sys/frame.h>
 148
 149 #if defined(SPARC)
 150
 151 #if defined IS_LP64
 152
 153 #define FRAME_PTR_OFFSET 1
 154 #define FRAME_OFFSET     0
 155 #define STACK_BIAS       0x7ff
 156
 157 #else
 158
 159 #define FRAME_PTR_OFFSET 1
 160 #define FRAME_OFFSET     0
 161 #define STACK_BIAS       0
 162
 163 #endif
 164
 165 #elif defined(INTEL)
 166
 167 #define FRAME_PTR_OFFSET 3
 168 #define FRAME_OFFSET     0
 169 #define STACK_BIAS       0
 170
 171 #endif /* (SPARC || INTEL) */
 172
 173 static void osl_diagnose_backtrace_Impl (oslDebugMessageFunc f)
 174 {
 175     jmp_buf        ctx;
 176     long           fpval;
 177     struct frame * fp;
 178     int            i;
 179
 180 #if defined(SPARC)
 181     asm("ta 3");
 182 #endif /* SPARC */
 183     setjmp (ctx);
 184
 185     fpval = ((long*)(ctx))[FRAME_PTR_OFFSET];
 186     fp = (struct frame*)((char*)(fpval) + STACK_BIAS);
 187
 188     for (i = 0; (i < FRAME_OFFSET) && (fp != 0); i++)
 189         fp = (struct frame*)((char*)(fp->fr_savfp) + STACK_BIAS);
 190
 191     for (i = 0; (fp != 0) && (fp->fr_savpc != 0); i++)
 192     {
 193         struct frame * prev = (struct frame*)((char*)(fp->fr_savfp) + STACK_BIAS);
 194         osl_diagnose_frame_Impl (f, i, (void*)(fp->fr_savpc));
 195         fp = (prev > fp) ? prev : 0;
 196     }
 197 }
 198
 199 #else  /* (LINUX || SOLARIS) */
 200
 201 static void osl_diagnose_backtrace_Impl (oslDebugMessageFunc f)
 202 {
 203     (void) f;
 204     /* not yet implemented */
 205 }
 206
 207 #endif /* (LINUX || SOLARIS) */
 208
 209 /************************************************************************/
 210 /* osl_assertFailedLine */
 211 /************************************************************************/
 212 sal_Bool SAL_CALL osl_assertFailedLine (
 213     const sal_Char* pszFileName,
 214     sal_Int32       nLine,
 215     const sal_Char* pszMessage)
 216 {
 217     oslDebugMessageFunc f = g_pDebugMessageFunc;
 218     char                szMessage[1024];
 219
 220     // after reporting the assertion, abort if told so by SAL_DIAGNOSE_ABORT, but *not* if
 221     // assertions are routed to some external instance
 222     char const * env = getenv( "SAL_DIAGNOSE_ABORT" );
 223     char const * envBacktrace = getenv( "SAL_DIAGNOSE_BACKTRACE" );
 224     sal_Bool const doAbort = ( ( env != NULL ) && ( *env != '\0' ) && ( f == NULL ) );
 225
 226     /* If there's a callback for detailed messages, use it */
 227     if ( g_pDetailedDebugMessageFunc != NULL )
 228     {
 229         g_pDetailedDebugMessageFunc( pszFileName, nLine, pszMessage );
 230         return sal_False;
 231     }
 232
 233     /* if SAL assertions are disabled in general, stop here */
 234     if ( getenv("DISABLE_SAL_DBGBOX") )
 235         return doAbort;
 236
 237     /* format message into buffer */
 238     if (pszMessage != 0)
 239     {
 240         snprintf(szMessage, sizeof(szMessage),
 241                  "Error: File %s, Line %" SAL_PRIdINT32 ": %s\n",
 242                  pszFileName, nLine, pszMessage);
 243     }
 244     else
 245     {
 246         snprintf(szMessage, sizeof(szMessage),
 247                  "Error: File %s, Line %" SAL_PRIdINT32 "\n",
 248                  pszFileName, nLine);
 249     }
 250
 251     /* acquire lock to serialize output message(s) */
 252     pthread_mutex_lock(&g_mutex);
 253
 254     /* output message buffer */
 255     OSL_DIAGNOSE_OUTPUTMESSAGE(f, szMessage);
 256
 257     /* should we output backtrace? */
 258     if( envBacktrace != NULL && *envBacktrace != '\0' )
 259         osl_diagnose_backtrace_Impl(f);
 260
 261     /* release lock and leave */
 262     pthread_mutex_unlock(&g_mutex);
 263
 264     return doAbort;
 265 }
 266
 267 /************************************************************************/
 268 /* osl_breakDebug */
 269 /************************************************************************/
 270 void SAL_CALL osl_breakDebug()
 271 {
 272     abort();
 273 }
 274
 275 /************************************************************************/
 276 /* osl_reportError */
 277 /************************************************************************/
 278 sal_Int32 SAL_CALL osl_reportError (
 279     sal_uInt32      nType,
 280     const sal_Char* pszMessage)
 281 {
 282     (void) nType; /* unused */
 283     fputs(pszMessage, stderr);
 284     return 0;
 285 }
 286
 287 /************************************************************************/
 288 /* osl_setDebugMessageFunc */
 289 /************************************************************************/
 290 oslDebugMessageFunc SAL_CALL osl_setDebugMessageFunc (
 291     oslDebugMessageFunc pNewFunc)
 292 {
 293     oslDebugMessageFunc pOldFunc = g_pDebugMessageFunc;
 294     g_pDebugMessageFunc = pNewFunc;
 295     return pOldFunc;
 296 }
 297
 298 /************************************************************************/
 299 /* osl_setDetailedDebugMessageFunc */
 300 /************************************************************************/
 301 pfunc_osl_printDetailedDebugMessage SAL_CALL osl_setDetailedDebugMessageFunc (
 302     pfunc_osl_printDetailedDebugMessage pNewFunc)
 303 {
 304     oslDetailedDebugMessageFunc pOldFunc = g_pDetailedDebugMessageFunc;
 305     g_pDetailedDebugMessageFunc = pNewFunc;
 306     return pOldFunc;
 307 }
 308
 309 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */