code_generator_x86_64.h revision 42249c3602c3d0243396ee3627ffb5906aa77c1e
1/* 2 * Copyright (C) 2014 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17#ifndef ART_COMPILER_OPTIMIZING_CODE_GENERATOR_X86_64_H_ 18#define ART_COMPILER_OPTIMIZING_CODE_GENERATOR_X86_64_H_ 19 20#include "arch/x86_64/instruction_set_features_x86_64.h" 21#include "code_generator.h" 22#include "dex/compiler_enums.h" 23#include "driver/compiler_options.h" 24#include "nodes.h" 25#include "parallel_move_resolver.h" 26#include "utils/x86_64/assembler_x86_64.h" 27 28namespace art { 29namespace x86_64 { 30 31// Use a local definition to prevent copying mistakes. 32static constexpr size_t kX86_64WordSize = kX86_64PointerSize; 33 34// Some x86_64 instructions require a register to be available as temp. 35static constexpr Register TMP = R11; 36 37static constexpr Register kParameterCoreRegisters[] = { RSI, RDX, RCX, R8, R9 }; 38static constexpr FloatRegister kParameterFloatRegisters[] = 39 { XMM0, XMM1, XMM2, XMM3, XMM4, XMM5, XMM6, XMM7 }; 40 41static constexpr size_t kParameterCoreRegistersLength = arraysize(kParameterCoreRegisters); 42static constexpr size_t kParameterFloatRegistersLength = arraysize(kParameterFloatRegisters); 43 44static constexpr Register kRuntimeParameterCoreRegisters[] = { RDI, RSI, RDX, RCX }; 45static constexpr size_t kRuntimeParameterCoreRegistersLength = 46 arraysize(kRuntimeParameterCoreRegisters); 47static constexpr FloatRegister kRuntimeParameterFpuRegisters[] = { XMM0, XMM1 }; 48static constexpr size_t kRuntimeParameterFpuRegistersLength = 49 arraysize(kRuntimeParameterFpuRegisters); 50 51// These XMM registers are non-volatile in ART ABI, but volatile in native ABI. 52// If the ART ABI changes, this list must be updated. It is used to ensure that 53// these are not clobbered by any direct call to native code (such as math intrinsics). 54static constexpr FloatRegister non_volatile_xmm_regs[] = { XMM12, XMM13, XMM14, XMM15 }; 55 56 57class InvokeRuntimeCallingConvention : public CallingConvention<Register, FloatRegister> { 58 public: 59 InvokeRuntimeCallingConvention() 60 : CallingConvention(kRuntimeParameterCoreRegisters, 61 kRuntimeParameterCoreRegistersLength, 62 kRuntimeParameterFpuRegisters, 63 kRuntimeParameterFpuRegistersLength, 64 kX86_64PointerSize) {} 65 66 private: 67 DISALLOW_COPY_AND_ASSIGN(InvokeRuntimeCallingConvention); 68}; 69 70class InvokeDexCallingConvention : public CallingConvention<Register, FloatRegister> { 71 public: 72 InvokeDexCallingConvention() : CallingConvention( 73 kParameterCoreRegisters, 74 kParameterCoreRegistersLength, 75 kParameterFloatRegisters, 76 kParameterFloatRegistersLength, 77 kX86_64PointerSize) {} 78 79 private: 80 DISALLOW_COPY_AND_ASSIGN(InvokeDexCallingConvention); 81}; 82 83class FieldAccessCallingConventionX86_64 : public FieldAccessCallingConvention { 84 public: 85 FieldAccessCallingConventionX86_64() {} 86 87 Location GetObjectLocation() const OVERRIDE { 88 return Location::RegisterLocation(RSI); 89 } 90 Location GetFieldIndexLocation() const OVERRIDE { 91 return Location::RegisterLocation(RDI); 92 } 93 Location GetReturnLocation(Primitive::Type type ATTRIBUTE_UNUSED) const OVERRIDE { 94 return Location::RegisterLocation(RAX); 95 } 96 Location GetSetValueLocation(Primitive::Type type, bool is_instance) const OVERRIDE { 97 return Primitive::Is64BitType(type) 98 ? Location::RegisterLocation(RDX) 99 : (is_instance 100 ? Location::RegisterLocation(RDX) 101 : Location::RegisterLocation(RSI)); 102 } 103 Location GetFpuLocation(Primitive::Type type ATTRIBUTE_UNUSED) const OVERRIDE { 104 return Location::FpuRegisterLocation(XMM0); 105 } 106 107 private: 108 DISALLOW_COPY_AND_ASSIGN(FieldAccessCallingConventionX86_64); 109}; 110 111 112class InvokeDexCallingConventionVisitorX86_64 : public InvokeDexCallingConventionVisitor { 113 public: 114 InvokeDexCallingConventionVisitorX86_64() {} 115 virtual ~InvokeDexCallingConventionVisitorX86_64() {} 116 117 Location GetNextLocation(Primitive::Type type) OVERRIDE; 118 Location GetReturnLocation(Primitive::Type type) const OVERRIDE; 119 Location GetMethodLocation() const OVERRIDE; 120 121 private: 122 InvokeDexCallingConvention calling_convention; 123 124 DISALLOW_COPY_AND_ASSIGN(InvokeDexCallingConventionVisitorX86_64); 125}; 126 127class CodeGeneratorX86_64; 128 129class ParallelMoveResolverX86_64 : public ParallelMoveResolverWithSwap { 130 public: 131 ParallelMoveResolverX86_64(ArenaAllocator* allocator, CodeGeneratorX86_64* codegen) 132 : ParallelMoveResolverWithSwap(allocator), codegen_(codegen) {} 133 134 void EmitMove(size_t index) OVERRIDE; 135 void EmitSwap(size_t index) OVERRIDE; 136 void SpillScratch(int reg) OVERRIDE; 137 void RestoreScratch(int reg) OVERRIDE; 138 139 X86_64Assembler* GetAssembler() const; 140 141 private: 142 void Exchange32(CpuRegister reg, int mem); 143 void Exchange32(XmmRegister reg, int mem); 144 void Exchange32(int mem1, int mem2); 145 void Exchange64(CpuRegister reg, int mem); 146 void Exchange64(XmmRegister reg, int mem); 147 void Exchange64(int mem1, int mem2); 148 149 CodeGeneratorX86_64* const codegen_; 150 151 DISALLOW_COPY_AND_ASSIGN(ParallelMoveResolverX86_64); 152}; 153 154class LocationsBuilderX86_64 : public HGraphVisitor { 155 public: 156 LocationsBuilderX86_64(HGraph* graph, CodeGeneratorX86_64* codegen) 157 : HGraphVisitor(graph), codegen_(codegen) {} 158 159#define DECLARE_VISIT_INSTRUCTION(name, super) \ 160 void Visit##name(H##name* instr) OVERRIDE; 161 162 FOR_EACH_CONCRETE_INSTRUCTION_COMMON(DECLARE_VISIT_INSTRUCTION) 163 FOR_EACH_CONCRETE_INSTRUCTION_X86_64(DECLARE_VISIT_INSTRUCTION) 164 165#undef DECLARE_VISIT_INSTRUCTION 166 167 void VisitInstruction(HInstruction* instruction) OVERRIDE { 168 LOG(FATAL) << "Unreachable instruction " << instruction->DebugName() 169 << " (id " << instruction->GetId() << ")"; 170 } 171 172 private: 173 void HandleInvoke(HInvoke* invoke); 174 void HandleBitwiseOperation(HBinaryOperation* operation); 175 void HandleCondition(HCondition* condition); 176 void HandleShift(HBinaryOperation* operation); 177 void HandleFieldSet(HInstruction* instruction, const FieldInfo& field_info); 178 void HandleFieldGet(HInstruction* instruction); 179 180 CodeGeneratorX86_64* const codegen_; 181 InvokeDexCallingConventionVisitorX86_64 parameter_visitor_; 182 183 DISALLOW_COPY_AND_ASSIGN(LocationsBuilderX86_64); 184}; 185 186class InstructionCodeGeneratorX86_64 : public InstructionCodeGenerator { 187 public: 188 InstructionCodeGeneratorX86_64(HGraph* graph, CodeGeneratorX86_64* codegen); 189 190#define DECLARE_VISIT_INSTRUCTION(name, super) \ 191 void Visit##name(H##name* instr) OVERRIDE; 192 193 FOR_EACH_CONCRETE_INSTRUCTION_COMMON(DECLARE_VISIT_INSTRUCTION) 194 FOR_EACH_CONCRETE_INSTRUCTION_X86_64(DECLARE_VISIT_INSTRUCTION) 195 196#undef DECLARE_VISIT_INSTRUCTION 197 198 void VisitInstruction(HInstruction* instruction) OVERRIDE { 199 LOG(FATAL) << "Unreachable instruction " << instruction->DebugName() 200 << " (id " << instruction->GetId() << ")"; 201 } 202 203 X86_64Assembler* GetAssembler() const { return assembler_; } 204 205 private: 206 // Generate code for the given suspend check. If not null, `successor` 207 // is the block to branch to if the suspend check is not needed, and after 208 // the suspend call. 209 void GenerateSuspendCheck(HSuspendCheck* instruction, HBasicBlock* successor); 210 void GenerateClassInitializationCheck(SlowPathCode* slow_path, CpuRegister class_reg); 211 void HandleBitwiseOperation(HBinaryOperation* operation); 212 void GenerateRemFP(HRem* rem); 213 void DivRemOneOrMinusOne(HBinaryOperation* instruction); 214 void DivByPowerOfTwo(HDiv* instruction); 215 void GenerateDivRemWithAnyConstant(HBinaryOperation* instruction); 216 void GenerateDivRemIntegral(HBinaryOperation* instruction); 217 void HandleCondition(HCondition* condition); 218 void HandleShift(HBinaryOperation* operation); 219 220 void HandleFieldSet(HInstruction* instruction, 221 const FieldInfo& field_info, 222 bool value_can_be_null); 223 void HandleFieldGet(HInstruction* instruction, const FieldInfo& field_info); 224 225 // Generate a heap reference load using one register `out`: 226 // 227 // out <- *(out + offset) 228 // 229 // while honoring heap poisoning and/or read barriers (if any). 230 // Register `temp` is used when generating a read barrier. 231 void GenerateReferenceLoadOneRegister(HInstruction* instruction, 232 Location out, 233 uint32_t offset, 234 Location temp); 235 // Generate a heap reference load using two different registers 236 // `out` and `obj`: 237 // 238 // out <- *(obj + offset) 239 // 240 // while honoring heap poisoning and/or read barriers (if any). 241 // Register `temp` is used when generating a Baker's read barrier. 242 void GenerateReferenceLoadTwoRegisters(HInstruction* instruction, 243 Location out, 244 Location obj, 245 uint32_t offset, 246 Location temp); 247 // Generate a GC root reference load: 248 // 249 // root <- *(obj + offset) 250 // 251 // while honoring read barriers (if any). 252 void GenerateGcRootFieldLoad(HInstruction* instruction, 253 Location root, 254 CpuRegister obj, 255 uint32_t offset); 256 257 void GenerateImplicitNullCheck(HNullCheck* instruction); 258 void GenerateExplicitNullCheck(HNullCheck* instruction); 259 void PushOntoFPStack(Location source, uint32_t temp_offset, 260 uint32_t stack_adjustment, bool is_float); 261 template<class LabelType> 262 void GenerateTestAndBranch(HInstruction* instruction, 263 size_t condition_input_index, 264 LabelType* true_target, 265 LabelType* false_target); 266 template<class LabelType> 267 void GenerateCompareTestAndBranch(HCondition* condition, 268 LabelType* true_target, 269 LabelType* false_target); 270 template<class LabelType> 271 void GenerateFPJumps(HCondition* cond, LabelType* true_label, LabelType* false_label); 272 273 void HandleGoto(HInstruction* got, HBasicBlock* successor); 274 275 X86_64Assembler* const assembler_; 276 CodeGeneratorX86_64* const codegen_; 277 278 DISALLOW_COPY_AND_ASSIGN(InstructionCodeGeneratorX86_64); 279}; 280 281// Class for fixups to jump tables. 282class JumpTableRIPFixup; 283 284class CodeGeneratorX86_64 : public CodeGenerator { 285 public: 286 CodeGeneratorX86_64(HGraph* graph, 287 const X86_64InstructionSetFeatures& isa_features, 288 const CompilerOptions& compiler_options, 289 OptimizingCompilerStats* stats = nullptr); 290 virtual ~CodeGeneratorX86_64() {} 291 292 void GenerateFrameEntry() OVERRIDE; 293 void GenerateFrameExit() OVERRIDE; 294 void Bind(HBasicBlock* block) OVERRIDE; 295 void Move(HInstruction* instruction, Location location, HInstruction* move_for) OVERRIDE; 296 void MoveConstant(Location destination, int32_t value) OVERRIDE; 297 void MoveLocation(Location dst, Location src, Primitive::Type dst_type) OVERRIDE; 298 void AddLocationAsTemp(Location location, LocationSummary* locations) OVERRIDE; 299 300 size_t SaveCoreRegister(size_t stack_index, uint32_t reg_id) OVERRIDE; 301 size_t RestoreCoreRegister(size_t stack_index, uint32_t reg_id) OVERRIDE; 302 size_t SaveFloatingPointRegister(size_t stack_index, uint32_t reg_id) OVERRIDE; 303 size_t RestoreFloatingPointRegister(size_t stack_index, uint32_t reg_id) OVERRIDE; 304 305 // Generate code to invoke a runtime entry point. 306 void InvokeRuntime(QuickEntrypointEnum entrypoint, 307 HInstruction* instruction, 308 uint32_t dex_pc, 309 SlowPathCode* slow_path) OVERRIDE; 310 311 void InvokeRuntime(int32_t entry_point_offset, 312 HInstruction* instruction, 313 uint32_t dex_pc, 314 SlowPathCode* slow_path); 315 316 size_t GetWordSize() const OVERRIDE { 317 return kX86_64WordSize; 318 } 319 320 size_t GetFloatingPointSpillSlotSize() const OVERRIDE { 321 return kX86_64WordSize; 322 } 323 324 HGraphVisitor* GetLocationBuilder() OVERRIDE { 325 return &location_builder_; 326 } 327 328 HGraphVisitor* GetInstructionVisitor() OVERRIDE { 329 return &instruction_visitor_; 330 } 331 332 X86_64Assembler* GetAssembler() OVERRIDE { 333 return &assembler_; 334 } 335 336 const X86_64Assembler& GetAssembler() const OVERRIDE { 337 return assembler_; 338 } 339 340 ParallelMoveResolverX86_64* GetMoveResolver() OVERRIDE { 341 return &move_resolver_; 342 } 343 344 uintptr_t GetAddressOf(HBasicBlock* block) const OVERRIDE { 345 return GetLabelOf(block)->Position(); 346 } 347 348 Location GetStackLocation(HLoadLocal* load) const OVERRIDE; 349 350 void SetupBlockedRegisters(bool is_baseline) const OVERRIDE; 351 Location AllocateFreeRegister(Primitive::Type type) const OVERRIDE; 352 void DumpCoreRegister(std::ostream& stream, int reg) const OVERRIDE; 353 void DumpFloatingPointRegister(std::ostream& stream, int reg) const OVERRIDE; 354 void Finalize(CodeAllocator* allocator) OVERRIDE; 355 356 InstructionSet GetInstructionSet() const OVERRIDE { 357 return InstructionSet::kX86_64; 358 } 359 360 // Emit a write barrier. 361 void MarkGCCard(CpuRegister temp, 362 CpuRegister card, 363 CpuRegister object, 364 CpuRegister value, 365 bool value_can_be_null); 366 367 void GenerateMemoryBarrier(MemBarrierKind kind); 368 369 // Helper method to move a value between two locations. 370 void Move(Location destination, Location source); 371 372 Label* GetLabelOf(HBasicBlock* block) const { 373 return CommonGetLabelOf<Label>(block_labels_, block); 374 } 375 376 void Initialize() OVERRIDE { 377 block_labels_ = CommonInitializeLabels<Label>(); 378 } 379 380 bool NeedsTwoRegisters(Primitive::Type type ATTRIBUTE_UNUSED) const OVERRIDE { 381 return false; 382 } 383 384 // Check if the desired_dispatch_info is supported. If it is, return it, 385 // otherwise return a fall-back info that should be used instead. 386 HInvokeStaticOrDirect::DispatchInfo GetSupportedInvokeStaticOrDirectDispatch( 387 const HInvokeStaticOrDirect::DispatchInfo& desired_dispatch_info, 388 MethodReference target_method) OVERRIDE; 389 390 void GenerateStaticOrDirectCall(HInvokeStaticOrDirect* invoke, Location temp) OVERRIDE; 391 void GenerateVirtualCall(HInvokeVirtual* invoke, Location temp) OVERRIDE; 392 393 void MoveFromReturnRegister(Location trg, Primitive::Type type) OVERRIDE; 394 395 void EmitLinkerPatches(ArenaVector<LinkerPatch>* linker_patches) OVERRIDE; 396 397 const X86_64InstructionSetFeatures& GetInstructionSetFeatures() const { 398 return isa_features_; 399 } 400 401 // Fast path implementation of ReadBarrier::Barrier for a heap 402 // reference field load when Baker's read barriers are used. 403 void GenerateFieldLoadWithBakerReadBarrier(HInstruction* instruction, 404 Location out, 405 CpuRegister obj, 406 uint32_t offset, 407 Location temp, 408 bool needs_null_check); 409 // Fast path implementation of ReadBarrier::Barrier for a heap 410 // reference array load when Baker's read barriers are used. 411 void GenerateArrayLoadWithBakerReadBarrier(HInstruction* instruction, 412 Location out, 413 CpuRegister obj, 414 uint32_t data_offset, 415 Location index, 416 Location temp, 417 bool needs_null_check); 418 419 // Generate a read barrier for a heap reference within `instruction` 420 // using a slow path. 421 // 422 // A read barrier for an object reference read from the heap is 423 // implemented as a call to the artReadBarrierSlow runtime entry 424 // point, which is passed the values in locations `ref`, `obj`, and 425 // `offset`: 426 // 427 // mirror::Object* artReadBarrierSlow(mirror::Object* ref, 428 // mirror::Object* obj, 429 // uint32_t offset); 430 // 431 // The `out` location contains the value returned by 432 // artReadBarrierSlow. 433 // 434 // When `index` provided (i.e., when it is different from 435 // Location::NoLocation()), the offset value passed to 436 // artReadBarrierSlow is adjusted to take `index` into account. 437 void GenerateReadBarrierSlow(HInstruction* instruction, 438 Location out, 439 Location ref, 440 Location obj, 441 uint32_t offset, 442 Location index = Location::NoLocation()); 443 444 // If read barriers are enabled, generate a read barrier for a heap 445 // reference using a slow path. If heap poisoning is enabled, also 446 // unpoison the reference in `out`. 447 void MaybeGenerateReadBarrierSlow(HInstruction* instruction, 448 Location out, 449 Location ref, 450 Location obj, 451 uint32_t offset, 452 Location index = Location::NoLocation()); 453 454 // Generate a read barrier for a GC root within `instruction` using 455 // a slow path. 456 // 457 // A read barrier for an object reference GC root is implemented as 458 // a call to the artReadBarrierForRootSlow runtime entry point, 459 // which is passed the value in location `root`: 460 // 461 // mirror::Object* artReadBarrierForRootSlow(GcRoot<mirror::Object>* root); 462 // 463 // The `out` location contains the value returned by 464 // artReadBarrierForRootSlow. 465 void GenerateReadBarrierForRootSlow(HInstruction* instruction, Location out, Location root); 466 467 int ConstantAreaStart() const { 468 return constant_area_start_; 469 } 470 471 Address LiteralDoubleAddress(double v); 472 Address LiteralFloatAddress(float v); 473 Address LiteralInt32Address(int32_t v); 474 Address LiteralInt64Address(int64_t v); 475 476 // Load a 64 bit value into a register in the most efficient manner. 477 void Load64BitValue(CpuRegister dest, int64_t value); 478 Address LiteralCaseTable(HPackedSwitch* switch_instr); 479 480 // Store a 64 bit value into a DoubleStackSlot in the most efficient manner. 481 void Store64BitValueToStack(Location dest, int64_t value); 482 483 // Assign a 64 bit constant to an address. 484 void MoveInt64ToAddress(const Address& addr_low, 485 const Address& addr_high, 486 int64_t v, 487 HInstruction* instruction); 488 489 // Ensure that prior stores complete to memory before subsequent loads. 490 // The locked add implementation will avoid serializing device memory, but will 491 // touch (but not change) the top of the stack. The locked add should not be used for 492 // ordering non-temporal stores. 493 void MemoryFence(bool force_mfence = false) { 494 if (!force_mfence && isa_features_.PrefersLockedAddSynchronization()) { 495 assembler_.lock()->addl(Address(CpuRegister(RSP), 0), Immediate(0)); 496 } else { 497 assembler_.mfence(); 498 } 499 } 500 501 private: 502 // Factored implementation of GenerateFieldLoadWithBakerReadBarrier 503 // and GenerateArrayLoadWithBakerReadBarrier. 504 void GenerateReferenceLoadWithBakerReadBarrier(HInstruction* instruction, 505 Location ref, 506 CpuRegister obj, 507 const Address& src, 508 Location temp, 509 bool needs_null_check); 510 511 struct PcRelativeDexCacheAccessInfo { 512 PcRelativeDexCacheAccessInfo(const DexFile& dex_file, uint32_t element_off) 513 : target_dex_file(dex_file), element_offset(element_off), label() { } 514 515 const DexFile& target_dex_file; 516 uint32_t element_offset; 517 Label label; 518 }; 519 520 // Labels for each block that will be compiled. 521 Label* block_labels_; // Indexed by block id. 522 Label frame_entry_label_; 523 LocationsBuilderX86_64 location_builder_; 524 InstructionCodeGeneratorX86_64 instruction_visitor_; 525 ParallelMoveResolverX86_64 move_resolver_; 526 X86_64Assembler assembler_; 527 const X86_64InstructionSetFeatures& isa_features_; 528 529 // Offset to the start of the constant area in the assembled code. 530 // Used for fixups to the constant area. 531 int constant_area_start_; 532 533 // Method patch info. Using ArenaDeque<> which retains element addresses on push/emplace_back(). 534 ArenaDeque<MethodPatchInfo<Label>> method_patches_; 535 ArenaDeque<MethodPatchInfo<Label>> relative_call_patches_; 536 // PC-relative DexCache access info. 537 ArenaDeque<PcRelativeDexCacheAccessInfo> pc_relative_dex_cache_patches_; 538 539 // When we don't know the proper offset for the value, we use kDummy32BitOffset. 540 // We will fix this up in the linker later to have the right value. 541 static constexpr int32_t kDummy32BitOffset = 256; 542 543 // Fixups for jump tables need to be handled specially. 544 ArenaVector<JumpTableRIPFixup*> fixups_to_jump_tables_; 545 546 DISALLOW_COPY_AND_ASSIGN(CodeGeneratorX86_64); 547}; 548 549} // namespace x86_64 550} // namespace art 551 552#endif // ART_COMPILER_OPTIMIZING_CODE_GENERATOR_X86_64_H_ 553