e5c1ca498559c711ef9afd8d0ada3b32d239acb9
[cacao.git] / src / vm / jit / codegen-common.h
1 /* src/vm/jit/codegen-common.h - architecture independent code generator stuff
2
3    Copyright (C) 1996-2005, 2006 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    Contact: cacao@cacaojvm.org
26
27    Authors: Christian Thalinger
28
29    Changes: Christian Ullrich
30             Edwin Steiner
31
32    $Id: codegen-common.h 5332 2006-09-05 19:38:28Z twisti $
33
34 */
35
36
37 #ifndef _CODEGEN_COMMON_H
38 #define _CODEGEN_COMMON_H
39
40 /* forward typedefs ***********************************************************/
41
42 typedef struct codegendata codegendata;
43 typedef struct codegen_critical_section_t codegen_critical_section_t;
44
45
46 #include "config.h"
47 #include "vm/types.h"
48
49 #include "vm/global.h"
50 #include "vm/references.h"
51 #include "vm/method.h"
52 #include "vm/jit/dseg.h"
53 #include "vm/jit/jit.h"
54 #include "vm/jit/reg.h"
55 #include "vm/jit/code.h"
56
57
58 #define MCODEINITSIZE (1<<15)       /* 32 Kbyte code area initialization size */
59 #define DSEGINITSIZE  (1<<12)       /*  4 Kbyte data area initialization size */
60
61 #define NCODEINITSIZE (1<<15)       /* 32 Kbyte code area initialization size */
62
63
64 /* Register Pack/Unpack Macros ************************************************/
65
66 /* ATTENTION: Don't change the order where low and high bits are
67    stored! At least mips32 relies in one case on that order. */
68
69 #define PACK_REGS(low,high) \
70     ( (((high) & 0x0000ffff) << 16) | ((low) & 0x0000ffff) )
71
72 #define GET_LOW_REG(a)      ((a) & 0x0000ffff)
73 #define GET_HIGH_REG(a)    (((a) & 0xffff0000) >> 16)
74
75
76 /************************* critical sections  *********************************/
77
78 struct codegen_critical_section_t {
79         codegen_critical_section_t *next;
80         s4                  mcodebegin;
81         s4                  mcodeend;
82         s4                  mcoderestart;
83 };
84
85
86 struct codegendata {
87         u1             *mcodebase;      /* base pointer of code area              */
88         u1             *mcodeend;       /* pointer to end of code area            */
89         s4              mcodesize;      /* complete size of code area (bytes)     */
90         u1             *mcodeptr;       /* code generation pointer                */
91         u1             *lastmcodeptr;   /* last patcher position of basic block   */
92
93 #if defined(ENABLE_INTRP)
94         u1             *ncodebase;      /* base pointer of native code area       */
95         s4              ncodesize;      /* complete size of native code area      */
96         u1             *ncodeptr;       /* native code generation pointer         */
97
98         u4              lastinstwithoutdispatch; /* ~0 if there was a dispatch    */
99
100         s4              lastpatcheroffset; /* -1 if current super has no patcher  */
101         s4              dynsuperm;      /* offsets of start of current dynamic ...*/
102         s4              dynsupern;      /* ... superinstruction starts            */
103         struct superstart *superstarts; /* list of supers without patchers        */
104 #endif
105
106         dsegentry      *dseg;           /* chain of data segment entries          */
107         s4              dseglen;        /* used size of data area (bytes)         */
108                                     /* data area grows from top to bottom     */
109
110         jumpref        *jumpreferences; /* list of jumptable target addresses     */
111
112 #if defined(__I386__) || defined(__X86_64__) || defined(__XDSPCORE__) || defined(ENABLE_INTRP)
113         dataref        *datareferences; /* list of data segment references        */
114 #endif
115
116         exceptionref   *exceptionrefs;  /* list of exception branches             */
117         patchref       *patchrefs;
118
119         linenumberref  *linenumberreferences; /* list of line numbers and the     */
120                                         /* program counters of their first        */
121                                         /* instruction                            */
122         s4              linenumbertablesizepos;
123         s4              linenumbertablestartpos;
124         s4              linenumbertab;
125
126         methodinfo     *method;
127         s4              exceptiontablelength; /* exceptiontable length            */
128         exceptiontable *exceptiontable; /* the exceptiontable                     */
129
130         codegen_critical_section_t *threadcrit; /* List of critical code regions          */
131         codegen_critical_section_t threadcritcurrent;
132         s4                 threadcritcount; /* Number of critical regions         */
133
134         s4              maxstack;
135         s4              maxlocals;
136         s4              stackframesize;    /* stackframe size of this method      */
137 };
138
139
140 /* methodtree_element *********************************************************/
141
142 typedef struct methodtree_element methodtree_element;
143
144 struct methodtree_element {
145         u1 *startpc;
146         u1 *endpc;
147 };
148
149
150 /* function prototypes ********************************************************/
151
152 void codegen_init(void);
153 void codegen_setup(jitdata *jd);
154
155 void codegen_close(void);
156
157 void codegen_increase(codegendata *cd);
158
159 #if defined(ENABLE_INTRP)
160 u1 *codegen_ncode_increase(codegendata *cd, u1 *ncodeptr);
161 #endif
162
163 void codegen_addreference(codegendata *cd, basicblock *target);
164
165 void codegen_add_arithmeticexception_ref(codegendata *cd);
166 void codegen_add_arrayindexoutofboundsexception_ref(codegendata *cd, s4 reg);
167 void codegen_add_arraystoreexception_ref(codegendata *cd);
168 void codegen_add_classcastexception_ref(codegendata *cd, s4 reg);
169 void codegen_add_nullpointerexception_ref(codegendata *cd);
170 void codegen_add_fillinstacktrace_ref(codegendata *cd);
171
172
173 void codegen_addpatchref(codegendata *cd, functionptr patcher, voidptr ref,
174                                                  s4 disp);
175
176 void codegen_insertmethod(u1 *startpc, u1 *endpc);
177 u1 *codegen_get_pv_from_pc(u1 *pc);
178 u1 *codegen_get_pv_from_pc_nocheck(u1 *pc);
179
180 void codegen_finish(jitdata *jd);
181
182 codeinfo *codegen_createnativestub(functionptr f, methodinfo *m);
183 #if defined(ENABLE_DISASSEMBLER)
184 void codegen_disassemble_nativestub(methodinfo *m, u1 *start, u1 *end);
185 #endif
186
187 void codegen_start_native_call(u1 *datasp, u1 *pv, u1 *sp, u1 *ra);
188 java_objectheader *codegen_finish_native_call(u1 *datasp);
189
190 u1 *createcompilerstub(methodinfo *m);
191 u1 *createnativestub(functionptr f, jitdata *jd, methoddesc *nmd);
192
193 #if defined(ENABLE_INTRP)
194 u1 *intrp_createcompilerstub(methodinfo *m);
195 u1 *intrp_createnativestub(functionptr f, jitdata *jd, methoddesc *md);
196 #endif
197
198 void removecompilerstub(u1 *stub);
199 void removenativestub(u1 *stub);
200
201 s4 codegen_reg_of_var(registerdata *rd, u2 opcode, stackptr v, s4 tempregnum);
202 s4 codegen_reg_of_dst(jitdata *jd, instruction *iptr, s4 tempregnum);
203
204 #if defined(ENABLE_THREADS)
205 void codegen_threadcritrestart(codegendata *cd, int offset);
206 void codegen_threadcritstart(codegendata *cd, int offset);
207 void codegen_threadcritstop(codegendata *cd, int offset);
208 #endif
209
210 /* machine dependent functions */
211 u1 *md_codegen_get_pv_from_pc(u1 *ra);
212
213 bool codegen(jitdata *jd);
214
215 #if defined(ENABLE_INTRP)
216 bool intrp_codegen(jitdata *jd);
217 #endif
218
219 #endif /* _CODEGEN_COMMON_H */
220
221
222 /*
223  * These are local overrides for various environment variables in Emacs.
224  * Please do not remove this and leave it at the end of the file, where
225  * Emacs will automagically detect them.
226  * ---------------------------------------------------------------------
227  * Local variables:
228  * mode: c
229  * indent-tabs-mode: t
230  * c-basic-offset: 4
231  * tab-width: 4
232  * End:
233  * vim:noexpandtab:sw=4:ts=4:
234  */