0cbf0a2a8001463eb5e9dd3756b8d9bca0862862
[cacao.git] / src / vm / jit / code.hpp
1 /* src/vm/jit/code.hpp - codeinfo struct for representing compiled code
2
3    Copyright (C) 1996-2005, 2006, 2007, 2008
4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
5
6    This file is part of CACAO.
7
8    This program is free software; you can redistribute it and/or
9    modify it under the terms of the GNU General Public License as
10    published by the Free Software Foundation; either version 2, or (at
11    your option) any later version.
12
13    This program is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21    02110-1301, USA.
22
23 */
24
25
26 #ifndef _CODE_HPP
27 #define _CODE_HPP
28
29 #include "config.h"
30
31 #include <assert.h>
32 #include <stdint.h>
33
34 #include "vm/types.h"
35
36 #include "toolbox/list.hpp"
37
38 #include "vm/global.h"
39 #include "vm/method.hpp"
40
41 #include "vm/jit/exceptiontable.h"
42 #include "vm/jit/linenumbertable.hpp"
43 #include "vm/jit/methodheader.h"
44 #include "vm/jit/patcher-common.hpp"
45 #include "vm/jit/replace.hpp"
46
47
48 /* constants ******************************************************************/
49
50 #define CODE_FLAG_INVALID         0x0001
51 #define CODE_FLAG_LEAFMETHOD      0x0002
52 #define CODE_FLAG_SYNCHRONIZED    0x0004
53 #define CODE_FLAG_TLH             0x0008
54
55
56 /* codeinfo *******************************************************************
57
58    A codeinfo represents a particular realization of a method in
59    machine code.
60
61    ATTENTION: The methodinfo entry in the code-structure MUST have the
62    offset 0, otherwise we have a problem in our compiler stub. This is
63    checked with an assert in code_init().
64
65 *******************************************************************************/
66
67 struct codeinfo {
68         methodinfo   *m;                    /* method this is a realization of    */
69         codeinfo     *prev;                 /* previous codeinfo of this method   */
70
71         uint32_t      flags;                /* OR of CODE_FLAG_ constants         */
72
73         u1            optlevel;             /* optimization level of this code    */
74         s4            basicblockcount;      /* number of basic blocks             */
75
76         int32_t       synchronizedoffset;   /* stack offset of synchronized obj.  */
77
78         /* machine code */
79         u1           *mcode;                /* pointer to machine code            */
80         u1           *entrypoint;           /* machine code entry point           */
81         s4            mcodelength;          /* length of generated machine code   */
82
83         exceptiontable_t  *exceptiontable;
84         LinenumberTable* linenumbertable;
85
86         /* patcher list */
87 #ifdef __cplusplus
88         List<patchref_t>* patchers;
89 #else
90         List*         patchers;
91 #endif
92
93         /* replacement */                                   
94         s4            stackframesize;       /* size of the stackframe in slots    */
95
96 #if defined(ENABLE_REPLACEMENT)
97         rplpoint     *rplpoints;            /* replacement points                 */
98         rplalloc     *regalloc;             /* register allocation info           */
99         s4            rplpointcount;        /* number of replacement points       */
100         s4            globalcount;          /* number of global allocations       */
101         s4            regalloccount;        /* number of total allocations        */
102         s4            memuse;               /* number of arg + local slots        */
103         u1            savedintcount;        /* number of callee saved int regs    */
104         u1            savedfltcount;        /* number of callee saved flt regs    */
105 # if defined(HAS_ADDRESS_REGISTER_FILE)
106         u1            savedadrcount;        /* number of callee saved adr regs    */
107 # endif
108         u1           *savedmcode;           /* saved code under patches           */
109 #endif
110
111 #if defined(ENABLE_PROFILING)
112         u4            frequency;            /* number of method invocations       */
113         u4           *bbfrequency;                  
114         s8            cycles;               /* number of cpu cycles               */
115 #endif
116 };
117
118
119 #ifdef __cplusplus
120 extern "C" {
121 #endif
122
123 /* inline functions ***********************************************************/
124
125 /* code_xxx_invalid ************************************************************
126
127    Functions for CODE_FLAG_INVALID.
128
129 *******************************************************************************/
130
131 inline static int code_is_invalid(codeinfo *code)
132 {
133         return (code->flags & CODE_FLAG_INVALID);
134 }
135
136 inline static void code_flag_invalid(codeinfo *code)
137 {
138         code->flags |= CODE_FLAG_INVALID;
139 }
140
141 inline static void code_unflag_invalid(codeinfo *code)
142 {
143         code->flags &= ~CODE_FLAG_INVALID;
144 }
145
146
147 /* code_xxx_leafmethod *********************************************************
148
149    Functions for CODE_FLAG_LEAFMETHOD.
150
151 *******************************************************************************/
152
153 inline static int code_is_leafmethod(codeinfo *code)
154 {
155         return (code->flags & CODE_FLAG_LEAFMETHOD);
156 }
157
158 inline static void code_flag_leafmethod(codeinfo *code)
159 {
160         code->flags |= CODE_FLAG_LEAFMETHOD;
161 }
162
163 inline static void code_unflag_leafmethod(codeinfo *code)
164 {
165         code->flags &= ~CODE_FLAG_LEAFMETHOD;
166 }
167
168
169 /* code_xxx_synchronized *******************************************************
170
171    Functions for CODE_FLAG_SYNCHRONIZED.
172
173 *******************************************************************************/
174
175 inline static int code_is_synchronized(codeinfo *code)
176 {
177         return (code->flags & CODE_FLAG_SYNCHRONIZED);
178 }
179
180 inline static void code_flag_synchronized(codeinfo *code)
181 {
182         code->flags |= CODE_FLAG_SYNCHRONIZED;
183 }
184
185 inline static void code_unflag_synchronized(codeinfo *code)
186 {
187         code->flags &= ~CODE_FLAG_SYNCHRONIZED;
188 }
189
190
191 /* code_get_codeinfo_for_pv ****************************************************
192
193    Return the codeinfo for the given PV.
194
195    IN:
196        pv...............PV
197
198    RETURN VALUE:
199        the codeinfo *
200
201 *******************************************************************************/
202
203 inline static codeinfo *code_get_codeinfo_for_pv(void *pv)
204 {
205         codeinfo *code;
206
207         assert(pv != NULL);
208
209         code = *((codeinfo **) (((uintptr_t) pv) + CodeinfoPointer));
210
211         return code;
212 }
213
214
215 /* function prototypes ********************************************************/
216
217 void code_init(void);
218
219 codeinfo *code_codeinfo_new(methodinfo *m);
220 void code_codeinfo_free(codeinfo *code);
221
222 codeinfo *code_find_codeinfo_for_pc(void *pc);
223 codeinfo *code_find_codeinfo_for_pc_nocheck(void *pc);
224
225 methodinfo *code_get_methodinfo_for_pv(void *pv);
226
227 #if defined(ENABLE_REPLACEMENT)
228 int code_get_sync_slot_count(codeinfo *code);
229 #endif /* defined(ENABLE_REPLACEMENT) */
230
231 void code_free_code_of_method(methodinfo *m);
232
233 #ifdef __cplusplus
234 }
235 #endif
236
237 #endif // _CODE_HPP
238
239
240 /*
241  * These are local overrides for various environment variables in Emacs.
242  * Please do not remove this and leave it at the end of the file, where
243  * Emacs will automagically detect them.
244  * ---------------------------------------------------------------------
245  * Local variables:
246  * mode: c++
247  * indent-tabs-mode: t
248  * c-basic-offset: 4
249  * tab-width: 4
250  * End:
251  * vim:noexpandtab:sw=4:ts=4:
252  */