-/* vm/jit/stack.h - stack analysis header
+/* src/vm/jit/stack.h - stack analysis header
- Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
- C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
- E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
- J. Wenninger, Institut f. Computersprachen - TU Wien
+ Copyright (C) 1996-2005, 2006, 2008
+ CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
This file is part of CACAO.
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
- Contact: cacao@cacaojvm.org
-
- Authors: Christian Thalinger
-
- Changes: Christian Ullrich
-
- $Id: stack.h 5365 2006-09-06 10:56:43Z edwin $
-
*/
#ifndef _STACK_H
#define _STACK_H
+/* forward typedefs ***********************************************************/
+
+typedef struct stackelement_t stackelement_t;
+
+
#include "config.h"
+#include <stdint.h>
+
#include "vm/types.h"
-#include "vm/exceptions.h"
#include "vm/global.h"
-#include "vm/jit/jit.h"
+
+#include "vm/jit/jit.hpp"
#include "vm/jit/reg.h"
-/* macros used internally by analyse_stack ************************************/
+/* stack element structure ****************************************************/
-/* convenient abbreviations */
-#define CURKIND curstack->varkind
-#define CURTYPE curstack->type
+/* flags */
+#define SAVEDVAR 1 /* variable has to survive method invocations */
+#define INMEMORY 2 /* variable stored in memory */
+#define SAVREG 4 /* allocated to a saved register */
+#define ARGREG 8 /* allocated to an arg register */
+#define PASSTHROUGH 32 /* stackslot was passed-through by an ICMD */
+#define PREALLOC 64 /* preallocated var like for ARGVARS. Used */
+ /* with the new var system */
+#define INOUT 128 /* variable is an invar or/and an outvar */
-/*--------------------------------------------------*/
-/* STACK DEPTH CHECKING */
-/*--------------------------------------------------*/
+#define IS_SAVEDVAR(x) ((x) & SAVEDVAR)
+#define IS_INMEMORY(x) ((x) & INMEMORY)
+
+
+/* variable kinds */
+
+#define UNDEFVAR 0 /* stack slot will become temp during regalloc*/
+#define TEMPVAR 1 /* stack slot is temp register */
+#define STACKVAR 2 /* stack slot is numbered stack slot */
+#define LOCALVAR 3 /* stack slot is local variable */
+#define ARGVAR 4 /* stack slot is argument variable */
-#if defined(ENABLE_VERIFIER)
-#define CHECK_STACK_DEPTH(depthA,depthB) \
- do { \
- if ((depthA) != (depthB)) \
- goto throw_stack_depth_error; \
- } while (0)
-#else /* !ENABLE_VERIFIER */
-#define CHECK_STACK_DEPTH(depthA,depthB)
-#endif /* ENABLE_VERIFIER */
+struct stackelement_t {
+ stackelement_t *prev; /* pointer to next element towards bottom */
+ instruction *creator; /* instruction that created this element */
+ s4 type; /* slot type of stack element */
+ s4 flags; /* flags (SAVED, INMEMORY) */
+ s4 varkind; /* kind of variable or register */
+ s4 varnum; /* number of variable */
+};
+
+
+/* macros used internally by analyse_stack ************************************/
/*--------------------------------------------------*/
/* BASIC TYPE CHECKING */
/* XXX would be nice if we did not have to pass the expected type */
#if defined(ENABLE_VERIFIER)
-#define CHECK_BASIC_TYPE(expected,actual) \
- do { \
- if ((actual) != (expected)) { \
- expectedtype = (expected); \
- goto throw_stack_type_error; \
- } \
- } while (0)
+#define CHECK_BASIC_TYPE(expected,actual) \
+ do { \
+ if ((actual) != (expected)) { \
+ expectedtype = (expected); \
+ goto throw_stack_type_error; \
+ } \
+ } while (0)
#else /* !ENABLE_VERIFIER */
#define CHECK_BASIC_TYPE(expected,actual)
#endif /* ENABLE_VERIFIER */
/* underflow checks */
#if defined(ENABLE_VERIFIER)
-#define REQUIRE(num) \
- do { \
- if (stackdepth < (num)) \
- goto throw_stack_underflow; \
- } while (0)
+#define REQUIRE(num) \
+ do { \
+ if (stackdepth < (num)) \
+ goto throw_stack_underflow; \
+ } while (0)
#else /* !ENABLE_VERIFIER */
#define REQUIRE(num)
#endif /* ENABLE_VERIFIER */
-#define REQUIRE_1 REQUIRE(1)
-#define REQUIRE_2 REQUIRE(2)
-#define REQUIRE_3 REQUIRE(3)
-#define REQUIRE_4 REQUIRE(4)
-
/* overflow check */
/* We allow ACONST instructions inserted as arguments to builtin
/* XXX we should find a way to remove the opc/op1 check */
#if defined(ENABLE_VERIFIER)
-#define CHECKOVERFLOW \
- do { \
- if (stackdepth > m->maxstack) \
- if ((iptr->opc != ICMD_ACONST) || !(iptr->flags.bits & INS_FLAG_NOCHECK)) \
- goto throw_stack_overflow; \
- } while(0)
+#define CHECKOVERFLOW \
+ do { \
+ if (stackdepth > m->maxstack) \
+ if ((iptr->opc != ICMD_ACONST) || INSTRUCTION_MUST_CHECK(iptr))\
+ goto throw_stack_overflow; \
+ } while(0)
#else /* !ENABLE_VERIFIER */
#define CHECKOVERFLOW
#endif /* ENABLE_VERIFIER */
/* ALLOCATING STACK SLOTS */
/*--------------------------------------------------*/
-#define NEWSTACK(s,v,n) \
- do { \
- new->prev = curstack; \
- new->type = (s); \
- new->flags = 0; \
- new->varkind = (v); \
- new->varnum = (n); \
- curstack = new; \
- new++; \
+#define NEWSTACK(s,v,n) \
+ do { \
+ sd.new->prev = curstack; \
+ sd.new->type = (s); \
+ sd.new->flags = 0; \
+ sd.new->varkind = (v); \
+ sd.new->varnum = (n); \
+ curstack = sd.new; \
+ sd.var[(n)].type = (s); \
+ sd.var[(n)].flags = 0; \
+ sd.new++; \
} while (0)
/* Initialize regoff, so -sia can show regnames even before reg.inc */
#define NEWSTACKn(s,n) NEWSTACK(s,UNDEFVAR,n)
#define NEWSTACK0(s) NEWSTACK(s,UNDEFVAR,0)
-/* allocate the input stack for an exception handler */
-#define NEWXSTACK {NEWSTACK(TYPE_ADR,STACKVAR,0);curstack=0;}
+/* function prototypes ********************************************************/
-/*--------------------------------------------------*/
-/* STACK MANIPULATION */
-/*--------------------------------------------------*/
-
-/* resetting to an empty operand stack */
-
-#define STACKRESET \
- do { \
- curstack = 0; \
- stackdepth = 0; \
- } while (0)
-
-
-/* set the output stack of the current instruction */
-
-#define SETDST iptr->dst = curstack;
-
-
-/* The following macros do NOT check stackdepth, set stackdepth or iptr->dst */
-
-#define POP(s) \
- do { \
- CHECK_BASIC_TYPE((s),curstack->type); \
- if (curstack->varkind == UNDEFVAR) \
- curstack->varkind = TEMPVAR; \
- curstack = curstack->prev; \
- } while (0)
-
-#define POPANY \
- do { \
- if (curstack->varkind == UNDEFVAR) \
- curstack->varkind = TEMPVAR; \
- curstack = curstack->prev; \
- } while (0)
-
-/* Do not copy Interface Stackslots over DUPx, Swaps! */
-#define COPY(s,d) \
- do { \
- (d)->flags = 0; \
- (d)->type = (s)->type; \
- if ( (s)->varkind != STACKVAR) { \
- (d)->varkind = (s)->varkind; \
- (d)->varnum = (s)->varnum; \
- } else { \
- (d)->varkind = TEMPVAR; \
- (d)->varnum = 0; \
- } \
- } while (0)
-
-
-/*--------------------------------------------------*/
-/* STACK OPERATIONS MODELING */
-/*--------------------------------------------------*/
-
-/* The following macros are used to model the stack manipulations of
- * different kinds of instructions.
- *
- * These macros check the input stackdepth and they set the output
- * stackdepth and the output stack of the instruction (iptr->dst).
- *
- * These macros do *not* check for stack overflows!
- */
-
-#define PUSHCONST(s){NEWSTACKn(s,stackdepth);SETDST;stackdepth++;}
-#define LOAD(s,v,n) {NEWSTACK(s,v,n);SETDST;stackdepth++;}
-#define STORE(s) {REQUIRE_1;POP(s);SETDST;stackdepth--;}
-
-#define OP1_0(s) \
- do { \
- REQUIRE_1; \
- POP(s); \
- SETDST; \
- stackdepth--; \
- } while (0)
-
-#define OP1_0ANY \
- do { \
- REQUIRE_1; \
- POPANY; \
- SETDST; \
- stackdepth--; \
- } while (0)
-
-#define OP0_1(s) \
- do { \
- NEWSTACKn(s, stackdepth); \
- SETDST; \
- stackdepth++; \
- } while (0)
-
-#define OP1_1(s,d) \
- do { \
- REQUIRE_1; \
- POP(s); \
- NEWSTACKn(d, stackdepth - 1);\
- SETDST; \
- } while (0)
-
-#define OP2_0(s) \
- do { \
- REQUIRE_2; \
- POP(s); \
- POP(s); \
- SETDST; \
- stackdepth -= 2; \
- } while (0)
-
-#define OPTT2_0(t,b) \
- do { \
- REQUIRE_2; \
- POP(t); \
- POP(b); \
- SETDST; \
- stackdepth -= 2; \
- } while (0)
-
-#define OP2_1(s) \
- do { \
- REQUIRE_2; \
- POP(s); \
- POP(s); \
- NEWSTACKn(s, stackdepth - 2); \
- SETDST; \
- stackdepth--; \
- } while (0)
-
-#define OP2IAT_1(s) \
- do { \
- REQUIRE_2; \
- POP(TYPE_INT); \
- POP(TYPE_ADR); \
- NEWSTACKn(s, stackdepth - 2); \
- SETDST; \
- stackdepth--; \
- } while (0)
-
-#define OP2IT_1(s) \
- do { \
- REQUIRE_2; \
- POP(TYPE_INT); \
- POP(s); \
- NEWSTACKn(s, stackdepth - 2); \
- SETDST; \
- stackdepth--; \
- } while (0)
-
-#define OPTT2_1(s,d) \
- do { \
- REQUIRE_2; \
- POP(s); \
- POP(s); \
- NEWSTACKn(d, stackdepth - 2); \
- SETDST; \
- stackdepth--; \
- } while (0)
-
-#define OP2_2(s) \
- do { \
- REQUIRE_2; \
- POP(s); \
- POP(s); \
- NEWSTACKn(s, stackdepth - 2); \
- NEWSTACKn(s, stackdepth - 1); \
- SETDST; \
- } while (0)
-
-#define OP3TIA_0(s) \
- do { \
- REQUIRE_3; \
- POP(s); \
- POP(TYPE_INT); \
- POP(TYPE_ADR); \
- SETDST; \
- stackdepth -= 3; \
- } while (0)
-
-#define OP3_0(s) \
- do { \
- REQUIRE_3; \
- POP(s); \
- POP(s); \
- POP(s); \
- SETDST; \
- stackdepth -= 3; \
- } while (0)
-
-#define POPMANY(i) \
- do { \
- REQUIRE((i)); \
- stackdepth -= (i); \
- while(--(i) >= 0) { \
- POPANY; \
- } \
- SETDST; \
- } while (0)
+#ifdef __cplusplus
+extern "C" {
+#endif
-/* Do not copy Interface Stackslots over DUP! */
-#define DUP {REQUIRE_1; \
- if (CURKIND != STACKVAR) { \
- NEWSTACK(CURTYPE,CURKIND,curstack->varnum); \
- } else { \
- NEWSTACK(CURTYPE, TEMPVAR, stackdepth); \
- } \
- SETDST; stackdepth++;}
-#define SWAP {REQUIRE_2;COPY(curstack,new);POPANY;COPY(curstack,new+1);POPANY;\
- new[0].prev=curstack;new[1].prev=new;\
- curstack=new+1;new+=2;SETDST;}
-#define DUP_X1 {REQUIRE_2;COPY(curstack,new);COPY(curstack,new+2);POPANY;\
- COPY(curstack,new+1);POPANY;new[0].prev=curstack;\
- new[1].prev=new;new[2].prev=new+1;\
- curstack=new+2;new+=3;SETDST;stackdepth++;}
-#define DUP2_X1 {REQUIRE_3;COPY(curstack,new+1);COPY(curstack,new+4);POPANY;\
- COPY(curstack,new);COPY(curstack,new+3);POPANY;\
- COPY(curstack,new+2);POPANY;new[0].prev=curstack;\
- new[1].prev=new;new[2].prev=new+1;\
- new[3].prev=new+2;new[4].prev=new+3;\
- curstack=new+4;new+=5;SETDST;stackdepth+=2;}
-#define DUP_X2 {REQUIRE_3;COPY(curstack,new);COPY(curstack,new+3);POPANY;\
- COPY(curstack,new+2);POPANY;COPY(curstack,new+1);POPANY;\
- new[0].prev=curstack;new[1].prev=new;\
- new[2].prev=new+1;new[3].prev=new+2;\
- curstack=new+3;new+=4;SETDST;stackdepth++;}
-#define DUP2_X2 {REQUIRE_4;COPY(curstack,new+1);COPY(curstack,new+5);POPANY;\
- COPY(curstack,new);COPY(curstack,new+4);POPANY;\
- COPY(curstack,new+3);POPANY;COPY(curstack,new+2);POPANY;\
- new[0].prev=curstack;new[1].prev=new;\
- new[2].prev=new+1;new[3].prev=new+2;\
- new[4].prev=new+3;new[5].prev=new+4;\
- curstack=new+5;new+=6;SETDST;stackdepth+=2;}
+bool stack_init(void);
+bool stack_analyse(jitdata *jd);
-/*--------------------------------------------------*/
-/* MACROS FOR HANDLING BASIC BLOCKS */
-/*--------------------------------------------------*/
+void stack_javalocals_store(instruction *iptr, s4 *javalocals);
-/* COPYCURSTACK makes a copy of the current operand stack (curstack)
- * and returns it in the variable copy.
- *
- * This macro is used to propagate the operand stack from one basic
- * block to another. The destination block receives the copy as its
- * input stack.
- */
-#define COPYCURSTACK(copy) {\
- int d;\
- stackptr s;\
- if(curstack){\
- s=curstack;\
- new+=stackdepth;\
- d=stackdepth;\
- copy=new;\
- while(s){\
- copy--;d--;\
- copy->prev=copy-1;\
- copy->type=s->type;\
- copy->flags=0;\
- copy->varkind=STACKVAR;\
- copy->varnum=d;\
- s=s->prev;\
- }\
- copy->prev=NULL;\
- copy=new-1;\
- }\
- else\
- copy=NULL;\
+#ifdef __cplusplus
}
-
-/* MARKREACHED marks the destination block <b> as reached. If this
- * block has been reached before we check if stack depth and types
- * match. Otherwise the destination block receives a copy of the
- * current stack as its input stack.
- *
- * b...destination block
- * c...current stack
- */
-
-/* XXX this macro is much too big! */
-
-#define MARKREACHED(b,c) \
- do { \
- if ((b) <= (bptr)) \
- (b)->bitflags |= BBFLAG_REPLACEMENT; \
- if ((b)->flags < BBREACHED) { \
- int locali; \
- COPYCURSTACK((c)); \
- (b)->flags = BBREACHED; \
- (b)->instack = (c); \
- (b)->indepth = stackdepth; \
- (b)->invars = DMNEW(stackptr, stackdepth); \
- for (locali = stackdepth; locali--; (c) = (c)->prev) \
- (b)->invars[locali] = (c); \
- } else { \
- stackptr s = curstack; \
- stackptr t = (b)->instack; \
- CHECK_STACK_DEPTH((b)->indepth, stackdepth); \
- while (s) { \
- CHECK_BASIC_TYPE(s->type,t->type); \
- s = s->prev; \
- t = t->prev; \
- } \
- } \
- } while (0)
-
-
-/* external macros ************************************************************/
-
-#define BLOCK_OF(index) \
- (jd->new_basicblocks + jd->new_basicblockindex[index])
-
-
-/* function prototypes ********************************************************/
-
-bool stack_init(void);
-
-bool new_stack_analyse(jitdata *jd);
+#endif
#endif /* _STACK_H */