* Again changed the stacktrace system: more specific functions (i hope this
[cacao.git] / 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 2990 2005-07-11 21:24:35Z twisti $
32
33 */
34
35
36 #ifndef _STACKTRACE_H
37 #define _STACKTRACE_H
38
39 /* forward typedefs ***********************************************************/
40
41 typedef struct stackframeinfo stackframeinfo;
42 typedef struct stackTraceBuffer stackTraceBuffer;
43 typedef struct stacktraceelement stacktraceelement;
44
45 #include "config.h"
46 #include "types.h"
47
48 #include "vm/method.h"
49
50
51 /* stackframeinfo *************************************************************/
52
53 struct stackframeinfo {
54         void        *oldThreadspecificHeadValue;
55         void       **addressOfThreadspecificHead;
56         methodinfo  *method;                /* methodinfo of current function     */
57         u1          *pv;                    /* PV of current function             */
58         u1          *sp;                    /* SP of parent Java function         */
59         functionptr  ra;                    /* RA to parent Java function         */
60         functionptr  xpc;                   /* XPC (for inline stubs)             */
61         void        *padding;               /* multiple of 16-byte padding        */
62 };
63
64
65 struct stacktraceelement {
66 #if SIZEOF_VOID_P == 8
67         u8          linenumber;
68 #else
69         u4          linenumber;
70 #endif
71         methodinfo *method;
72 };
73
74
75 struct stackTraceBuffer {
76         s4                 needsFree;
77         stacktraceelement *start;
78         s4                 size;
79         s4                 full;
80 };
81
82
83 /* function prototypes ********************************************************/
84
85 void stacktrace_create_inline_stackframeinfo(stackframeinfo *sfi, u1 *pv,
86                                                                                          u1 *sp, functionptr ra,
87                                                                                          functionptr xpc);
88
89 void stacktrace_create_extern_stackframeinfo(stackframeinfo *sfi, u1 *pv,
90                                                                                          u1 *sp, functionptr ra,
91                                                                                          functionptr xpc);
92
93 void stacktrace_create_native_stackframeinfo(stackframeinfo *sfi, u1 *pv,
94                                                                                          u1 *sp, functionptr ra);
95
96 void stacktrace_remove_stackframeinfo(stackframeinfo *sfi);
97
98 /* inline exception creating functions */
99 java_objectheader *stacktrace_inline_arithmeticexception(u1 *pv, u1 *sp,
100                                                                                                                  functionptr ra,
101                                                                                                                  functionptr xpc);
102
103 java_objectheader *stacktrace_inline_arrayindexoutofboundsexception(u1 *pv,
104                                                                                                                                         u1 *sp,
105                                                                                                                                         functionptr ra,
106                                                                                                                                         functionptr xpc,
107                                                                                                                                         s4 index);
108
109 java_objectheader *stacktrace_inline_arraystoreexception(u1 *pv, u1 *sp,
110                                                                                                                  functionptr ra,
111                                                                                                                  functionptr xpc);
112
113 java_objectheader *stacktrace_inline_classcastexception(u1 *pv, u1 *sp,
114                                                                                                                 functionptr ra,
115                                                                                                                 functionptr xpc);
116
117 java_objectheader *stacktrace_inline_negativearraysizeexception(u1 *pv, u1 *sp,
118                                                                                                                                 functionptr ra,
119                                                                                                                                 functionptr xpc);
120
121 java_objectheader *stacktrace_inline_nullpointerexception(u1 *pv, u1 *sp,
122                                                                                                                   functionptr ra,
123                                                                                                                   functionptr xpc);
124
125
126 /* hardware exception creating functions */
127 java_objectheader *stacktrace_hardware_arithmeticexception(u1 *pv, u1 *sp,
128                                                                                                                    functionptr ra,
129                                                                                                                    functionptr xpc);
130
131 java_objectheader *stacktrace_hardware_nullpointerexception(u1 *pv, u1 *sp,
132                                                                                                                         functionptr ra,
133                                                                                                                         functionptr xpc);
134
135 /* refill the stacktrace of an existing exception */
136 java_objectheader *stacktrace_inline_fillInStackTrace(u1 *pv, u1 *sp,
137                                                                                                           functionptr ra,
138                                                                                                           functionptr xpc);
139
140 java_objectheader *stacktrace_extern_fillInStackTrace(u1 *pv, u1 *sp, 
141                                                                                                           functionptr ra,
142                                                                                                           functionptr xpc);
143
144 void cacao_stacktrace_NormalTrace(void **target);
145 java_objectarray *cacao_createClassContextArray(void);
146 java_objectheader *cacao_currentClassLoader(void);
147 methodinfo* cacao_callingMethod(void);
148 java_objectarray *cacao_getStackForVMAccessController(void);
149 void stacktrace_dump_trace(void);
150
151 /* machine dependent functions (code in ARCH_DIR/md.c) */
152 functionptr md_stacktrace_get_returnaddress(u1 *sp, u4 framesize);
153
154 #endif /* _STACKTRACE_H */
155
156
157 /*
158  * These are local overrides for various environment variables in Emacs.
159  * Please do not remove this and leave it at the end of the file, where
160  * Emacs will automagically detect them.
161  * ---------------------------------------------------------------------
162  * Local variables:
163  * mode: c
164  * indent-tabs-mode: t
165  * c-basic-offset: 4
166  * tab-width: 4
167  * End:
168  */