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 executionstate;
  43 typedef struct sourcestate sourcestate;
  44
  45 #include "config.h"
  46 #include "vm/types.h"
  47
  48 #include "arch.h"
  49 #include "md-abi.h"
  50
  51 #include "vm/method.h"
  52 #include "vm/jit/reg.h"
  53
  54
  55 /*** structs *********************************************************/
  56
  57 typedef struct rplalloc rplalloc;
  58
  59 /* `rplalloc` is a compact struct for register allocation info        */
  60
  61 struct rplalloc {
  62         unsigned int index:16;  /* register index / stack slot offset     */
  63         unsigned int flags:4;   /* OR of (INMEMORY,...)                   */
  64         int          type:4;    /* TYPE_... constant                      */
  65         unsigned int next:1;    /* if true, switch to next local          */
  66 };
  67
  68 #if INMEMORY > 0x08
  69 #error value of INMEMORY is too big to fit in rplalloc.flags
  70 #endif
  71
  72 /* An `rplpoint` represents a replacement point in a compiled method  */
  73
  74 struct rplpoint {
  75         u1          *pc;           /* machine code PC of this point       */
  76         u1          *outcode;      /* pointer to replacement-out code     */
  77         codeinfo    *code;         /* codeinfo this point belongs to      */
  78         rplpoint    *target;       /* target of the replacement           */
  79         u8           mcode;        /* saved maching code for patching     */
  80         rplalloc    *regalloc;     /* pointer to register index table     */
  81         unsigned int regalloccount:24; /* number of local allocations     */
  82         unsigned int type:4;           /* BBTYPE_... constant             */
  83         unsigned int flags:8;          /* OR of RPLPOINT_... constants    */
  84 };
  85
  86 /* An `executionsstate` represents the state of a thread as it reached */
  87 /* an replacement point or is about to enter one.                      */
  88
  89 struct executionstate {
  90         u1           *pc;                               /* program counter */
  91         u1           *sp;                   /* stack pointer within method */
  92         u1           *pv;                   /* procedure value. NULL means */
  93                                             /* search the AVL tree         */
  94
  95         u8            intregs[INT_REG_CNT];             /* register values */
  96         u8            fltregs[FLT_REG_CNT];             /* register values */
  97 };
  98
  99 /* `sourcestate` will probably only be used for debugging              */
 100
 101 struct sourcestate {
 102         u8           *javastack;
 103         s4            javastackdepth;
 104
 105         u8           *javalocals;      /* indexed by (i*5 + type) */
 106         s4            javalocalcount;
 107
 108         u8            savedintregs[INT_SAV_CNT + 1]; /* XXX */
 109         u8            savedfltregs[FLT_SAV_CNT + 1]; /* XXX */
 110
 111         u8           *syncslots;
 112         s4            syncslotcount;
 113
 114         u1           *stackbase;
 115 };
 116
 117 /*** prototypes ********************************************************/
 118
 119 bool replace_create_replacement_points(jitdata *jd);
 120 void replace_free_replacement_points(codeinfo *code);
 121
 122 void replace_activate_replacement_point(rplpoint *rp,rplpoint *target);
 123 void replace_deactivate_replacement_point(rplpoint *rp);
 124 void replace_activate(codeinfo *code,codeinfo *target);
 125
 126 void replace_me(rplpoint *rp,executionstate *es);
 127
 128 #ifndef NDEBUG
 129 void replace_show_replacement_points(codeinfo *code);
 130 void replace_replacement_point_println(rplpoint *rp);
 131 void replace_executionstate_println(executionstate *es,codeinfo *code);
 132 void replace_sourcestate_println(sourcestate *ss);
 133 #endif
 134
 135 /* machine dependent functions (code in ARCH_DIR/md.c) */
 136
 137 #if defined(ENABLE_JIT)
 138 void md_patch_replacement_point(rplpoint *rp);
 139 #endif
 140
 141 #endif
 142
 143 /*
 144  * These are local overrides for various environment variables in Emacs.
 145  * Please do not remove this and leave it at the end of the file, where
 146  * Emacs will automagically detect them.
 147  * ---------------------------------------------------------------------
 148  * Local variables:
 149  * mode: c
 150  * indent-tabs-mode: t
 151  * c-basic-offset: 4
 152  * tab-width: 4
 153  * End:
 154  * vim:noexpandtab:sw=4:ts=4:
 155  */