1 /* src/vm/jit/replace.h - on-stack replacement of methods
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
8 This file is part of CACAO.
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.
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.
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
36 #if !defined(ENABLE_REPLACEMENT)
38 /*** macros for the codegens (disabled version) ************************/
40 #define REPLACEMENT_POINTS_INIT(cd, jd)
41 #define REPLACEMENT_POINTS_RESET(cd, jd)
42 #define REPLACEMENT_POINT_BLOCK_START(cd, bptr)
43 #define REPLACEMENT_POINT_INLINE_START(cd, iptr)
44 #define REPLACEMENT_POINT_INLINE_BODY(cd, iptr)
45 #define REPLACEMENT_POINT_RETURN(cd, iptr)
46 #define REPLACEMENT_POINT_INVOKE(cd, iptr)
47 #define REPLACEMENT_POINT_INVOKE_RETURN(cd, iptr)
48 #define REPLACEMENT_EMIT_STUBS(jd)
50 #else /* defined(ENABLE_REPLACEMENT) */
52 /* forward typedefs ***********************************************************/
54 typedef struct rplalloc rplalloc;
55 typedef struct rplpoint rplpoint;
56 typedef struct executionstate_t executionstate_t;
57 typedef struct sourcestate_t sourcestate_t;
58 typedef struct sourceframe_t sourceframe_t;
59 typedef struct replace_safestack_t replace_safestack_t;
60 typedef union replace_val_t replace_val_t;
65 #include "vm/jit/reg.h"
66 #include "vm/jit/stacktrace.h"
68 #include "vmcore/method.h"
71 /* alignment for the safe stack used during replacement */
73 #define REPLACE_STACK_ALIGNMENT 16
75 /* the size of the safe stack we use during replacement */
76 /* Must be a multiple of REPLACE_STACK_ALIGNMENT. */
78 #define REPLACE_SAFESTACK_SIZE 16384 /* bytes */
81 /*** structs *********************************************************/
83 #define RPLALLOC_STACK -1
84 #define RPLALLOC_PARAM -2
85 #define RPLALLOC_SYNC -3
87 /* `rplalloc` is a compact struct for register allocation info */
89 /* XXX optimize this for space efficiency */
91 s4 index; /* local index, -1 for stack slot */
92 s4 regoff; /* register index / stack slot offset */
93 unsigned int flags:4; /* OR of (INMEMORY,...) */
94 unsigned int type:4; /* TYPE_... constant */
98 #error value of INMEMORY is too big to fit in rplalloc.flags
102 /* XXX what to do about overlapping rplpoints? */
103 /* CAUTION: Do not change the numerical values. These are used as */
104 /* indices into replace_normalize_type_map. */
105 #define RPLPOINT_TYPE_STD BBTYPE_STD
106 #define RPLPOINT_TYPE_EXH BBTYPE_EXH
107 #define RPLPOINT_TYPE_SBR BBTYPE_SBR
108 #define RPLPOINT_TYPE_CALL 3
109 #define RPLPOINT_TYPE_INLINE 4
110 #define RPLPOINT_TYPE_RETURN 5
111 #define RPLPOINT_TYPE_BODY 6
113 #define RPLPOINT_FLAG_NOTRAP 0x01 /* rplpoint cannot be trapped */
114 #define RPLPOINT_FLAG_COUNTDOWN 0x02 /* count down hits */
115 #define RPLPOINT_FLAG_ACTIVE 0x08 /* trap is active */
119 #define RPLPOINT_CHECK(type) , RPLPOINT_TYPE_##type
120 #define RPLPOINT_CHECK_BB(bptr) , (bptr)->type
122 #define RPLPOINT_CHECK(type)
123 #define RPLPOINT_CHECK_BB(bptr)
127 /* An `rplpoint` represents a replacement point in a compiled method */
130 u1 *pc; /* machine code PC of this point */
131 methodinfo *method; /* source method this point is in */
132 rplpoint *parent; /* rplpoint of the inlined body */ /* XXX unify with code */
133 rplalloc *regalloc; /* pointer to register index table */
134 s4 id; /* id of the rplpoint within method */
135 s4 callsize; /* size of call code in bytes */
136 unsigned int regalloccount:20; /* number of local allocations */
137 unsigned int type:4; /* RPLPOINT_TYPE_... constant */
138 unsigned int flags:8; /* OR of RPLPOINT_... constants */
142 union replace_val_t {
152 java_objectheader *a;
156 /* An `executionsstate` represents the state of a thread as it reached */
157 /* an replacement point or is about to enter one. */
159 struct executionstate_t {
160 u1 *pc; /* program counter */
161 u1 *sp; /* stack pointer within method */
162 u1 *pv; /* procedure value. NULL means */
163 /* search the AVL tree */
165 ptrint intregs[INT_REG_CNT]; /* register values */
166 double fltregs[FLT_REG_CNT]; /* register values */
168 codeinfo *code; /* codeinfo corresponding to the pv */
172 struct sourceframe_t {
173 sourceframe_t *down; /* source frame down the call chain */
175 methodinfo *method; /* method this frame is in */
180 replace_val_t instance;
182 replace_val_t *javastack; /* values of stack vars */
183 u1 *javastacktype; /* types of stack vars */
184 s4 javastackdepth; /* number of stack vars */
186 replace_val_t *javalocals; /* values of javalocals */
187 u1 *javalocaltype; /* types of javalocals */
188 s4 javalocalcount; /* number of javalocals */
190 replace_val_t *syncslots;
191 s4 syncslotcount; /* XXX do we need more than one? */
194 rplpoint *fromrp; /* rplpoint used to read this frame */
195 codeinfo *fromcode; /* code this frame was using */
196 rplpoint *torp; /* rplpoint this frame was mapped to */
197 codeinfo *tocode; /* code this frame was mapped to */
199 /* info for native frames */
200 stackframeinfo *sfi; /* sfi for native frames, otherwise NULL */
201 s4 nativeframesize; /* size (bytes) of native frame */
203 ptrint nativesavint[INT_SAV_CNT]; /* XXX temporary */
204 double nativesavflt[FLT_REG_CNT]; /* XXX temporary */
207 #define REPLACE_IS_NATIVE_FRAME(frame) ((frame)->sfi != NULL)
208 #define REPLACE_IS_JAVA_FRAME(frame) ((frame)->sfi == NULL)
211 struct sourcestate_t {
212 sourceframe_t *frames; /* list of source frames, from bottom up */
216 /* replace_safestack_t *********************************************************
218 This struct is used to allocate a safe stack area to be used during the
219 last phase of replacement. It also contains copies of all data needed
220 during this phase. (The data cannot be kept in normal variables, as
221 the C stack may be destroyed during replacement.)
223 CAUTION: Do not change the layout of this struct! The assembler code
224 depends on the order of fields. (`stack` must be first,
225 directly followed by `es`.)
227 *******************************************************************************/
229 struct replace_safestack_t {
230 u1 stack[REPLACE_SAFESTACK_SIZE];
233 u1 *mem; /* start of the allocated memory chunk */
238 /*** macros for the codegens *******************************************/
240 #define REPLACEMENT_POINTS_INIT(cd, jd) \
241 if (!replace_create_replacement_points(jd)) \
243 (cd)->replacementpoint = (jd)->code->rplpoints;
245 #define REPLACEMENT_POINTS_RESET(cd, jd) \
246 (cd)->replacementpoint = (jd)->code->rplpoints;
248 #define REPLACEMENT_POINT_BLOCK_START(cd, bptr) \
249 if ((bptr)->bitflags & BBFLAG_REPLACEMENT) \
250 codegen_set_replacement_point((cd) RPLPOINT_CHECK_BB(bptr));
252 #define REPLACEMENT_POINT_INLINE_START(cd, iptr) \
253 codegen_set_replacement_point(cd RPLPOINT_CHECK(INLINE));
255 #define REPLACEMENT_POINT_INLINE_BODY(cd, iptr) \
256 codegen_set_replacement_point_notrap(cd RPLPOINT_CHECK(BODY));
258 #define REPLACEMENT_POINT_RETURN(cd, iptr) \
259 codegen_set_replacement_point(cd RPLPOINT_CHECK(RETURN));
261 #define REPLACEMENT_POINT_INVOKE(cd, iptr) \
262 codegen_set_replacement_point(cd RPLPOINT_CHECK(CALL));
264 #define REPLACEMENT_POINT_INVOKE_RETURN(cd, iptr) \
265 if (iptr->opc != ICMD_BUILTIN) \
266 cd->replacementpoint[-1].callsize = (cd->mcodeptr - cd->mcodebase)\
267 - (ptrint) cd->replacementpoint[-1].pc;
269 #define REPLACEMENT_EMIT_STUBS(jd) \
270 emit_replacement_stubs(jd);
272 /*** prototypes ********************************************************/
274 bool replace_create_replacement_points(jitdata *jd);
275 void replace_free_replacement_points(codeinfo *code);
277 void replace_activate_replacement_points(codeinfo *code, bool mappable);
278 void replace_deactivate_replacement_points(codeinfo *code);
280 void replace_me(rplpoint *rp,executionstate_t *es);
283 void replace_show_replacement_points(codeinfo *code);
284 void replace_replacement_point_println(rplpoint *rp, int depth);
285 void replace_executionstate_println(executionstate_t *es);
286 void replace_sourcestate_println(sourcestate_t *ss);
287 void replace_sourcestate_println_short(sourcestate_t *ss);
288 void replace_source_frame_println(sourceframe_t *frame);
291 /* machine dependent functions (code in ARCH_DIR/md.c) */
293 #if defined(ENABLE_JIT)
294 void md_patch_replacement_point(codeinfo *code, s4 index, rplpoint *rp,
298 #endif /* defined(ENABLE_REPLACEMENT) */
300 #endif /* _REPLACE_H */
304 * These are local overrides for various environment variables in Emacs.
305 * Please do not remove this and leave it at the end of the file, where
306 * Emacs will automagically detect them.
307 * ---------------------------------------------------------------------
310 * indent-tabs-mode: t
314 * vim:noexpandtab:sw=4:ts=4: