src/vm/jit/codegen-common.h

   1 /* src/vm/jit/codegen-common.h - architecture independent code generator stuff
   2
   3    Copyright (C) 1996-2005, 2006, 2007 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 */
  26
  27
  28 #ifndef _CODEGEN_COMMON_H
  29 #define _CODEGEN_COMMON_H
  30
  31 /* forward typedefs ***********************************************************/
  32
  33 typedef struct codegendata            codegendata;
  34 typedef struct branchref              branchref;
  35 typedef struct branch_label_ref_t     branch_label_ref_t;
  36 typedef struct critical_section_ref_t critical_section_ref_t;
  37 typedef struct jumpref                jumpref;
  38 typedef struct dataref                dataref;
  39 typedef struct exceptionref           exceptionref;
  40 typedef struct patchref               patchref;
  41 typedef struct linenumberref          linenumberref;
  42
  43
  44 #include "config.h"
  45 #include "vm/types.h"
  46
  47 #include "vm/global.h"
  48
  49 #include "vm/jit/dseg.h"
  50 #include "vm/jit/jit.h"
  51 #include "vm/jit/reg.h"
  52 #include "vm/jit/code.h"
  53 #include "vm/jit/replace.h"
  54
  55 #include "vmcore/descriptor.h"
  56 #include "vmcore/method.h"
  57 #include "vmcore/references.h"
  58
  59
  60 #define MCODEINITSIZE (1<<15)       /* 32 Kbyte code area initialization size */
  61 #define DSEGINITSIZE  (1<<12)       /*  4 Kbyte data area initialization size */
  62
  63 #define NCODEINITSIZE (1<<15)       /* 32 Kbyte code area initialization size */
  64
  65
  66 /* Register Pack/Unpack Macros ************************************************/
  67
  68 /* ATTENTION: Don't change the order where low and high bits are
  69    stored! At least mips32 relies in one case on that order. */
  70
  71 #define PACK_REGS(low,high) \
  72     ( (((high) & 0x0000ffff) << 16) | ((low) & 0x0000ffff) )
  73
  74 #define GET_LOW_REG(a)      ((a) & 0x0000ffff)
  75 #define GET_HIGH_REG(a)    (((a) & 0xffff0000) >> 16)
  76
  77
  78 /* branch conditions **********************************************************/
  79
  80 #define BRANCH_UNCONDITIONAL    -1
  81
  82 #define BRANCH_EQ               (ICMD_IFEQ - ICMD_IFEQ)
  83 #define BRANCH_NE               (ICMD_IFNE - ICMD_IFEQ)
  84 #define BRANCH_LT               (ICMD_IFLT - ICMD_IFEQ)
  85 #define BRANCH_GE               (ICMD_IFGE - ICMD_IFEQ)
  86 #define BRANCH_GT               (ICMD_IFGT - ICMD_IFEQ)
  87 #define BRANCH_LE               (ICMD_IFLE - ICMD_IFEQ)
  88
  89 #define BRANCH_ULT              256
  90 #define BRANCH_ULE              257
  91 #define BRANCH_UGE              258
  92 #define BRANCH_UGT              259
  93
  94 #define BRANCH_NAN              260
  95
  96
  97 /* common branch options ******************************************************/
  98
  99 #define BRANCH_OPT_NONE         0
 100
 101
 102 /* codegendata ****************************************************************/
 103
 104 struct codegendata {
 105         u4              flags;          /* code generator flags                   */
 106         u1             *mcodebase;      /* base pointer of code area              */
 107         u1             *mcodeend;       /* pointer to end of code area            */
 108         s4              mcodesize;      /* complete size of code area (bytes)     */
 109         u1             *mcodeptr;       /* code generation pointer                */
 110         u1             *lastmcodeptr;   /* last patcher position of basic block   */
 111
 112 #if defined(ENABLE_INTRP)
 113         u1             *ncodebase;      /* base pointer of native code area       */
 114         s4              ncodesize;      /* complete size of native code area      */
 115         u1             *ncodeptr;       /* native code generation pointer         */
 116
 117         u4              lastinstwithoutdispatch; /* ~0 if there was a dispatch    */
 118
 119         s4              lastpatcheroffset; /* -1 if current super has no patcher  */
 120         s4              dynsuperm;      /* offsets of start of current dynamic ...*/
 121         s4              dynsupern;      /* ... superinstruction starts            */
 122         struct superstart *superstarts; /* list of supers without patchers        */
 123 #endif
 124
 125         dsegentry      *dseg;           /* chain of data segment entries          */
 126         s4              dseglen;        /* used size of data area (bytes)         */
 127                                     /* data area grows from top to bottom     */
 128
 129         jumpref        *jumpreferences; /* list of jumptable target addresses     */
 130
 131 #if defined(__I386__) || defined(__X86_64__) || defined(__XDSPCORE__) || defined(__M68K__) || defined(ENABLE_INTRP) || defined(__S390__)
 132         dataref        *datareferences; /* list of data segment references        */
 133 #endif
 134
 135 /*      list_t         *patchrefs; */
 136         patchref       *patchrefs;
 137         list_t         *brancheslabel;
 138         list_t         *listcritical;   /* list of critical sections              */
 139
 140         linenumberref  *linenumberreferences; /* list of line numbers and the     */
 141                                         /* program counters of their first        */
 142                                         /* instruction                            */
 143         s4              linenumbertablesizepos;
 144         s4              linenumbertablestartpos;
 145         s4              linenumbertab;
 146
 147         methodinfo     *method;
 148
 149         s4              stackframesize;    /* stackframe size of this method      */
 150
 151 #if defined(ENABLE_REPLACEMENT)
 152         rplpoint       *replacementpoint;  /* current replacement point           */
 153 #endif
 154 };
 155
 156
 157 #define CODEGENDATA_FLAG_ERROR           0x00000001
 158 #define CODEGENDATA_FLAG_LONGBRANCHES    0x00000002
 159
 160
 161 #define CODEGENDATA_HAS_FLAG_ERROR(cd) \
 162     ((cd)->flags & CODEGENDATA_FLAG_ERROR)
 163
 164 #define CODEGENDATA_HAS_FLAG_LONGBRANCHES(cd) \
 165     ((cd)->flags & CODEGENDATA_FLAG_LONGBRANCHES)
 166
 167
 168 /* branchref *****************************************************************/
 169
 170 struct branchref {
 171         s4         branchmpc;       /* patching position in code segment          */
 172         s4         condition;       /* conditional branch condition               */
 173         s4         reg;             /* register number to check                   */
 174         u4         options;         /* branch options                             */
 175         branchref *next;            /* next element in branchref list             */
 176 };
 177
 178
 179 /* branch_label_ref_t *********************************************************/
 180
 181 struct branch_label_ref_t {
 182         s4         mpc;             /* position in code segment                   */
 183         s4         label;           /* label number                               */
 184         s4         condition;       /* conditional branch condition               */
 185         s4         reg;             /* register number to check                   */
 186         u4         options;         /* branch options                             */
 187         listnode_t linkage;
 188 };
 189
 190
 191 /* critical_section_ref_t *****************************************************/
 192
 193 struct critical_section_ref_t {
 194         s4         start;           /* relative offset to method entry-point      */
 195         s4         end;
 196         s4         restart;
 197         listnode_t linkage;
 198 };
 199
 200
 201 /* jumpref ********************************************************************/
 202
 203 struct jumpref {
 204         s4          tablepos;       /* patching position in data segment          */
 205         basicblock *target;         /* target basic block                         */
 206         jumpref    *next;           /* next element in jumpref list               */
 207 };
 208
 209
 210 /* dataref ********************************************************************/
 211
 212 struct dataref {
 213         s4       datapos;           /* patching position in generated code        */
 214         dataref *next;              /* next element in dataref list               */
 215 };
 216
 217
 218 /* patchref *******************************************************************/
 219
 220 struct patchref {
 221         s4           branchpos;     /* relative offset to method entrypoint       */
 222         s4           disp;          /* displacement of ref in the data segment    */
 223         functionptr  patcher;       /* patcher function to call                   */
 224         voidptr      ref;           /* reference passed                           */
 225 /*      listnode     linkage; */
 226         patchref    *next;
 227 };
 228
 229
 230 /* linenumberref **************************************************************/
 231
 232 struct linenumberref {
 233         s4             tablepos;    /* patching position in data segment          */
 234         s4             linenumber;  /* line number, used for inserting into the   */
 235                                     /* table and for validity checking            */
 236                                     /* -1......start of inlined body              */
 237                                     /* -2......end of inlined body                */
 238                                     /* <= -3...special entry with methodinfo *    */
 239                                                                 /* (see doc/inlining_stacktrace.txt)          */
 240         ptrint         targetmpc;   /* machine code program counter of first      */
 241                                     /* instruction for given line                 */
 242                                                                 /* NOTE: for linenumber <= -3 this is a the   */
 243                                     /* (methodinfo *) of the inlined method       */
 244         linenumberref *next;        /* next element in linenumberref list         */
 245 };
 246
 247
 248 /* methodtree_element *********************************************************/
 249
 250 typedef struct methodtree_element methodtree_element;
 251
 252 struct methodtree_element {
 253         u1 *startpc;
 254         u1 *endpc;
 255 };
 256
 257
 258 /* function prototypes ********************************************************/
 259
 260 void codegen_init(void);
 261 void codegen_setup(jitdata *jd);
 262
 263 bool codegen_generate(jitdata *jd);
 264 bool codegen_emit(jitdata *jd);
 265
 266 #if defined(ENABLE_INTRP)
 267 bool intrp_codegen(jitdata *jd);
 268 #endif
 269
 270 void codegen_close(void);
 271
 272 void codegen_increase(codegendata *cd);
 273
 274 #if defined(ENABLE_INTRP)
 275 u1 *codegen_ncode_increase(codegendata *cd, u1 *ncodeptr);
 276 #endif
 277
 278 void codegen_add_branch_ref(codegendata *cd, basicblock *target, s4 condition, s4 reg, u4 options);
 279 void codegen_resolve_branchrefs(codegendata *cd, basicblock *bptr);
 280
 281 void codegen_branch_label_add(codegendata *cd, s4 label, s4 condition, s4 reg, u4 options);
 282
 283
 284 void codegen_add_patch_ref(codegendata *cd, functionptr patcher, voidptr ref,
 285                                                    s4 disp);
 286 /* XXX REMOVE ME: don't-break-trunk macro */
 287 #define codegen_addpatchref codegen_add_patch_ref
 288
 289 void codegen_insertmethod(u1 *startpc, u1 *endpc);
 290 u1 *codegen_get_pv_from_pc(u1 *pc);
 291 u1 *codegen_get_pv_from_pc_nocheck(u1 *pc);
 292
 293 #if defined(ENABLE_REPLACEMENT)
 294 #if !defined(NDEBUG)
 295 void codegen_set_replacement_point_notrap(codegendata *cd, s4 type);
 296 void codegen_set_replacement_point(codegendata *cd, s4 type);
 297 #else
 298 void codegen_set_replacement_point_notrap(codegendata *cd);
 299 void codegen_set_replacement_point(codegendata *cd);
 300 #endif
 301 #endif /* defined(ENABLE_REPLACEMENT) */
 302
 303 void codegen_finish(jitdata *jd);
 304
 305 #if defined(ENABLE_DISASSEMBLER)
 306 void codegen_disassemble_nativestub(methodinfo *m, u1 *start, u1 *end);
 307 #endif
 308
 309 /* stub functions */
 310
 311 u1       *codegen_generate_stub_compiler(methodinfo *m);
 312 codeinfo *codegen_generate_stub_native(methodinfo *m, functionptr f);
 313
 314 void      codegen_emit_stub_compiler(jitdata *jd);
 315 void      codegen_emit_stub_native(jitdata *jd, methoddesc *nmd, functionptr f);
 316
 317 #if defined(ENABLE_INTRP)
 318 u1 *intrp_createcompilerstub(methodinfo *m);
 319 u1 *intrp_createnativestub(functionptr f, jitdata *jd, methoddesc *md);
 320 #endif
 321
 322 void removecompilerstub(u1 *stub);
 323 void removenativestub(u1 *stub);
 324
 325 void codegen_start_native_call(u1 *datasp, u1 *pv, u1 *sp, u1 *ra);
 326 java_object_t *codegen_finish_native_call(u1 *datasp);
 327
 328 s4 codegen_reg_of_var(u2 opcode, varinfo *v, s4 tempregnum);
 329 s4 codegen_reg_of_dst(jitdata *jd, instruction *iptr, s4 tempregnum);
 330
 331 #if defined(ENABLE_THREADS)
 332 void codegen_critical_section_new(codegendata *cd);
 333 void codegen_critical_section_start(codegendata *cd);
 334 void codegen_critical_section_end(codegendata *cd);
 335
 336 # define CODEGEN_CRITICAL_SECTION_NEW      codegen_critical_section_new(cd)
 337 # define CODEGEN_CRITICAL_SECTION_START    codegen_critical_section_start(cd)
 338 # define CODEGEN_CRITICAL_SECTION_END      codegen_critical_section_end(cd)
 339 #else
 340 # define CODEGEN_CRITICAL_SECTION_NEW      /* no-op */
 341 # define CODEGEN_CRITICAL_SECTION_START    /* no-op */
 342 # define CODEGEN_CRITICAL_SECTION_END      /* no-op */
 343 #endif
 344
 345 /* machine dependent functions */
 346 u1 *md_codegen_get_pv_from_pc(u1 *ra);
 347
 348
 349 #if defined(ENABLE_SSA)
 350 void codegen_emit_phi_moves(jitdata *jd, basicblock *bptr);
 351 #endif
 352
 353 #endif /* _CODEGEN_COMMON_H */
 354
 355
 356 /*
 357  * These are local overrides for various environment variables in Emacs.
 358  * Please do not remove this and leave it at the end of the file, where
 359  * Emacs will automagically detect them.
 360  * ---------------------------------------------------------------------
 361  * Local variables:
 362  * mode: c
 363  * indent-tabs-mode: t
 364  * c-basic-offset: 4
 365  * tab-width: 4
 366  * End:
 367  * vim:noexpandtab:sw=4:ts=4:
 368  */