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