src/vm/jit/patcher-common.h

   1 /* src/vm/jit/patcher-common.h - architecture independent code patching stuff
   2
   3    Copyright (C) 2007, 2008
   4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
   5
   6    This file is part of CACAO.
   7
   8    This program is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU General Public License as
  10    published by the Free Software Foundation; either version 2, or (at
  11    your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23 */
  24
  25
  26 #ifndef _PATCHER_COMMON_H
  27 #define _PATCHER_COMMON_H
  28
  29 /* forward typedefs ***********************************************************/
  30
  31 #include "config.h"
  32 #include "vm/types.h"
  33
  34 #include "toolbox/list.h"
  35
  36 #include "vm/global.h"
  37
  38 #include "vm/jit/jit.h"
  39
  40
  41 /* patchref_t ******************************************************************
  42
  43    A patcher reference contains information about a code position
  44    which needs additional code patching during runtime.
  45
  46 *******************************************************************************/
  47
  48 typedef struct patchref_t {
  49         ptrint       mpc;           /* absolute position in code segment          */
  50         ptrint       datap;         /* absolute position in data segment          */
  51         s4           disp;          /* displacement of ref in the data segment    */
  52         functionptr  patcher;       /* patcher function to call                   */
  53         void*        ref;           /* reference passed                           */
  54         uint32_t     mcode;         /* machine code to be patched back in         */
  55         bool         done;          /* XXX preliminary: patch already applied?    */
  56         listnode_t   linkage;
  57 } patchref_t;
  58
  59
  60 /* macros *********************************************************************/
  61
  62
  63 /* function prototypes ********************************************************/
  64
  65 void patcher_list_create(codeinfo *code);
  66 void patcher_list_reset(codeinfo *code);
  67 void patcher_list_free(codeinfo *code);
  68
  69 void patcher_add_patch_ref(jitdata *jd, functionptr patcher, void* ref, s4 disp);
  70
  71 void patcher_resolve(jitdata* jd);
  72
  73 bool patcher_is_patched(patchref_t* pr);
  74 bool patcher_is_patched_at(void* pc);
  75
  76 // MD function.
  77 bool patcher_is_valid_trap_instruction_at(void* pc);
  78
  79 java_handle_t *patcher_handler(u1 *pc);
  80
  81
  82 /* empty patcher (just patches back original mcode) ***************************/
  83
  84 void patcher_patch_code(patchref_t *pr);
  85
  86
  87 /* patcher prototypes and macros **********************************************/
  88
  89 /* new patcher functions */
  90
  91 bool patcher_resolve_class(patchref_t *pr);
  92 #define PATCHER_resolve_class (functionptr) patcher_resolve_class
  93
  94 bool patcher_initialize_class(patchref_t *pr);
  95 #define PATCHER_initialize_class (functionptr) patcher_initialize_class
  96
  97 bool patcher_resolve_classref_to_classinfo(patchref_t *pr);
  98 #define PATCHER_resolve_classref_to_classinfo (functionptr) patcher_resolve_classref_to_classinfo
  99
 100 bool patcher_resolve_classref_to_vftbl(patchref_t *pr);
 101 #define PATCHER_resolve_classref_to_vftbl (functionptr) patcher_resolve_classref_to_vftbl
 102
 103 bool patcher_resolve_classref_to_index(patchref_t *pr);
 104 #define PATCHER_resolve_classref_to_index (functionptr) patcher_resolve_classref_to_index
 105
 106 bool patcher_resolve_classref_to_flags(patchref_t *pr);
 107 #define PATCHER_resolve_classref_to_flags (functionptr) patcher_resolve_classref_to_flags
 108
 109 bool patcher_resolve_native_function(patchref_t *pr);
 110 #define PATCHER_resolve_native_function (functionptr) patcher_resolve_native_function
 111
 112 /* old patcher functions */
 113
 114 bool patcher_get_putstatic(patchref_t *pr);
 115 #define PATCHER_get_putstatic (functionptr) patcher_get_putstatic
 116
 117 #if defined(__I386__)
 118
 119 bool patcher_getfield(patchref_t *pr);
 120 #define PATCHER_getfield (functionptr) patcher_getfield
 121
 122 bool patcher_putfield(patchref_t *pr);
 123 #define PATCHER_putfield (functionptr) patcher_putfield
 124
 125 #else
 126
 127 bool patcher_get_putfield(patchref_t *pr);
 128 #define PATCHER_get_putfield (functionptr) patcher_get_putfield
 129
 130 #endif /* defined(__I386__) */
 131
 132 #if defined(__I386__) || defined(__X86_64__)
 133
 134 bool patcher_putfieldconst(patchref_t *pr);
 135 #define PATCHER_putfieldconst (functionptr) patcher_putfieldconst
 136
 137 #endif /* defined(__I386__) || defined(__X86_64__) */
 138
 139 bool patcher_invokestatic_special(patchref_t *pr);
 140 #define PATCHER_invokestatic_special (functionptr) patcher_invokestatic_special
 141
 142 bool patcher_invokevirtual(patchref_t *pr);
 143 #define PATCHER_invokevirtual (functionptr) patcher_invokevirtual
 144
 145 bool patcher_invokeinterface(patchref_t *pr);
 146 #define PATCHER_invokeinterface (functionptr) patcher_invokeinterface
 147
 148 #if defined(__ALPHA__) || defined(__I386__) || defined(__MIPS__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__S390__) || defined(__X86_64__) || defined(__M68K__)
 149
 150 bool patcher_checkcast_interface(patchref_t *pr);
 151 #define PATCHER_checkcast_interface (functionptr) patcher_checkcast_interface
 152
 153 bool patcher_instanceof_interface(patchref_t *pr);
 154 #define PATCHER_instanceof_interface (functionptr) patcher_instanceof_interface
 155
 156 #endif /* defined(__ALPHA__) || defined(__I386__) || defined(__MIPS__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__S390__) || defined(__X86_64__) || defined(__M68K__) */
 157
 158 #if defined(__S390__)
 159
 160 bool patcher_checkcast_instanceof_interface(patchref_t *pr);
 161 #define PATCHER_checkcast_instanceof_interface (functionptr) patcher_checkcast_instanceof_interface
 162
 163 #endif /* defined(__S390__) */
 164
 165 #if defined(__I386__)
 166
 167 bool patcher_aconst(patchref_t *pr);
 168 #define PATCHER_aconst (functionptr) patcher_aconst
 169
 170 bool patcher_builtin_multianewarray(patchref_t *pr);
 171 #define PATCHER_builtin_multianewarray (functionptr) patcher_builtin_multianewarray
 172
 173 bool patcher_builtin_arraycheckcast(patchref_t *pr);
 174 #define PATCHER_builtin_arraycheckcast (functionptr) patcher_builtin_arraycheckcast
 175
 176 bool patcher_checkcast_instanceof_flags(patchref_t *pr);
 177 #define PATCHER_checkcast_instanceof_flags (functionptr) patcher_checkcast_instanceof_flags
 178
 179 bool patcher_checkcast_class(patchref_t *pr);
 180 #define PATCHER_checkcast_class (functionptr) patcher_checkcast_class
 181
 182 bool patcher_instanceof_class(patchref_t *pr);
 183 #define PATCHER_instanceof_class (functionptr) patcher_instanceof_class
 184
 185 #endif /* defined(__I386__) */
 186
 187
 188 #endif /* _PATCHER_COMMON_H */
 189
 190
 191 /*
 192  * These are local overrides for various environment variables in Emacs.
 193  * Please do not remove this and leave it at the end of the file, where
 194  * Emacs will automagically detect them.
 195  * ---------------------------------------------------------------------
 196  * Local variables:
 197  * mode: c
 198  * indent-tabs-mode: t
 199  * c-basic-offset: 4
 200  * tab-width: 4
 201  * End:
 202  * vim:noexpandtab:sw=4:ts=4:
 203  */