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