optimizing_compiler.cc revision 0f7dca4ca0be8d2f8776794d35edf8b51b5bc997
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#include "optimizing_compiler.h" 18 19#include <fstream> 20#include <stdint.h> 21 22#ifdef ART_ENABLE_CODEGEN_arm64 23#include "instruction_simplifier_arm64.h" 24#endif 25 26#ifdef ART_ENABLE_CODEGEN_x86 27#include "pc_relative_fixups_x86.h" 28#endif 29 30#include "art_method-inl.h" 31#include "base/arena_allocator.h" 32#include "base/arena_containers.h" 33#include "base/dumpable.h" 34#include "base/macros.h" 35#include "base/timing_logger.h" 36#include "boolean_simplifier.h" 37#include "bounds_check_elimination.h" 38#include "builder.h" 39#include "code_generator.h" 40#include "compiled_method.h" 41#include "compiler.h" 42#include "constant_folding.h" 43#include "dead_code_elimination.h" 44#include "dex/quick/dex_file_to_method_inliner_map.h" 45#include "dex/verified_method.h" 46#include "dex/verification_results.h" 47#include "driver/compiler_driver.h" 48#include "driver/compiler_driver-inl.h" 49#include "driver/compiler_options.h" 50#include "driver/dex_compilation_unit.h" 51#include "elf_writer_quick.h" 52#include "graph_checker.h" 53#include "graph_visualizer.h" 54#include "gvn.h" 55#include "induction_var_analysis.h" 56#include "inliner.h" 57#include "instruction_simplifier.h" 58#include "intrinsics.h" 59#include "jit/jit_code_cache.h" 60#include "licm.h" 61#include "jni/quick/jni_compiler.h" 62#include "load_store_elimination.h" 63#include "nodes.h" 64#include "prepare_for_register_allocation.h" 65#include "reference_type_propagation.h" 66#include "register_allocator.h" 67#include "sharpening.h" 68#include "side_effects_analysis.h" 69#include "ssa_builder.h" 70#include "ssa_phi_elimination.h" 71#include "ssa_liveness_analysis.h" 72#include "utils/assembler.h" 73#include "verifier/method_verifier.h" 74 75namespace art { 76 77/** 78 * Used by the code generator, to allocate the code in a vector. 79 */ 80class CodeVectorAllocator FINAL : public CodeAllocator { 81 public: 82 explicit CodeVectorAllocator(ArenaAllocator* arena) 83 : memory_(arena->Adapter(kArenaAllocCodeBuffer)), 84 size_(0) {} 85 86 virtual uint8_t* Allocate(size_t size) { 87 size_ = size; 88 memory_.resize(size); 89 return &memory_[0]; 90 } 91 92 size_t GetSize() const { return size_; } 93 const ArenaVector<uint8_t>& GetMemory() const { return memory_; } 94 95 private: 96 ArenaVector<uint8_t> memory_; 97 size_t size_; 98 99 DISALLOW_COPY_AND_ASSIGN(CodeVectorAllocator); 100}; 101 102/** 103 * Filter to apply to the visualizer. Methods whose name contain that filter will 104 * be dumped. 105 */ 106static constexpr const char kStringFilter[] = ""; 107 108class PassScope; 109 110class PassObserver : public ValueObject { 111 public: 112 PassObserver(HGraph* graph, 113 const char* method_name, 114 CodeGenerator* codegen, 115 std::ostream* visualizer_output, 116 CompilerDriver* compiler_driver) 117 : graph_(graph), 118 method_name_(method_name), 119 timing_logger_enabled_(compiler_driver->GetDumpPasses()), 120 timing_logger_(method_name, true, true), 121 disasm_info_(graph->GetArena()), 122 visualizer_enabled_(!compiler_driver->GetDumpCfgFileName().empty()), 123 visualizer_(visualizer_output, graph, *codegen), 124 graph_in_bad_state_(false) { 125 if (timing_logger_enabled_ || visualizer_enabled_) { 126 if (!IsVerboseMethod(compiler_driver, method_name)) { 127 timing_logger_enabled_ = visualizer_enabled_ = false; 128 } 129 if (visualizer_enabled_) { 130 visualizer_.PrintHeader(method_name_); 131 codegen->SetDisassemblyInformation(&disasm_info_); 132 } 133 } 134 } 135 136 ~PassObserver() { 137 if (timing_logger_enabled_) { 138 LOG(INFO) << "TIMINGS " << method_name_; 139 LOG(INFO) << Dumpable<TimingLogger>(timing_logger_); 140 } 141 } 142 143 void DumpDisassembly() const { 144 if (visualizer_enabled_) { 145 visualizer_.DumpGraphWithDisassembly(); 146 } 147 } 148 149 void SetGraphInBadState() { graph_in_bad_state_ = true; } 150 151 private: 152 void StartPass(const char* pass_name) { 153 // Dump graph first, then start timer. 154 if (visualizer_enabled_) { 155 visualizer_.DumpGraph(pass_name, /* is_after_pass */ false, graph_in_bad_state_); 156 } 157 if (timing_logger_enabled_) { 158 timing_logger_.StartTiming(pass_name); 159 } 160 } 161 162 void EndPass(const char* pass_name) { 163 // Pause timer first, then dump graph. 164 if (timing_logger_enabled_) { 165 timing_logger_.EndTiming(); 166 } 167 if (visualizer_enabled_) { 168 visualizer_.DumpGraph(pass_name, /* is_after_pass */ true, graph_in_bad_state_); 169 } 170 171 // Validate the HGraph if running in debug mode. 172 if (kIsDebugBuild) { 173 if (!graph_in_bad_state_) { 174 if (graph_->IsInSsaForm()) { 175 SSAChecker checker(graph_); 176 checker.Run(); 177 if (!checker.IsValid()) { 178 LOG(FATAL) << "Error after " << pass_name << ": " << Dumpable<SSAChecker>(checker); 179 } 180 } else { 181 GraphChecker checker(graph_); 182 checker.Run(); 183 if (!checker.IsValid()) { 184 LOG(FATAL) << "Error after " << pass_name << ": " << Dumpable<GraphChecker>(checker); 185 } 186 } 187 } 188 } 189 } 190 191 static bool IsVerboseMethod(CompilerDriver* compiler_driver, const char* method_name) { 192 // Test an exact match to --verbose-methods. If verbose-methods is set, this overrides an 193 // empty kStringFilter matching all methods. 194 if (compiler_driver->GetCompilerOptions().HasVerboseMethods()) { 195 return compiler_driver->GetCompilerOptions().IsVerboseMethod(method_name); 196 } 197 198 // Test the kStringFilter sub-string. constexpr helper variable to silence unreachable-code 199 // warning when the string is empty. 200 constexpr bool kStringFilterEmpty = arraysize(kStringFilter) <= 1; 201 if (kStringFilterEmpty || strstr(method_name, kStringFilter) != nullptr) { 202 return true; 203 } 204 205 return false; 206 } 207 208 HGraph* const graph_; 209 const char* method_name_; 210 211 bool timing_logger_enabled_; 212 TimingLogger timing_logger_; 213 214 DisassemblyInformation disasm_info_; 215 216 bool visualizer_enabled_; 217 HGraphVisualizer visualizer_; 218 219 // Flag to be set by the compiler if the pass failed and the graph is not 220 // expected to validate. 221 bool graph_in_bad_state_; 222 223 friend PassScope; 224 225 DISALLOW_COPY_AND_ASSIGN(PassObserver); 226}; 227 228class PassScope : public ValueObject { 229 public: 230 PassScope(const char *pass_name, PassObserver* pass_observer) 231 : pass_name_(pass_name), 232 pass_observer_(pass_observer) { 233 pass_observer_->StartPass(pass_name_); 234 } 235 236 ~PassScope() { 237 pass_observer_->EndPass(pass_name_); 238 } 239 240 private: 241 const char* const pass_name_; 242 PassObserver* const pass_observer_; 243}; 244 245class OptimizingCompiler FINAL : public Compiler { 246 public: 247 explicit OptimizingCompiler(CompilerDriver* driver); 248 ~OptimizingCompiler(); 249 250 bool CanCompileMethod(uint32_t method_idx, const DexFile& dex_file, CompilationUnit* cu) const 251 OVERRIDE; 252 253 CompiledMethod* Compile(const DexFile::CodeItem* code_item, 254 uint32_t access_flags, 255 InvokeType invoke_type, 256 uint16_t class_def_idx, 257 uint32_t method_idx, 258 jobject class_loader, 259 const DexFile& dex_file, 260 Handle<mirror::DexCache> dex_cache) const OVERRIDE; 261 262 CompiledMethod* JniCompile(uint32_t access_flags, 263 uint32_t method_idx, 264 const DexFile& dex_file) const OVERRIDE { 265 return ArtQuickJniCompileMethod(GetCompilerDriver(), access_flags, method_idx, dex_file); 266 } 267 268 uintptr_t GetEntryPointOf(ArtMethod* method) const OVERRIDE 269 SHARED_REQUIRES(Locks::mutator_lock_) { 270 return reinterpret_cast<uintptr_t>(method->GetEntryPointFromQuickCompiledCodePtrSize( 271 InstructionSetPointerSize(GetCompilerDriver()->GetInstructionSet()))); 272 } 273 274 void InitCompilationUnit(CompilationUnit& cu) const OVERRIDE; 275 276 void Init() OVERRIDE; 277 278 void UnInit() const OVERRIDE; 279 280 void MaybeRecordStat(MethodCompilationStat compilation_stat) const { 281 if (compilation_stats_.get() != nullptr) { 282 compilation_stats_->RecordStat(compilation_stat); 283 } 284 } 285 286 bool JitCompile(Thread* self, jit::JitCodeCache* code_cache, ArtMethod* method) 287 OVERRIDE 288 SHARED_REQUIRES(Locks::mutator_lock_); 289 290 private: 291 // Whether we should run any optimization or register allocation. If false, will 292 // just run the code generation after the graph was built. 293 const bool run_optimizations_; 294 295 // Create a 'CompiledMethod' for an optimized graph. 296 CompiledMethod* EmitOptimized(ArenaAllocator* arena, 297 CodeVectorAllocator* code_allocator, 298 CodeGenerator* codegen, 299 CompilerDriver* driver) const; 300 301 // Create a 'CompiledMethod' for a non-optimized graph. 302 CompiledMethod* EmitBaseline(ArenaAllocator* arena, 303 CodeVectorAllocator* code_allocator, 304 CodeGenerator* codegen, 305 CompilerDriver* driver) const; 306 307 // Try compiling a method and return the code generator used for 308 // compiling it. 309 // This method: 310 // 1) Builds the graph. Returns null if it failed to build it. 311 // 2) If `run_optimizations_` is set: 312 // 2.1) Transform the graph to SSA. Returns null if it failed. 313 // 2.2) Run optimizations on the graph, including register allocator. 314 // 3) Generate code with the `code_allocator` provided. 315 CodeGenerator* TryCompile(ArenaAllocator* arena, 316 CodeVectorAllocator* code_allocator, 317 const DexFile::CodeItem* code_item, 318 uint32_t access_flags, 319 InvokeType invoke_type, 320 uint16_t class_def_idx, 321 uint32_t method_idx, 322 jobject class_loader, 323 const DexFile& dex_file, 324 Handle<mirror::DexCache> dex_cache) const; 325 326 std::unique_ptr<OptimizingCompilerStats> compilation_stats_; 327 328 std::unique_ptr<std::ostream> visualizer_output_; 329 330 DISALLOW_COPY_AND_ASSIGN(OptimizingCompiler); 331}; 332 333static const int kMaximumCompilationTimeBeforeWarning = 100; /* ms */ 334 335OptimizingCompiler::OptimizingCompiler(CompilerDriver* driver) 336 : Compiler(driver, kMaximumCompilationTimeBeforeWarning), 337 run_optimizations_( 338 driver->GetCompilerOptions().GetCompilerFilter() != CompilerOptions::kTime) {} 339 340void OptimizingCompiler::Init() { 341 // Enable C1visualizer output. Must be done in Init() because the compiler 342 // driver is not fully initialized when passed to the compiler's constructor. 343 CompilerDriver* driver = GetCompilerDriver(); 344 const std::string cfg_file_name = driver->GetDumpCfgFileName(); 345 if (!cfg_file_name.empty()) { 346 CHECK_EQ(driver->GetThreadCount(), 1U) 347 << "Graph visualizer requires the compiler to run single-threaded. " 348 << "Invoke the compiler with '-j1'."; 349 std::ios_base::openmode cfg_file_mode = 350 driver->GetDumpCfgAppend() ? std::ofstream::app : std::ofstream::out; 351 visualizer_output_.reset(new std::ofstream(cfg_file_name, cfg_file_mode)); 352 } 353 if (driver->GetDumpStats()) { 354 compilation_stats_.reset(new OptimizingCompilerStats()); 355 } 356} 357 358void OptimizingCompiler::UnInit() const { 359} 360 361OptimizingCompiler::~OptimizingCompiler() { 362 if (compilation_stats_.get() != nullptr) { 363 compilation_stats_->Log(); 364 } 365} 366 367void OptimizingCompiler::InitCompilationUnit(CompilationUnit& cu ATTRIBUTE_UNUSED) const { 368} 369 370bool OptimizingCompiler::CanCompileMethod(uint32_t method_idx ATTRIBUTE_UNUSED, 371 const DexFile& dex_file ATTRIBUTE_UNUSED, 372 CompilationUnit* cu ATTRIBUTE_UNUSED) const { 373 return true; 374} 375 376static bool IsInstructionSetSupported(InstructionSet instruction_set) { 377 return (instruction_set == kArm && !kArm32QuickCodeUseSoftFloat) 378 || instruction_set == kArm64 379 || (instruction_set == kThumb2 && !kArm32QuickCodeUseSoftFloat) 380 || instruction_set == kMips 381 || instruction_set == kMips64 382 || instruction_set == kX86 383 || instruction_set == kX86_64; 384} 385 386static void RunOptimizations(HOptimization* optimizations[], 387 size_t length, 388 PassObserver* pass_observer) { 389 for (size_t i = 0; i < length; ++i) { 390 PassScope scope(optimizations[i]->GetPassName(), pass_observer); 391 optimizations[i]->Run(); 392 } 393} 394 395static void MaybeRunInliner(HGraph* graph, 396 CodeGenerator* codegen, 397 CompilerDriver* driver, 398 OptimizingCompilerStats* stats, 399 const DexCompilationUnit& dex_compilation_unit, 400 PassObserver* pass_observer, 401 StackHandleScopeCollection* handles) { 402 const CompilerOptions& compiler_options = driver->GetCompilerOptions(); 403 bool should_inline = (compiler_options.GetInlineDepthLimit() > 0) 404 && (compiler_options.GetInlineMaxCodeUnits() > 0); 405 if (!should_inline) { 406 return; 407 } 408 409 ArenaAllocator* arena = graph->GetArena(); 410 HInliner* inliner = new (arena) HInliner( 411 graph, codegen, dex_compilation_unit, dex_compilation_unit, driver, handles, stats); 412 ReferenceTypePropagation* type_propagation = 413 new (arena) ReferenceTypePropagation(graph, handles, 414 "reference_type_propagation_after_inlining"); 415 416 HOptimization* optimizations[] = { 417 inliner, 418 // Run another type propagation phase: inlining will open up more opportunities 419 // to remove checkcast/instanceof and null checks. 420 type_propagation, 421 }; 422 423 RunOptimizations(optimizations, arraysize(optimizations), pass_observer); 424} 425 426static void RunArchOptimizations(InstructionSet instruction_set, 427 HGraph* graph, 428 OptimizingCompilerStats* stats, 429 PassObserver* pass_observer) { 430 ArenaAllocator* arena = graph->GetArena(); 431 switch (instruction_set) { 432#ifdef ART_ENABLE_CODEGEN_arm64 433 case kArm64: { 434 arm64::InstructionSimplifierArm64* simplifier = 435 new (arena) arm64::InstructionSimplifierArm64(graph, stats); 436 SideEffectsAnalysis* side_effects = new (arena) SideEffectsAnalysis(graph); 437 GVNOptimization* gvn = new (arena) GVNOptimization(graph, *side_effects, "GVN_after_arch"); 438 HOptimization* arm64_optimizations[] = { 439 simplifier, 440 side_effects, 441 gvn 442 }; 443 RunOptimizations(arm64_optimizations, arraysize(arm64_optimizations), pass_observer); 444 break; 445 } 446#endif 447#ifdef ART_ENABLE_CODEGEN_x86 448 case kX86: { 449 x86::PcRelativeFixups* pc_relative_fixups = new (arena) x86::PcRelativeFixups(graph, stats); 450 HOptimization* x86_optimizations[] = { 451 pc_relative_fixups 452 }; 453 RunOptimizations(x86_optimizations, arraysize(x86_optimizations), pass_observer); 454 break; 455 } 456#endif 457 default: 458 break; 459 } 460} 461 462NO_INLINE // Avoid increasing caller's frame size by large stack-allocated objects. 463static void AllocateRegisters(HGraph* graph, 464 CodeGenerator* codegen, 465 PassObserver* pass_observer) { 466 PrepareForRegisterAllocation(graph).Run(); 467 SsaLivenessAnalysis liveness(graph, codegen); 468 { 469 PassScope scope(SsaLivenessAnalysis::kLivenessPassName, pass_observer); 470 liveness.Analyze(); 471 } 472 { 473 PassScope scope(RegisterAllocator::kRegisterAllocatorPassName, pass_observer); 474 RegisterAllocator(graph->GetArena(), codegen, liveness).AllocateRegisters(); 475 } 476} 477 478static void RunOptimizations(HGraph* graph, 479 CodeGenerator* codegen, 480 CompilerDriver* driver, 481 OptimizingCompilerStats* stats, 482 const DexCompilationUnit& dex_compilation_unit, 483 PassObserver* pass_observer) { 484 ScopedObjectAccess soa(Thread::Current()); 485 StackHandleScopeCollection handles(soa.Self()); 486 ScopedThreadSuspension sts(soa.Self(), kNative); 487 488 ArenaAllocator* arena = graph->GetArena(); 489 HDeadCodeElimination* dce1 = new (arena) HDeadCodeElimination( 490 graph, stats, HDeadCodeElimination::kInitialDeadCodeEliminationPassName); 491 HDeadCodeElimination* dce2 = new (arena) HDeadCodeElimination( 492 graph, stats, HDeadCodeElimination::kFinalDeadCodeEliminationPassName); 493 HConstantFolding* fold1 = new (arena) HConstantFolding(graph); 494 InstructionSimplifier* simplify1 = new (arena) InstructionSimplifier(graph, stats); 495 HBooleanSimplifier* boolean_simplify = new (arena) HBooleanSimplifier(graph); 496 HConstantFolding* fold2 = new (arena) HConstantFolding(graph, "constant_folding_after_inlining"); 497 SideEffectsAnalysis* side_effects = new (arena) SideEffectsAnalysis(graph); 498 GVNOptimization* gvn = new (arena) GVNOptimization(graph, *side_effects); 499 LICM* licm = new (arena) LICM(graph, *side_effects); 500 LoadStoreElimination* lse = new (arena) LoadStoreElimination(graph, *side_effects); 501 HInductionVarAnalysis* induction = new (arena) HInductionVarAnalysis(graph); 502 BoundsCheckElimination* bce = new (arena) BoundsCheckElimination(graph, induction); 503 ReferenceTypePropagation* type_propagation = 504 new (arena) ReferenceTypePropagation(graph, &handles); 505 HSharpening* sharpening = new (arena) HSharpening(graph, codegen, dex_compilation_unit, driver); 506 InstructionSimplifier* simplify2 = new (arena) InstructionSimplifier( 507 graph, stats, "instruction_simplifier_after_types"); 508 InstructionSimplifier* simplify3 = new (arena) InstructionSimplifier( 509 graph, stats, "instruction_simplifier_after_bce"); 510 InstructionSimplifier* simplify4 = new (arena) InstructionSimplifier( 511 graph, stats, "instruction_simplifier_before_codegen"); 512 513 IntrinsicsRecognizer* intrinsics = new (arena) IntrinsicsRecognizer(graph, driver); 514 515 HOptimization* optimizations1[] = { 516 intrinsics, 517 fold1, 518 simplify1, 519 type_propagation, 520 sharpening, 521 dce1, 522 simplify2 523 }; 524 525 RunOptimizations(optimizations1, arraysize(optimizations1), pass_observer); 526 527 MaybeRunInliner(graph, codegen, driver, stats, dex_compilation_unit, pass_observer, &handles); 528 529 // TODO: Update passes incompatible with try/catch so we have the same 530 // pipeline for all methods. 531 if (graph->HasTryCatch()) { 532 HOptimization* optimizations2[] = { 533 side_effects, 534 gvn, 535 dce2, 536 // The codegen has a few assumptions that only the instruction simplifier 537 // can satisfy. For example, the code generator does not expect to see a 538 // HTypeConversion from a type to the same type. 539 simplify4, 540 }; 541 542 RunOptimizations(optimizations2, arraysize(optimizations2), pass_observer); 543 } else { 544 HOptimization* optimizations2[] = { 545 // BooleanSimplifier depends on the InstructionSimplifier removing 546 // redundant suspend checks to recognize empty blocks. 547 boolean_simplify, 548 fold2, // TODO: if we don't inline we can also skip fold2. 549 side_effects, 550 gvn, 551 licm, 552 induction, 553 bce, 554 simplify3, 555 lse, 556 dce2, 557 // The codegen has a few assumptions that only the instruction simplifier 558 // can satisfy. For example, the code generator does not expect to see a 559 // HTypeConversion from a type to the same type. 560 simplify4, 561 }; 562 563 RunOptimizations(optimizations2, arraysize(optimizations2), pass_observer); 564 } 565 566 RunArchOptimizations(driver->GetInstructionSet(), graph, stats, pass_observer); 567 AllocateRegisters(graph, codegen, pass_observer); 568} 569 570// The stack map we generate must be 4-byte aligned on ARM. Since existing 571// maps are generated alongside these stack maps, we must also align them. 572static ArrayRef<const uint8_t> AlignVectorSize(ArenaVector<uint8_t>& vector) { 573 size_t size = vector.size(); 574 size_t aligned_size = RoundUp(size, 4); 575 for (; size < aligned_size; ++size) { 576 vector.push_back(0); 577 } 578 return ArrayRef<const uint8_t>(vector); 579} 580 581static ArenaVector<LinkerPatch> EmitAndSortLinkerPatches(CodeGenerator* codegen) { 582 ArenaVector<LinkerPatch> linker_patches(codegen->GetGraph()->GetArena()->Adapter()); 583 codegen->EmitLinkerPatches(&linker_patches); 584 585 // Sort patches by literal offset. Required for .oat_patches encoding. 586 std::sort(linker_patches.begin(), linker_patches.end(), 587 [](const LinkerPatch& lhs, const LinkerPatch& rhs) { 588 return lhs.LiteralOffset() < rhs.LiteralOffset(); 589 }); 590 591 return linker_patches; 592} 593 594CompiledMethod* OptimizingCompiler::EmitOptimized(ArenaAllocator* arena, 595 CodeVectorAllocator* code_allocator, 596 CodeGenerator* codegen, 597 CompilerDriver* compiler_driver) const { 598 ArenaVector<LinkerPatch> linker_patches = EmitAndSortLinkerPatches(codegen); 599 ArenaVector<uint8_t> stack_map(arena->Adapter(kArenaAllocStackMaps)); 600 stack_map.resize(codegen->ComputeStackMapsSize()); 601 codegen->BuildStackMaps(MemoryRegion(stack_map.data(), stack_map.size())); 602 603 MaybeRecordStat(MethodCompilationStat::kCompiledOptimized); 604 605 CompiledMethod* compiled_method = CompiledMethod::SwapAllocCompiledMethod( 606 compiler_driver, 607 codegen->GetInstructionSet(), 608 ArrayRef<const uint8_t>(code_allocator->GetMemory()), 609 // Follow Quick's behavior and set the frame size to zero if it is 610 // considered "empty" (see the definition of 611 // art::CodeGenerator::HasEmptyFrame). 612 codegen->HasEmptyFrame() ? 0 : codegen->GetFrameSize(), 613 codegen->GetCoreSpillMask(), 614 codegen->GetFpuSpillMask(), 615 ArrayRef<const SrcMapElem>(codegen->GetSrcMappingTable()), 616 ArrayRef<const uint8_t>(), // mapping_table. 617 ArrayRef<const uint8_t>(stack_map), 618 ArrayRef<const uint8_t>(), // native_gc_map. 619 ArrayRef<const uint8_t>(*codegen->GetAssembler()->cfi().data()), 620 ArrayRef<const LinkerPatch>(linker_patches)); 621 622 return compiled_method; 623} 624 625CompiledMethod* OptimizingCompiler::EmitBaseline( 626 ArenaAllocator* arena, 627 CodeVectorAllocator* code_allocator, 628 CodeGenerator* codegen, 629 CompilerDriver* compiler_driver) const { 630 ArenaVector<LinkerPatch> linker_patches = EmitAndSortLinkerPatches(codegen); 631 632 ArenaVector<uint8_t> mapping_table(arena->Adapter(kArenaAllocBaselineMaps)); 633 codegen->BuildMappingTable(&mapping_table); 634 ArenaVector<uint8_t> vmap_table(arena->Adapter(kArenaAllocBaselineMaps)); 635 codegen->BuildVMapTable(&vmap_table); 636 ArenaVector<uint8_t> gc_map(arena->Adapter(kArenaAllocBaselineMaps)); 637 codegen->BuildNativeGCMap(&gc_map, *compiler_driver); 638 639 MaybeRecordStat(MethodCompilationStat::kCompiledBaseline); 640 CompiledMethod* compiled_method = CompiledMethod::SwapAllocCompiledMethod( 641 compiler_driver, 642 codegen->GetInstructionSet(), 643 ArrayRef<const uint8_t>(code_allocator->GetMemory()), 644 // Follow Quick's behavior and set the frame size to zero if it is 645 // considered "empty" (see the definition of 646 // art::CodeGenerator::HasEmptyFrame). 647 codegen->HasEmptyFrame() ? 0 : codegen->GetFrameSize(), 648 codegen->GetCoreSpillMask(), 649 codegen->GetFpuSpillMask(), 650 ArrayRef<const SrcMapElem>(codegen->GetSrcMappingTable()), 651 AlignVectorSize(mapping_table), 652 AlignVectorSize(vmap_table), 653 AlignVectorSize(gc_map), 654 ArrayRef<const uint8_t>(*codegen->GetAssembler()->cfi().data()), 655 ArrayRef<const LinkerPatch>(linker_patches)); 656 return compiled_method; 657} 658 659CodeGenerator* OptimizingCompiler::TryCompile(ArenaAllocator* arena, 660 CodeVectorAllocator* code_allocator, 661 const DexFile::CodeItem* code_item, 662 uint32_t access_flags, 663 InvokeType invoke_type, 664 uint16_t class_def_idx, 665 uint32_t method_idx, 666 jobject class_loader, 667 const DexFile& dex_file, 668 Handle<mirror::DexCache> dex_cache) const { 669 std::string method_name = PrettyMethod(method_idx, dex_file); 670 MaybeRecordStat(MethodCompilationStat::kAttemptCompilation); 671 CompilerDriver* compiler_driver = GetCompilerDriver(); 672 InstructionSet instruction_set = compiler_driver->GetInstructionSet(); 673 674 // Always use the thumb2 assembler: some runtime functionality (like implicit stack 675 // overflow checks) assume thumb2. 676 if (instruction_set == kArm) { 677 instruction_set = kThumb2; 678 } 679 680 // Do not attempt to compile on architectures we do not support. 681 if (!IsInstructionSetSupported(instruction_set)) { 682 MaybeRecordStat(MethodCompilationStat::kNotCompiledUnsupportedIsa); 683 return nullptr; 684 } 685 686 if (Compiler::IsPathologicalCase(*code_item, method_idx, dex_file)) { 687 MaybeRecordStat(MethodCompilationStat::kNotCompiledPathological); 688 return nullptr; 689 } 690 691 // Implementation of the space filter: do not compile a code item whose size in 692 // code units is bigger than 128. 693 static constexpr size_t kSpaceFilterOptimizingThreshold = 128; 694 const CompilerOptions& compiler_options = compiler_driver->GetCompilerOptions(); 695 if ((compiler_options.GetCompilerFilter() == CompilerOptions::kSpace) 696 && (code_item->insns_size_in_code_units_ > kSpaceFilterOptimizingThreshold)) { 697 MaybeRecordStat(MethodCompilationStat::kNotCompiledSpaceFilter); 698 return nullptr; 699 } 700 701 DexCompilationUnit dex_compilation_unit( 702 nullptr, class_loader, Runtime::Current()->GetClassLinker(), dex_file, code_item, 703 class_def_idx, method_idx, access_flags, 704 compiler_driver->GetVerifiedMethod(&dex_file, method_idx), dex_cache); 705 706 bool requires_barrier = dex_compilation_unit.IsConstructor() 707 && compiler_driver->RequiresConstructorBarrier(Thread::Current(), 708 dex_compilation_unit.GetDexFile(), 709 dex_compilation_unit.GetClassDefIndex()); 710 HGraph* graph = new (arena) HGraph( 711 arena, dex_file, method_idx, requires_barrier, compiler_driver->GetInstructionSet(), 712 kInvalidInvokeType, compiler_driver->GetCompilerOptions().GetDebuggable()); 713 714 std::unique_ptr<CodeGenerator> codegen( 715 CodeGenerator::Create(graph, 716 instruction_set, 717 *compiler_driver->GetInstructionSetFeatures(), 718 compiler_driver->GetCompilerOptions())); 719 if (codegen.get() == nullptr) { 720 MaybeRecordStat(MethodCompilationStat::kNotCompiledNoCodegen); 721 return nullptr; 722 } 723 codegen->GetAssembler()->cfi().SetEnabled( 724 compiler_driver->GetCompilerOptions().GetGenerateDebugInfo()); 725 726 PassObserver pass_observer(graph, 727 method_name.c_str(), 728 codegen.get(), 729 visualizer_output_.get(), 730 compiler_driver); 731 732 const uint8_t* interpreter_metadata = nullptr; 733 { 734 ScopedObjectAccess soa(Thread::Current()); 735 StackHandleScope<1> hs(soa.Self()); 736 Handle<mirror::ClassLoader> loader(hs.NewHandle( 737 soa.Decode<mirror::ClassLoader*>(class_loader))); 738 ArtMethod* art_method = compiler_driver->ResolveMethod( 739 soa, dex_cache, loader, &dex_compilation_unit, method_idx, invoke_type); 740 // We may not get a method, for example if its class is erroneous. 741 // TODO: Clean this up, the compiler driver should just pass the ArtMethod to compile. 742 if (art_method != nullptr) { 743 interpreter_metadata = art_method->GetQuickenedInfo(); 744 } 745 } 746 HGraphBuilder builder(graph, 747 &dex_compilation_unit, 748 &dex_compilation_unit, 749 &dex_file, 750 compiler_driver, 751 compilation_stats_.get(), 752 interpreter_metadata, 753 dex_cache); 754 755 VLOG(compiler) << "Building " << method_name; 756 757 { 758 PassScope scope(HGraphBuilder::kBuilderPassName, &pass_observer); 759 if (!builder.BuildGraph(*code_item)) { 760 pass_observer.SetGraphInBadState(); 761 return nullptr; 762 } 763 } 764 765 VLOG(compiler) << "Optimizing " << method_name; 766 if (run_optimizations_) { 767 { 768 PassScope scope(SsaBuilder::kSsaBuilderPassName, &pass_observer); 769 if (!graph->TryBuildingSsa()) { 770 // We could not transform the graph to SSA, bailout. 771 LOG(INFO) << "Skipping compilation of " << method_name << ": it contains a non natural loop"; 772 MaybeRecordStat(MethodCompilationStat::kNotCompiledCannotBuildSSA); 773 pass_observer.SetGraphInBadState(); 774 return nullptr; 775 } 776 } 777 778 RunOptimizations(graph, 779 codegen.get(), 780 compiler_driver, 781 compilation_stats_.get(), 782 dex_compilation_unit, 783 &pass_observer); 784 codegen->CompileOptimized(code_allocator); 785 } else { 786 codegen->CompileBaseline(code_allocator); 787 } 788 pass_observer.DumpDisassembly(); 789 790 if (kArenaAllocatorCountAllocations) { 791 if (arena->BytesAllocated() > 4 * MB) { 792 MemStats mem_stats(arena->GetMemStats()); 793 LOG(INFO) << PrettyMethod(method_idx, dex_file) << " " << Dumpable<MemStats>(mem_stats); 794 } 795 } 796 797 return codegen.release(); 798} 799 800static bool CanHandleVerificationFailure(const VerifiedMethod* verified_method) { 801 // For access errors the compiler will use the unresolved helpers (e.g. HInvokeUnresolved). 802 uint32_t unresolved_mask = verifier::VerifyError::VERIFY_ERROR_NO_CLASS 803 | verifier::VerifyError::VERIFY_ERROR_ACCESS_CLASS 804 | verifier::VerifyError::VERIFY_ERROR_ACCESS_FIELD 805 | verifier::VerifyError::VERIFY_ERROR_ACCESS_METHOD; 806 return (verified_method->GetEncounteredVerificationFailures() & (~unresolved_mask)) == 0; 807} 808 809CompiledMethod* OptimizingCompiler::Compile(const DexFile::CodeItem* code_item, 810 uint32_t access_flags, 811 InvokeType invoke_type, 812 uint16_t class_def_idx, 813 uint32_t method_idx, 814 jobject jclass_loader, 815 const DexFile& dex_file, 816 Handle<mirror::DexCache> dex_cache) const { 817 CompilerDriver* compiler_driver = GetCompilerDriver(); 818 CompiledMethod* method = nullptr; 819 DCHECK(Runtime::Current()->IsAotCompiler()); 820 const VerifiedMethod* verified_method = compiler_driver->GetVerifiedMethod(&dex_file, method_idx); 821 DCHECK(!verified_method->HasRuntimeThrow()); 822 if (compiler_driver->IsMethodVerifiedWithoutFailures(method_idx, class_def_idx, dex_file) 823 || CanHandleVerificationFailure(verified_method)) { 824 ArenaAllocator arena(Runtime::Current()->GetArenaPool()); 825 CodeVectorAllocator code_allocator(&arena); 826 std::unique_ptr<CodeGenerator> codegen( 827 TryCompile(&arena, 828 &code_allocator, 829 code_item, 830 access_flags, 831 invoke_type, 832 class_def_idx, 833 method_idx, 834 jclass_loader, 835 dex_file, 836 dex_cache)); 837 if (codegen.get() != nullptr) { 838 if (run_optimizations_) { 839 method = EmitOptimized(&arena, &code_allocator, codegen.get(), compiler_driver); 840 } else { 841 method = EmitBaseline(&arena, &code_allocator, codegen.get(), compiler_driver); 842 } 843 } 844 } else { 845 if (compiler_driver->GetCompilerOptions().VerifyAtRuntime()) { 846 MaybeRecordStat(MethodCompilationStat::kNotCompiledVerifyAtRuntime); 847 } else { 848 MaybeRecordStat(MethodCompilationStat::kNotCompiledClassNotVerified); 849 } 850 } 851 852 if (kIsDebugBuild && 853 IsCompilingWithCoreImage() && 854 IsInstructionSetSupported(compiler_driver->GetInstructionSet())) { 855 // For testing purposes, we put a special marker on method names that should be compiled 856 // with this compiler. This makes sure we're not regressing. 857 std::string method_name = PrettyMethod(method_idx, dex_file); 858 bool shouldCompile = method_name.find("$opt$") != std::string::npos; 859 DCHECK((method != nullptr) || !shouldCompile) << "Didn't compile " << method_name; 860 } 861 862 return method; 863} 864 865Compiler* CreateOptimizingCompiler(CompilerDriver* driver) { 866 return new OptimizingCompiler(driver); 867} 868 869bool IsCompilingWithCoreImage() { 870 const std::string& image = Runtime::Current()->GetImageLocation(); 871 return EndsWith(image, "core.art") || EndsWith(image, "core-optimizing.art"); 872} 873 874bool OptimizingCompiler::JitCompile(Thread* self, 875 jit::JitCodeCache* code_cache, 876 ArtMethod* method) { 877 StackHandleScope<2> hs(self); 878 Handle<mirror::ClassLoader> class_loader(hs.NewHandle( 879 method->GetDeclaringClass()->GetClassLoader())); 880 Handle<mirror::DexCache> dex_cache(hs.NewHandle(method->GetDexCache())); 881 882 jobject jclass_loader = class_loader.ToJObject(); 883 const DexFile* dex_file = method->GetDexFile(); 884 const uint16_t class_def_idx = method->GetClassDefIndex(); 885 const DexFile::CodeItem* code_item = dex_file->GetCodeItem(method->GetCodeItemOffset()); 886 const uint32_t method_idx = method->GetDexMethodIndex(); 887 const uint32_t access_flags = method->GetAccessFlags(); 888 const InvokeType invoke_type = method->GetInvokeType(); 889 890 ArenaAllocator arena(Runtime::Current()->GetArenaPool()); 891 CodeVectorAllocator code_allocator(&arena); 892 std::unique_ptr<CodeGenerator> codegen; 893 { 894 // Go to native so that we don't block GC during compilation. 895 ScopedThreadSuspension sts(self, kNative); 896 897 DCHECK(run_optimizations_); 898 codegen.reset( 899 TryCompile(&arena, 900 &code_allocator, 901 code_item, 902 access_flags, 903 invoke_type, 904 class_def_idx, 905 method_idx, 906 jclass_loader, 907 *dex_file, 908 dex_cache)); 909 if (codegen.get() == nullptr) { 910 return false; 911 } 912 } 913 914 size_t stack_map_size = codegen->ComputeStackMapsSize(); 915 uint8_t* stack_map_data = code_cache->ReserveData(self, stack_map_size); 916 if (stack_map_data == nullptr) { 917 return false; 918 } 919 codegen->BuildStackMaps(MemoryRegion(stack_map_data, stack_map_size)); 920 const void* code = code_cache->CommitCode( 921 self, 922 method, 923 nullptr, 924 stack_map_data, 925 nullptr, 926 codegen->HasEmptyFrame() ? 0 : codegen->GetFrameSize(), 927 codegen->GetCoreSpillMask(), 928 codegen->GetFpuSpillMask(), 929 code_allocator.GetMemory().data(), 930 code_allocator.GetSize()); 931 932 if (code == nullptr) { 933 code_cache->ClearData(self, stack_map_data); 934 return false; 935 } 936 937 return true; 938} 939 940} // namespace art 941