Blame glib/glib/gbacktrace.c

Packit db3073
/* GLIB - Library of useful routines for C programming
Packit db3073
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
Packit db3073
 *
Packit db3073
 * This library is free software; you can redistribute it and/or
Packit db3073
 * modify it under the terms of the GNU Lesser General Public
Packit db3073
 * License as published by the Free Software Foundation; either
Packit db3073
 * version 2 of the License, or (at your option) any later version.
Packit db3073
 *
Packit db3073
 * This library is distributed in the hope that it will be useful,
Packit db3073
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit db3073
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit db3073
 * Lesser General Public License for more details.
Packit db3073
 *
Packit db3073
 * You should have received a copy of the GNU Lesser General Public
Packit db3073
 * License along with this library; if not, write to the
Packit db3073
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Packit db3073
 * Boston, MA 02111-1307, USA.
Packit db3073
 */
Packit db3073
Packit db3073
/*
Packit db3073
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
Packit db3073
 * file for a list of people on the GLib Team.  See the ChangeLog
Packit db3073
 * files for a list of changes.  These files are distributed with
Packit db3073
 * GLib at ftp://ftp.gtk.org/pub/gtk/.
Packit db3073
 */
Packit db3073
Packit db3073
/*
Packit db3073
 * MT safe ; except for g_on_error_stack_trace, but who wants thread safety
Packit db3073
 * then
Packit db3073
 */
Packit db3073
Packit db3073
#include "config.h"
Packit db3073
#include "glibconfig.h"
Packit db3073
Packit db3073
#include <signal.h>
Packit db3073
#include <stdarg.h>
Packit db3073
#include <stdio.h>
Packit db3073
#include <stdlib.h>
Packit db3073
Packit db3073
#ifdef HAVE_SYS_TIME_H
Packit db3073
#include <sys/time.h>
Packit db3073
#endif
Packit db3073
#ifdef HAVE_SYS_TIMES_H
Packit db3073
#include <sys/times.h>
Packit db3073
#endif
Packit db3073
#include <sys/types.h>
Packit db3073
#ifdef HAVE_SYS_WAIT_H
Packit db3073
#include <sys/wait.h>
Packit db3073
#endif
Packit db3073
Packit db3073
#include <time.h>
Packit db3073
#ifdef HAVE_UNISTD_H
Packit db3073
#include <unistd.h>
Packit db3073
#endif
Packit db3073
Packit db3073
#ifdef HAVE_SYS_SELECT_H
Packit db3073
#include <sys/select.h>
Packit db3073
#endif /* HAVE_SYS_SELECT_H */
Packit db3073
Packit db3073
#include <string.h> /* for bzero on BSD systems */
Packit db3073
Packit db3073
#ifdef G_OS_WIN32
Packit db3073
#  define STRICT                /* Strict typing, please */
Packit db3073
#  define _WIN32_WINDOWS 0x0401 /* to get IsDebuggerPresent */
Packit db3073
#  include <windows.h>
Packit db3073
#  undef STRICT
Packit db3073
#endif
Packit db3073
Packit db3073
#include "gbacktrace.h"
Packit db3073
Packit db3073
#include "gtypes.h"
Packit db3073
#include "gmain.h"
Packit db3073
#include "gprintfint.h"
Packit db3073
#include "gutils.h"
Packit db3073
Packit db3073
Packit db3073
#ifndef NO_FD_SET
Packit db3073
#  define SELECT_MASK fd_set
Packit db3073
#else
Packit db3073
#  if defined(_IBMR2)
Packit db3073
#    define SELECT_MASK void
Packit db3073
#  else
Packit db3073
#    define SELECT_MASK int
Packit db3073
#  endif
Packit db3073
#endif
Packit db3073
Packit db3073
Packit db3073
#ifndef G_OS_WIN32
Packit db3073
static void stack_trace (char **args);
Packit db3073
#endif
Packit db3073
Packit db3073
extern volatile gboolean glib_on_error_halt;
Packit db3073
volatile gboolean glib_on_error_halt = TRUE;
Packit db3073
Packit db3073
/**
Packit db3073
 * g_on_error_query:
Packit db3073
 * @prg_name: the program name, needed by <command>gdb</command>
Packit db3073
 *     for the [S]tack trace option. If @prg_name is %NULL, g_get_prgname()
Packit db3073
 *     is called to get the program name (which will work correctly if
Packit db3073
 *     gdk_init() or gtk_init() has been called)
Packit db3073
 *
Packit db3073
 * Prompts the user with
Packit db3073
 * <computeroutput>[E]xit, [H]alt, show [S]tack trace or [P]roceed</computeroutput>.
Packit db3073
 * This function is intended to be used for debugging use only.
Packit db3073
 * The following example shows how it can be used together with
Packit db3073
 * the g_log() functions.
Packit db3073
 *
Packit db3073
 * |[
Packit db3073
 * #include <glib.h>
Packit db3073
 *
Packit db3073
 * static void
Packit db3073
 * log_handler (const gchar   *log_domain,
Packit db3073
 *              GLogLevelFlags log_level,
Packit db3073
 *              const gchar   *message,
Packit db3073
 *              gpointer       user_data)
Packit db3073
 * {
Packit db3073
 *   g_log_default_handler (log_domain, log_level, message, user_data);
Packit db3073
 *
Packit db3073
 *   g_on_error_query (MY_PROGRAM_NAME);
Packit db3073
 * }
Packit db3073
 *
Packit db3073
 * int
Packit db3073
 * main (int argc, char *argv[])
Packit db3073
 * {
Packit db3073
 *   g_log_set_handler (MY_LOG_DOMAIN,
Packit db3073
 *                      G_LOG_LEVEL_WARNING |
Packit db3073
 *                      G_LOG_LEVEL_ERROR |
Packit db3073
 *                      G_LOG_LEVEL_CRITICAL,
Packit db3073
 *                      log_handler,
Packit db3073
 *                      NULL);
Packit db3073
 *   /* ... */
