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