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 #define RPLPOINT_TYPE_STD     BBTYPE_STD
  81 #define RPLPOINT_TYPE_EXH     BBTYPE_EXH
  82 #define RPLPOINT_TYPE_SBR     BBTYPE_SBR
  83 #define RPLPOINT_TYPE_CALL    3
  84 #define RPLPOINT_TYPE_INLINE  4
  85 #define RPLPOINT_TYPE_RETURN  5
  86
  87 #define RPLPOINT_FLAG_NOTRAP  0x01  /* rplpoint cannot be trapped */
  88
  89
  90 /* An `rplpoint` represents a replacement point in a compiled method  */
  91
  92 struct rplpoint {
  93         u1          *pc;           /* machine code PC of this point       */
  94         u1          *outcode;      /* pointer to replacement-out code     */ /* XXX only for trappable rps */
  95         methodinfo  *method;       /* source method this point is in      */
  96         rplpoint    *target;       /* target of the replacement           */ /* XXX remove? */
  97         codeinfo    *code;         /* codeinfo this point belongs to      */ /* XXX unify with parent */
  98         rplpoint    *parent;       /* rplpoint of the inlined body        */ /* XXX unify with code */
  99         rplalloc    *regalloc;     /* pointer to register index table     */
 100         u8           mcode;        /* saved maching code for patching     */ /* XXX only for trappable rps */
 101         s4           id;           /* id of the rplpoint within method    */
 102         s4           callsize;     /* size of call code in bytes          */
 103         unsigned int regalloccount:24; /* number of local allocations     */
 104         unsigned int type:4;           /* RPLPOINT_TYPE_... constant      */
 105         unsigned int flags:8;          /* OR of RPLPOINT_... constants    */
 106 };
 107
 108
 109 /* An `executionsstate` represents the state of a thread as it reached */
 110 /* an replacement point or is about to enter one.                      */
 111
 112 struct executionstate_t {
 113         u1           *pc;                               /* program counter */
 114         u1           *sp;                   /* stack pointer within method */
 115         u1           *pv;                   /* procedure value. NULL means */
 116                                             /* search the AVL tree         */
 117
 118         u8            intregs[INT_REG_CNT];             /* register values */
 119         u8            fltregs[FLT_REG_CNT];             /* register values */
 120
 121         codeinfo     *code;            /* codeinfo corresponding to the pv */
 122 };
 123
 124
 125 struct sourceframe_t {
 126         sourceframe_t *up;                  /* source frame above this one */
 127
 128         methodinfo    *method;                  /* method this frame is in */
 129         s4             id;
 130
 131         u8            *javastack;                  /* values of stack vars */
 132         u1            *javastacktype;              /*  types of stack vars */
 133         s4             javastackdepth;             /* number of stack vars */
 134
 135         u8            *javalocals;                 /* values of javalocals */
 136         u1            *javalocaltype;              /*  types of javalocals */
 137         s4             javalocalcount;             /* number of javalocals */
 138
 139         u8            *syncslots;
 140         s4             syncslotcount; /* XXX do we need more than one? */
 141
 142 #if !defined(NDEBUG)
 143         rplpoint      *debug_rp;
 144 #endif
 145 };
 146
 147
 148 struct sourcestate_t {
 149         sourceframe_t *frames;    /* list of source frames, from bottom up */
 150 };
 151
 152
 153 /*** prototypes ********************************************************/
 154
 155 bool replace_create_replacement_points(jitdata *jd);
 156 void replace_free_replacement_points(codeinfo *code);
 157
 158 void replace_activate_replacement_point(rplpoint *rp,rplpoint *target);
 159 void replace_deactivate_replacement_point(rplpoint *rp);
 160 void replace_activate(codeinfo *code,codeinfo *target);
 161
 162 void replace_me(rplpoint *rp,executionstate_t *es);
 163
 164 #if !defined(NDEBUG)
 165 void replace_show_replacement_points(codeinfo *code);
 166 void replace_replacement_point_println(rplpoint *rp, int depth);
 167 void replace_executionstate_println(executionstate_t *es);
 168 void replace_sourcestate_println(sourcestate_t *ss);
 169 void replace_source_frame_println(sourceframe_t *frame);
 170 #endif
 171
 172 /* machine dependent functions (code in ARCH_DIR/md.c) */
 173
 174 #if defined(ENABLE_JIT)
 175 void md_patch_replacement_point(rplpoint *rp);
 176 #endif
 177
 178 #endif
 179
 180 /*
 181  * These are local overrides for various environment variables in Emacs.
 182  * Please do not remove this and leave it at the end of the file, where
 183  * Emacs will automagically detect them.
 184  * ---------------------------------------------------------------------
 185  * Local variables:
 186  * mode: c
 187  * indent-tabs-mode: t
 188  * c-basic-offset: 4
 189  * tab-width: 4
 190  * End:
 191  * vim:noexpandtab:sw=4:ts=4:
 192  */