glib/gbacktrace.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-or-later
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_BACKTRACE_H__
  28 #define __G_BACKTRACE_H__
  29
  30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gtypes.h>
  35 #ifdef __sun__
  36 #include <sys/select.h>
  37 #endif
  38 #include <signal.h>
  39
  40 G_BEGIN_DECLS
  41
  42 GLIB_AVAILABLE_IN_ALL
  43 void g_on_error_query (const gchar *prg_name);
  44 GLIB_AVAILABLE_IN_ALL
  45 void g_on_error_stack_trace (const gchar *prg_name);
  46
  47 /**
  48  * G_BREAKPOINT:
  49  *
  50  * Inserts a breakpoint instruction into the code.
  51  *
  52  * On architectures which support it, this is implemented as a soft interrupt
  53  * and on other architectures it raises a `SIGTRAP` signal.
  54  *
  55  * `SIGTRAP` is used rather than abort() to allow breakpoints to be skipped past
  56  * in a debugger if they are not the desired target of debugging.
  57  */
  58 #if (defined (__i386__) || defined (__x86_64__)) && defined (__GNUC__) && __GNUC__ >= 2
  59 #  define G_BREAKPOINT()        G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END
  60 #elif (defined (_MSC_VER) || defined (__DMC__)) && defined (_M_IX86)
  61 #  define G_BREAKPOINT()        G_STMT_START{ __asm int 3h }G_STMT_END
  62 #elif defined (_MSC_VER)
  63 #  define G_BREAKPOINT()        G_STMT_START{ __debugbreak(); }G_STMT_END
  64 #elif defined (__alpha__) && !defined(__osf__) && defined (__GNUC__) && __GNUC__ >= 2
  65 #  define G_BREAKPOINT()        G_STMT_START{ __asm__ __volatile__ ("bpt"); }G_STMT_END
  66 #elif defined (__APPLE__) || (defined(_WIN32) && (defined(__clang__) || defined(__GNUC__)))
  67 #  define G_BREAKPOINT()        G_STMT_START{ __builtin_trap(); }G_STMT_END
  68 #else   /* !__i386__ && !__alpha__ */
  69 #  define G_BREAKPOINT()        G_STMT_START{ raise (SIGTRAP); }G_STMT_END
  70 #endif  /* __i386__ */
  71
  72 G_END_DECLS
  73
  74 #endif /* __G_BACKTRACE_H__ */