sysdeps/s390/s390-64/backtrace.c

   1 /* Return backtrace of current program state.  64 bit S/390 version.
   2    Copyright (C) 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
   3    Contributed by Martin Schwidefsky <schwidefsky@de.ibm.com>.
   4    This file is part of the GNU C Library.
   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, write to the Free
  18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19    02111-1307 USA.  */
  20
  21 #include <bits/libc-lock.h>
  22 #include <dlfcn.h>
  23 #include <execinfo.h>
  24 #include <stddef.h>
  25 #include <stdlib.h>
  26 #include <unwind.h>
  27
  28
  29 /* This is a global variable set at program start time.  It marks the
  30    highest used stack address.  */
  31 extern void *__libc_stack_end;
  32
  33
  34 /* This is the stack layout we see for every non-leaf function.
  35            size                    offset
  36     %r15 ->    +------------------+
  37              8 | back chain       |   0
  38              8 | end of stack     |   8
  39             32 | scratch          |  16
  40             80 | save area r6-r15 |  48
  41             16 | save area f4,f6  | 128
  42             16 | empty            | 144
  43                +------------------+
  44    r14 in the save area holds the return address.
  45 */
  46
  47 struct layout
  48 {
  49   long back_chain;
  50   long end_of_stack;
  51   long scratch[4];
  52   long save_grps[10];
  53   long save_fp[2];
  54   long empty[2];
  55 };
  56
  57 struct trace_arg
  58 {
  59   void **array;
  60   int cnt, size;
  61 };
  62
  63 #ifdef SHARED
  64 static _Unwind_Reason_Code (*unwind_backtrace) (_Unwind_Trace_Fn, void *);
  65 static _Unwind_Ptr (*unwind_getip) (struct _Unwind_Context *);
  66
  67 static void
  68 init (void)
  69 {
  70   void *handle = __libc_dlopen ("libgcc_s.so.1");
  71
  72   if (handle == NULL)
  73     return;
  74
  75   unwind_backtrace = __libc_dlsym (handle, "_Unwind_Backtrace");
  76   unwind_getip = __libc_dlsym (handle, "_Unwind_GetIP");
  77   if (unwind_getip == NULL)
  78     unwind_backtrace = NULL;
  79 }
  80 #else
  81 # define unwind_backtrace _Unwind_Backtrace
  82 # define unwind_getip _Unwind_GetIP
  83 #endif
  84
  85 int
  86 __backchain_backtrace (void **array, int size)
  87 {
  88   /* We assume that all the code is generated with frame pointers set.  */
  89   struct layout *stack;
  90   int cnt = 0;
  91
  92   asm ("LGR  %0,%%r15" : "=d" (stack) );
  93   /* We skip the call to this function, it makes no sense to record it.  */
  94   stack = (struct layout *) stack->back_chain;
  95   while (cnt < size)
  96     {
  97       if (stack == NULL || (void *) stack > __libc_stack_end)
  98         /* This means the address is out of range.  Note that for the
  99            toplevel we see a frame pointer with value NULL which clearly is
 100            out of range.  */
 101         break;
 102
 103       array[cnt++] = (void *) stack->save_grps[8];
 104
 105       stack = (struct layout *) stack->back_chain;
 106     }
 107
 108   return cnt;
 109 }
 110
 111 static _Unwind_Reason_Code
 112 backtrace_helper (struct _Unwind_Context *ctx, void *a)
 113 {
 114   struct trace_arg *arg = a;
 115
 116   /* We are first called with address in the __backtrace function.
 117      Skip it.  */
 118   if (arg->cnt != -1)
 119     arg->array[arg->cnt] = (void *) unwind_getip (ctx);
 120   if (++arg->cnt == arg->size)
 121     return _URC_END_OF_STACK;
 122   return _URC_NO_REASON;
 123 }
 124
 125 int
 126 __backtrace (void **array, int size)
 127 {
 128   struct trace_arg arg = { .array = array, .size = size, .cnt = -1 };
 129 #ifdef SHARED
 130   __libc_once_define (static, once);
 131
 132   __libc_once (once, init);
 133 #endif
 134   if (unwind_backtrace == NULL)
 135     return __backchain_backtrace (array, size);
 136
 137   if (size >= 1)
 138     unwind_backtrace (backtrace_helper, &arg);
 139
 140   return arg.cnt != -1 ? arg.cnt : 0;
 141 }
 142
 143 weak_alias (__backtrace, backtrace)
 144 libc_hidden_def (__backtrace)