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