1 /* vm/jit/stack.h - stack analysis header
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
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
25 Contact: cacao@cacaojvm.org
27 Authors: Christian Thalinger
29 Changes: Christian Ullrich
31 $Id: stack.h 5234 2006-08-14 17:50:12Z christian $
43 #include "vm/exceptions.h"
44 #include "vm/global.h"
45 #include "vm/jit/jit.h"
46 #include "vm/jit/reg.h"
49 /* macros used internally by analyse_stack ************************************/
51 /* convenient abbreviations */
52 #define CURKIND curstack->varkind
53 #define CURTYPE curstack->type
56 /*--------------------------------------------------*/
57 /* STACK DEPTH CHECKING */
58 /*--------------------------------------------------*/
60 #if defined(ENABLE_VERIFIER)
61 #define CHECK_STACK_DEPTH(depthA,depthB) \
63 if ((depthA) != (depthB)) \
64 goto throw_stack_depth_error; \
66 #else /* !ENABLE_VERIFIER */
67 #define CHECK_STACK_DEPTH(depthA,depthB)
68 #endif /* ENABLE_VERIFIER */
71 /*--------------------------------------------------*/
72 /* BASIC TYPE CHECKING */
73 /*--------------------------------------------------*/
75 /* XXX would be nice if we did not have to pass the expected type */
77 #if defined(ENABLE_VERIFIER)
78 #define CHECK_BASIC_TYPE(expected,actual) \
80 if ((actual) != (expected)) { \
81 expectedtype = (expected); \
82 goto throw_stack_type_error; \
85 #else /* !ENABLE_VERIFIER */
86 #define CHECK_BASIC_TYPE(expected,actual)
87 #endif /* ENABLE_VERIFIER */
89 /*--------------------------------------------------*/
90 /* STACK UNDERFLOW/OVERFLOW CHECKS */
91 /*--------------------------------------------------*/
93 /* underflow checks */
95 #if defined(ENABLE_VERIFIER)
96 #define REQUIRE(num) \
98 if (stackdepth < (num)) \
99 goto throw_stack_underflow; \
101 #else /* !ENABLE_VERIFIER */
103 #endif /* ENABLE_VERIFIER */
105 #define REQUIRE_1 REQUIRE(1)
106 #define REQUIRE_2 REQUIRE(2)
107 #define REQUIRE_3 REQUIRE(3)
108 #define REQUIRE_4 REQUIRE(4)
112 /* We allow ACONST instructions inserted as arguments to builtin
113 * functions to exceed the maximum stack depth. Maybe we should check
114 * against maximum stack depth only at block boundaries?
117 /* XXX we should find a way to remove the opc/op1 check */
118 #if defined(ENABLE_VERIFIER)
119 #define NEW_CHECKOVERFLOW \
121 if (stackdepth > m->maxstack) \
122 if ((iptr->opc != ICMD_ACONST) || !(iptr->flags.bits & INS_FLAG_NOCHECK)) \
123 goto throw_stack_overflow; \
125 #else /* !ENABLE_VERIFIER */
126 #define NEW_CHECKOVERFLOW
127 #endif /* ENABLE_VERIFIER */
129 /* XXX we should find a way to remove the opc/op1 check */
130 #if defined(ENABLE_VERIFIER)
131 #define CHECKOVERFLOW \
133 if (stackdepth > m->maxstack) \
134 if ((iptr[0].opc != ICMD_ACONST) || (iptr[0].op1 == 0)) \
135 goto throw_stack_overflow; \
137 #else /* !ENABLE_VERIFIER */
138 #define CHECKOVERFLOW
139 #endif /* ENABLE_VERIFIER */
141 /*--------------------------------------------------*/
142 /* ALLOCATING STACK SLOTS */
143 /*--------------------------------------------------*/
145 #define NEWSTACK(s,v,n) \
147 new->prev = curstack; \
150 new->varkind = (v); \
156 /* Initialize regoff, so -sia can show regnames even before reg.inc */
157 /* regs[rd->intregargnum] has to be set for this */
158 /* new->regoff = (IS_FLT_DBL_TYPE(s))?-1:rd->intreg_argnum; } */
160 #define NEWSTACKn(s,n) NEWSTACK(s,UNDEFVAR,n)
161 #define NEWSTACK0(s) NEWSTACK(s,UNDEFVAR,0)
163 /* allocate the input stack for an exception handler */
164 #define NEWXSTACK {NEWSTACK(TYPE_ADR,STACKVAR,0);curstack=0;}
167 /*--------------------------------------------------*/
168 /* STACK MANIPULATION */
169 /*--------------------------------------------------*/
171 /* resetting to an empty operand stack */
180 /* set the output stack of the current instruction */
182 #define SETDST iptr->dst = curstack;
185 /* The following macros do NOT check stackdepth, set stackdepth or iptr->dst */
189 CHECK_BASIC_TYPE((s),curstack->type); \
190 if (curstack->varkind == UNDEFVAR) \
191 curstack->varkind = TEMPVAR; \
192 curstack = curstack->prev; \
197 if (curstack->varkind == UNDEFVAR) \
198 curstack->varkind = TEMPVAR; \
199 curstack = curstack->prev; \
202 /* Do not copy Interface Stackslots over DUPx, Swaps! */
206 (d)->type = (s)->type; \
207 if ( (s)->varkind != STACKVAR) { \
208 (d)->varkind = (s)->varkind; \
209 (d)->varnum = (s)->varnum; \
211 (d)->varkind = TEMPVAR; \
217 /*--------------------------------------------------*/
218 /* STACK OPERATIONS MODELING */
219 /*--------------------------------------------------*/
221 /* The following macros are used to model the stack manipulations of
222 * different kinds of instructions.
224 * These macros check the input stackdepth and they set the output
225 * stackdepth and the output stack of the instruction (iptr->dst).
227 * These macros do *not* check for stack overflows!
230 #define PUSHCONST(s){NEWSTACKn(s,stackdepth);SETDST;stackdepth++;}
231 #define LOAD(s,v,n) {NEWSTACK(s,v,n);SETDST;stackdepth++;}
232 #define STORE(s) {REQUIRE_1;POP(s);SETDST;stackdepth--;}
252 NEWSTACKn(s, stackdepth); \
261 NEWSTACKn(d, stackdepth - 1);\
274 #define OPTT2_0(t,b) \
288 NEWSTACKn(s, stackdepth - 2); \
293 #define OP2IAT_1(s) \
298 NEWSTACKn(s, stackdepth - 2); \
308 NEWSTACKn(s, stackdepth - 2); \
313 #define OPTT2_1(s,d) \
318 NEWSTACKn(d, stackdepth - 2); \
328 NEWSTACKn(s, stackdepth - 2); \
329 NEWSTACKn(s, stackdepth - 1); \
333 #define OP3TIA_0(s) \
357 while(--(i) >= 0) { \
363 /* Do not copy Interface Stackslots over DUP! */
364 #define DUP {REQUIRE_1; \
365 if (CURKIND != STACKVAR) { \
366 NEWSTACK(CURTYPE,CURKIND,curstack->varnum); \
368 NEWSTACK(CURTYPE, TEMPVAR, stackdepth); \
370 SETDST; stackdepth++;}
371 #define SWAP {REQUIRE_2;COPY(curstack,new);POPANY;COPY(curstack,new+1);POPANY;\
372 new[0].prev=curstack;new[1].prev=new;\
373 curstack=new+1;new+=2;SETDST;}
374 #define DUP_X1 {REQUIRE_2;COPY(curstack,new);COPY(curstack,new+2);POPANY;\
375 COPY(curstack,new+1);POPANY;new[0].prev=curstack;\
376 new[1].prev=new;new[2].prev=new+1;\
377 curstack=new+2;new+=3;SETDST;stackdepth++;}
378 #define DUP2_X1 {REQUIRE_3;COPY(curstack,new+1);COPY(curstack,new+4);POPANY;\
379 COPY(curstack,new);COPY(curstack,new+3);POPANY;\
380 COPY(curstack,new+2);POPANY;new[0].prev=curstack;\
381 new[1].prev=new;new[2].prev=new+1;\
382 new[3].prev=new+2;new[4].prev=new+3;\
383 curstack=new+4;new+=5;SETDST;stackdepth+=2;}
384 #define DUP_X2 {REQUIRE_3;COPY(curstack,new);COPY(curstack,new+3);POPANY;\
385 COPY(curstack,new+2);POPANY;COPY(curstack,new+1);POPANY;\
386 new[0].prev=curstack;new[1].prev=new;\
387 new[2].prev=new+1;new[3].prev=new+2;\
388 curstack=new+3;new+=4;SETDST;stackdepth++;}
389 #define DUP2_X2 {REQUIRE_4;COPY(curstack,new+1);COPY(curstack,new+5);POPANY;\
390 COPY(curstack,new);COPY(curstack,new+4);POPANY;\
391 COPY(curstack,new+3);POPANY;COPY(curstack,new+2);POPANY;\
392 new[0].prev=curstack;new[1].prev=new;\
393 new[2].prev=new+1;new[3].prev=new+2;\
394 new[4].prev=new+3;new[5].prev=new+4;\
395 curstack=new+5;new+=6;SETDST;stackdepth+=2;}
398 /*--------------------------------------------------*/
399 /* MACROS FOR HANDLING BASIC BLOCKS */
400 /*--------------------------------------------------*/
402 /* COPYCURSTACK makes a copy of the current operand stack (curstack)
403 * and returns it in the variable copy.
405 * This macro is used to propagate the operand stack from one basic
406 * block to another. The destination block receives the copy as its
409 #define COPYCURSTACK(copy) {\
422 copy->varkind=STACKVAR;\
433 /* MARKREACHED marks the destination block <b> as reached. If this
434 * block has been reached before we check if stack depth and types
435 * match. Otherwise the destination block receives a copy of the
436 * current stack as its input stack.
438 * b...destination block
442 #define MARKREACHED(b,c) \
445 (b)->bitflags |= BBFLAG_REPLACEMENT; \
446 if ((b)->flags < BBREACHED) { \
448 (b)->flags = BBREACHED; \
449 (b)->instack = (c); \
450 (b)->indepth = stackdepth; \
452 stackptr s = curstack; \
453 stackptr t = (b)->instack; \
454 CHECK_STACK_DEPTH((b)->indepth, stackdepth); \
456 CHECK_BASIC_TYPE(s->type,t->type); \
464 /* function prototypes ********************************************************/
466 bool stack_init(void);
468 bool stack_analyse(jitdata *jd);
470 #endif /* _STACK_H */
474 * These are local overrides for various environment variables in Emacs.
475 * Please do not remove this and leave it at the end of the file, where
476 * Emacs will automagically detect them.
477 * ---------------------------------------------------------------------
480 * indent-tabs-mode: t
484 * vim:noexpandtab:sw=4:ts=4: