src/vm/jit/patcher-common.hpp

   1 /* src/vm/jit/patcher-common.hpp - 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_HPP
  27 #define _PATCHER_COMMON_HPP
  28
  29 /* forward typedefs ***********************************************************/
  30
  31 typedef struct patchref_t patchref_t;
  32
  33 #include "config.h"
  34 #include "vm/types.h"
  35
  36 #include "toolbox/list.hpp"
  37
  38 #include "vm/global.h"
  39
  40 #include "vm/jit/jit.hpp"
  41
  42
  43 /* patchref_t ******************************************************************
  44
  45    A patcher reference contains information about a code position
  46    which needs additional code patching during runtime.
  47
  48 *******************************************************************************/
  49
  50 struct patchref_t {
  51         ptrint       mpc;           /* absolute position in code segment          */
  52         ptrint       datap;         /* absolute position in data segment          */
  53         s4           disp;          /* displacement of ref in the data segment    */
  54         functionptr  patcher;       /* patcher function to call                   */
  55         void*        ref;           /* reference passed                           */
  56         uint32_t     mcode;         /* machine code to be patched back in         */
  57         bool         done;          /* XXX preliminary: patch already applied?    */
  58 };
  59
  60
  61 /* macros *********************************************************************/
  62
  63
  64 /* function prototypes ********************************************************/
  65
  66 #ifdef __cplusplus
  67 extern "C" {
  68 #endif
  69
  70 void patcher_list_create(codeinfo *code);
  71 void patcher_list_reset(codeinfo *code);
  72 void patcher_list_free(codeinfo *code);
  73
  74 void patcher_add_patch_ref(jitdata *jd, functionptr patcher, void* ref, s4 disp);
  75
  76 void patcher_resolve(jitdata* jd);
  77
  78 bool patcher_is_patched(patchref_t* pr);
  79 bool patcher_is_patched_at(void* pc);
  80
  81 // MD function.
  82 bool patcher_is_valid_trap_instruction_at(void* pc);
  83
  84 java_handle_t *patcher_handler(u1 *pc);
  85
  86
  87 /* empty patcher (just patches back original mcode) ***************************/
  88
  89 void patcher_patch_code(patchref_t *pr);
  90
  91
  92 /* patcher prototypes and macros **********************************************/
  93
  94 /* new patcher functions */
  95
  96 bool patcher_resolve_class(patchref_t *pr);
  97 #define PATCHER_resolve_class (functionptr) patcher_resolve_class
  98
  99 bool patcher_initialize_class(patchref_t *pr);
 100 #define PATCHER_initialize_class (functionptr) patcher_initialize_class
 101
 102 bool patcher_resolve_classref_to_classinfo(patchref_t *pr);
 103 #define PATCHER_resolve_classref_to_classinfo (functionptr) patcher_resolve_classref_to_classinfo
 104
 105 bool patcher_resolve_classref_to_vftbl(patchref_t *pr);
 106 #define PATCHER_resolve_classref_to_vftbl (functionptr) patcher_resolve_classref_to_vftbl
 107
 108 bool patcher_resolve_classref_to_index(patchref_t *pr);
 109 #define PATCHER_resolve_classref_to_index (functionptr) patcher_resolve_classref_to_index
 110
 111 bool patcher_resolve_classref_to_flags(patchref_t *pr);
 112 #define PATCHER_resolve_classref_to_flags (functionptr) patcher_resolve_classref_to_flags
 113
 114 bool patcher_resolve_native_function(patchref_t *pr);
 115 #define PATCHER_resolve_native_function (functionptr) patcher_resolve_native_function
 116
 117 /* old patcher functions */
 118
 119 bool patcher_get_putstatic(patchref_t *pr);
 120 #define PATCHER_get_putstatic (functionptr) patcher_get_putstatic
 121
 122 #if defined(__I386__)
 123
 124 bool patcher_getfield(patchref_t *pr);
 125 #define PATCHER_getfield (functionptr) patcher_getfield
 126
 127 bool patcher_putfield(patchref_t *pr);
 128 #define PATCHER_putfield (functionptr) patcher_putfield
 129
 130 #else
 131
 132 bool patcher_get_putfield(patchref_t *pr);
 133 #define PATCHER_get_putfield (functionptr) patcher_get_putfield
 134
 135 #endif /* defined(__I386__) */
 136
 137 #if defined(__I386__) || defined(__X86_64__)
 138
 139 bool patcher_putfieldconst(patchref_t *pr);
 140 #define PATCHER_putfieldconst (functionptr) patcher_putfieldconst
 141
 142 #endif /* defined(__I386__) || defined(__X86_64__) */
 143
 144 bool patcher_invokestatic_special(patchref_t *pr);
 145 #define PATCHER_invokestatic_special (functionptr) patcher_invokestatic_special
 146
 147 bool patcher_invokevirtual(patchref_t *pr);
 148 #define PATCHER_invokevirtual (functionptr) patcher_invokevirtual
 149
 150 bool patcher_invokeinterface(patchref_t *pr);
 151 #define PATCHER_invokeinterface (functionptr) patcher_invokeinterface
 152
 153 #if defined(__ALPHA__) || defined(__I386__) || defined(__MIPS__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__S390__) || defined(__X86_64__) || defined(__M68K__)
 154
 155 bool patcher_checkcast_interface(patchref_t *pr);
 156 #define PATCHER_checkcast_interface (functionptr) patcher_checkcast_interface
 157
 158 bool patcher_instanceof_interface(patchref_t *pr);
 159 #define PATCHER_instanceof_interface (functionptr) patcher_instanceof_interface
 160
 161 #endif /* defined(__ALPHA__) || defined(__I386__) || defined(__MIPS__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__S390__) || defined(__X86_64__) || defined(__M68K__) */
 162
 163 #if defined(__S390__)
 164
 165 bool patcher_checkcast_instanceof_interface(patchref_t *pr);
 166 #define PATCHER_checkcast_instanceof_interface (functionptr) patcher_checkcast_instanceof_interface
 167
 168 #endif /* defined(__S390__) */
 169
 170 #if defined(__I386__)
 171
 172 bool patcher_aconst(patchref_t *pr);
 173 #define PATCHER_aconst (functionptr) patcher_aconst
 174
 175 bool patcher_builtin_multianewarray(patchref_t *pr);
 176 #define PATCHER_builtin_multianewarray (functionptr) patcher_builtin_multianewarray
 177
 178 bool patcher_builtin_arraycheckcast(patchref_t *pr);
 179 #define PATCHER_builtin_arraycheckcast (functionptr) patcher_builtin_arraycheckcast
 180
 181 bool patcher_checkcast_instanceof_flags(patchref_t *pr);
 182 #define PATCHER_checkcast_instanceof_flags (functionptr) patcher_checkcast_instanceof_flags
 183
 184 bool patcher_checkcast_class(patchref_t *pr);
 185 #define PATCHER_checkcast_class (functionptr) patcher_checkcast_class
 186
 187 bool patcher_instanceof_class(patchref_t *pr);
 188 #define PATCHER_instanceof_class (functionptr) patcher_instanceof_class
 189
 190 #endif /* defined(__I386__) */
 191
 192 #ifdef __cplusplus
 193 } // extern "C"
 194 #endif
 195
 196 #endif // _PATCHER_COMMON_HPP
 197
 198
 199 /*
 200  * These are local overrides for various environment variables in Emacs.
 201  * Please do not remove this and leave it at the end of the file, where
 202  * Emacs will automagically detect them.
 203  * ---------------------------------------------------------------------
 204  * Local variables:
 205  * mode: c++
 206  * indent-tabs-mode: t
 207  * c-basic-offset: 4
 208  * tab-width: 4
 209  * End:
 210  * vim:noexpandtab:sw=4:ts=4:
 211  */