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 "md-abi.h"
  41
  42 #include "vmcore/class.h"
  43 #include "vmcore/method.h"
  44
  45
  46 /* stackframeinfo **************************************************************
  47
  48    ATTENTION: Keep the number of elements of this structure even, to
  49    make sure that the stack keeps aligned (e.g. 16-bytes for x86_64).
  50
  51 *******************************************************************************/
  52
  53 struct stackframeinfo {
  54         stackframeinfo *prev;               /* pointer to prev stackframeinfo     */
  55         methodinfo     *method;             /* methodinfo of current function     */
  56         u1             *pv;                 /* PV of current function             */
  57         u1             *sp;                 /* SP of parent Java function         */
  58         u1             *ra;                 /* RA to parent Java function         */
  59         u1             *xpc;                /* XPC (for inline stubs)             */
  60 #if defined(ENABLE_GC_CACAO)
  61         /*
  62          * The exact GC needs to be able to recover saved registers, so the
  63          * native-stub saves these registers here
  64          */
  65 # if defined(HAS_ADDRESS_REGISTER_FILE)
  66         ptrint          adrregs[ADR_SAV_CNT];
  67 # else
  68         ptrint          intregs[INT_SAV_CNT];
  69 # endif
  70 #endif
  71 };
  72
  73
  74 /* stacktrace_entry ***********************************************************/
  75
  76 struct stacktrace_entry {
  77 #if SIZEOF_VOID_P == 8
  78         u8          linenumber;
  79 #else
  80         u4          linenumber;
  81 #endif
  82         methodinfo *method;
  83 };
  84
  85
  86 /* stacktracebuffer ***********************************************************/
  87
  88 #define STACKTRACE_CAPACITY_DEFAULT      80
  89 #define STACKTRACE_CAPACITY_INCREMENT    80
  90
  91 struct stacktracebuffer {
  92         s4               capacity;          /* size of the buffer                 */
  93         s4               used;              /* current entries in the buffer      */
  94         stacktrace_entry entries[80];       /* the actual entries                 */
  95 };
  96
  97
  98 /* stacktracecontainer ********************************************************
  99
 100    ATTENTION: Use the stacktracecontainer to place a stacktrace onto the heap
 101    with stacktrace_fillInStackTrace() so that the GC does not get confused.
 102
 103 *******************************************************************************/
 104
 105 typedef struct stacktracecontainer {
 106         java_array_t            header;     /* default array header for the GC    */
 107         struct stacktracebuffer stb;        /* wrapped stacktracebuffer           */
 108 } stacktracecontainer;
 109
 110
 111 /* function prototypes ********************************************************/
 112
 113 #if defined(ENABLE_INTRP)
 114 void stacktrace_create_stackframeinfo(stackframeinfo *sfi, u1 *pv, u1 *sp,
 115                                                                           u1 *ra);
 116 #endif
 117
 118 void stacktrace_create_extern_stackframeinfo(stackframeinfo *sfi, u1 *pv,
 119                                                                                          u1 *sp, u1 *ra, u1 *xpc);
 120
 121 void stacktrace_create_native_stackframeinfo(stackframeinfo *sfi, u1 *pv,
 122                                                                                          u1 *sp, u1 *ra);
 123
 124 void stacktrace_remove_stackframeinfo(stackframeinfo *sfi);
 125
 126
 127 stacktracebuffer *stacktrace_create(stackframeinfo *sfi);
 128
 129 stacktracecontainer *stacktrace_fillInStackTrace(void);
 130
 131 #if defined(ENABLE_JAVASE)
 132 java_handle_objectarray_t *stacktrace_getClassContext(void);
 133 classinfo                 *stacktrace_getCurrentClass(void);
 134 java_handle_objectarray_t *stacktrace_getStack(void);
 135 #endif
 136
 137 void stacktrace_print_trace_from_buffer(stacktracebuffer *stb);
 138 void stacktrace_print_trace(java_handle_t *xptr);
 139
 140 /* machine dependent functions (code in ARCH_DIR/md.c) */
 141
 142 #if defined(ENABLE_JIT)
 143 u1 *md_stacktrace_get_returnaddress(u1 *sp, u4 framesize);
 144 # if defined(__SPARC_64__)
 145 u1 *md_get_framepointer(u1 *sp);
 146 u1 *md_get_pv_from_stackframe(u1 *sp);
 147 # endif
 148 #endif
 149
 150 #if defined(ENABLE_INTRP)
 151 u1 *intrp_md_stacktrace_get_returnaddress(u1 *sp, u4 framesize);
 152 #endif
 153
 154 #if defined(ENABLE_CYCLES_STATS)
 155 void stacktrace_print_cycles_stats(FILE *file);
 156 #endif
 157
 158 #endif /* _STACKTRACE_H */
 159
 160
 161 /*
 162  * These are local overrides for various environment variables in Emacs.
 163  * Please do not remove this and leave it at the end of the file, where
 164  * Emacs will automagically detect them.
 165  * ---------------------------------------------------------------------
 166  * Local variables:
 167  * mode: c
 168  * indent-tabs-mode: t
 169  * c-basic-offset: 4
 170  * tab-width: 4
 171  * End:
 172  * vim:noexpandtab:sw=4:ts=4:
 173  */