src/vm/jit/patcher-common.hpp

   1 /* src/vm/jit/patcher-common.hpp - architecture independent code patching stuff
   2
   3    Copyright (C) 2007, 2008, 2009
   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 #if !defined(NDEBUG)
  75 void patcher_list_show(codeinfo *code);
  76 #endif
  77
  78 void patcher_add_patch_ref(jitdata *jd, functionptr patcher, void* ref, s4 disp);
  79
  80 void patcher_resolve(jitdata* jd);
  81
  82 bool patcher_is_patched(patchref_t* pr);
  83 bool patcher_is_patched_at(void* pc);
  84
  85 // MD function.
  86 bool patcher_is_valid_trap_instruction_at(void* pc);
  87
  88 java_handle_t *patcher_handler(u1 *pc);
  89
  90
  91 /* empty patcher (just patches back original mcode) ***************************/
  92
  93 void patcher_patch_code(patchref_t *pr);
  94
  95
  96 /* patcher prototypes and macros **********************************************/
  97
  98 /* new patcher functions */
  99
 100 bool patcher_resolve_class(patchref_t *pr);
 101 #define PATCHER_resolve_class (functionptr) patcher_resolve_class
 102
 103 bool patcher_initialize_class(patchref_t *pr);
 104 #define PATCHER_initialize_class (functionptr) patcher_initialize_class
 105
 106 bool patcher_resolve_classref_to_classinfo(patchref_t *pr);
 107 #define PATCHER_resolve_classref_to_classinfo (functionptr) patcher_resolve_classref_to_classinfo
 108
 109 bool patcher_resolve_classref_to_vftbl(patchref_t *pr);
 110 #define PATCHER_resolve_classref_to_vftbl (functionptr) patcher_resolve_classref_to_vftbl
 111
 112 bool patcher_resolve_classref_to_index(patchref_t *pr);
 113 #define PATCHER_resolve_classref_to_index (functionptr) patcher_resolve_classref_to_index
 114
 115 bool patcher_resolve_classref_to_flags(patchref_t *pr);
 116 #define PATCHER_resolve_classref_to_flags (functionptr) patcher_resolve_classref_to_flags
 117
 118 bool patcher_resolve_native_function(patchref_t *pr);
 119 #define PATCHER_resolve_native_function (functionptr) patcher_resolve_native_function
 120
 121 bool patcher_breakpoint(patchref_t *pr);
 122 #define PATCHER_breakpoint (functionptr) patcher_breakpoint
 123
 124 /* old patcher functions */
 125
 126 bool patcher_get_putstatic(patchref_t *pr);
 127 #define PATCHER_get_putstatic (functionptr) patcher_get_putstatic
 128
 129 #if defined(__I386__)
 130
 131 bool patcher_getfield(patchref_t *pr);
 132 #define PATCHER_getfield (functionptr) patcher_getfield
 133
 134 bool patcher_putfield(patchref_t *pr);
 135 #define PATCHER_putfield (functionptr) patcher_putfield
 136
 137 #else
 138
 139 bool patcher_get_putfield(patchref_t *pr);
 140 #define PATCHER_get_putfield (functionptr) patcher_get_putfield
 141
 142 #endif /* defined(__I386__) */
 143
 144 #if defined(__I386__) || defined(__X86_64__)
 145
 146 bool patcher_putfieldconst(patchref_t *pr);
 147 #define PATCHER_putfieldconst (functionptr) patcher_putfieldconst
 148
 149 #endif /* defined(__I386__) || defined(__X86_64__) */
 150
 151 bool patcher_invokestatic_special(patchref_t *pr);
 152 #define PATCHER_invokestatic_special (functionptr) patcher_invokestatic_special
 153
 154 bool patcher_invokevirtual(patchref_t *pr);
 155 #define PATCHER_invokevirtual (functionptr) patcher_invokevirtual
 156
 157 bool patcher_invokeinterface(patchref_t *pr);
 158 #define PATCHER_invokeinterface (functionptr) patcher_invokeinterface
 159
 160 #if defined(__ALPHA__) || defined(__I386__) || defined(__MIPS__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__S390__) || defined(__X86_64__) || defined(__M68K__)
 161
 162 bool patcher_checkcast_interface(patchref_t *pr);
 163 #define PATCHER_checkcast_interface (functionptr) patcher_checkcast_interface
 164
 165 bool patcher_instanceof_interface(patchref_t *pr);
 166 #define PATCHER_instanceof_interface (functionptr) patcher_instanceof_interface
 167
 168 #endif /* defined(__ALPHA__) || defined(__I386__) || defined(__MIPS__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__S390__) || defined(__X86_64__) || defined(__M68K__) */
 169
 170 #if defined(__S390__)
 171
 172 bool patcher_checkcast_instanceof_interface(patchref_t *pr);
 173 #define PATCHER_checkcast_instanceof_interface (functionptr) patcher_checkcast_instanceof_interface
 174
 175 #endif /* defined(__S390__) */
 176
 177 #if defined(__I386__)
 178
 179 bool patcher_aconst(patchref_t *pr);
 180 #define PATCHER_aconst (functionptr) patcher_aconst
 181
 182 bool patcher_builtin_multianewarray(patchref_t *pr);
 183 #define PATCHER_builtin_multianewarray (functionptr) patcher_builtin_multianewarray
 184
 185 bool patcher_builtin_arraycheckcast(patchref_t *pr);
 186 #define PATCHER_builtin_arraycheckcast (functionptr) patcher_builtin_arraycheckcast
 187
 188 bool patcher_checkcast_instanceof_flags(patchref_t *pr);
 189 #define PATCHER_checkcast_instanceof_flags (functionptr) patcher_checkcast_instanceof_flags
 190
 191 bool patcher_checkcast_class(patchref_t *pr);
 192 #define PATCHER_checkcast_class (functionptr) patcher_checkcast_class
 193
 194 bool patcher_instanceof_class(patchref_t *pr);
 195 #define PATCHER_instanceof_class (functionptr) patcher_instanceof_class
 196
 197 #endif /* defined(__I386__) */
 198
 199 #ifdef __cplusplus
 200 } // extern "C"
 201 #endif
 202
 203 #endif // _PATCHER_COMMON_HPP
 204
 205
 206 /*
 207  * These are local overrides for various environment variables in Emacs.
 208  * Please do not remove this and leave it at the end of the file, where
 209  * Emacs will automagically detect them.
 210  * ---------------------------------------------------------------------
 211  * Local variables:
 212  * mode: c++
 213  * indent-tabs-mode: t
 214  * c-basic-offset: 4
 215  * tab-width: 4
 216  * End:
 217  * vim:noexpandtab:sw=4:ts=4:
 218  */