compiler_driver.h revision 944da603cde59a4277f3bbc31d860a90842a1a2a 
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 <unordered_set>
23#include <vector>
24
25#include "arch/instruction_set.h"
26#include "base/arena_allocator.h"
27#include "base/bit_utils.h"
28#include "base/mutex.h"
29#include "base/timing_logger.h"
30#include "class_reference.h"
31#include "compiler.h"
32#include "dex_file.h"
33#include "driver/compiled_method_storage.h"
34#include "jit/offline_profiling_info.h"
35#include "invoke_type.h"
36#include "method_reference.h"
37#include "mirror/class.h"  // For mirror::Class::Status.
38#include "os.h"
39#include "runtime.h"
40#include "safe_map.h"
41#include "thread_pool.h"
42#include "utils/array_ref.h"
43#include "utils/dex_cache_arrays_layout.h"
44
45namespace art {
46
47namespace mirror {
48class DexCache;
49}  // namespace mirror
50
51namespace verifier {
52class MethodVerifier;
53}  // namespace verifier
54
55class CompiledClass;
56class CompiledMethod;
57class CompilerOptions;
58class DexCompilationUnit;
59class DexFileToMethodInlinerMap;
60struct InlineIGetIPutData;
61class InstructionSetFeatures;
62class ParallelCompilationManager;
63class ScopedObjectAccess;
64template <class Allocator> class SrcMap;
65class SrcMapElem;
66using SwapSrcMap = SrcMap<SwapAllocator<SrcMapElem>>;
67template<class T> class Handle;
68class TimingLogger;
69class VerificationResults;
70class VerifiedMethod;
71
72enum EntryPointCallingConvention {
73  // ABI of invocations to a method's interpreter entry point.
74  kInterpreterAbi,
75  // ABI of calls to a method's native code, only used for native methods.
76  kJniAbi,
77  // ABI of calls to a method's quick code entry point.
78  kQuickAbi
79};
80
81class CompilerDriver {
82 public:
83  // Create a compiler targeting the requested "instruction_set".
84  // "image" should be true if image specific optimizations should be
85  // enabled.  "image_classes" lets the compiler know what classes it
86  // can assume will be in the image, with null implying all available
87  // classes.
88  CompilerDriver(const CompilerOptions* compiler_options,
89                 VerificationResults* verification_results,
90                 DexFileToMethodInlinerMap* method_inliner_map,
91                 Compiler::Kind compiler_kind,
92                 InstructionSet instruction_set,
93                 const InstructionSetFeatures* instruction_set_features,
94                 bool boot_image, std::unordered_set<std::string>* image_classes,
95                 std::unordered_set<std::string>* compiled_classes,
96                 std::unordered_set<std::string>* compiled_methods,
97                 size_t thread_count,
98                 bool dump_stats,
99                 bool dump_passes,
100                 CumulativeLogger* timer,
101                 int swap_fd,
102                 const ProfileCompilationInfo* profile_compilation_info);
103
104  ~CompilerDriver();
105
106  // Set dex files that will be stored in the oat file after being compiled.
107  void SetDexFilesForOatFile(const std::vector<const DexFile*>& dex_files) {
108    dex_files_for_oat_file_ = &dex_files;
109  }
110
111  // Get dex file that will be stored in the oat file after being compiled.
112  ArrayRef<const DexFile* const> GetDexFilesForOatFile() const {
113    return (dex_files_for_oat_file_ != nullptr)
114        ? ArrayRef<const DexFile* const>(*dex_files_for_oat_file_)
115        : ArrayRef<const DexFile* const>();
116  }
117
118  void CompileAll(jobject class_loader,
119                  const std::vector<const DexFile*>& dex_files,
120                  TimingLogger* timings)
121      REQUIRES(!Locks::mutator_lock_, !compiled_classes_lock_);
122
123  // Compile a single Method.
124  void CompileOne(Thread* self, ArtMethod* method, TimingLogger* timings)
125      SHARED_REQUIRES(Locks::mutator_lock_)
126      REQUIRES(!compiled_methods_lock_, !compiled_classes_lock_);
127
128  VerificationResults* GetVerificationResults() const {
129    return verification_results_;
130  }
131
132  DexFileToMethodInlinerMap* GetMethodInlinerMap() const {
133    return method_inliner_map_;
134  }
135
136  InstructionSet GetInstructionSet() const {
137    return instruction_set_;
138  }
139
140  const InstructionSetFeatures* GetInstructionSetFeatures() const {
141    return instruction_set_features_;
142  }
143
144  const CompilerOptions& GetCompilerOptions() const {
145    return *compiler_options_;
146  }
147
148  Compiler* GetCompiler() const {
149    return compiler_.get();
150  }
151
152  // Are we compiling and creating an image file?
153  bool IsBootImage() const {
154    return boot_image_;
155  }
156
157  const std::unordered_set<std::string>* GetImageClasses() const {
158    return image_classes_.get();
159  }
160
161  // Generate the trampolines that are invoked by unresolved direct methods.
162  const std::vector<uint8_t>* CreateJniDlsymLookup() const;
163  const std::vector<uint8_t>* CreateQuickGenericJniTrampoline() const;
164  const std::vector<uint8_t>* CreateQuickImtConflictTrampoline() const;
165  const std::vector<uint8_t>* CreateQuickResolutionTrampoline() const;
166  const std::vector<uint8_t>* CreateQuickToInterpreterBridge() const;
167
168  CompiledClass* GetCompiledClass(ClassReference ref) const
169      REQUIRES(!compiled_classes_lock_);
170
171  CompiledMethod* GetCompiledMethod(MethodReference ref) const
172      REQUIRES(!compiled_methods_lock_);
173  size_t GetNonRelativeLinkerPatchCount() const
174      REQUIRES(!compiled_methods_lock_);
175
176  // Add a compiled method.
177  void AddCompiledMethod(const MethodReference& method_ref,
178                         CompiledMethod* const compiled_method,
179                         size_t non_relative_linker_patch_count)
180      REQUIRES(!compiled_methods_lock_);
181  // Remove and delete a compiled method.
182  void RemoveCompiledMethod(const MethodReference& method_ref) REQUIRES(!compiled_methods_lock_);
183
184  void AddRequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
185                                     uint16_t class_def_index)
186      REQUIRES(!freezing_constructor_lock_);
187  bool RequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
188                                  uint16_t class_def_index) const
189      REQUIRES(!freezing_constructor_lock_);
190
191  // Callbacks from compiler to see what runtime checks must be generated.
192
193  bool CanAssumeTypeIsPresentInDexCache(const DexFile& dex_file, uint32_t type_idx);
194
195  bool CanAssumeStringIsPresentInDexCache(const DexFile& dex_file, uint32_t string_idx)
196      REQUIRES(!Locks::mutator_lock_);
197
198  // Are runtime access checks necessary in the compiled code?
199  bool CanAccessTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
200                                  uint32_t type_idx, bool* type_known_final = nullptr,
201                                  bool* type_known_abstract = nullptr,
202                                  bool* equals_referrers_class = nullptr)
203      REQUIRES(!Locks::mutator_lock_);
204
205  // Are runtime access and instantiable checks necessary in the code?
206  // out_is_finalizable is set to whether the type is finalizable.
207  bool CanAccessInstantiableTypeWithoutChecks(uint32_t referrer_idx,
208                                              const DexFile& dex_file,
209                                              uint32_t type_idx,
210                                              bool* out_is_finalizable)
211      REQUIRES(!Locks::mutator_lock_);
212
213  bool CanEmbedTypeInCode(const DexFile& dex_file, uint32_t type_idx,
214                          bool* is_type_initialized, bool* use_direct_type_ptr,
215                          uintptr_t* direct_type_ptr, bool* out_is_finalizable);
216
217  // Query methods for the java.lang.ref.Reference class.
218  bool CanEmbedReferenceTypeInCode(ClassReference* ref,
219                                   bool* use_direct_type_ptr, uintptr_t* direct_type_ptr);
220  uint32_t GetReferenceSlowFlagOffset() const;
221  uint32_t GetReferenceDisableFlagOffset() const;
222
223  // Get the DexCache for the
224  mirror::DexCache* GetDexCache(const DexCompilationUnit* mUnit)
225    SHARED_REQUIRES(Locks::mutator_lock_);
226
227  mirror::ClassLoader* GetClassLoader(const ScopedObjectAccess& soa,
228                                      const DexCompilationUnit* mUnit)
229    SHARED_REQUIRES(Locks::mutator_lock_);
230
231  // Resolve compiling method's class. Returns null on failure.
232  mirror::Class* ResolveCompilingMethodsClass(
233      const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
234      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit)
235      SHARED_REQUIRES(Locks::mutator_lock_);
236
237  mirror::Class* ResolveClass(
238      const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
239      Handle<mirror::ClassLoader> class_loader, uint16_t type_index,
240      const DexCompilationUnit* mUnit)
241      SHARED_REQUIRES(Locks::mutator_lock_);
242
243  // Resolve a field. Returns null on failure, including incompatible class change.
244  // NOTE: Unlike ClassLinker's ResolveField(), this method enforces is_static.
245  ArtField* ResolveField(
246      const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
247      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
248      uint32_t field_idx, bool is_static)
249      SHARED_REQUIRES(Locks::mutator_lock_);
250
251  // Resolve a field with a given dex file.
252  ArtField* ResolveFieldWithDexFile(
253      const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
254      Handle<mirror::ClassLoader> class_loader, const DexFile* dex_file,
255      uint32_t field_idx, bool is_static)
256      SHARED_REQUIRES(Locks::mutator_lock_);
257
258  // Get declaration location of a resolved field.
259  void GetResolvedFieldDexFileLocation(
260      ArtField* resolved_field, const DexFile** declaring_dex_file,
261      uint16_t* declaring_class_idx, uint16_t* declaring_field_idx)
262      SHARED_REQUIRES(Locks::mutator_lock_);
263
264  bool IsFieldVolatile(ArtField* field) SHARED_REQUIRES(Locks::mutator_lock_);
265  MemberOffset GetFieldOffset(ArtField* field) SHARED_REQUIRES(Locks::mutator_lock_);
266
267  // Find a dex cache for a dex file.
268  inline mirror::DexCache* FindDexCache(const DexFile* dex_file)
269      SHARED_REQUIRES(Locks::mutator_lock_);
270
271  // Can we fast-path an IGET/IPUT access to an instance field? If yes, compute the field offset.
272  std::pair<bool, bool> IsFastInstanceField(
273      mirror::DexCache* dex_cache, mirror::Class* referrer_class,
274      ArtField* resolved_field, uint16_t field_idx)
275      SHARED_REQUIRES(Locks::mutator_lock_);
276
277  // Can we fast-path an SGET/SPUT access to a static field? If yes, compute the type index
278  // of the declaring class in the referrer's dex file.
279  std::pair<bool, bool> IsFastStaticField(
280      mirror::DexCache* dex_cache, mirror::Class* referrer_class,
281      ArtField* resolved_field, uint16_t field_idx, uint32_t* storage_index)
282      SHARED_REQUIRES(Locks::mutator_lock_);
283
284  // Return whether the declaring class of `resolved_method` is
285  // available to `referrer_class`. If this is true, compute the type
286  // index of the declaring class in the referrer's dex file and
287  // return it through the out argument `storage_index`; otherwise
288  // return DexFile::kDexNoIndex through `storage_index`.
289  bool IsClassOfStaticMethodAvailableToReferrer(mirror::DexCache* dex_cache,
290                                                mirror::Class* referrer_class,
291                                                ArtMethod* resolved_method,
292                                                uint16_t method_idx,
293                                                uint32_t* storage_index)
294      SHARED_REQUIRES(Locks::mutator_lock_);
295
296  // Is static field's in referrer's class?
297  bool IsStaticFieldInReferrerClass(mirror::Class* referrer_class, ArtField* resolved_field)
298      SHARED_REQUIRES(Locks::mutator_lock_);
299
300  // Is static field's class initialized?
301  bool IsStaticFieldsClassInitialized(mirror::Class* referrer_class,
302                                      ArtField* resolved_field)
303      SHARED_REQUIRES(Locks::mutator_lock_);
304
305  // Resolve a method. Returns null on failure, including incompatible class change.
306  ArtMethod* ResolveMethod(
307      ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
308      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
309      uint32_t method_idx, InvokeType invoke_type, bool check_incompatible_class_change = true)
310      SHARED_REQUIRES(Locks::mutator_lock_);
311
312  // Get declaration location of a resolved field.
313  void GetResolvedMethodDexFileLocation(
314      ArtMethod* resolved_method, const DexFile** declaring_dex_file,
315      uint16_t* declaring_class_idx, uint16_t* declaring_method_idx)
316      SHARED_REQUIRES(Locks::mutator_lock_);
317
318  // Get the index in the vtable of the method.
319  uint16_t GetResolvedMethodVTableIndex(
320      ArtMethod* resolved_method, InvokeType type)
321      SHARED_REQUIRES(Locks::mutator_lock_);
322
323  // Can we fast-path an INVOKE? If no, returns 0. If yes, returns a non-zero opaque flags value
324  // for ProcessedInvoke() and computes the necessary lowering info.
325  int IsFastInvoke(
326      ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
327      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
328      mirror::Class* referrer_class, ArtMethod* resolved_method, InvokeType* invoke_type,
329      MethodReference* target_method, const MethodReference* devirt_target,
330      uintptr_t* direct_code, uintptr_t* direct_method)
331      SHARED_REQUIRES(Locks::mutator_lock_);
332
333  // Is method's class initialized for an invoke?
334  // For static invokes to determine whether we need to consider potential call to <clinit>().
335  // For non-static invokes, assuming a non-null reference, the class is always initialized.
336  bool IsMethodsClassInitialized(mirror::Class* referrer_class, ArtMethod* resolved_method)
337      SHARED_REQUIRES(Locks::mutator_lock_);
338
339  // Get the layout of dex cache arrays for a dex file. Returns invalid layout if the
340  // dex cache arrays don't have a fixed layout.
341  DexCacheArraysLayout GetDexCacheArraysLayout(const DexFile* dex_file);
342
343  void ProcessedInstanceField(bool resolved);
344  void ProcessedStaticField(bool resolved, bool local);
345  void ProcessedInvoke(InvokeType invoke_type, int flags);
346
347  void ComputeFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit,
348                        const ScopedObjectAccess& soa, bool is_static,
349                        ArtField** resolved_field,
350                        mirror::Class** referrer_class,
351                        mirror::DexCache** dex_cache)
352      SHARED_REQUIRES(Locks::mutator_lock_);
353
354  // Can we fast path instance field access? Computes field's offset and volatility.
355  bool ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
356                                MemberOffset* field_offset, bool* is_volatile)
357      REQUIRES(!Locks::mutator_lock_);
358
359  ArtField* ComputeInstanceFieldInfo(uint32_t field_idx,
360                                             const DexCompilationUnit* mUnit,
361                                             bool is_put,
362                                             const ScopedObjectAccess& soa)
363      SHARED_REQUIRES(Locks::mutator_lock_);
364
365
366  // Can we fastpath static field access? Computes field's offset, volatility and whether the
367  // field is within the referrer (which can avoid checking class initialization).
368  bool ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
369                              MemberOffset* field_offset, uint32_t* storage_index,
370                              bool* is_referrers_class, bool* is_volatile, bool* is_initialized,
371                              Primitive::Type* type)
372      REQUIRES(!Locks::mutator_lock_);
373
374  // Can we fastpath a interface, super class or virtual method call? Computes method's vtable
375  // index.
376  bool ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
377                         bool update_stats, bool enable_devirtualization,
378                         InvokeType* type, MethodReference* target_method, int* vtable_idx,
379                         uintptr_t* direct_code, uintptr_t* direct_method)
380      REQUIRES(!Locks::mutator_lock_);
381
382  const VerifiedMethod* GetVerifiedMethod(const DexFile* dex_file, uint32_t method_idx) const;
383  bool IsSafeCast(const DexCompilationUnit* mUnit, uint32_t dex_pc);
384
385  bool GetSupportBootImageFixup() const {
386    return support_boot_image_fixup_;
387  }
388
389  void SetSupportBootImageFixup(bool support_boot_image_fixup) {
390    support_boot_image_fixup_ = support_boot_image_fixup;
391  }
392
393  void SetCompilerContext(void* compiler_context) {
394    compiler_context_ = compiler_context;
395  }
396
397  void* GetCompilerContext() const {
398    return compiler_context_;
399  }
400
401  size_t GetThreadCount() const {
402    return parallel_thread_count_;
403  }
404
405  bool GetDumpStats() const {
406    return dump_stats_;
407  }
408
409  bool GetDumpPasses() const {
410    return dump_passes_;
411  }
412
413  CumulativeLogger* GetTimingsLogger() const {
414    return timings_logger_;
415  }
416
417  void SetDedupeEnabled(bool dedupe_enabled) {
418    compiled_method_storage_.SetDedupeEnabled(dedupe_enabled);
419  }
420  bool DedupeEnabled() const {
421    return compiled_method_storage_.DedupeEnabled();
422  }
423
424  // Checks if class specified by type_idx is one of the image_classes_
425  bool IsImageClass(const char* descriptor) const;
426
427  // Checks whether the provided class should be compiled, i.e., is in classes_to_compile_.
428  bool IsClassToCompile(const char* descriptor) const;
429
430  // Checks whether the provided method should be compiled, i.e., is in method_to_compile_.
431  bool IsMethodToCompile(const MethodReference& method_ref) const;
432
433  // Checks whether profile guided compilation is enabled and if the method should be compiled
434  // according to the profile file.
435  bool ShouldCompileBasedOnProfile(const MethodReference& method_ref) const;
436
437  void RecordClassStatus(ClassReference ref, mirror::Class::Status status)
438      REQUIRES(!compiled_classes_lock_);
439
440  // Checks if the specified method has been verified without failures. Returns
441  // false if the method is not in the verification results (GetVerificationResults).
442  bool IsMethodVerifiedWithoutFailures(uint32_t method_idx,
443                                       uint16_t class_def_idx,
444                                       const DexFile& dex_file) const;
445
446  // Get memory usage during compilation.
447  std::string GetMemoryUsageString(bool extended) const;
448
449  bool IsStringTypeIndex(uint16_t type_index, const DexFile* dex_file);
450  bool IsStringInit(uint32_t method_index, const DexFile* dex_file, int32_t* offset);
451
452  void SetHadHardVerifierFailure() {
453    had_hard_verifier_failure_ = true;
454  }
455
456  Compiler::Kind GetCompilerKind() {
457    return compiler_kind_;
458  }
459
460  CompiledMethodStorage* GetCompiledMethodStorage() {
461    return &compiled_method_storage_;
462  }
463
464  // Can we assume that the klass is loaded?
465  bool CanAssumeClassIsLoaded(mirror::Class* klass)
466      SHARED_REQUIRES(Locks::mutator_lock_);
467
468  bool MayInline(const DexFile* inlined_from, const DexFile* inlined_into) const {
469    if (!kIsTargetBuild) {
470      return MayInlineInternal(inlined_from, inlined_into);
471    }
472    return true;
473  }
474
475 private:
476  // Return whether the declaring class of `resolved_member` is
477  // available to `referrer_class` for read or write access using two
478  // Boolean values returned as a pair. If is true at least for read
479  // access, compute the type index of the declaring class in the
480  // referrer's dex file and return it through the out argument
481  // `storage_index`; otherwise return DexFile::kDexNoIndex through
482  // `storage_index`.
483  template <typename ArtMember>
484  std::pair<bool, bool> IsClassOfStaticMemberAvailableToReferrer(mirror::DexCache* dex_cache,
485                                                                 mirror::Class* referrer_class,
486                                                                 ArtMember* resolved_member,
487                                                                 uint16_t member_idx,
488                                                                 uint32_t* storage_index)
489      SHARED_REQUIRES(Locks::mutator_lock_);
490
491  // Can `referrer_class` access the resolved `member`?
492  // Dispatch call to mirror::Class::CanAccessResolvedField or
493  // mirror::Class::CanAccessResolvedMember depending on the value of
494  // ArtMember.
495  template <typename ArtMember>
496  static bool CanAccessResolvedMember(mirror::Class* referrer_class,
497                                      mirror::Class* access_to,
498                                      ArtMember* member,
499                                      mirror::DexCache* dex_cache,
500                                      uint32_t field_idx)
501      SHARED_REQUIRES(Locks::mutator_lock_);
502
503  // Can we assume that the klass is initialized?
504  bool CanAssumeClassIsInitialized(mirror::Class* klass)
505      SHARED_REQUIRES(Locks::mutator_lock_);
506  bool CanReferrerAssumeClassIsInitialized(mirror::Class* referrer_class, mirror::Class* klass)
507      SHARED_REQUIRES(Locks::mutator_lock_);
508
509  // These flags are internal to CompilerDriver for collecting INVOKE resolution statistics.
510  // The only external contract is that unresolved method has flags 0 and resolved non-0.
511  enum {
512    kBitMethodResolved = 0,
513    kBitVirtualMadeDirect,
514    kBitPreciseTypeDevirtualization,
515    kBitDirectCallToBoot,
516    kBitDirectMethodToBoot
517  };
518  static constexpr int kFlagMethodResolved              = 1 << kBitMethodResolved;
519  static constexpr int kFlagVirtualMadeDirect           = 1 << kBitVirtualMadeDirect;
520  static constexpr int kFlagPreciseTypeDevirtualization = 1 << kBitPreciseTypeDevirtualization;
521  static constexpr int kFlagDirectCallToBoot            = 1 << kBitDirectCallToBoot;
522  static constexpr int kFlagDirectMethodToBoot          = 1 << kBitDirectMethodToBoot;
523  static constexpr int kFlagsMethodResolvedVirtualMadeDirect =
524      kFlagMethodResolved | kFlagVirtualMadeDirect;
525  static constexpr int kFlagsMethodResolvedPreciseTypeDevirtualization =
526      kFlagsMethodResolvedVirtualMadeDirect | kFlagPreciseTypeDevirtualization;
527
528 public:  // TODO make private or eliminate.
529  // Compute constant code and method pointers when possible.
530  void GetCodeAndMethodForDirectCall(/*out*/InvokeType* type,
531                                     InvokeType sharp_type,
532                                     bool no_guarantee_of_dex_cache_entry,
533                                     const mirror::Class* referrer_class,
534                                     ArtMethod* method,
535                                     /*out*/int* stats_flags,
536                                     MethodReference* target_method,
537                                     uintptr_t* direct_code, uintptr_t* direct_method)
538      SHARED_REQUIRES(Locks::mutator_lock_);
539
540 private:
541  void PreCompile(jobject class_loader,
542                  const std::vector<const DexFile*>& dex_files,
543                  TimingLogger* timings)
544      REQUIRES(!Locks::mutator_lock_, !compiled_classes_lock_);
545
546  void LoadImageClasses(TimingLogger* timings) REQUIRES(!Locks::mutator_lock_);
547
548  // Attempt to resolve all type, methods, fields, and strings
549  // referenced from code in the dex file following PathClassLoader
550  // ordering semantics.
551  void Resolve(jobject class_loader,
552               const std::vector<const DexFile*>& dex_files,
553               TimingLogger* timings)
554      REQUIRES(!Locks::mutator_lock_);
555  void ResolveDexFile(jobject class_loader,
556                      const DexFile& dex_file,
557                      const std::vector<const DexFile*>& dex_files,
558                      ThreadPool* thread_pool,
559                      size_t thread_count,
560                      TimingLogger* timings)
561      REQUIRES(!Locks::mutator_lock_);
562
563  void Verify(jobject class_loader,
564              const std::vector<const DexFile*>& dex_files,
565              TimingLogger* timings);
566  void VerifyDexFile(jobject class_loader,
567                     const DexFile& dex_file,
568                     const std::vector<const DexFile*>& dex_files,
569                     ThreadPool* thread_pool,
570                     size_t thread_count,
571                     TimingLogger* timings)
572      REQUIRES(!Locks::mutator_lock_);
573
574  void SetVerified(jobject class_loader,
575                   const std::vector<const DexFile*>& dex_files,
576                   TimingLogger* timings);
577  void SetVerifiedDexFile(jobject class_loader,
578                          const DexFile& dex_file,
579                          const std::vector<const DexFile*>& dex_files,
580                          ThreadPool* thread_pool,
581                          size_t thread_count,
582                          TimingLogger* timings)
583      REQUIRES(!Locks::mutator_lock_);
584
585  void InitializeClasses(jobject class_loader,
586                         const std::vector<const DexFile*>& dex_files,
587                         TimingLogger* timings)
588      REQUIRES(!Locks::mutator_lock_, !compiled_classes_lock_);
589  void InitializeClasses(jobject class_loader,
590                         const DexFile& dex_file,
591                         const std::vector<const DexFile*>& dex_files,
592                         TimingLogger* timings)
593      REQUIRES(!Locks::mutator_lock_, !compiled_classes_lock_);
594
595  void UpdateImageClasses(TimingLogger* timings) REQUIRES(!Locks::mutator_lock_);
596  static void FindClinitImageClassesCallback(mirror::Object* object, void* arg)
597      SHARED_REQUIRES(Locks::mutator_lock_);
598
599  void Compile(jobject class_loader,
600               const std::vector<const DexFile*>& dex_files,
601               TimingLogger* timings);
602  void CompileDexFile(jobject class_loader,
603                      const DexFile& dex_file,
604                      const std::vector<const DexFile*>& dex_files,
605                      ThreadPool* thread_pool,
606                      size_t thread_count,
607                      TimingLogger* timings)
608      REQUIRES(!Locks::mutator_lock_);
609
610  bool MayInlineInternal(const DexFile* inlined_from, const DexFile* inlined_into) const;
611
612  void InitializeThreadPools();
613  void FreeThreadPools();
614  void CheckThreadPools();
615
616  const CompilerOptions* const compiler_options_;
617  VerificationResults* const verification_results_;
618  DexFileToMethodInlinerMap* const method_inliner_map_;
619
620  std::unique_ptr<Compiler> compiler_;
621  Compiler::Kind compiler_kind_;
622
623  const InstructionSet instruction_set_;
624  const InstructionSetFeatures* const instruction_set_features_;
625
626  // All class references that require
627  mutable ReaderWriterMutex freezing_constructor_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
628  std::set<ClassReference> freezing_constructor_classes_ GUARDED_BY(freezing_constructor_lock_);
629
630  typedef SafeMap<const ClassReference, CompiledClass*> ClassTable;
631  // All class references that this compiler has compiled.
632  mutable Mutex compiled_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
633  ClassTable compiled_classes_ GUARDED_BY(compiled_classes_lock_);
634
635  typedef SafeMap<const MethodReference, CompiledMethod*, MethodReferenceComparator> MethodTable;
636
637 public:
638  // Lock is public so that non-members can have lock annotations.
639  mutable Mutex compiled_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
640
641 private:
642  // All method references that this compiler has compiled.
643  MethodTable compiled_methods_ GUARDED_BY(compiled_methods_lock_);
644  // Number of non-relative patches in all compiled methods. These patches need space
645  // in the .oat_patches ELF section if requested in the compiler options.
646  size_t non_relative_linker_patch_count_ GUARDED_BY(compiled_methods_lock_);
647
648  const bool boot_image_;
649
650  // If image_ is true, specifies the classes that will be included in the image.
651  // Note if image_classes_ is null, all classes are included in the image.
652  std::unique_ptr<std::unordered_set<std::string>> image_classes_;
653
654  // Specifies the classes that will be compiled. Note that if classes_to_compile_ is null,
655  // all classes are eligible for compilation (duplication filters etc. will still apply).
656  // This option may be restricted to the boot image, depending on a flag in the implementation.
657  std::unique_ptr<std::unordered_set<std::string>> classes_to_compile_;
658
659  // Specifies the methods that will be compiled. Note that if methods_to_compile_ is null,
660  // all methods are eligible for compilation (compilation filters etc. will still apply).
661  // This option may be restricted to the boot image, depending on a flag in the implementation.
662  std::unique_ptr<std::unordered_set<std::string>> methods_to_compile_;
663
664  bool had_hard_verifier_failure_;
665
666  // A thread pool that can (potentially) run tasks in parallel.
667  std::unique_ptr<ThreadPool> parallel_thread_pool_;
668  size_t parallel_thread_count_;
669
670  // A thread pool that guarantees running single-threaded on the main thread.
671  std::unique_ptr<ThreadPool> single_thread_pool_;
672
673  class AOTCompilationStats;
674  std::unique_ptr<AOTCompilationStats> stats_;
675
676  bool dump_stats_;
677  const bool dump_passes_;
678
679  CumulativeLogger* const timings_logger_;
680
681  typedef void (*CompilerCallbackFn)(CompilerDriver& driver);
682  typedef MutexLock* (*CompilerMutexLockFn)(CompilerDriver& driver);
683
684  void* compiler_context_;
685
686  bool support_boot_image_fixup_;
687
688  // List of dex files that will be stored in the oat file.
689  const std::vector<const DexFile*>* dex_files_for_oat_file_;
690
691  CompiledMethodStorage compiled_method_storage_;
692
693  // Info for profile guided compilation.
694  const ProfileCompilationInfo* const profile_compilation_info_;
695
696  friend class CompileClassVisitor;
697  DISALLOW_COPY_AND_ASSIGN(CompilerDriver);
698};
699
700}  // namespace art
701
702#endif  // ART_COMPILER_DRIVER_COMPILER_DRIVER_H_
703