* Removed all Id tags.
[cacao.git] / src / vm / exceptions.h
1 /* src/vm/exceptions.h - exception related functions prototypes
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 _EXCEPTIONS_H
29 #define _EXCEPTIONS_H
30
31 /* forward typedefs ***********************************************************/
32
33 #include "config.h"
34 #include "vm/types.h"
35
36 #include "vm/global.h"
37
38 #include "vm/jit/stacktrace.h"
39
40 #include "vmcore/references.h"
41 #include "vmcore/method.h"
42
43
44 /* hardware-exception defines **************************************************
45
46    These defines define an internal number for the various hardware
47    exceptions.
48
49    ATTENTION: These values are also used as load-displacements on some
50    architectures. Thus, these values must NOT be aligned to 4 or
51    8-byte boundaries, since normal loads could have such offsets with
52    a base of NULL which should result in a NullPointerException.
53
54    NOTE: In exceptions_init() we have a check whether the offset of
55    java_arrayheader.data[0] is greater than the largest displacement
56    defined below.  Otherwise normal array loads/stores could trigger
57    an exception.
58
59 *******************************************************************************/
60
61 #define EXCEPTION_HARDWARE_NULLPOINTER              0
62 #define EXCEPTION_HARDWARE_ARITHMETIC               1
63 #define EXCEPTION_HARDWARE_ARRAYINDEXOUTOFBOUNDS    2
64 #define EXCEPTION_HARDWARE_CLASSCAST                3
65
66 #define EXCEPTION_HARDWARE_EXCEPTION                5
67 #define EXCEPTION_HARDWARE_PATCHER                  6
68 #define EXCEPTION_HARDWARE_COMPILER                 7
69
70 #define EXCEPTION_HARDWARE_LARGEST                  7
71
72
73 /* function prototypes ********************************************************/
74
75 bool           exceptions_init(void);
76
77 java_handle_t *exceptions_get_exception(void);
78 void           exceptions_set_exception(java_handle_t *o);
79 void           exceptions_clear_exception(void);
80 java_handle_t *exceptions_get_and_clear_exception(void);
81
82 java_handle_t *new_exception_utfmessage(const char *classname,
83                                                                                         utf *message);
84
85
86 /* functions to generate compiler exceptions */
87
88 java_handle_t *exceptions_new_abstractmethoderror(void);
89 java_handle_t *exceptions_asm_new_abstractmethoderror(u1 *sp, u1 *ra);
90 java_handle_t *exceptions_new_arraystoreexception(void);
91
92 void exceptions_throw_abstractmethoderror(void);
93 void exceptions_throw_classcircularityerror(classinfo *c);
94 void exceptions_throw_classformaterror(classinfo *c, const char *message, ...);
95 void exceptions_throw_classnotfoundexception(utf *name);
96 void exceptions_throw_noclassdeffounderror(utf *name);
97 void exceptions_throw_noclassdeffounderror_cause(java_handle_t *cause);
98 void exceptions_throw_noclassdeffounderror_wrong_name(classinfo *c, utf *name);
99 void exceptions_throw_linkageerror(const char *message, classinfo *c);
100 void exceptions_throw_nosuchfielderror(classinfo *c, utf *name);
101 void exceptions_throw_nosuchmethoderror(classinfo *c, utf *name, utf *desc);
102 void exceptions_throw_exceptionininitializererror(java_handle_t *cause);
103 void exceptions_throw_incompatibleclasschangeerror(classinfo *c,
104                                                                                                    const char *message);
105 void exceptions_throw_instantiationerror(classinfo *c);
106 void exceptions_throw_internalerror(const char *message, ...);
107 void exceptions_throw_outofmemoryerror(void);
108 void exceptions_throw_verifyerror(methodinfo *m, const char *message, ...);
109 void exceptions_throw_verifyerror_for_stack(methodinfo *m, int type);
110 void exceptions_throw_unsatisfiedlinkerror(utf *name);
111 void exceptions_throw_unsupportedclassversionerror(classinfo *c, u4 ma, u4 mi);
112
113 java_handle_t *exceptions_new_arithmeticexception(void);
114
115 java_handle_t *exceptions_new_arrayindexoutofboundsexception(s4 index);
116 void exceptions_throw_arrayindexoutofboundsexception(void);
117 void exceptions_throw_arraystoreexception(void);
118
119 java_handle_t *exceptions_new_classcastexception(java_handle_t *o);
120
121 void exceptions_throw_clonenotsupportedexception(void);
122 void exceptions_throw_illegalaccessexception(utf *message);
123 void exceptions_throw_illegalargumentexception(void);
124 void exceptions_throw_illegalmonitorstateexception(void);
125 void exceptions_throw_interruptedexception(void);
126 void exceptions_throw_instantiationexception(classinfo *c);
127 void exceptions_throw_invocationtargetexception(java_handle_t *cause);
128 void exceptions_throw_negativearraysizeexception(void);
129
130 java_handle_t *exceptions_new_nullpointerexception(void);
131 void exceptions_throw_nullpointerexception(void);
132 void exceptions_throw_privilegedactionexception(java_handle_t *cause);
133 void exceptions_throw_stringindexoutofboundsexception(void);
134
135 void exceptions_classnotfoundexception_to_noclassdeffounderror(void);
136
137 java_handle_t *exceptions_fillinstacktrace(void);
138
139 void exceptions_print_exception(java_handle_t *xptr);
140 void exceptions_print_current_exception(void);
141 void exceptions_print_stacktrace(void);
142
143 #endif /* _EXCEPTIONS_H */
144
145
146 /*
147  * These are local overrides for various environment variables in Emacs.
148  * Please do not remove this and leave it at the end of the file, where
149  * Emacs will automagically detect them.
150  * ---------------------------------------------------------------------
151  * Local variables:
152  * mode: c
153  * indent-tabs-mode: t
154  * c-basic-offset: 4
155  * tab-width: 4
156  * End:
157  * vim:noexpandtab:sw=4:ts=4:
158  */