src/vm/jit/stacktrace.h

   1 /* src/vm/jit/stacktrace.h - header file for stacktrace generation
   2
   3    Copyright (C) 1996-2005, 2006, 2007 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   7
   8    This file is part of CACAO.
   9
  10    This program is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2, or (at
  13    your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful, but
  16    WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25 */
  26
  27
  28 #ifndef _STACKTRACE_H
  29 #define _STACKTRACE_H
  30
  31 /* forward typedefs ***********************************************************/
  32
  33 typedef struct stackframeinfo stackframeinfo;
  34 typedef struct stacktracebuffer stacktracebuffer;
  35 typedef struct stacktrace_entry stacktrace_entry;
  36
  37 #include "config.h"
  38 #include "vm/types.h"
  39
  40 #include "vmcore/class.h"
  41 #include "vmcore/method.h"
  42
  43
  44 /* stackframeinfo **************************************************************
  45
  46    ATTENTION: Keep the number of elements of this structure even, to
  47    make sure that the stack keeps aligned (e.g. 16-bytes for x86_64).
  48
  49 *******************************************************************************/
  50
  51 struct stackframeinfo {
  52         stackframeinfo *prev;               /* pointer to prev stackframeinfo     */
  53         methodinfo     *method;             /* methodinfo of current function     */
  54         u1             *pv;                 /* PV of current function             */
  55         u1             *sp;                 /* SP of parent Java function         */
  56         u1             *ra;                 /* RA to parent Java function         */
  57         u1             *xpc;                /* XPC (for inline stubs)             */
  58 #if defined(ENABLE_GC_CACAO)
  59         /*
  60          * The exact GC needs to be able to recover saved registers, so the
  61          * native-stub saves these registers here
  62          */
  63 # if defined(HAS_ADDRESS_REGISTER_FILE)
  64         ptrint          adrregs[ADR_SAV_CNT];
  65 # else
  66         ptrint          intregs[INT_SAV_CNT];
  67 # endif
  68 #endif
  69 };
  70
  71
  72 /* stacktrace_entry ***********************************************************/
  73
  74 struct stacktrace_entry {
  75 #if SIZEOF_VOID_P == 8
  76         u8          linenumber;
  77 #else
  78         u4          linenumber;
  79 #endif
  80         methodinfo *method;
  81 };
  82
  83
  84 /* stacktracebuffer ***********************************************************/
  85
  86 #define STACKTRACE_CAPACITY_DEFAULT      80
  87 #define STACKTRACE_CAPACITY_INCREMENT    80
  88
  89 struct stacktracebuffer {
  90         s4                capacity;         /* size of the buffer                 */
  91         s4                used;             /* current entries in the buffer      */
  92         stacktrace_entry *entries;          /* the actual entries                 */
  93 };
  94
  95
  96 /* stacktracecontainer ********************************************************
  97
  98    ATTENTION: Use the stacktracecontainer to place a stacktrace onto the heap
  99    with stacktrace_fillInStackTrace() so that the GC does not get confused.
 100
 101 *******************************************************************************/
 102
 103 typedef struct stacktracecontainer {
 104         java_array_t            header;     /* default array header for the GC    */
 105         struct stacktracebuffer stb;        /* let entries point to data below    */
 106         stacktrace_entry        data[1];    /* the actual array of entries        */
 107 } stacktracecontainer;
 108
 109
 110 /* function prototypes ********************************************************/
 111
 112 #if defined(ENABLE_INTRP)
 113 void stacktrace_create_stackframeinfo(stackframeinfo *sfi, u1 *pv, u1 *sp,
 114                                                                           u1 *ra);
 115 #endif
 116
 117 void stacktrace_create_extern_stackframeinfo(stackframeinfo *sfi, u1 *pv,
 118                                                                                          u1 *sp, u1 *ra, u1 *xpc);
 119
 120 void stacktrace_create_native_stackframeinfo(stackframeinfo *sfi, u1 *pv,
 121                                                                                          u1 *sp, u1 *ra);
 122
 123 void stacktrace_remove_stackframeinfo(stackframeinfo *sfi);
 124
 125
 126 stacktracebuffer *stacktrace_create(stackframeinfo *sfi);
 127
 128 stacktracecontainer *stacktrace_fillInStackTrace(void);
 129
 130 #if defined(ENABLE_JAVASE)
 131 java_handle_objectarray_t *stacktrace_getClassContext(void);
 132 classinfo                 *stacktrace_getCurrentClass(void);
 133 java_handle_objectarray_t *stacktrace_getStack(void);
 134 #endif
 135
 136 void stacktrace_print_trace_from_buffer(stacktracebuffer *stb);
 137 void stacktrace_print_trace(java_handle_t *xptr);
 138
 139 /* machine dependent functions (code in ARCH_DIR/md.c) */
 140
 141 #if defined(ENABLE_JIT)
 142 u1 *md_stacktrace_get_returnaddress(u1 *sp, u4 framesize);
 143 # if defined(__SPARC_64__)
 144 u1 *md_get_framepointer(u1 *sp);
 145 u1 *md_get_pv_from_stackframe(u1 *sp);
 146 # endif
 147 #endif
 148
 149 #if defined(ENABLE_INTRP)
 150 u1 *intrp_md_stacktrace_get_returnaddress(u1 *sp, u4 framesize);
 151 #endif
 152
 153 #if defined(ENABLE_CYCLES_STATS)
 154 void stacktrace_print_cycles_stats(FILE *file);
 155 #endif
 156
 157 #endif /* _STACKTRACE_H */
 158
 159
 160 /*
 161  * These are local overrides for various environment variables in Emacs.
 162  * Please do not remove this and leave it at the end of the file, where
 163  * Emacs will automagically detect them.
 164  * ---------------------------------------------------------------------
 165  * Local variables:
 166  * mode: c
 167  * indent-tabs-mode: t
 168  * c-basic-offset: 4
 169  * tab-width: 4
 170  * End:
 171  * vim:noexpandtab:sw=4:ts=4:
 172  */