src/share/vm/asm/assembler.hpp

Fri, 30 Nov 2012 11:44:05 -0800

author
twisti
date
Fri, 30 Nov 2012 11:44:05 -0800
changeset 4317
6ab62ad83507
parent 4316
1acccb7c0b01
child 4318
cd3d6a6b95d9
permissions
-rw-r--r--

8003195: AbstractAssembler should not store code pointers but use the CodeSection directly
Reviewed-by: twisti, kvn
Contributed-by: Bharadwaj Yadavalli <bharadwaj.yadavalli@oracle.com>

duke@435 1 /*
mikael@4153 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
stefank@2314 25 #ifndef SHARE_VM_ASM_ASSEMBLER_HPP
stefank@2314 26 #define SHARE_VM_ASM_ASSEMBLER_HPP
stefank@2314 27
stefank@2314 28 #include "code/oopRecorder.hpp"
stefank@2314 29 #include "code/relocInfo.hpp"
stefank@2314 30 #include "memory/allocation.hpp"
stefank@2314 31 #include "utilities/debug.hpp"
stefank@2314 32 #include "utilities/growableArray.hpp"
stefank@2314 33 #include "utilities/top.hpp"
stefank@2314 34 #ifdef TARGET_ARCH_x86
stefank@2314 35 # include "register_x86.hpp"
stefank@2314 36 # include "vm_version_x86.hpp"
stefank@2314 37 #endif
stefank@2314 38 #ifdef TARGET_ARCH_sparc
stefank@2314 39 # include "register_sparc.hpp"
stefank@2314 40 # include "vm_version_sparc.hpp"
stefank@2314 41 #endif
stefank@2314 42 #ifdef TARGET_ARCH_zero
stefank@2314 43 # include "register_zero.hpp"
stefank@2314 44 # include "vm_version_zero.hpp"
stefank@2314 45 #endif
bobv@2508 46 #ifdef TARGET_ARCH_arm
bobv@2508 47 # include "register_arm.hpp"
bobv@2508 48 # include "vm_version_arm.hpp"
bobv@2508 49 #endif
bobv@2508 50 #ifdef TARGET_ARCH_ppc
bobv@2508 51 # include "register_ppc.hpp"
bobv@2508 52 # include "vm_version_ppc.hpp"
bobv@2508 53 #endif
stefank@2314 54
twisti@1040 55 // This file contains platform-independent assembler declarations.
duke@435 56
duke@435 57 class CodeBuffer;
duke@435 58 class MacroAssembler;
duke@435 59 class AbstractAssembler;
duke@435 60 class Label;
duke@435 61
duke@435 62 /**
duke@435 63 * Labels represent destinations for control transfer instructions. Such
duke@435 64 * instructions can accept a Label as their target argument. A Label is
duke@435 65 * bound to the current location in the code stream by calling the
duke@435 66 * MacroAssembler's 'bind' method, which in turn calls the Label's 'bind'
duke@435 67 * method. A Label may be referenced by an instruction before it's bound
duke@435 68 * (i.e., 'forward referenced'). 'bind' stores the current code offset
duke@435 69 * in the Label object.
duke@435 70 *
duke@435 71 * If an instruction references a bound Label, the offset field(s) within
duke@435 72 * the instruction are immediately filled in based on the Label's code
duke@435 73 * offset. If an instruction references an unbound label, that
duke@435 74 * instruction is put on a list of instructions that must be patched
duke@435 75 * (i.e., 'resolved') when the Label is bound.
duke@435 76 *
duke@435 77 * 'bind' will call the platform-specific 'patch_instruction' method to
duke@435 78 * fill in the offset field(s) for each unresolved instruction (if there
duke@435 79 * are any). 'patch_instruction' lives in one of the
duke@435 80 * cpu/<arch>/vm/assembler_<arch>* files.
duke@435 81 *
duke@435 82 * Instead of using a linked list of unresolved instructions, a Label has
duke@435 83 * an array of unresolved instruction code offsets. _patch_index
duke@435 84 * contains the total number of forward references. If the Label's array
duke@435 85 * overflows (i.e., _patch_index grows larger than the array size), a
duke@435 86 * GrowableArray is allocated to hold the remaining offsets. (The cache
duke@435 87 * size is 4 for now, which handles over 99.5% of the cases)
duke@435 88 *
duke@435 89 * Labels may only be used within a single CodeSection. If you need
duke@435 90 * to create references between code sections, use explicit relocations.
duke@435 91 */
duke@435 92 class Label VALUE_OBJ_CLASS_SPEC {
duke@435 93 private:
duke@435 94 enum { PatchCacheSize = 4 };
duke@435 95
duke@435 96 // _loc encodes both the binding state (via its sign)
duke@435 97 // and the binding locator (via its value) of a label.
duke@435 98 //
duke@435 99 // _loc >= 0 bound label, loc() encodes the target (jump) position
duke@435 100 // _loc == -1 unbound label
duke@435 101 int _loc;
duke@435 102
duke@435 103 // References to instructions that jump to this unresolved label.
duke@435 104 // These instructions need to be patched when the label is bound
duke@435 105 // using the platform-specific patchInstruction() method.
duke@435 106 //
duke@435 107 // To avoid having to allocate from the C-heap each time, we provide
duke@435 108 // a local cache and use the overflow only if we exceed the local cache
duke@435 109 int _patches[PatchCacheSize];
duke@435 110 int _patch_index;
duke@435 111 GrowableArray<int>* _patch_overflow;
duke@435 112
duke@435 113 Label(const Label&) { ShouldNotReachHere(); }
duke@435 114
duke@435 115 public:
duke@435 116
duke@435 117 /**
duke@435 118 * After binding, be sure 'patch_instructions' is called later to link
duke@435 119 */
duke@435 120 void bind_loc(int loc) {
duke@435 121 assert(loc >= 0, "illegal locator");
duke@435 122 assert(_loc == -1, "already bound");
duke@435 123 _loc = loc;
duke@435 124 }
duke@435 125 void bind_loc(int pos, int sect); // = bind_loc(locator(pos, sect))
duke@435 126
duke@435 127 #ifndef PRODUCT
duke@435 128 // Iterates over all unresolved instructions for printing
duke@435 129 void print_instructions(MacroAssembler* masm) const;
duke@435 130 #endif // PRODUCT
duke@435 131
duke@435 132 /**
duke@435 133 * Returns the position of the the Label in the code buffer
duke@435 134 * The position is a 'locator', which encodes both offset and section.
duke@435 135 */
duke@435 136 int loc() const {
duke@435 137 assert(_loc >= 0, "unbound label");
duke@435 138 return _loc;
duke@435 139 }
duke@435 140 int loc_pos() const; // == locator_pos(loc())
duke@435 141 int loc_sect() const; // == locator_sect(loc())
duke@435 142
duke@435 143 bool is_bound() const { return _loc >= 0; }
duke@435 144 bool is_unbound() const { return _loc == -1 && _patch_index > 0; }
duke@435 145 bool is_unused() const { return _loc == -1 && _patch_index == 0; }
duke@435 146
duke@435 147 /**
duke@435 148 * Adds a reference to an unresolved displacement instruction to
duke@435 149 * this unbound label
duke@435 150 *
duke@435 151 * @param cb the code buffer being patched
duke@435 152 * @param branch_loc the locator of the branch instruction in the code buffer
duke@435 153 */
duke@435 154 void add_patch_at(CodeBuffer* cb, int branch_loc);
duke@435 155
duke@435 156 /**
duke@435 157 * Iterate over the list of patches, resolving the instructions
duke@435 158 * Call patch_instruction on each 'branch_loc' value
duke@435 159 */
duke@435 160 void patch_instructions(MacroAssembler* masm);
duke@435 161
duke@435 162 void init() {
duke@435 163 _loc = -1;
duke@435 164 _patch_index = 0;
duke@435 165 _patch_overflow = NULL;
duke@435 166 }
duke@435 167
duke@435 168 Label() {
duke@435 169 init();
duke@435 170 }
duke@435 171 };
duke@435 172
jrose@1057 173 // A union type for code which has to assemble both constant and
jrose@1057 174 // non-constant operands, when the distinction cannot be made
jrose@1057 175 // statically.
jrose@1100 176 class RegisterOrConstant VALUE_OBJ_CLASS_SPEC {
jrose@1057 177 private:
jrose@1057 178 Register _r;
jrose@1057 179 intptr_t _c;
jrose@1057 180
jrose@1057 181 public:
jrose@1100 182 RegisterOrConstant(): _r(noreg), _c(0) {}
jrose@1100 183 RegisterOrConstant(Register r): _r(r), _c(0) {}
jrose@1100 184 RegisterOrConstant(intptr_t c): _r(noreg), _c(c) {}
jrose@1057 185
jrose@1057 186 Register as_register() const { assert(is_register(),""); return _r; }
jrose@1057 187 intptr_t as_constant() const { assert(is_constant(),""); return _c; }
jrose@1057 188
jrose@1057 189 Register register_or_noreg() const { return _r; }
jrose@1057 190 intptr_t constant_or_zero() const { return _c; }
jrose@1057 191
jrose@1057 192 bool is_register() const { return _r != noreg; }
jrose@1057 193 bool is_constant() const { return _r == noreg; }
jrose@1057 194 };
duke@435 195
duke@435 196 // The Abstract Assembler: Pure assembler doing NO optimizations on the
duke@435 197 // instruction level; i.e., what you write is what you get.
duke@435 198 // The Assembler is generating code into a CodeBuffer.
duke@435 199 class AbstractAssembler : public ResourceObj {
duke@435 200 friend class Label;
duke@435 201
duke@435 202 protected:
duke@435 203 CodeSection* _code_section; // section within the code buffer
duke@435 204 OopRecorder* _oop_recorder; // support for relocInfo::oop_type
duke@435 205
duke@435 206 // Code emission & accessing
twisti@4317 207 inline address addr_at(int pos) const;
duke@435 208
duke@435 209 // This routine is called with a label is used for an address.
duke@435 210 // Labels and displacements truck in offsets, but target must return a PC.
duke@435 211 address target(Label& L); // return _code_section->target(L)
duke@435 212
duke@435 213 bool is8bit(int x) const { return -0x80 <= x && x < 0x80; }
duke@435 214 bool isByte(int x) const { return 0 <= x && x < 0x100; }
duke@435 215 bool isShiftCount(int x) const { return 0 <= x && x < 32; }
duke@435 216
twisti@4317 217 void emit_byte(int x) { emit_int8 (x); } // deprecated
twisti@4317 218 void emit_word(int x) { emit_int16(x); } // deprecated
twisti@4317 219 void emit_long(jint x) { emit_int32(x); } // deprecated
twisti@4317 220
twisti@4317 221 inline void emit_int8( int8_t x);
twisti@4317 222 inline void emit_int16( int16_t x);
twisti@4317 223 inline void emit_int32( int32_t x);
twisti@4317 224 inline void emit_int64( int64_t x);
twisti@4317 225
twisti@4317 226 inline void emit_float( jfloat x);
twisti@4317 227 inline void emit_double(jdouble x);
twisti@4317 228 inline void emit_address(address x);
duke@435 229
duke@435 230 // Instruction boundaries (required when emitting relocatable values).
duke@435 231 class InstructionMark: public StackObj {
duke@435 232 private:
duke@435 233 AbstractAssembler* _assm;
duke@435 234
duke@435 235 public:
duke@435 236 InstructionMark(AbstractAssembler* assm) : _assm(assm) {
duke@435 237 assert(assm->inst_mark() == NULL, "overlapping instructions");
duke@435 238 _assm->set_inst_mark();
duke@435 239 }
duke@435 240 ~InstructionMark() {
duke@435 241 _assm->clear_inst_mark();
duke@435 242 }
duke@435 243 };
duke@435 244 friend class InstructionMark;
duke@435 245 #ifdef ASSERT
duke@435 246 // Make it return true on platforms which need to verify
duke@435 247 // instruction boundaries for some operations.
duke@435 248 inline static bool pd_check_instruction_mark();
kvn@3395 249
kvn@3395 250 // Add delta to short branch distance to verify that it still fit into imm8.
kvn@3395 251 int _short_branch_delta;
kvn@3395 252
kvn@3395 253 int short_branch_delta() const { return _short_branch_delta; }
kvn@3395 254 void set_short_branch_delta() { _short_branch_delta = 32; }
kvn@3395 255 void clear_short_branch_delta() { _short_branch_delta = 0; }
kvn@3395 256
kvn@3395 257 class ShortBranchVerifier: public StackObj {
kvn@3395 258 private:
kvn@3395 259 AbstractAssembler* _assm;
kvn@3395 260
kvn@3395 261 public:
kvn@3395 262 ShortBranchVerifier(AbstractAssembler* assm) : _assm(assm) {
kvn@3395 263 assert(assm->short_branch_delta() == 0, "overlapping instructions");
kvn@3395 264 _assm->set_short_branch_delta();
kvn@3395 265 }
kvn@3395 266 ~ShortBranchVerifier() {
kvn@3395 267 _assm->clear_short_branch_delta();
kvn@3395 268 }
kvn@3395 269 };
kvn@3395 270 #else
kvn@3395 271 // Dummy in product.
kvn@3395 272 class ShortBranchVerifier: public StackObj {
kvn@3395 273 public:
kvn@3395 274 ShortBranchVerifier(AbstractAssembler* assm) {}
kvn@3395 275 };
duke@435 276 #endif
duke@435 277
duke@435 278 // Label functions
duke@435 279 void print(Label& L);
duke@435 280
duke@435 281 public:
duke@435 282
duke@435 283 // Creation
duke@435 284 AbstractAssembler(CodeBuffer* code);
duke@435 285
duke@435 286 // ensure buf contains all code (call this before using/copying the code)
duke@435 287 void flush();
duke@435 288
twisti@3310 289 // min and max values for signed immediate ranges
twisti@3310 290 static int min_simm(int nbits) { return -(intptr_t(1) << (nbits - 1)) ; }
twisti@3310 291 static int max_simm(int nbits) { return (intptr_t(1) << (nbits - 1)) - 1; }
twisti@3310 292
twisti@3310 293 // Define some:
twisti@3310 294 static int min_simm10() { return min_simm(10); }
twisti@3310 295 static int min_simm13() { return min_simm(13); }
twisti@3310 296 static int min_simm16() { return min_simm(16); }
twisti@3310 297
twisti@3310 298 // Test if x is within signed immediate range for nbits
twisti@3310 299 static bool is_simm(intptr_t x, int nbits) { return min_simm(nbits) <= x && x <= max_simm(nbits); }
twisti@3310 300
twisti@3310 301 // Define some:
twisti@3310 302 static bool is_simm5( intptr_t x) { return is_simm(x, 5 ); }
twisti@3310 303 static bool is_simm8( intptr_t x) { return is_simm(x, 8 ); }
twisti@3310 304 static bool is_simm10(intptr_t x) { return is_simm(x, 10); }
twisti@3310 305 static bool is_simm11(intptr_t x) { return is_simm(x, 11); }
twisti@3310 306 static bool is_simm12(intptr_t x) { return is_simm(x, 12); }
twisti@3310 307 static bool is_simm13(intptr_t x) { return is_simm(x, 13); }
twisti@3310 308 static bool is_simm16(intptr_t x) { return is_simm(x, 16); }
twisti@3310 309 static bool is_simm26(intptr_t x) { return is_simm(x, 26); }
twisti@3310 310 static bool is_simm32(intptr_t x) { return is_simm(x, 32); }
twisti@3310 311
duke@435 312 // Accessors
duke@435 313 CodeSection* code_section() const { return _code_section; }
twisti@4317 314 inline CodeBuffer* code() const;
twisti@4317 315 inline int sect() const;
twisti@4317 316 inline address pc() const;
twisti@4317 317 inline int offset() const;
twisti@4317 318 inline int locator() const; // CodeBuffer::locator(offset(), sect())
twisti@4317 319
duke@435 320 OopRecorder* oop_recorder() const { return _oop_recorder; }
duke@435 321 void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
duke@435 322
duke@435 323 address inst_mark() const;
duke@435 324 void set_inst_mark();
duke@435 325 void clear_inst_mark();
duke@435 326
duke@435 327 // Constants in code
duke@435 328 void a_byte(int x);
duke@435 329 void a_long(jint x);
duke@435 330 void relocate(RelocationHolder const& rspec, int format = 0);
duke@435 331 void relocate( relocInfo::relocType rtype, int format = 0) {
duke@435 332 if (rtype != relocInfo::none)
duke@435 333 relocate(Relocation::spec_simple(rtype), format);
duke@435 334 }
duke@435 335
duke@435 336 static int code_fill_byte(); // used to pad out odd-sized code buffers
duke@435 337
duke@435 338 // Associate a comment with the current offset. It will be printed
duke@435 339 // along with the disassembly when printing nmethods. Currently
duke@435 340 // only supported in the instruction section of the code buffer.
duke@435 341 void block_comment(const char* comment);
duke@435 342
duke@435 343 // Label functions
duke@435 344 void bind(Label& L); // binds an unbound label L to the current code position
duke@435 345
duke@435 346 // Move to a different section in the same code buffer.
duke@435 347 void set_code_section(CodeSection* cs);
duke@435 348
duke@435 349 // Inform assembler when generating stub code and relocation info
duke@435 350 address start_a_stub(int required_space);
duke@435 351 void end_a_stub();
duke@435 352 // Ditto for constants.
duke@435 353 address start_a_const(int required_space, int required_align = sizeof(double));
kvn@4316 354 void end_a_const(CodeSection* cs); // Pass the codesection to continue in (insts or stubs?).
duke@435 355
twisti@2350 356 // constants support
kvn@4316 357 //
kvn@4316 358 // We must remember the code section (insts or stubs) in c1
kvn@4316 359 // so we can reset to the proper section in end_a_const().
twisti@2350 360 address long_constant(jlong c) {
kvn@4316 361 CodeSection* c1 = _code_section;
twisti@2350 362 address ptr = start_a_const(sizeof(c), sizeof(c));
twisti@2350 363 if (ptr != NULL) {
twisti@4317 364 emit_int64(c);
kvn@4316 365 end_a_const(c1);
twisti@2350 366 }
twisti@2350 367 return ptr;
twisti@2350 368 }
duke@435 369 address double_constant(jdouble c) {
kvn@4316 370 CodeSection* c1 = _code_section;
duke@435 371 address ptr = start_a_const(sizeof(c), sizeof(c));
duke@435 372 if (ptr != NULL) {
twisti@4317 373 emit_double(c);
kvn@4316 374 end_a_const(c1);
duke@435 375 }
duke@435 376 return ptr;
duke@435 377 }
duke@435 378 address float_constant(jfloat c) {
kvn@4316 379 CodeSection* c1 = _code_section;
duke@435 380 address ptr = start_a_const(sizeof(c), sizeof(c));
duke@435 381 if (ptr != NULL) {
twisti@4317 382 emit_float(c);
kvn@4316 383 end_a_const(c1);
duke@435 384 }
duke@435 385 return ptr;
duke@435 386 }
twisti@2350 387 address address_constant(address c) {
kvn@4316 388 CodeSection* c1 = _code_section;
twisti@2350 389 address ptr = start_a_const(sizeof(c), sizeof(c));
twisti@2350 390 if (ptr != NULL) {
twisti@4317 391 emit_address(c);
kvn@4316 392 end_a_const(c1);
twisti@2350 393 }
twisti@2350 394 return ptr;
twisti@2350 395 }
duke@435 396 address address_constant(address c, RelocationHolder const& rspec) {
kvn@4316 397 CodeSection* c1 = _code_section;
duke@435 398 address ptr = start_a_const(sizeof(c), sizeof(c));
duke@435 399 if (ptr != NULL) {
duke@435 400 relocate(rspec);
twisti@4317 401 emit_address(c);
kvn@4316 402 end_a_const(c1);
duke@435 403 }
duke@435 404 return ptr;
duke@435 405 }
duke@435 406
jrose@1057 407 // Bootstrapping aid to cope with delayed determination of constants.
jrose@1057 408 // Returns a static address which will eventually contain the constant.
jrose@1057 409 // The value zero (NULL) stands instead of a constant which is still uncomputed.
jrose@1057 410 // Thus, the eventual value of the constant must not be zero.
jrose@1057 411 // This is fine, since this is designed for embedding object field
jrose@1057 412 // offsets in code which must be generated before the object class is loaded.
jrose@1057 413 // Field offsets are never zero, since an object's header (mark word)
jrose@1057 414 // is located at offset zero.
twisti@3969 415 RegisterOrConstant delayed_value(int(*value_fn)(), Register tmp, int offset = 0);
twisti@3969 416 RegisterOrConstant delayed_value(address(*value_fn)(), Register tmp, int offset = 0);
jrose@1100 417 virtual RegisterOrConstant delayed_value_impl(intptr_t* delayed_value_addr, Register tmp, int offset) = 0;
jrose@1057 418 // Last overloading is platform-dependent; look in assembler_<arch>.cpp.
jrose@1057 419 static intptr_t* delayed_value_addr(int(*constant_fn)());
jrose@1057 420 static intptr_t* delayed_value_addr(address(*constant_fn)());
jrose@1057 421 static void update_delayed_values();
jrose@1057 422
duke@435 423 // Bang stack to trigger StackOverflowError at a safe location
duke@435 424 // implementation delegates to machine-specific bang_stack_with_offset
duke@435 425 void generate_stack_overflow_check( int frame_size_in_bytes );
duke@435 426 virtual void bang_stack_with_offset(int offset) = 0;
duke@435 427
duke@435 428
duke@435 429 /**
duke@435 430 * A platform-dependent method to patch a jump instruction that refers
duke@435 431 * to this label.
duke@435 432 *
duke@435 433 * @param branch the location of the instruction to patch
duke@435 434 * @param masm the assembler which generated the branch
duke@435 435 */
duke@435 436 void pd_patch_instruction(address branch, address target);
duke@435 437
duke@435 438 #ifndef PRODUCT
duke@435 439 /**
duke@435 440 * Platform-dependent method of printing an instruction that needs to be
duke@435 441 * patched.
duke@435 442 *
duke@435 443 * @param branch the instruction to be patched in the buffer.
duke@435 444 */
duke@435 445 static void pd_print_patched_instruction(address branch);
duke@435 446 #endif // PRODUCT
duke@435 447 };
duke@435 448
stefank@2314 449 #ifdef TARGET_ARCH_x86
stefank@2314 450 # include "assembler_x86.hpp"
stefank@2314 451 #endif
stefank@2314 452 #ifdef TARGET_ARCH_sparc
stefank@2314 453 # include "assembler_sparc.hpp"
stefank@2314 454 #endif
stefank@2314 455 #ifdef TARGET_ARCH_zero
stefank@2314 456 # include "assembler_zero.hpp"
stefank@2314 457 #endif
bobv@2508 458 #ifdef TARGET_ARCH_arm
bobv@2508 459 # include "assembler_arm.hpp"
bobv@2508 460 #endif
bobv@2508 461 #ifdef TARGET_ARCH_ppc
bobv@2508 462 # include "assembler_ppc.hpp"
bobv@2508 463 #endif
stefank@2314 464
stefank@2314 465
stefank@2314 466 #endif // SHARE_VM_ASM_ASSEMBLER_HPP

mercurial