1 /* vm/jit/stack.h - stack analysis header
3 Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
4 R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
5 C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
6 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., 59 Temple Place - Suite 330, Boston, MA
25 Contact: cacao@complang.tuwien.ac.at
27 Authors: Christian Thalinger
29 $Id: stack.h 2870 2005-06-29 12:39:31Z christian $
37 #include "vm/global.h"
38 #include "vm/exceptions.h"
39 #include "vm/jit/reg.h"
42 /**********************************************************************/
43 /* Macros used internally by analyse_stack */
44 /**********************************************************************/
47 #define COUNT(cnt) cnt++
52 /* convenient abbreviations */
53 #define CURKIND curstack->varkind
54 #define CURTYPE curstack->type
56 /*--------------------------------------------------*/
57 /* SIGNALING ERRORS */
58 /*--------------------------------------------------*/
60 #define TYPE_VERIFYERROR(t) \
77 type = "object/array"; \
80 *exceptionptr = new_verifyerror(m, \
81 "Expecting to find %s on stack", \
87 /*--------------------------------------------------*/
88 /* STACK UNDERFLOW/OVERFLOW CHECKS */
89 /*--------------------------------------------------*/
91 /* underflow checks */
93 #define REQUIRE(num) \
95 if (stackdepth < (num)) { \
97 new_verifyerror(m, "Unable to pop operand off an empty stack"); \
102 #define REQUIRE_1 REQUIRE(1)
103 #define REQUIRE_2 REQUIRE(2)
104 #define REQUIRE_3 REQUIRE(3)
105 #define REQUIRE_4 REQUIRE(4)
109 /* We allow ACONST instructions inserted as arguments to builtin
110 * functions to exceed the maximum stack depth. Maybe we should check
111 * against maximum stack depth only at block boundaries?
114 #define CHECKOVERFLOW \
116 if (stackdepth > m->maxstack) { \
117 if (iptr[0].opc != ICMD_ACONST || iptr[0].op1 == 0) { \
118 *exceptionptr = new_verifyerror(m, "Stack size too large"); \
125 /*--------------------------------------------------*/
126 /* ALLOCATING STACK SLOTS */
127 /*--------------------------------------------------*/
129 #define NEWSTACK_(s,v,n) {new->prev=curstack;new->type=s;new->flags=0; \
130 new->varkind=v;new->varnum=n;curstack=new;new++;}
131 /* Initialize regoff, so -sia can show regnames even before reg.inc */
132 /* regs[rd->intregargnum has to be set for this */
133 /* new->regoff = (IS_FLT_DBL_TYPE(s))?-1:rd->intreg_argnum; }*/
135 #define NEWSTACK(s,v,n) {NEWSTACK_(s,v,n); m->maxlifetimes++;}
137 #define NEWSTACK(s,v,n) NEWSTACK_(s,v,n)
140 #define NEWSTACKn(s,n) NEWSTACK(s,UNDEFVAR,n)
141 #define NEWSTACK0(s) NEWSTACK(s,UNDEFVAR,0)
143 /* allocate the input stack for an exception handler */
144 #define NEWXSTACK {NEWSTACK(TYPE_ADR,STACKVAR,0);curstack=0;}
147 /*--------------------------------------------------*/
148 /* STACK MANIPULATION */
149 /*--------------------------------------------------*/
151 /* resetting to an empty operand stack */
160 /* set the output stack of the current instruction */
162 #define SETDST iptr->dst = curstack;
165 /* The following macros do NOT check stackdepth, set stackdepth or iptr->dst */
169 if ((s) != curstack->type) { \
170 TYPE_VERIFYERROR((s)); \
172 if (curstack->varkind == UNDEFVAR) \
173 curstack->varkind = TEMPVAR; \
174 curstack = curstack->prev; \
179 if (curstack->varkind == UNDEFVAR) \
180 curstack->varkind = TEMPVAR; \
181 curstack = curstack->prev; \
187 (d)->type = (s)->type; \
188 (d)->varkind = (s)->varkind; \
189 (d)->varnum = (s)->varnum; \
193 /*--------------------------------------------------*/
194 /* STACK OPERATIONS MODELING */
195 /*--------------------------------------------------*/
197 /* The following macros are used to model the stack manipulations of
198 * different kinds of instructions.
200 * These macros check the input stackdepth and they set the output
201 * stackdepth and the output stack of the instruction (iptr->dst).
203 * These macros do *not* check for stack overflows!
206 #define PUSHCONST(s){NEWSTACKn(s,stackdepth);SETDST;stackdepth++;}
207 #define LOAD(s,v,n) {NEWSTACK(s,v,n);SETDST;stackdepth++;}
208 #define STORE(s) {REQUIRE_1;POP(s);SETDST;stackdepth--;}
209 #define OP1_0(s) {REQUIRE_1;POP(s);SETDST;stackdepth--;}
210 #define OP1_0ANY {REQUIRE_1;POPANY;SETDST;stackdepth--;}
214 NEWSTACKn((s),stackdepth); \
223 NEWSTACKn((d),stackdepth - 1);\
227 #define OP2_0(s) {REQUIRE_2;POP(s);POP(s);SETDST;stackdepth-=2;}
228 #define OPTT2_0(t,b){REQUIRE_2;POP(t);POP(b);SETDST;stackdepth-=2;}
229 #define OP2_1(s) {REQUIRE_2;POP(s);POP(s);NEWSTACKn(s,stackdepth-2);SETDST;stackdepth--;}
230 #define OP2IAT_1(s) {REQUIRE_2;POP(TYPE_INT);POP(TYPE_ADR);NEWSTACKn(s,stackdepth-2);\
231 SETDST;stackdepth--;}
232 #define OP2IT_1(s) {REQUIRE_2;POP(TYPE_INT);POP(s);NEWSTACKn(s,stackdepth-2);\
233 SETDST;stackdepth--;}
234 #define OPTT2_1(s,d){REQUIRE_2;POP(s);POP(s);NEWSTACKn(d,stackdepth-2);SETDST;stackdepth--;}
235 #define OP2_2(s) {REQUIRE_2;POP(s);POP(s);NEWSTACKn(s,stackdepth-2);\
236 NEWSTACKn(s,stackdepth-1);SETDST;}
237 #define OP3TIA_0(s) {REQUIRE_3;POP(s);POP(TYPE_INT);POP(TYPE_ADR);SETDST;stackdepth-=3;}
238 #define OP3_0(s) {REQUIRE_3;POP(s);POP(s);POP(s);SETDST;stackdepth-=3;}
244 while(--(i) >= 0) { \
250 #define DUP {REQUIRE_1;NEWSTACK(CURTYPE,CURKIND,curstack->varnum);SETDST; \
252 #define SWAP {REQUIRE_2;COPY(curstack,new);POPANY;COPY(curstack,new+1);POPANY;\
253 new[0].prev=curstack;new[1].prev=new;\
254 curstack=new+1;new+=2;SETDST;}
255 #define DUP_X1 {REQUIRE_2;COPY(curstack,new);COPY(curstack,new+2);POPANY;\
256 COPY(curstack,new+1);POPANY;new[0].prev=curstack;\
257 new[1].prev=new;new[2].prev=new+1;\
258 curstack=new+2;new+=3;SETDST;stackdepth++;}
259 #define DUP2_X1 {REQUIRE_3;COPY(curstack,new+1);COPY(curstack,new+4);POPANY;\
260 COPY(curstack,new);COPY(curstack,new+3);POPANY;\
261 COPY(curstack,new+2);POPANY;new[0].prev=curstack;\
262 new[1].prev=new;new[2].prev=new+1;\
263 new[3].prev=new+2;new[4].prev=new+3;\
264 curstack=new+4;new+=5;SETDST;stackdepth+=2;}
265 #define DUP_X2 {REQUIRE_3;COPY(curstack,new);COPY(curstack,new+3);POPANY;\
266 COPY(curstack,new+2);POPANY;COPY(curstack,new+1);POPANY;\
267 new[0].prev=curstack;new[1].prev=new;\
268 new[2].prev=new+1;new[3].prev=new+2;\
269 curstack=new+3;new+=4;SETDST;stackdepth++;}
270 #define DUP2_X2 {REQUIRE_4;COPY(curstack,new+1);COPY(curstack,new+5);POPANY;\
271 COPY(curstack,new);COPY(curstack,new+4);POPANY;\
272 COPY(curstack,new+3);POPANY;COPY(curstack,new+2);POPANY;\
273 new[0].prev=curstack;new[1].prev=new;\
274 new[2].prev=new+1;new[3].prev=new+2;\
275 new[4].prev=new+3;new[5].prev=new+4;\
276 curstack=new+5;new+=6;SETDST;stackdepth+=2;}
279 /*--------------------------------------------------*/
280 /* MACROS FOR HANDLING BASIC BLOCKS */
281 /*--------------------------------------------------*/
283 /* COPYCURSTACK makes a copy of the current operand stack (curstack)
284 * and returns it in the variable copy.
286 * This macro is used to propagate the operand stack from one basic
287 * block to another. The destination block receives the copy as its
290 #define COPYCURSTACK(copy) {\
303 copy->varkind=STACKVAR;\
314 /* BBEND is called at the end of each basic block (after the last
315 * instruction of the block has been processed).
318 #define BBEND(s,i) { \
319 (i) = stackdepth - 1; \
322 if ((copy->varkind == STACKVAR) && (copy->varnum > (i))) \
323 copy->varkind = TEMPVAR; \
325 copy->varkind = STACKVAR; \
328 rd->interfaces[(i)][copy->type].type = copy->type; \
329 rd->interfaces[(i)][copy->type].flags |= copy->flags; \
330 (i)--; copy = copy->prev; \
332 (i) = bptr->indepth - 1; \
333 copy = bptr->instack; \
335 rd->interfaces[(i)][copy->type].type = copy->type; \
336 if (copy->varkind == STACKVAR) { \
337 if (copy->flags & SAVEDVAR) \
338 rd->interfaces[(i)][copy->type].flags |= SAVEDVAR; \
340 (i)--; copy = copy->prev; \
345 /* MARKREACHED marks the destination block <b> as reached. If this
346 * block has been reached before we check if stack depth and types
347 * match. Otherwise the destination block receives a copy of the
348 * current stack as its input stack.
350 * b...destination block
354 #define MARKREACHED(b,c) \
356 if ((b)->flags < 0) { \
359 (b)->instack = (c); \
360 (b)->indepth = stackdepth; \
362 stackptr s = curstack; \
363 stackptr t = (b)->instack; \
364 if ((b)->indepth != stackdepth) { \
365 show_icmd_method(m, cd, rd); \
366 log_text("Stack depth mismatch"); \
370 if (s->type != t->type) \
371 TYPE_VERIFYERROR(t->type); \
379 /* function prototypes ********************************************************/
381 methodinfo *analyse_stack(methodinfo *m, codegendata *cd, registerdata *rd);
383 void icmd_print_stack(codegendata *cd, stackptr s);
384 void show_icmd_method(methodinfo *m, codegendata *cd, registerdata *rd);
385 void show_icmd_block(methodinfo *m, codegendata *cd, basicblock *bptr);
386 void show_icmd(instruction *iptr, bool deadcode);
388 /* machine dependent return value handling function */
389 void md_return_alloc(methodinfo *m, registerdata *rd, s4 return_type,
392 #endif /* _STACK_H */
396 * These are local overrides for various environment variables in Emacs.
397 * Please do not remove this and leave it at the end of the file, where
398 * Emacs will automagically detect them.
399 * ---------------------------------------------------------------------
402 * indent-tabs-mode: t