debug/backtrace.c

   1 /* Return backtrace of current program state.  Generic version.
   2    Copyright (C) 1998, 2000, 2002, 2004, 2005 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
   5
   6    The GNU C 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    The GNU C 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 the GNU C Library; if not, see
  18    <http://www.gnu.org/licenses/>.  */
  19
  20 #include <execinfo.h>
  21 #include <signal.h>
  22 #include <frame.h>
  23 #include <sigcontextinfo.h>
  24 #include <bp-checks.h>
  25 #include <ldsodefs.h>
  26
  27 /* This implementation assumes a stack layout that matches the defaults
  28    used by gcc's `__builtin_frame_address' and `__builtin_return_address'
  29    (FP is the frame pointer register):
  30
  31           +-----------------+     +-----------------+
  32     FP -> | previous FP --------> | previous FP ------>...
  33           |                 |     |                 |
  34           | return address  |     | return address  |
  35           +-----------------+     +-----------------+
  36
  37   */
  38
  39 /* Get some notion of the current stack.  Need not be exactly the top
  40    of the stack, just something somewhere in the current frame.  */
  41 #ifndef CURRENT_STACK_FRAME
  42 # define CURRENT_STACK_FRAME  ({ char __csf; &__csf; })
  43 #endif
  44
  45 /* By default we assume that the stack grows downward.  */
  46 #ifndef INNER_THAN
  47 # define INNER_THAN <
  48 #endif
  49
  50 /* By default assume the `next' pointer in struct layout points to the
  51    next struct layout.  */
  52 #ifndef ADVANCE_STACK_FRAME
  53 # define ADVANCE_STACK_FRAME(next) BOUNDED_1 ((struct layout *) (next))
  54 #endif
  55
  56 /* By default, the frame pointer is just what we get from gcc.  */
  57 #ifndef FIRST_FRAME_POINTER
  58 # define FIRST_FRAME_POINTER  __builtin_frame_address (0)
  59 #endif
  60
  61 int
  62 __backtrace (array, size)
  63      void **array;
  64      int size;
  65 {
  66   struct layout *current;
  67   void *__unbounded top_frame;
  68   void *__unbounded top_stack;
  69   int cnt = 0;
  70
  71   top_frame = FIRST_FRAME_POINTER;
  72   top_stack = CURRENT_STACK_FRAME;
  73
  74   /* We skip the call to this function, it makes no sense to record it.  */
  75   current = BOUNDED_1 ((struct layout *) top_frame);
  76   while (cnt < size)
  77     {
  78       if ((void *) current INNER_THAN top_stack
  79           || !((void *) current INNER_THAN __libc_stack_end))
  80        /* This means the address is out of range.  Note that for the
  81           toplevel we see a frame pointer with value NULL which clearly is
  82           out of range.  */
  83         break;
  84
  85       array[cnt++] = current->return_address;
  86
  87       current = ADVANCE_STACK_FRAME (current->next);
  88     }
  89
  90   return cnt;
  91 }
  92 weak_alias (__backtrace, backtrace)
  93 libc_hidden_def (__backtrace)