Packit db3073
 * ]|
Packit db3073
 *
Packit db3073
 * If [E]xit is selected, the application terminates with a call
Packit db3073
 * to <literal>_exit(0)</literal>.
Packit db3073
 *
Packit db3073
 * If [S]tack trace is selected, g_on_error_stack_trace() is called.
Packit db3073
 * This invokes <command>gdb</command>, which attaches to the current
Packit db3073
 * process and shows a stack trace. The prompt is then shown again.
Packit db3073
 *
Packit db3073
 * If [P]roceed is selected, the function returns.
Packit db3073
 *
Packit db3073
 * This function may cause different actions on non-UNIX platforms.
Packit db3073
 */
Packit db3073
void
Packit db3073
g_on_error_query (const gchar *prg_name)
Packit db3073
{
Packit db3073
#ifndef G_OS_WIN32
Packit db3073
  static const gchar * const query1 = "[E]xit, [H]alt";
Packit db3073
  static const gchar * const query2 = ", show [S]tack trace";
Packit db3073
  static const gchar * const query3 = " or [P]roceed";
Packit db3073
  gchar buf[16];
Packit db3073
Packit db3073
  if (!prg_name)
Packit db3073
    prg_name = g_get_prgname ();
Packit db3073
Packit db3073
 retry:
Packit db3073
Packit db3073
  if (prg_name)
Packit db3073
    _g_fprintf (stdout,
Packit db3073
                "%s (pid:%u): %s%s%s: ",
Packit db3073
                prg_name,
Packit db3073
                (guint) getpid (),
Packit db3073
                query1,
Packit db3073
                query2,
Packit db3073
                query3);
Packit db3073
  else
Packit db3073
    _g_fprintf (stdout,
Packit db3073
                "(process:%u): %s%s: ",
Packit db3073
                (guint) getpid (),
Packit db3073
                query1,
Packit db3073
                query3);
Packit db3073
  fflush (stdout);
Packit db3073
Packit db3073
  if (isatty(0) && isatty(1))
Packit db3073
    fgets (buf, 8, stdin);
Packit db3073
  else
Packit db3073
    strcpy (buf, "E\n");
Packit db3073
Packit db3073
  if ((buf[0] == 'E' || buf[0] == 'e')
Packit db3073
      && buf[1] == '\n')
Packit db3073
    _exit (0);
Packit db3073
  else if ((buf[0] == 'P' || buf[0] == 'p')
Packit db3073
           && buf[1] == '\n')
Packit db3073
    return;
Packit db3073
  else if (prg_name
Packit db3073
           && (buf[0] == 'S' || buf[0] == 's')
Packit db3073
           && buf[1] == '\n')
Packit db3073
    {
Packit db3073
      g_on_error_stack_trace (prg_name);
Packit db3073
      goto retry;
Packit db3073
    }
Packit db3073
  else if ((buf[0] == 'H' || buf[0] == 'h')
Packit db3073
           && buf[1] == '\n')
Packit db3073
    {
Packit db3073
      while (glib_on_error_halt)
Packit db3073
        ;
Packit db3073
      glib_on_error_halt = TRUE;
Packit db3073
      return;
Packit db3073
    }
Packit db3073
  else
Packit db3073
    goto retry;
Packit db3073
#else
Packit db3073
  if (!prg_name)
Packit db3073
    prg_name = g_get_prgname ();
Packit db3073
Packit db3073
  MessageBox (NULL, "g_on_error_query called, program terminating",
Packit db3073
              (prg_name && *prg_name) ? prg_name : NULL,
Packit db3073
              MB_OK|MB_ICONERROR);
Packit db3073
  _exit(0);
Packit db3073
#endif
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_on_error_stack_trace:
Packit db3073
 * @prg_name: the program name, needed by <command>gdb</command>
Packit db3073
 *     for the [S]tack trace option.
Packit db3073
 *
Packit db3073
 * Invokes <command>gdb</command>, which attaches to the current
Packit db3073
 * process and shows a stack trace. Called by g_on_error_query()
Packit db3073
 * when the [S]tack trace option is selected. You can get the current
Packit db3073
 * process's "program name" with g_get_prgname(), assuming that you
Packit db3073
 * have called gtk_init() or gdk_init().
Packit db3073
 *
Packit db3073
 * This function may cause different actions on non-UNIX platforms.
Packit db3073
 */
Packit db3073
void
Packit db3073
g_on_error_stack_trace (const gchar *prg_name)
Packit db3073
{
Packit db3073
#if defined(G_OS_UNIX) || defined(G_OS_BEOS)
Packit db3073
  pid_t pid;
Packit db3073
  gchar buf[16];
Packit db3073
  gchar *args[4] = { "gdb", NULL, NULL, NULL };
Packit db3073
  int status;
Packit db3073
Packit db3073
  if (!prg_name)
Packit db3073
    return;
Packit db3073
Packit db3073
  _g_sprintf (buf, "%u", (guint) getpid ());
Packit db3073
Packit db3073
  args[1] = (gchar*) prg_name;
Packit db3073
  args[2] = buf;
Packit db3073
Packit db3073
  pid = fork ();
Packit db3073
  if (pid == 0)
Packit db3073
    {
Packit db3073
      stack_trace (args);
Packit db3073
      _exit (0);
Packit db3073
    }
Packit db3073
  else if (pid == (pid_t) -1)
Packit db3073
    {
Packit db3073
      perror ("unable to fork gdb");
Packit db3073
      return;
Packit db3073
    }
Packit db3073
Packit db3073
  waitpid (pid, &status, 0);
Packit db3073
#else
Packit db3073
  if (IsDebuggerPresent ())
Packit db3073
    G_BREAKPOINT ();
Packit db3073
  else
Packit db3073
    abort ();
Packit db3073
#endif
Packit db3073
}
Packit db3073
Packit db3073
#ifndef G_OS_WIN32
Packit db3073
Packit db3073
static gboolean stack_trace_done = FALSE;
Packit db3073
Packit db3073
static void
Packit db3073
stack_trace_sigchld (int signum)
Packit db3073
{
Packit db3073
  stack_trace_done = TRUE;
Packit db3073
}
Packit db3073
Packit db3073
static void
Packit db3073
stack_trace (char **args)
Packit db3073
{
Packit db3073
  pid_t pid;
Packit db3073
  int in_fd[2];
Packit db3073
  int out_fd[2];
Packit db3073
  SELECT_MASK fdset;
Packit db3073
  SELECT_MASK readset;
Packit db3073
  struct timeval tv;
Packit db3073
  int sel, idx, state;
Packit db3073
  char buffer[256];
Packit db3073
  char c;
Packit db3073
Packit db3073
  stack_trace_done = FALSE;
Packit db3073
  signal (SIGCHLD, stack_trace_sigchld);
Packit db3073
Packit db3073
  if ((pipe (in_fd) == -1) || (pipe (out_fd) == -1))
Packit db3073
    {
Packit db3073
      perror ("unable to open pipe");
Packit db3073
      _exit (0);
Packit db3073
    }
Packit db3073
Packit db3073
  pid = fork ();
Packit db3073
  if (pid == 0)
Packit db3073
    {
Packit db3073
      close (0); dup (in_fd[0]);   /* set the stdin to the in pipe */
Packit db3073
      close (1); dup (out_fd[1]);  /* set the stdout to the out pipe */
Packit db3073
      close (2); dup (out_fd[1]);  /* set the stderr to the out pipe */
Packit db3073
Packit db3073
      execvp (args[0], args);      /* exec gdb */
Packit db3073
      perror ("exec failed");
Packit db3073
      _exit (0);
Packit db3073
    }
Packit db3073
  else if (pid == (pid_t) -1)
Packit db3073
    {
Packit db3073
      perror ("unable to fork");
Packit db3073
      _exit (0);
Packit db3073
    }
Packit db3073
Packit db3073
  FD_ZERO (&fdset);
Packit db3073
  FD_SET (out_fd[0], &fdset);
Packit db3073
Packit db3073
  write (in_fd[1], "backtrace\n", 10);
Packit db3073
  write (in_fd[1], "p x = 0\n", 8);
Packit db3073
  write (in_fd[1], "quit\n", 5);
Packit db3073
Packit db3073
  idx = 0;
Packit db3073
  state = 0;
Packit db3073
Packit db3073
  while (1)
Packit db3073
    {
Packit db3073
      readset = fdset;
Packit db3073
      tv.tv_sec = 1;
Packit db3073
      tv.tv_usec = 0;
Packit db3073
Packit db3073
      sel = select (FD_SETSIZE, &readset, NULL, NULL, &tv;;
Packit db3073
      if (sel == -1)
Packit db3073
        break;
Packit db3073
Packit db3073
      if ((sel > 0) && (FD_ISSET (out_fd[0], &readset)))
Packit db3073
        {
Packit db3073
          if (read (out_fd[0], &c, 1))
Packit db3073
            {
Packit db3073
              switch (state)
Packit db3073
                {
Packit db3073
                case 0:
Packit db3073
                  if (c == '#')
Packit db3073
                    {
Packit db3073
                      state = 1;
Packit db3073
                      idx = 0;
Packit db3073
                      buffer[idx++] = c;
Packit db3073
                    }
Packit db3073
                  break;
Packit db3073
                case 1:
Packit db3073
                  buffer[idx++] = c;
Packit db3073
                  if ((c == '\n') || (c == '\r'))
Packit db3073
                    {
Packit db3073
                      buffer[idx] = 0;
Packit db3073
                      _g_fprintf (stdout, "%s", buffer);
Packit db3073
                      state = 0;
Packit db3073
                      idx = 0;
Packit db3073
                    }
Packit db3073
                  break;
Packit db3073
                default:
Packit db3073
                  break;
Packit db3073
                }
Packit db3073
            }
Packit db3073
        }
Packit db3073
      else if (stack_trace_done)
Packit db3073
        break;
Packit db3073
    }
Packit db3073
Packit db3073
  close (in_fd[0]);
Packit db3073
  close (in_fd[1]);
Packit db3073
  close (out_fd[0]);
Packit db3073
  close (out_fd[1]);
Packit db3073
  _exit (0);
Packit db3073
}
Packit db3073
Packit db3073
#endif /* !G_OS_WIN32 */