4e88fb0a1fe6075623e25d05e42f1b0fb36f4e41
[cacao.git] / src / vm / jit / code.h
1 /* src/vm/jit/code.h - 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_H
27 #define _CODE_H
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.h"
37
38 #include "vm/global.h"
39 #include "vm/method.h"
40
41 #include "vm/jit/exceptiontable.h"
42 #include "vm/jit/linenumbertable.h"
43 #include "vm/jit/methodheader.h"
44 #include "vm/jit/replace.hpp"
45
46
47 /* constants ******************************************************************/
48
49 #define CODE_FLAG_INVALID         0x0001
50 #define CODE_FLAG_LEAFMETHOD      0x0002
51 #define CODE_FLAG_SYNCHRONIZED    0x0004
52 #define CODE_FLAG_TLH             0x0008
53
54
55 /* codeinfo *******************************************************************
56
57    A codeinfo represents a particular realization of a method in
58    machine code.
59
60    ATTENTION: The methodinfo entry in the code-structure MUST have the
61    offset 0, otherwise we have a problem in our compiler stub. This is
62    checked with an assert in code_init().
63
64 *******************************************************************************/
65
66 struct codeinfo {
67         methodinfo   *m;                    /* method this is a realization of    */
68         codeinfo     *prev;                 /* previous codeinfo of this method   */
69
70         uint32_t      flags;                /* OR of CODE_FLAG_ constants         */
71
72         u1            optlevel;             /* optimization level of this code    */
73         s4            basicblockcount;      /* number of basic blocks             */
74
75         int32_t       synchronizedoffset;   /* stack offset of synchronized obj.  */
76
77         /* machine code */
78         u1           *mcode;                /* pointer to machine code            */
79         u1           *entrypoint;           /* machine code entry point           */
80         s4            mcodelength;          /* length of generated machine code   */
81
82         exceptiontable_t  *exceptiontable;
83         linenumbertable_t *linenumbertable;
84
85         /* patcher list */
86         list_t       *patchers;
87
88         /* replacement */                                   
89         s4            stackframesize;       /* size of the stackframe in slots    */
90
91 #if defined(ENABLE_REPLACEMENT)
92         rplpoint     *rplpoints;            /* replacement points                 */
93         rplalloc     *regalloc;             /* register allocation info           */
94         s4            rplpointcount;        /* number of replacement points       */
95         s4            globalcount;          /* number of global allocations       */
96         s4            regalloccount;        /* number of total allocations        */
97         s4            memuse;               /* number of arg + local slots        */
98         u1            savedintcount;        /* number of callee saved int regs    */
99         u1            savedfltcount;        /* number of callee saved flt regs    */
100 # if defined(HAS_ADDRESS_REGISTER_FILE)
101         u1            savedadrcount;        /* number of callee saved adr regs    */
102 # endif
103         u1           *savedmcode;           /* saved code under patches           */
104 #endif
105
106 #if defined(ENABLE_PROFILING)
107         u4            frequency;            /* number of method invocations       */
108         u4           *bbfrequency;                  
109         s8            cycles;               /* number of cpu cycles               */
110 #endif
111 };
112
113
114 #ifdef __cplusplus
115 extern "C" {
116 #endif
117
118 /* inline functions ***********************************************************/
119
120 /* code_xxx_invalid ************************************************************
121
122    Functions for CODE_FLAG_INVALID.
123
124 *******************************************************************************/
125
126 inline static int code_is_invalid(codeinfo *code)
127 {
128         return (code->flags & CODE_FLAG_INVALID);
129 }
130
131 inline static void code_flag_invalid(codeinfo *code)
132 {
133         code->flags |= CODE_FLAG_INVALID;
134 }
135
136 inline static void code_unflag_invalid(codeinfo *code)
137 {
138         code->flags &= ~CODE_FLAG_INVALID;
139 }
140
141
142 /* code_xxx_leafmethod *********************************************************
143
144    Functions for CODE_FLAG_LEAFMETHOD.
145
146 *******************************************************************************/
147
148 inline static int code_is_leafmethod(codeinfo *code)
149 {
150         return (code->flags & CODE_FLAG_LEAFMETHOD);
151 }
152
153 inline static void code_flag_leafmethod(codeinfo *code)
154 {
155         code->flags |= CODE_FLAG_LEAFMETHOD;
156 }
157
158 inline static void code_unflag_leafmethod(codeinfo *code)
159 {
160         code->flags &= ~CODE_FLAG_LEAFMETHOD;
161 }
162
163
164 /* code_xxx_synchronized *******************************************************
165
166    Functions for CODE_FLAG_SYNCHRONIZED.
167
168 *******************************************************************************/
169
170 inline static int code_is_synchronized(codeinfo *code)
171 {
172         return (code->flags & CODE_FLAG_SYNCHRONIZED);
173 }
174
175 inline static void code_flag_synchronized(codeinfo *code)
176 {
177         code->flags |= CODE_FLAG_SYNCHRONIZED;
178 }
179
180 inline static void code_unflag_synchronized(codeinfo *code)
181 {
182         code->flags &= ~CODE_FLAG_SYNCHRONIZED;
183 }
184
185
186 /* code_get_codeinfo_for_pv ****************************************************
187
188    Return the codeinfo for the given PV.
189
190    IN:
191        pv...............PV
192
193    RETURN VALUE:
194        the codeinfo *
195
196 *******************************************************************************/
197
198 inline static codeinfo *code_get_codeinfo_for_pv(void *pv)
199 {
200         codeinfo *code;
201
202         assert(pv != NULL);
203
204         code = *((codeinfo **) (((uintptr_t) pv) + CodeinfoPointer));
205
206         return code;
207 }
208
209
210 /* function prototypes ********************************************************/
211
212 void code_init(void);
213
214 codeinfo *code_codeinfo_new(methodinfo *m);
215 void code_codeinfo_free(codeinfo *code);
216
217 codeinfo *code_find_codeinfo_for_pc(void *pc);
218 codeinfo *code_find_codeinfo_for_pc_nocheck(void *pc);
219
220 methodinfo *code_get_methodinfo_for_pv(void *pv);
221
222 #if defined(ENABLE_REPLACEMENT)
223 int code_get_sync_slot_count(codeinfo *code);
224 #endif /* defined(ENABLE_REPLACEMENT) */
225
226 void code_free_code_of_method(methodinfo *m);
227
228 #ifdef __cplusplus
229 }
230 #endif
231
232 #endif /* _CODE_H */
233
234
235 /*
236  * These are local overrides for various environment variables in Emacs.
237  * Please do not remove this and leave it at the end of the file, where
238  * Emacs will automagically detect them.
239  * ---------------------------------------------------------------------
240  * Local variables:
241  * mode: c
242  * indent-tabs-mode: t
243  * c-basic-offset: 4
244  * tab-width: 4
245  * End:
246  * vim:noexpandtab:sw=4:ts=4:
247  */