compiler_driver.h revision 26318f722958ac1cba6a812026a1377f37c54941
1/* 2 * Copyright (C) 2011 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_DRIVER_COMPILER_DRIVER_H_ 18#define ART_COMPILER_DRIVER_COMPILER_DRIVER_H_ 19 20#include <set> 21#include <string> 22#include <vector> 23 24#include "base/mutex.h" 25#include "base/timing_logger.h" 26#include "class_reference.h" 27#include "compiled_method.h" 28#include "compiler.h" 29#include "dex_file.h" 30#include "driver/compiler_options.h" 31#include "instruction_set.h" 32#include "invoke_type.h" 33#include "method_reference.h" 34#include "mirror/class.h" // For mirror::Class::Status. 35#include "os.h" 36#include "profiler.h" 37#include "runtime.h" 38#include "safe_map.h" 39#include "thread_pool.h" 40#include "utils/arena_allocator.h" 41#include "utils/dedupe_set.h" 42 43namespace art { 44 45namespace verifier { 46class MethodVerifier; 47} // namespace verifier 48 49class CompiledClass; 50class CompilerOptions; 51class DexCompilationUnit; 52class DexFileToMethodInlinerMap; 53struct InlineIGetIPutData; 54class OatWriter; 55class ParallelCompilationManager; 56class ScopedObjectAccess; 57template<class T> class Handle; 58class TimingLogger; 59class VerificationResults; 60class VerifiedMethod; 61 62enum EntryPointCallingConvention { 63 // ABI of invocations to a method's interpreter entry point. 64 kInterpreterAbi, 65 // ABI of calls to a method's native code, only used for native methods. 66 kJniAbi, 67 // ABI of calls to a method's portable code entry point. 68 kPortableAbi, 69 // ABI of calls to a method's quick code entry point. 70 kQuickAbi 71}; 72 73enum DexToDexCompilationLevel { 74 kDontDexToDexCompile, // Only meaning wrt image time interpretation. 75 kRequired, // Dex-to-dex compilation required for correctness. 76 kOptimize // Perform required transformation and peep-hole optimizations. 77}; 78 79// Thread-local storage compiler worker threads 80class CompilerTls { 81 public: 82 CompilerTls() : llvm_info_(nullptr) {} 83 ~CompilerTls() {} 84 85 void* GetLLVMInfo() { return llvm_info_; } 86 87 void SetLLVMInfo(void* llvm_info) { llvm_info_ = llvm_info; } 88 89 private: 90 void* llvm_info_; 91}; 92 93class CompilerDriver { 94 public: 95 // Create a compiler targeting the requested "instruction_set". 96 // "image" should be true if image specific optimizations should be 97 // enabled. "image_classes" lets the compiler know what classes it 98 // can assume will be in the image, with nullptr implying all available 99 // classes. 100 explicit CompilerDriver(const CompilerOptions* compiler_options, 101 VerificationResults* verification_results, 102 DexFileToMethodInlinerMap* method_inliner_map, 103 Compiler::Kind compiler_kind, 104 InstructionSet instruction_set, 105 InstructionSetFeatures instruction_set_features, 106 bool image, std::set<std::string>* image_classes, 107 std::set<std::string>* compiled_classes, 108 size_t thread_count, bool dump_stats, bool dump_passes, 109 CumulativeLogger* timer, std::string profile_file = ""); 110 111 ~CompilerDriver(); 112 113 void CompileAll(jobject class_loader, const std::vector<const DexFile*>& dex_files, 114 TimingLogger* timings) 115 LOCKS_EXCLUDED(Locks::mutator_lock_); 116 117 // Compile a single Method. 118 void CompileOne(mirror::ArtMethod* method, TimingLogger* timings) 119 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 120 121 VerificationResults* GetVerificationResults() const { 122 return verification_results_; 123 } 124 125 DexFileToMethodInlinerMap* GetMethodInlinerMap() const { 126 return method_inliner_map_; 127 } 128 129 InstructionSet GetInstructionSet() const { 130 return instruction_set_; 131 } 132 133 InstructionSetFeatures GetInstructionSetFeatures() const { 134 return instruction_set_features_; 135 } 136 137 const CompilerOptions& GetCompilerOptions() const { 138 return *compiler_options_; 139 } 140 141 Compiler* GetCompiler() const { 142 return compiler_.get(); 143 } 144 145 bool ProfilePresent() const { 146 return profile_present_; 147 } 148 149 // Are we compiling and creating an image file? 150 bool IsImage() const { 151 return image_; 152 } 153 154 const std::set<std::string>* GetImageClasses() const { 155 return image_classes_.get(); 156 } 157 158 CompilerTls* GetTls(); 159 160 // Generate the trampolines that are invoked by unresolved direct methods. 161 const std::vector<uint8_t>* CreateInterpreterToInterpreterBridge() const 162 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 163 const std::vector<uint8_t>* CreateInterpreterToCompiledCodeBridge() const 164 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 165 const std::vector<uint8_t>* CreateJniDlsymLookup() const 166 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 167 const std::vector<uint8_t>* CreatePortableImtConflictTrampoline() const 168 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 169 const std::vector<uint8_t>* CreatePortableResolutionTrampoline() const 170 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 171 const std::vector<uint8_t>* CreatePortableToInterpreterBridge() const 172 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 173 const std::vector<uint8_t>* CreateQuickGenericJniTrampoline() const 174 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 175 const std::vector<uint8_t>* CreateQuickImtConflictTrampoline() const 176 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 177 const std::vector<uint8_t>* CreateQuickResolutionTrampoline() const 178 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 179 const std::vector<uint8_t>* CreateQuickToInterpreterBridge() const 180 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 181 182 CompiledClass* GetCompiledClass(ClassReference ref) const 183 LOCKS_EXCLUDED(compiled_classes_lock_); 184 185 CompiledMethod* GetCompiledMethod(MethodReference ref) const 186 LOCKS_EXCLUDED(compiled_methods_lock_); 187 188 void AddRequiresConstructorBarrier(Thread* self, const DexFile* dex_file, 189 uint16_t class_def_index); 190 bool RequiresConstructorBarrier(Thread* self, const DexFile* dex_file, uint16_t class_def_index); 191 192 // Callbacks from compiler to see what runtime checks must be generated. 193 194 bool CanAssumeTypeIsPresentInDexCache(const DexFile& dex_file, uint32_t type_idx); 195 196 bool CanAssumeStringIsPresentInDexCache(const DexFile& dex_file, uint32_t string_idx) 197 LOCKS_EXCLUDED(Locks::mutator_lock_); 198 199 // Are runtime access checks necessary in the compiled code? 200 bool CanAccessTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file, 201 uint32_t type_idx, bool* type_known_final = nullptr, 202 bool* type_known_abstract = nullptr, 203 bool* equals_referrers_class = nullptr) 204 LOCKS_EXCLUDED(Locks::mutator_lock_); 205 206 // Are runtime access and instantiable checks necessary in the code? 207 bool CanAccessInstantiableTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file, 208 uint32_t type_idx) 209 LOCKS_EXCLUDED(Locks::mutator_lock_); 210 211 bool CanEmbedTypeInCode(const DexFile& dex_file, uint32_t type_idx, 212 bool* is_type_initialized, bool* use_direct_type_ptr, 213 uintptr_t* direct_type_ptr, bool* out_is_finalizable); 214 215 // Get the DexCache for the 216 mirror::DexCache* GetDexCache(const DexCompilationUnit* mUnit) 217 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 218 219 mirror::ClassLoader* GetClassLoader(ScopedObjectAccess& soa, const DexCompilationUnit* mUnit) 220 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 221 222 // Resolve compiling method's class. Returns nullptr on failure. 223 mirror::Class* ResolveCompilingMethodsClass( 224 const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache, 225 Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit) 226 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 227 228 // Resolve a field. Returns nullptr on failure, including incompatible class change. 229 // NOTE: Unlike ClassLinker's ResolveField(), this method enforces is_static. 230 mirror::ArtField* ResolveField( 231 const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache, 232 Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit, 233 uint32_t field_idx, bool is_static) 234 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 235 236 // Get declaration location of a resolved field. 237 void GetResolvedFieldDexFileLocation( 238 mirror::ArtField* resolved_field, const DexFile** declaring_dex_file, 239 uint16_t* declaring_class_idx, uint16_t* declaring_field_idx) 240 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 241 242 bool IsFieldVolatile(mirror::ArtField* field) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 243 244 // Can we fast-path an IGET/IPUT access to an instance field? If yes, compute the field offset. 245 std::pair<bool, bool> IsFastInstanceField( 246 mirror::DexCache* dex_cache, mirror::Class* referrer_class, 247 mirror::ArtField* resolved_field, uint16_t field_idx) 248 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 249 250 // Can we fast-path an SGET/SPUT access to a static field? If yes, compute the field offset, 251 // the type index of the declaring class in the referrer's dex file and whether the declaring 252 // class is the referrer's class or at least can be assumed to be initialized. 253 std::pair<bool, bool> IsFastStaticField( 254 mirror::DexCache* dex_cache, mirror::Class* referrer_class, 255 mirror::ArtField* resolved_field, uint16_t field_idx, MemberOffset* field_offset, 256 uint32_t* storage_index, bool* is_referrers_class, bool* is_initialized) 257 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 258 259 // Resolve a method. Returns nullptr on failure, including incompatible class change. 260 mirror::ArtMethod* ResolveMethod( 261 ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache, 262 Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit, 263 uint32_t method_idx, InvokeType invoke_type) 264 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 265 266 // Get declaration location of a resolved field. 267 void GetResolvedMethodDexFileLocation( 268 mirror::ArtMethod* resolved_method, const DexFile** declaring_dex_file, 269 uint16_t* declaring_class_idx, uint16_t* declaring_method_idx) 270 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 271 272 // Get declaration location of a resolved field. 273 uint16_t GetResolvedMethodVTableIndex( 274 mirror::ArtMethod* resolved_method, InvokeType type) 275 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 276 277 // Can we fast-path an INVOKE? If no, returns 0. If yes, returns a non-zero opaque flags value 278 // for ProcessedInvoke() and computes the necessary lowering info. 279 int IsFastInvoke( 280 ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache, 281 Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit, 282 mirror::Class* referrer_class, mirror::ArtMethod* resolved_method, InvokeType* invoke_type, 283 MethodReference* target_method, const MethodReference* devirt_target, 284 uintptr_t* direct_code, uintptr_t* direct_method) 285 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 286 287 // Does invokation of the resolved method need class initialization? 288 bool NeedsClassInitialization(mirror::Class* referrer_class, mirror::ArtMethod* resolved_method) 289 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 290 291 void ProcessedInstanceField(bool resolved); 292 void ProcessedStaticField(bool resolved, bool local); 293 void ProcessedInvoke(InvokeType invoke_type, int flags); 294 295 // Can we fast path instance field access? Computes field's offset and volatility. 296 bool ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put, 297 MemberOffset* field_offset, bool* is_volatile) 298 LOCKS_EXCLUDED(Locks::mutator_lock_); 299 300 mirror::ArtField* ComputeInstanceFieldInfo(uint32_t field_idx, 301 const DexCompilationUnit* mUnit, 302 bool is_put, 303 const ScopedObjectAccess& soa) 304 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 305 306 307 // Can we fastpath static field access? Computes field's offset, volatility and whether the 308 // field is within the referrer (which can avoid checking class initialization). 309 bool ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put, 310 MemberOffset* field_offset, uint32_t* storage_index, 311 bool* is_referrers_class, bool* is_volatile, bool* is_initialized) 312 LOCKS_EXCLUDED(Locks::mutator_lock_); 313 314 // Can we fastpath a interface, super class or virtual method call? Computes method's vtable 315 // index. 316 bool ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc, 317 bool update_stats, bool enable_devirtualization, 318 InvokeType* type, MethodReference* target_method, int* vtable_idx, 319 uintptr_t* direct_code, uintptr_t* direct_method) 320 LOCKS_EXCLUDED(Locks::mutator_lock_); 321 322 const VerifiedMethod* GetVerifiedMethod(const DexFile* dex_file, uint32_t method_idx) const; 323 bool IsSafeCast(const DexCompilationUnit* mUnit, uint32_t dex_pc); 324 325 // Record patch information for later fix up. 326 void AddCodePatch(const DexFile* dex_file, 327 uint16_t referrer_class_def_idx, 328 uint32_t referrer_method_idx, 329 InvokeType referrer_invoke_type, 330 uint32_t target_method_idx, 331 const DexFile* target_dex_file, 332 InvokeType target_invoke_type, 333 size_t literal_offset) 334 LOCKS_EXCLUDED(compiled_methods_lock_); 335 void AddRelativeCodePatch(const DexFile* dex_file, 336 uint16_t referrer_class_def_idx, 337 uint32_t referrer_method_idx, 338 InvokeType referrer_invoke_type, 339 uint32_t target_method_idx, 340 const DexFile* target_dex_file, 341 InvokeType target_invoke_type, 342 size_t literal_offset, 343 int32_t pc_relative_offset) 344 LOCKS_EXCLUDED(compiled_methods_lock_); 345 void AddMethodPatch(const DexFile* dex_file, 346 uint16_t referrer_class_def_idx, 347 uint32_t referrer_method_idx, 348 InvokeType referrer_invoke_type, 349 uint32_t target_method_idx, 350 const DexFile* target_dex_file, 351 InvokeType target_invoke_type, 352 size_t literal_offset) 353 LOCKS_EXCLUDED(compiled_methods_lock_); 354 void AddClassPatch(const DexFile* dex_file, 355 uint16_t referrer_class_def_idx, 356 uint32_t referrer_method_idx, 357 uint32_t target_method_idx, 358 size_t literal_offset) 359 LOCKS_EXCLUDED(compiled_methods_lock_); 360 361 bool GetSupportBootImageFixup() const { 362 return support_boot_image_fixup_; 363 } 364 365 void SetSupportBootImageFixup(bool support_boot_image_fixup) { 366 support_boot_image_fixup_ = support_boot_image_fixup; 367 } 368 369 ArenaPool* GetArenaPool() { 370 return &arena_pool_; 371 } 372 373 bool WriteElf(const std::string& android_root, 374 bool is_host, 375 const std::vector<const DexFile*>& dex_files, 376 OatWriter* oat_writer, 377 File* file); 378 379 // TODO: move to a common home for llvm helpers once quick/portable are merged. 380 static void InstructionSetToLLVMTarget(InstructionSet instruction_set, 381 std::string* target_triple, 382 std::string* target_cpu, 383 std::string* target_attr); 384 385 void SetCompilerContext(void* compiler_context) { 386 compiler_context_ = compiler_context; 387 } 388 389 void* GetCompilerContext() const { 390 return compiler_context_; 391 } 392 393 size_t GetThreadCount() const { 394 return thread_count_; 395 } 396 397 class CallPatchInformation; 398 class TypePatchInformation; 399 400 bool GetDumpPasses() const { 401 return dump_passes_; 402 } 403 404 bool DidIncludeDebugSymbols() const { 405 return compiler_options_->GetIncludeDebugSymbols(); 406 } 407 408 CumulativeLogger* GetTimingsLogger() const { 409 return timings_logger_; 410 } 411 412 class PatchInformation { 413 public: 414 const DexFile& GetDexFile() const { 415 return *dex_file_; 416 } 417 uint16_t GetReferrerClassDefIdx() const { 418 return referrer_class_def_idx_; 419 } 420 uint32_t GetReferrerMethodIdx() const { 421 return referrer_method_idx_; 422 } 423 size_t GetLiteralOffset() const { 424 return literal_offset_; 425 } 426 427 virtual bool IsCall() const { 428 return false; 429 } 430 virtual bool IsType() const { 431 return false; 432 } 433 virtual const CallPatchInformation* AsCall() const { 434 LOG(FATAL) << "Unreachable"; 435 return nullptr; 436 } 437 virtual const TypePatchInformation* AsType() const { 438 LOG(FATAL) << "Unreachable"; 439 return nullptr; 440 } 441 442 protected: 443 PatchInformation(const DexFile* dex_file, 444 uint16_t referrer_class_def_idx, 445 uint32_t referrer_method_idx, 446 size_t literal_offset) 447 : dex_file_(dex_file), 448 referrer_class_def_idx_(referrer_class_def_idx), 449 referrer_method_idx_(referrer_method_idx), 450 literal_offset_(literal_offset) { 451 CHECK(dex_file_ != nullptr); 452 } 453 virtual ~PatchInformation() {} 454 455 const DexFile* const dex_file_; 456 const uint16_t referrer_class_def_idx_; 457 const uint32_t referrer_method_idx_; 458 const size_t literal_offset_; 459 460 friend class CompilerDriver; 461 }; 462 463 class CallPatchInformation : public PatchInformation { 464 public: 465 InvokeType GetReferrerInvokeType() const { 466 return referrer_invoke_type_; 467 } 468 uint32_t GetTargetMethodIdx() const { 469 return target_method_idx_; 470 } 471 const DexFile* GetTargetDexFile() const { 472 return target_dex_file_; 473 } 474 InvokeType GetTargetInvokeType() const { 475 return target_invoke_type_; 476 } 477 478 const CallPatchInformation* AsCall() const { 479 return this; 480 } 481 bool IsCall() const { 482 return true; 483 } 484 virtual bool IsRelative() const { 485 return false; 486 } 487 virtual int RelativeOffset() const { 488 return 0; 489 } 490 491 protected: 492 CallPatchInformation(const DexFile* dex_file, 493 uint16_t referrer_class_def_idx, 494 uint32_t referrer_method_idx, 495 InvokeType referrer_invoke_type, 496 uint32_t target_method_idx, 497 const DexFile* target_dex_file, 498 InvokeType target_invoke_type, 499 size_t literal_offset) 500 : PatchInformation(dex_file, referrer_class_def_idx, 501 referrer_method_idx, literal_offset), 502 referrer_invoke_type_(referrer_invoke_type), 503 target_method_idx_(target_method_idx), 504 target_dex_file_(target_dex_file), 505 target_invoke_type_(target_invoke_type) { 506 } 507 508 private: 509 const InvokeType referrer_invoke_type_; 510 const uint32_t target_method_idx_; 511 const DexFile* target_dex_file_; 512 const InvokeType target_invoke_type_; 513 514 friend class CompilerDriver; 515 DISALLOW_COPY_AND_ASSIGN(CallPatchInformation); 516 }; 517 518 class RelativeCallPatchInformation : public CallPatchInformation { 519 public: 520 bool IsRelative() const { 521 return true; 522 } 523 int RelativeOffset() const { 524 return offset_; 525 } 526 527 private: 528 RelativeCallPatchInformation(const DexFile* dex_file, 529 uint16_t referrer_class_def_idx, 530 uint32_t referrer_method_idx, 531 InvokeType referrer_invoke_type, 532 uint32_t target_method_idx, 533 const DexFile* target_dex_file, 534 InvokeType target_invoke_type, 535 size_t literal_offset, 536 int32_t pc_relative_offset) 537 : CallPatchInformation(dex_file, referrer_class_def_idx, 538 referrer_method_idx, referrer_invoke_type, target_method_idx, 539 target_dex_file, target_invoke_type, literal_offset), 540 offset_(pc_relative_offset) { 541 } 542 543 const int offset_; 544 545 friend class CompilerDriver; 546 DISALLOW_COPY_AND_ASSIGN(RelativeCallPatchInformation); 547 }; 548 549 class TypePatchInformation : public PatchInformation { 550 public: 551 uint32_t GetTargetTypeIdx() const { 552 return target_type_idx_; 553 } 554 555 bool IsType() const { 556 return true; 557 } 558 const TypePatchInformation* AsType() const { 559 return this; 560 } 561 562 private: 563 TypePatchInformation(const DexFile* dex_file, 564 uint16_t referrer_class_def_idx, 565 uint32_t referrer_method_idx, 566 uint32_t target_type_idx, 567 size_t literal_offset) 568 : PatchInformation(dex_file, referrer_class_def_idx, 569 referrer_method_idx, literal_offset), 570 target_type_idx_(target_type_idx) { 571 } 572 573 const uint32_t target_type_idx_; 574 575 friend class CompilerDriver; 576 DISALLOW_COPY_AND_ASSIGN(TypePatchInformation); 577 }; 578 579 const std::vector<const CallPatchInformation*>& GetCodeToPatch() const { 580 return code_to_patch_; 581 } 582 const std::vector<const CallPatchInformation*>& GetMethodsToPatch() const { 583 return methods_to_patch_; 584 } 585 const std::vector<const TypePatchInformation*>& GetClassesToPatch() const { 586 return classes_to_patch_; 587 } 588 589 // Checks if class specified by type_idx is one of the image_classes_ 590 bool IsImageClass(const char* descriptor) const; 591 592 // Checks if the provided class should be compiled, i.e., is in classes_to_compile_. 593 bool IsClassToCompile(const char* descriptor) const; 594 595 void RecordClassStatus(ClassReference ref, mirror::Class::Status status) 596 LOCKS_EXCLUDED(compiled_classes_lock_); 597 598 std::vector<uint8_t>* DeduplicateCode(const std::vector<uint8_t>& code); 599 std::vector<uint8_t>* DeduplicateMappingTable(const std::vector<uint8_t>& code); 600 std::vector<uint8_t>* DeduplicateVMapTable(const std::vector<uint8_t>& code); 601 std::vector<uint8_t>* DeduplicateGCMap(const std::vector<uint8_t>& code); 602 std::vector<uint8_t>* DeduplicateCFIInfo(const std::vector<uint8_t>* cfi_info); 603 604 /* 605 * @brief return the pointer to the Call Frame Information. 606 * @return pointer to call frame information for this compilation. 607 */ 608 std::vector<uint8_t>* GetCallFrameInformation() const { 609 return cfi_info_.get(); 610 } 611 612 ProfileFile profile_file_; 613 bool profile_present_; 614 615 // Should the compiler run on this method given profile information? 616 bool SkipCompilation(const std::string& method_name); 617 618 private: 619 // These flags are internal to CompilerDriver for collecting INVOKE resolution statistics. 620 // The only external contract is that unresolved method has flags 0 and resolved non-0. 621 enum { 622 kBitMethodResolved = 0, 623 kBitVirtualMadeDirect, 624 kBitPreciseTypeDevirtualization, 625 kBitDirectCallToBoot, 626 kBitDirectMethodToBoot 627 }; 628 static constexpr int kFlagMethodResolved = 1 << kBitMethodResolved; 629 static constexpr int kFlagVirtualMadeDirect = 1 << kBitVirtualMadeDirect; 630 static constexpr int kFlagPreciseTypeDevirtualization = 1 << kBitPreciseTypeDevirtualization; 631 static constexpr int kFlagDirectCallToBoot = 1 << kBitDirectCallToBoot; 632 static constexpr int kFlagDirectMethodToBoot = 1 << kBitDirectMethodToBoot; 633 static constexpr int kFlagsMethodResolvedVirtualMadeDirect = 634 kFlagMethodResolved | kFlagVirtualMadeDirect; 635 static constexpr int kFlagsMethodResolvedPreciseTypeDevirtualization = 636 kFlagsMethodResolvedVirtualMadeDirect | kFlagPreciseTypeDevirtualization; 637 638 public: // TODO make private or eliminate. 639 // Compute constant code and method pointers when possible. 640 void GetCodeAndMethodForDirectCall(/*out*/InvokeType* type, 641 InvokeType sharp_type, 642 bool no_guarantee_of_dex_cache_entry, 643 const mirror::Class* referrer_class, 644 mirror::ArtMethod* method, 645 /*out*/int* stats_flags, 646 MethodReference* target_method, 647 uintptr_t* direct_code, uintptr_t* direct_method) 648 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 649 650 private: 651 void PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files, 652 ThreadPool* thread_pool, TimingLogger* timings) 653 LOCKS_EXCLUDED(Locks::mutator_lock_); 654 655 void LoadImageClasses(TimingLogger* timings); 656 657 // Attempt to resolve all type, methods, fields, and strings 658 // referenced from code in the dex file following PathClassLoader 659 // ordering semantics. 660 void Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files, 661 ThreadPool* thread_pool, TimingLogger* timings) 662 LOCKS_EXCLUDED(Locks::mutator_lock_); 663 void ResolveDexFile(jobject class_loader, const DexFile& dex_file, 664 const std::vector<const DexFile*>& dex_files, 665 ThreadPool* thread_pool, TimingLogger* timings) 666 LOCKS_EXCLUDED(Locks::mutator_lock_); 667 668 void Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files, 669 ThreadPool* thread_pool, TimingLogger* timings); 670 void VerifyDexFile(jobject class_loader, const DexFile& dex_file, 671 const std::vector<const DexFile*>& dex_files, 672 ThreadPool* thread_pool, TimingLogger* timings) 673 LOCKS_EXCLUDED(Locks::mutator_lock_); 674 675 void SetVerified(jobject class_loader, const std::vector<const DexFile*>& dex_files, 676 ThreadPool* thread_pool, TimingLogger* timings); 677 void SetVerifiedDexFile(jobject class_loader, const DexFile& dex_file, 678 const std::vector<const DexFile*>& dex_files, 679 ThreadPool* thread_pool, TimingLogger* timings) 680 LOCKS_EXCLUDED(Locks::mutator_lock_); 681 682 void InitializeClasses(jobject class_loader, const std::vector<const DexFile*>& dex_files, 683 ThreadPool* thread_pool, TimingLogger* timings) 684 LOCKS_EXCLUDED(Locks::mutator_lock_); 685 void InitializeClasses(jobject class_loader, const DexFile& dex_file, 686 const std::vector<const DexFile*>& dex_files, 687 ThreadPool* thread_pool, TimingLogger* timings) 688 LOCKS_EXCLUDED(Locks::mutator_lock_, compiled_classes_lock_); 689 690 void UpdateImageClasses(TimingLogger* timings) LOCKS_EXCLUDED(Locks::mutator_lock_); 691 static void FindClinitImageClassesCallback(mirror::Object* object, void* arg) 692 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 693 694 void Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files, 695 ThreadPool* thread_pool, TimingLogger* timings); 696 void CompileDexFile(jobject class_loader, const DexFile& dex_file, 697 const std::vector<const DexFile*>& dex_files, 698 ThreadPool* thread_pool, TimingLogger* timings) 699 LOCKS_EXCLUDED(Locks::mutator_lock_); 700 void CompileMethod(const DexFile::CodeItem* code_item, uint32_t access_flags, 701 InvokeType invoke_type, uint16_t class_def_idx, uint32_t method_idx, 702 jobject class_loader, const DexFile& dex_file, 703 DexToDexCompilationLevel dex_to_dex_compilation_level, 704 bool compilation_enabled) 705 LOCKS_EXCLUDED(compiled_methods_lock_); 706 707 static void CompileClass(const ParallelCompilationManager* context, size_t class_def_index) 708 LOCKS_EXCLUDED(Locks::mutator_lock_); 709 710 std::vector<const CallPatchInformation*> code_to_patch_; 711 std::vector<const CallPatchInformation*> methods_to_patch_; 712 std::vector<const TypePatchInformation*> classes_to_patch_; 713 714 const CompilerOptions* const compiler_options_; 715 VerificationResults* const verification_results_; 716 DexFileToMethodInlinerMap* const method_inliner_map_; 717 718 std::unique_ptr<Compiler> compiler_; 719 720 const InstructionSet instruction_set_; 721 const InstructionSetFeatures instruction_set_features_; 722 723 // All class references that require 724 mutable ReaderWriterMutex freezing_constructor_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 725 std::set<ClassReference> freezing_constructor_classes_ GUARDED_BY(freezing_constructor_lock_); 726 727 typedef SafeMap<const ClassReference, CompiledClass*> ClassTable; 728 // All class references that this compiler has compiled. 729 mutable Mutex compiled_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 730 ClassTable compiled_classes_ GUARDED_BY(compiled_classes_lock_); 731 732 typedef SafeMap<const MethodReference, CompiledMethod*, MethodReferenceComparator> MethodTable; 733 // All method references that this compiler has compiled. 734 mutable Mutex compiled_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 735 MethodTable compiled_methods_ GUARDED_BY(compiled_methods_lock_); 736 737 const bool image_; 738 739 // If image_ is true, specifies the classes that will be included in 740 // the image. Note if image_classes_ is nullptr, all classes are 741 // included in the image. 742 std::unique_ptr<std::set<std::string>> image_classes_; 743 744 // If image_ is true, specifies the classes that will be compiled in 745 // the image. Note if classes_to_compile_ is nullptr, all classes are 746 // included in the image. 747 std::unique_ptr<std::set<std::string>> classes_to_compile_; 748 749 size_t thread_count_; 750 uint64_t start_ns_; 751 752 class AOTCompilationStats; 753 std::unique_ptr<AOTCompilationStats> stats_; 754 755 bool dump_stats_; 756 const bool dump_passes_; 757 758 CumulativeLogger* const timings_logger_; 759 760 typedef void (*CompilerCallbackFn)(CompilerDriver& driver); 761 typedef MutexLock* (*CompilerMutexLockFn)(CompilerDriver& driver); 762 763 void* compiler_library_; 764 765 typedef void (*DexToDexCompilerFn)(CompilerDriver& driver, 766 const DexFile::CodeItem* code_item, 767 uint32_t access_flags, InvokeType invoke_type, 768 uint32_t class_dex_idx, uint32_t method_idx, 769 jobject class_loader, const DexFile& dex_file, 770 DexToDexCompilationLevel dex_to_dex_compilation_level); 771 DexToDexCompilerFn dex_to_dex_compiler_; 772 773 void* compiler_context_; 774 775 pthread_key_t tls_key_; 776 777 // Arena pool used by the compiler. 778 ArenaPool arena_pool_; 779 780 typedef void (*CompilerEnableAutoElfLoadingFn)(CompilerDriver& driver); 781 CompilerEnableAutoElfLoadingFn compiler_enable_auto_elf_loading_; 782 783 typedef const void* (*CompilerGetMethodCodeAddrFn) 784 (const CompilerDriver& driver, const CompiledMethod* cm, const mirror::ArtMethod* method); 785 CompilerGetMethodCodeAddrFn compiler_get_method_code_addr_; 786 787 bool support_boot_image_fixup_; 788 789 // Call Frame Information, which might be generated to help stack tracebacks. 790 std::unique_ptr<std::vector<uint8_t>> cfi_info_; 791 792 // DeDuplication data structures, these own the corresponding byte arrays. 793 class DedupeHashFunc { 794 public: 795 size_t operator()(const std::vector<uint8_t>& array) const { 796 // For small arrays compute a hash using every byte. 797 static const size_t kSmallArrayThreshold = 16; 798 size_t hash = 0x811c9dc5; 799 if (array.size() <= kSmallArrayThreshold) { 800 for (uint8_t b : array) { 801 hash = (hash * 16777619) ^ b; 802 } 803 } else { 804 // For larger arrays use the 2 bytes at 6 bytes (the location of a push registers 805 // instruction field for quick generated code on ARM) and then select a number of other 806 // values at random. 807 static const size_t kRandomHashCount = 16; 808 for (size_t i = 0; i < 2; ++i) { 809 uint8_t b = array[i + 6]; 810 hash = (hash * 16777619) ^ b; 811 } 812 for (size_t i = 2; i < kRandomHashCount; ++i) { 813 size_t r = i * 1103515245 + 12345; 814 uint8_t b = array[r % array.size()]; 815 hash = (hash * 16777619) ^ b; 816 } 817 } 818 hash += hash << 13; 819 hash ^= hash >> 7; 820 hash += hash << 3; 821 hash ^= hash >> 17; 822 hash += hash << 5; 823 return hash; 824 } 825 }; 826 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_code_; 827 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_mapping_table_; 828 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_vmap_table_; 829 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_gc_map_; 830 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_cfi_info_; 831 832 DISALLOW_COPY_AND_ASSIGN(CompilerDriver); 833}; 834 835} // namespace art 836 837#endif // ART_COMPILER_DRIVER_COMPILER_DRIVER_H_ 838