src/vm/jit/replace.h

   1 /* vm/jit/replace.h - on-stack replacement of methods
   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: Edwin Steiner
  28
  29    Changes:
  30
  31    $Id$
  32
  33 */
  34
  35
  36 #ifndef _REPLACE_H
  37 #define _REPLACE_H
  38
  39 /* forward typedefs ***********************************************************/
  40
  41 typedef struct rplpoint rplpoint;
  42 typedef struct executionstate_t executionstate_t;
  43 typedef struct sourcestate_t sourcestate_t;
  44 typedef struct sourceframe_t sourceframe_t;
  45
  46 #include "config.h"
  47 #include "vm/types.h"
  48
  49 #include "arch.h"
  50 #include "md-abi.h"
  51
  52 #include "vm/method.h"
  53 #include "vm/jit/reg.h"
  54
  55
  56 /*** structs *********************************************************/
  57
  58 typedef struct rplalloc rplalloc;
  59
  60 #define RPLALLOC_STACK  -1
  61 #define RPLALLOC_PARAM  -2
  62 #define RPLALLOC_SYNC   -3
  63
  64 /* `rplalloc` is a compact struct for register allocation info        */
  65
  66 /* XXX optimize this for space efficiency */
  67 struct rplalloc {
  68         s4           index;     /* local index, -1 for stack slot         */
  69         s4           regoff;    /* register index / stack slot offset     */
  70         unsigned int flags:4;   /* OR of (INMEMORY,...)                   */
  71         unsigned int type:4;    /* TYPE_... constant                      */
  72 };
  73
  74 #if INMEMORY > 0x08
  75 #error value of INMEMORY is too big to fit in rplalloc.flags
  76 #endif
  77
  78
  79 /* XXX what to do about overlapping rplpoints? */
  80 /* CAUTION: Do not change the numerical values. These are used as     */
  81 /*          indices into replace_normalize_type_map.                  */
  82 #define RPLPOINT_TYPE_STD     BBTYPE_STD
  83 #define RPLPOINT_TYPE_EXH     BBTYPE_EXH
  84 #define RPLPOINT_TYPE_SBR     BBTYPE_SBR
  85 #define RPLPOINT_TYPE_CALL    3
  86 #define RPLPOINT_TYPE_INLINE  4
  87 #define RPLPOINT_TYPE_RETURN  5
  88 #define RPLPOINT_TYPE_BODY    6
  89
  90 #define RPLPOINT_FLAG_NOTRAP  0x01  /* rplpoint cannot be trapped */
  91
  92
  93 #if !defined(NDEBUG)
  94 #define RPLPOINT_CHECK(type)     , RPLPOINT_TYPE_##type
  95 #define RPLPOINT_CHECK_BB(bptr)  , (bptr)->type
  96 #else
  97 #define RPLPOINT_CHECK(type)
  98 #define RPLPOINT_CHECK_BB(bptr)
  99 #endif
 100
 101
 102 /* An `rplpoint` represents a replacement point in a compiled method  */
 103
 104 struct rplpoint {
 105         u1          *pc;           /* machine code PC of this point       */
 106         u1          *outcode;      /* pointer to replacement-out code     */ /* XXX only for trappable rps */
 107         methodinfo  *method;       /* source method this point is in      */
 108         rplpoint    *target;       /* target of the replacement           */ /* XXX remove? */
 109         codeinfo    *code;         /* codeinfo this point belongs to      */ /* XXX unify with parent */
 110         rplpoint    *parent;       /* rplpoint of the inlined body        */ /* XXX unify with code */
 111         rplalloc    *regalloc;     /* pointer to register index table     */
 112         u8           mcode;        /* saved maching code for patching     */ /* XXX only for trappable rps */
 113         s4           id;           /* id of the rplpoint within method    */
 114         s4           callsize;     /* size of call code in bytes          */
 115         unsigned int regalloccount:24; /* number of local allocations     */
 116         unsigned int type:4;           /* RPLPOINT_TYPE_... constant      */
 117         unsigned int flags:8;          /* OR of RPLPOINT_... constants    */
 118 };
 119
 120
 121 /* An `executionsstate` represents the state of a thread as it reached */
 122 /* an replacement point or is about to enter one.                      */
 123
 124 struct executionstate_t {
 125         u1           *pc;                               /* program counter */
 126         u1           *sp;                   /* stack pointer within method */
 127         u1           *pv;                   /* procedure value. NULL means */
 128                                             /* search the AVL tree         */
 129
 130         u8            intregs[INT_REG_CNT];             /* register values */
 131         u8            fltregs[FLT_REG_CNT];             /* register values */
 132
 133         codeinfo     *code;            /* codeinfo corresponding to the pv */
 134 };
 135
 136
 137 struct sourceframe_t {
 138         sourceframe_t *down;           /* source frame down the call chain */
 139
 140         methodinfo    *method;                  /* method this frame is in */
 141         s4             id;
 142         s4             type;
 143
 144         u8             instance;
 145
 146         u8            *javastack;                  /* values of stack vars */
 147         u1            *javastacktype;              /*  types of stack vars */
 148         s4             javastackdepth;             /* number of stack vars */
 149
 150         u8            *javalocals;                 /* values of javalocals */
 151         u1            *javalocaltype;              /*  types of javalocals */
 152         s4             javalocalcount;             /* number of javalocals */
 153
 154         u8            *syncslots;
 155         s4             syncslotcount; /* XXX do we need more than one? */
 156
 157         rplpoint      *readrp;         /* rplpoint used to read this frame */
 158 };
 159
 160
 161 struct sourcestate_t {
 162         sourceframe_t *frames;    /* list of source frames, from bottom up */
 163 };
 164
 165
 166 /*** prototypes ********************************************************/
 167
 168 bool replace_create_replacement_points(jitdata *jd);
 169 void replace_free_replacement_points(codeinfo *code);
 170
 171 void replace_activate_replacement_point(rplpoint *rp,rplpoint *target);
 172 void replace_deactivate_replacement_point(rplpoint *rp);
 173 void replace_activate(codeinfo *code,codeinfo *target);
 174
 175 void replace_me(rplpoint *rp,executionstate_t *es);
 176
 177 #if !defined(NDEBUG)
 178 void replace_show_replacement_points(codeinfo *code);
 179 void replace_replacement_point_println(rplpoint *rp, int depth);
 180 void replace_executionstate_println(executionstate_t *es);
 181 void replace_sourcestate_println(sourcestate_t *ss);
 182 void replace_source_frame_println(sourceframe_t *frame);
 183 #endif
 184
 185 /* machine dependent functions (code in ARCH_DIR/md.c) */
 186
 187 #if defined(ENABLE_JIT)
 188 void md_patch_replacement_point(codeinfo *code, s4 index, rplpoint *rp,
 189                                                                 u1 *savedmcode);
 190 #endif
 191
 192 #endif
 193
 194 /*
 195  * These are local overrides for various environment variables in Emacs.
 196  * Please do not remove this and leave it at the end of the file, where
 197  * Emacs will automagically detect them.
 198  * ---------------------------------------------------------------------
 199  * Local variables:
 200  * mode: c
 201  * indent-tabs-mode: t
 202  * c-basic-offset: 4
 203  * tab-width: 4
 204  * End:
 205  * vim:noexpandtab:sw=4:ts=4:
 206  */