db68ad7e821333c3652175a4ae1113bd19de12d0
[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 3204 2005-09-17 11:15:13Z 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 /* ATTENTION: Keep the number of elements of this structure even, to
54    make sure that the stack keeps aligned (e.g. 16-bytes for x86_64) */
55
56 struct stackframeinfo {
57         stackframeinfo *prev;               /* pointer to prev stackframeinfo     */
58         methodinfo     *method;             /* methodinfo of current function     */
59         u1             *pv;                 /* PV of current function             */
60         u1             *sp;                 /* SP of parent Java function         */
61         functionptr     ra;                 /* RA to parent Java function         */
62         functionptr     xpc;                /* XPC (for inline stubs)             */
63 };
64
65
66 struct stacktraceelement {
67 #if SIZEOF_VOID_P == 8
68         u8          linenumber;
69 #else
70         u4          linenumber;
71 #endif
72         methodinfo *method;
73 };
74
75
76 struct stackTraceBuffer {
77         s4                 needsFree;
78         stacktraceelement *start;
79         s4                 size;
80         s4                 full;
81 };
82
83
84 /* function prototypes ********************************************************/
85
86 void stacktrace_create_inline_stackframeinfo(stackframeinfo *sfi, u1 *pv,
87                                                                                          u1 *sp, functionptr ra,
88                                                                                          functionptr xpc);
89
90 void stacktrace_create_extern_stackframeinfo(stackframeinfo *sfi, u1 *pv,
91                                                                                          u1 *sp, functionptr ra,
92                                                                                          functionptr xpc);
93
94 void stacktrace_create_native_stackframeinfo(stackframeinfo *sfi, u1 *pv,
95                                                                                          u1 *sp, functionptr ra);
96
97 void stacktrace_remove_stackframeinfo(stackframeinfo *sfi);
98
99 /* inline exception creating functions */
100 java_objectheader *stacktrace_inline_arithmeticexception(u1 *pv, u1 *sp,
101                                                                                                                  functionptr ra,
102                                                                                                                  functionptr xpc);
103
104 java_objectheader *stacktrace_inline_arrayindexoutofboundsexception(u1 *pv,
105                                                                                                                                         u1 *sp,
106                                                                                                                                         functionptr ra,
107                                                                                                                                         functionptr xpc,
108                                                                                                                                         s4 index);
109
110 java_objectheader *stacktrace_inline_arraystoreexception(u1 *pv, u1 *sp,
111                                                                                                                  functionptr ra,
112                                                                                                                  functionptr xpc);
113
114 java_objectheader *stacktrace_inline_classcastexception(u1 *pv, u1 *sp,
115                                                                                                                 functionptr ra,
116                                                                                                                 functionptr xpc);
117
118 java_objectheader *stacktrace_inline_negativearraysizeexception(u1 *pv, u1 *sp,
119                                                                                                                                 functionptr ra,
120                                                                                                                                 functionptr xpc);
121
122 java_objectheader *stacktrace_inline_nullpointerexception(u1 *pv, u1 *sp,
123                                                                                                                   functionptr ra,
124                                                                                                                   functionptr xpc);
125
126
127 /* hardware exception creating functions */
128 java_objectheader *stacktrace_hardware_arithmeticexception(u1 *pv, u1 *sp,
129                                                                                                                    functionptr ra,
130                                                                                                                    functionptr xpc);
131
132 java_objectheader *stacktrace_hardware_nullpointerexception(u1 *pv, u1 *sp,
133                                                                                                                         functionptr ra,
134                                                                                                                         functionptr xpc);
135
136 /* refill the stacktrace of an existing exception */
137 java_objectheader *stacktrace_inline_fillInStackTrace(u1 *pv, u1 *sp,
138                                                                                                           functionptr ra,
139                                                                                                           functionptr xpc);
140
141 bool cacao_stacktrace_NormalTrace(void **target);
142 java_objectarray *cacao_createClassContextArray(void);
143 java_objectheader *cacao_currentClassLoader(void);
144 methodinfo* cacao_callingMethod(void);
145 java_objectarray *cacao_getStackForVMAccessController(void);
146 void stacktrace_dump_trace(void);
147
148 /* machine dependent functions (code in ARCH_DIR/md.c) */
149 functionptr md_stacktrace_get_returnaddress(u1 *sp, u4 framesize);
150
151 #endif /* _STACKTRACE_H */
152
153
154 /*
155  * These are local overrides for various environment variables in Emacs.
156  * Please do not remove this and leave it at the end of the file, where
157  * Emacs will automagically detect them.
158  * ---------------------------------------------------------------------
159  * Local variables:
160  * mode: c
161  * indent-tabs-mode: t
162  * c-basic-offset: 4
163  * tab-width: 4
164  * End:
165  */