src/vm/jit/stacktrace.h

   1 /* src/vm/jit/stacktrace.h - header file for stacktrace generation
   2
   3    Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
   4    R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
   5    C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
   6    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., 59 Temple Place - Suite 330, Boston, MA
  23    02111-1307, USA.
  24
  25    Contact: cacao@complang.tuwien.ac.at
  26
  27    Authors: Christian Thalinger
  28
  29    Changes:
  30
  31    $Id: stacktrace.h 3651 2005-11-11 11:13:01Z twisti $
  32
  33 */
  34
  35
  36 #ifndef _STACKTRACE_H
  37 #define _STACKTRACE_H
  38
  39 /* forward typedefs ***********************************************************/
  40
  41 typedef struct exceptionentry exceptionentry;
  42 typedef struct stackframeinfo stackframeinfo;
  43 typedef struct stackTraceBuffer stackTraceBuffer;
  44 typedef struct stacktraceelement stacktraceelement;
  45
  46 #include "config.h"
  47 #include "vm/types.h"
  48
  49 #include "vm/method.h"
  50
  51
  52 /* exceptionentry **************************************************************
  53
  54    Datastructure which represents an exception entry in the exception
  55    table residing in the data segment.
  56
  57 *******************************************************************************/
  58
  59 struct exceptionentry {
  60         classinfo *catchtype;
  61         void      *handlerpc;
  62         void      *endpc;
  63         void      *startpc;
  64 };
  65
  66
  67 /* stackframeinfo **************************************************************
  68
  69    ATTENTION: Keep the number of elements of this structure even, to
  70    make sure that the stack keeps aligned (e.g. 16-bytes for x86_64).
  71
  72 *******************************************************************************/
  73
  74 struct stackframeinfo {
  75         stackframeinfo *prev;               /* pointer to prev stackframeinfo     */
  76         methodinfo     *method;             /* methodinfo of current function     */
  77         u1             *pv;                 /* PV of current function             */
  78         u1             *sp;                 /* SP of parent Java function         */
  79         functionptr     ra;                 /* RA to parent Java function         */
  80         functionptr     xpc;                /* XPC (for inline stubs)             */
  81 };
  82
  83 #if defined(USE_THREADS)
  84 #define STACKFRAMEINFO    (stackframeinfo **) (&THREADINFO->_stackframeinfo)
  85 #else
  86 extern stackframeinfo *_no_threads_stackframeinfo;
  87
  88 #define STACKFRAMEINFO    (&_no_threads_stackframeinfo)
  89 #endif
  90
  91
  92 struct stacktraceelement {
  93 #if SIZEOF_VOID_P == 8
  94         u8          linenumber;
  95 #else
  96         u4          linenumber;
  97 #endif
  98         methodinfo *method;
  99 };
 100
 101
 102 struct stackTraceBuffer {
 103         s4                 needsFree;
 104         stacktraceelement *start;
 105         s4                 size;
 106         s4                 full;
 107 };
 108
 109
 110 /* function prototypes ********************************************************/
 111
 112 #if defined(ENABLE_INTRP)
 113 void stacktrace_create_stackframeinfo(stackframeinfo *sfi, u1 *pv,
 114                                                                           u1 *sp, functionptr ra);
 115 #endif
 116
 117 void stacktrace_create_inline_stackframeinfo(stackframeinfo *sfi, u1 *pv,
 118                                                                                          u1 *sp, functionptr ra,
 119                                                                                          functionptr xpc);
 120
 121 void stacktrace_create_extern_stackframeinfo(stackframeinfo *sfi, u1 *pv,
 122                                                                                          u1 *sp, functionptr ra,
 123                                                                                          functionptr xpc);
 124
 125 void stacktrace_create_native_stackframeinfo(stackframeinfo *sfi, u1 *pv,
 126                                                                                          u1 *sp, functionptr ra);
 127
 128 void stacktrace_remove_stackframeinfo(stackframeinfo *sfi);
 129
 130 /* inline exception creating functions */
 131 java_objectheader *stacktrace_inline_arithmeticexception(u1 *pv, u1 *sp,
 132                                                                                                                  functionptr ra,
 133                                                                                                                  functionptr xpc);
 134
 135 java_objectheader *stacktrace_inline_arrayindexoutofboundsexception(u1 *pv,
 136                                                                                                                                         u1 *sp,
 137                                                                                                                                         functionptr ra,
 138                                                                                                                                         functionptr xpc,
 139                                                                                                                                         s4 index);
 140
 141 java_objectheader *stacktrace_inline_arraystoreexception(u1 *pv, u1 *sp,
 142                                                                                                                  functionptr ra,
 143                                                                                                                  functionptr xpc);
 144
 145 java_objectheader *stacktrace_inline_classcastexception(u1 *pv, u1 *sp,
 146                                                                                                                 functionptr ra,
 147                                                                                                                 functionptr xpc);
 148
 149 java_objectheader *stacktrace_inline_nullpointerexception(u1 *pv, u1 *sp,
 150                                                                                                                   functionptr ra,
 151                                                                                                                   functionptr xpc);
 152
 153
 154 /* hardware exception creating functions */
 155 java_objectheader *stacktrace_hardware_arithmeticexception(u1 *pv, u1 *sp,
 156                                                                                                                    functionptr ra,
 157                                                                                                                    functionptr xpc);
 158
 159 java_objectheader *stacktrace_hardware_nullpointerexception(u1 *pv, u1 *sp,
 160                                                                                                                         functionptr ra,
 161                                                                                                                         functionptr xpc);
 162
 163 /* refill the stacktrace of an existing exception */
 164 java_objectheader *stacktrace_inline_fillInStackTrace(u1 *pv, u1 *sp,
 165                                                                                                           functionptr ra,
 166                                                                                                           functionptr xpc);
 167
 168 bool cacao_stacktrace_NormalTrace(void **target);
 169 java_objectarray *cacao_createClassContextArray(void);
 170 java_objectheader *cacao_currentClassLoader(void);
 171 java_objectarray *cacao_getStackForVMAccessController(void);
 172
 173 void stacktrace_dump_trace(void);
 174 void stacktrace_print_trace(java_objectheader *xptr);
 175
 176 /* machine dependent functions (code in ARCH_DIR/md.c) */
 177 functionptr md_stacktrace_get_returnaddress(u1 *sp, u4 framesize);
 178
 179 #ifdef ENABLE_JVMTI
 180 typedef bool(*CacaoStackTraceCollector)(void **, stackTraceBuffer*);
 181
 182 bool cacao_stacktrace_fillInStackTrace(void **target,
 183                                                                            CacaoStackTraceCollector coll,
 184                                                                            threadobject* thread);
 185
 186 bool stackTraceCollector(void **target, stackTraceBuffer *buffer);
 187 #endif
 188
 189 #endif /* _STACKTRACE_H */
 190
 191
 192 /*
 193  * These are local overrides for various environment variables in Emacs.
 194  * Please do not remove this and leave it at the end of the file, where
 195  * Emacs will automagically detect them.
 196  * ---------------------------------------------------------------------
 197  * Local variables:
 198  * mode: c
 199  * indent-tabs-mode: t
 200  * c-basic-offset: 4
 201  * tab-width: 4
 202  * End:
 203  */