src/vm/jit/stack.h

   1 /* vm/jit/stack.h - stack analysis header
   2
   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
   7
   8    This file is part of CACAO.
   9
  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.
  14
  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.
  19
  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
  23    02110-1301, USA.
  24
  25    Contact: cacao@cacaojvm.org
  26
  27    Authors: Christian Thalinger
  28
  29    Changes: Christian Ullrich
  30
  31    $Id: stack.h 5436 2006-09-08 19:48:27Z edwin $
  32
  33 */
  34
  35
  36 #ifndef _STACK_H
  37 #define _STACK_H
  38
  39 #include "config.h"
  40
  41 #include "vm/types.h"
  42
  43 #include "vm/exceptions.h"
  44 #include "vm/global.h"
  45 #include "vm/jit/jit.h"
  46 #include "vm/jit/reg.h"
  47
  48
  49 /* macros used internally by analyse_stack ************************************/
  50
  51 /* convenient abbreviations */
  52 #define CURKIND    curstack->varkind
  53 #define CURTYPE    curstack->type
  54
  55
  56 /*--------------------------------------------------*/
  57 /* STACK DEPTH CHECKING                             */
  58 /*--------------------------------------------------*/
  59
  60 #if defined(ENABLE_VERIFIER)
  61 #define CHECK_STACK_DEPTH(depthA,depthB)                             \
  62     do {                                                             \
  63         if ((depthA) != (depthB))                                    \
  64             goto throw_stack_depth_error;                            \
  65     } while (0)
  66 #else /* !ENABLE_VERIFIER */
  67 #define CHECK_STACK_DEPTH(depthA,depthB)
  68 #endif /* ENABLE_VERIFIER */
  69
  70
  71 /*--------------------------------------------------*/
  72 /* BASIC TYPE CHECKING                              */
  73 /*--------------------------------------------------*/
  74
  75 /* XXX would be nice if we did not have to pass the expected type */
  76
  77 #if defined(ENABLE_VERIFIER)
  78 #define CHECK_BASIC_TYPE(expected,actual)                            \
  79     do {                                                             \
  80         if ((actual) != (expected)) {                                \
  81             expectedtype = (expected);                               \
  82             goto throw_stack_type_error;                             \
  83         }                                                            \
  84     } while (0)
  85 #else /* !ENABLE_VERIFIER */
  86 #define CHECK_BASIC_TYPE(expected,actual)
  87 #endif /* ENABLE_VERIFIER */
  88
  89 /*--------------------------------------------------*/
  90 /* STACK UNDERFLOW/OVERFLOW CHECKS                  */
  91 /*--------------------------------------------------*/
  92
  93 /* underflow checks */
  94
  95 #if defined(ENABLE_VERIFIER)
  96 #define REQUIRE(num)                                                 \
  97     do {                                                             \
  98         if (stackdepth < (num))                                      \
  99             goto throw_stack_underflow;                              \
 100     } while (0)
 101 #else /* !ENABLE_VERIFIER */
 102 #define REQUIRE(num)
 103 #endif /* ENABLE_VERIFIER */
 104
 105 #define REQUIRE_1     REQUIRE(1)
 106 #define REQUIRE_2     REQUIRE(2)
 107 #define REQUIRE_3     REQUIRE(3)
 108 #define REQUIRE_4     REQUIRE(4)
 109
 110
 111 /* overflow check */
 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?
 115  */
 116
 117 /* XXX we should find a way to remove the opc/op1 check */
 118 #if defined(ENABLE_VERIFIER)
 119 #define CHECKOVERFLOW                                                \
 120     do {                                                             \
 121         if (stackdepth > m->maxstack)                                \
 122             if ((iptr->opc != ICMD_ACONST) || INSTRUCTION_MUST_CHECK(iptr))\
 123                 goto throw_stack_overflow;                           \
 124     } while(0)
 125 #else /* !ENABLE_VERIFIER */
 126 #define CHECKOVERFLOW
 127 #endif /* ENABLE_VERIFIER */
 128
 129 /*--------------------------------------------------*/
 130 /* ALLOCATING STACK SLOTS                           */
 131 /*--------------------------------------------------*/
 132
 133 #define NEWSTACK(s,v,n)                                              \
 134     do {                                                             \
 135         sd.new->prev = curstack;                                     \
 136         sd.new->type = (s);                                          \
 137         sd.new->flags = 0;                                           \
 138         sd.new->varkind = (v);                                       \
 139         sd.new->varnum = (n);                                        \
 140         curstack = sd.new;                                           \
 141         sd.var[(n)].type = (s);                                      \
 142         sd.var[(n)].flags = 0;                                       \
 143         sd.new++;                                                    \
 144     } while (0)
 145
 146 /* Initialize regoff, so -sia can show regnames even before reg.inc */
 147 /* regs[rd->intregargnum] has to be set for this                    */
 148 /* new->regoff = (IS_FLT_DBL_TYPE(s))?-1:rd->intreg_argnum; }       */
 149
 150 #define NEWSTACKn(s,n)  NEWSTACK(s,UNDEFVAR,n)
 151 #define NEWSTACK0(s)    NEWSTACK(s,UNDEFVAR,0)
 152
 153
 154 /*--------------------------------------------------*/
 155 /* MACROS FOR HANDLING BASIC BLOCKS                 */
 156 /*--------------------------------------------------*/
 157
 158 /* COPYCURSTACK makes a copy of the current operand stack (curstack)
 159  * and returns it in the variable copy.
 160  *
 161  * This macro is used to propagate the operand stack from one basic
 162  * block to another. The destination block receives the copy as its
 163  * input stack.
 164  */
 165 #define COPYCURSTACK(sd, copy) {                                     \
 166     stackptr s;                                                      \
 167     if (curstack) {                                                  \
 168         s = curstack;                                                \
 169         (sd).new += stackdepth;                                      \
 170         copy = (sd).new;                                             \
 171         while (s) {                                                  \
 172             copy--;                                                  \
 173             copy->prev = copy-1;                                     \
 174             copy->creator = NULL;                                    \
 175             copy->type = s->type;                                    \
 176             copy->flags = 0;                                         \
 177             copy->varkind = STACKVAR;                                \
 178             copy->varnum = s->varnum;                                \
 179             SET_OUTVAR((sd), s);                                     \
 180             s = s->prev;                                             \
 181         }                                                            \
 182         copy->prev = NULL;                                           \
 183         copy = (sd).new-1;                                           \
 184     }                                                                \
 185     else                                                             \
 186         copy = NULL;                                                 \
 187 }
 188
 189
 190 /* external macros ************************************************************/
 191
 192 #define BLOCK_OF(index)                                              \
 193     (jd->new_basicblocks + jd->new_basicblockindex[index])
 194
 195
 196 /* function prototypes ********************************************************/
 197
 198 bool stack_init(void);
 199
 200 bool new_stack_analyse(jitdata *jd);
 201
 202 #endif /* _STACK_H */
 203
 204
 205 /*
 206  * These are local overrides for various environment variables in Emacs.
 207  * Please do not remove this and leave it at the end of the file, where
 208  * Emacs will automagically detect them.
 209  * ---------------------------------------------------------------------
 210  * Local variables:
 211  * mode: c
 212  * indent-tabs-mode: t
 213  * c-basic-offset: 4
 214  * tab-width: 4
 215  * End:
 216  * vim:noexpandtab:sw=4:ts=4:
 217  */