compiler_driver.h revision 9437b78780f9e6ffa5797ebe82de8e8d7f3a5ed6 
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  mirror::Class* ResolveClass(
232      const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
233      Handle<mirror::ClassLoader> class_loader, uint16_t type_index,
234      const DexCompilationUnit* mUnit)
235    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
236
237  // Resolve a field. Returns nullptr on failure, including incompatible class change.
238  // NOTE: Unlike ClassLinker's ResolveField(), this method enforces is_static.
239  mirror::ArtField* ResolveField(
240      const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
241      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
242      uint32_t field_idx, bool is_static)
243    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
244
245  // Resolve a field with a given dex file.
246  mirror::ArtField* ResolveFieldWithDexFile(
247      const ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
248      Handle<mirror::ClassLoader> class_loader, const DexFile* dex_file,
249      uint32_t field_idx, bool is_static)
250    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
251
252  // Get declaration location of a resolved field.
253  void GetResolvedFieldDexFileLocation(
254      mirror::ArtField* resolved_field, const DexFile** declaring_dex_file,
255      uint16_t* declaring_class_idx, uint16_t* declaring_field_idx)
256    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
257
258  bool IsFieldVolatile(mirror::ArtField* field) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
259  MemberOffset GetFieldOffset(mirror::ArtField* field) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
260
261  // Find a dex cache for a dex file.
262  inline mirror::DexCache* FindDexCache(const DexFile* dex_file)
263      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
264
265  // Can we fast-path an IGET/IPUT access to an instance field? If yes, compute the field offset.
266  std::pair<bool, bool> IsFastInstanceField(
267      mirror::DexCache* dex_cache, mirror::Class* referrer_class,
268      mirror::ArtField* resolved_field, uint16_t field_idx)
269    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
270
271  // Can we fast-path an SGET/SPUT access to a static field? If yes, compute the type index
272  // of the declaring class in the referrer's dex file.
273  std::pair<bool, bool> IsFastStaticField(
274      mirror::DexCache* dex_cache, mirror::Class* referrer_class,
275      mirror::ArtField* resolved_field, uint16_t field_idx, uint32_t* storage_index)
276    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
277
278  // Is static field's in referrer's class?
279  bool IsStaticFieldInReferrerClass(mirror::Class* referrer_class, mirror::ArtField* resolved_field)
280    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
281
282  // Is static field's class initialized?
283  bool IsStaticFieldsClassInitialized(mirror::Class* referrer_class,
284                                      mirror::ArtField* resolved_field)
285    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
286
287  // Resolve a method. Returns nullptr on failure, including incompatible class change.
288  mirror::ArtMethod* ResolveMethod(
289      ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
290      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
291      uint32_t method_idx, InvokeType invoke_type, bool check_incompatible_class_change = true)
292    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
293
294  // Get declaration location of a resolved field.
295  void GetResolvedMethodDexFileLocation(
296      mirror::ArtMethod* resolved_method, const DexFile** declaring_dex_file,
297      uint16_t* declaring_class_idx, uint16_t* declaring_method_idx)
298    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
299
300  // Get the index in the vtable of the method.
301  uint16_t GetResolvedMethodVTableIndex(
302      mirror::ArtMethod* resolved_method, InvokeType type)
303    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
304
305  // Can we fast-path an INVOKE? If no, returns 0. If yes, returns a non-zero opaque flags value
306  // for ProcessedInvoke() and computes the necessary lowering info.
307  int IsFastInvoke(
308      ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
309      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
310      mirror::Class* referrer_class, mirror::ArtMethod* resolved_method, InvokeType* invoke_type,
311      MethodReference* target_method, const MethodReference* devirt_target,
312      uintptr_t* direct_code, uintptr_t* direct_method)
313    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
314
315  // Is method's class initialized for an invoke?
316  // For static invokes to determine whether we need to consider potential call to <clinit>().
317  // For non-static invokes, assuming a non-null reference, the class is always initialized.
318  bool IsMethodsClassInitialized(mirror::Class* referrer_class, mirror::ArtMethod* resolved_method)
319    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
320
321  void ProcessedInstanceField(bool resolved);
322  void ProcessedStaticField(bool resolved, bool local);
323  void ProcessedInvoke(InvokeType invoke_type, int flags);
324
325  void ComputeFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit,
326                        const ScopedObjectAccess& soa, bool is_static,
327                        mirror::ArtField** resolved_field,
328                        mirror::Class** referrer_class,
329                        mirror::DexCache** dex_cache)
330      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
331
332  // Can we fast path instance field access? Computes field's offset and volatility.
333  bool ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
334                                MemberOffset* field_offset, bool* is_volatile)
335      LOCKS_EXCLUDED(Locks::mutator_lock_);
336
337  mirror::ArtField* ComputeInstanceFieldInfo(uint32_t field_idx,
338                                             const DexCompilationUnit* mUnit,
339                                             bool is_put,
340                                             const ScopedObjectAccess& soa)
341      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
342
343
344  // Can we fastpath static field access? Computes field's offset, volatility and whether the
345  // field is within the referrer (which can avoid checking class initialization).
346  bool ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
347                              MemberOffset* field_offset, uint32_t* storage_index,
348                              bool* is_referrers_class, bool* is_volatile, bool* is_initialized,
349                              Primitive::Type* type)
350      LOCKS_EXCLUDED(Locks::mutator_lock_);
351
352  // Can we fastpath a interface, super class or virtual method call? Computes method's vtable
353  // index.
354  bool ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
355                         bool update_stats, bool enable_devirtualization,
356                         InvokeType* type, MethodReference* target_method, int* vtable_idx,
357                         uintptr_t* direct_code, uintptr_t* direct_method)
358      LOCKS_EXCLUDED(Locks::mutator_lock_);
359
360  const VerifiedMethod* GetVerifiedMethod(const DexFile* dex_file, uint32_t method_idx) const;
361  bool IsSafeCast(const DexCompilationUnit* mUnit, uint32_t dex_pc);
362
363  bool GetSupportBootImageFixup() const {
364    return support_boot_image_fixup_;
365  }
366
367  void SetSupportBootImageFixup(bool support_boot_image_fixup) {
368    support_boot_image_fixup_ = support_boot_image_fixup;
369  }
370
371  SwapAllocator<void>& GetSwapSpaceAllocator() {
372    return *swap_space_allocator_.get();
373  }
374
375  bool WriteElf(const std::string& android_root,
376                bool is_host,
377                const std::vector<const DexFile*>& dex_files,
378                OatWriter* oat_writer,
379                File* file);
380
381  // TODO: move to a common home for llvm helpers once quick/portable are merged.
382  static void InstructionSetToLLVMTarget(InstructionSet instruction_set,
383                                         std::string* target_triple,
384                                         std::string* target_cpu,
385                                         std::string* target_attr);
386
387  void SetCompilerContext(void* compiler_context) {
388    compiler_context_ = compiler_context;
389  }
390
391  void* GetCompilerContext() const {
392    return compiler_context_;
393  }
394
395  size_t GetThreadCount() const {
396    return thread_count_;
397  }
398
399  bool GetDumpPasses() const {
400    return dump_passes_;
401  }
402
403  const std::string& GetDumpCfgFileName() const {
404    return dump_cfg_file_name_;
405  }
406
407  CumulativeLogger* GetTimingsLogger() const {
408    return timings_logger_;
409  }
410
411  void SetDedupeEnabled(bool dedupe_enabled) {
412    dedupe_enabled_ = dedupe_enabled;
413  }
414  bool DedupeEnabled() const {
415    return dedupe_enabled_;
416  }
417
418  // Checks if class specified by type_idx is one of the image_classes_
419  bool IsImageClass(const char* descriptor) const;
420
421  // Checks if the provided class should be compiled, i.e., is in classes_to_compile_.
422  bool IsClassToCompile(const char* descriptor) const;
423
424  void RecordClassStatus(ClassReference ref, mirror::Class::Status status)
425      LOCKS_EXCLUDED(compiled_classes_lock_);
426
427  SwapVector<uint8_t>* DeduplicateCode(const ArrayRef<const uint8_t>& code);
428  SwapSrcMap* DeduplicateSrcMappingTable(const ArrayRef<SrcMapElem>& src_map);
429  SwapVector<uint8_t>* DeduplicateMappingTable(const ArrayRef<const uint8_t>& code);
430  SwapVector<uint8_t>* DeduplicateVMapTable(const ArrayRef<const uint8_t>& code);
431  SwapVector<uint8_t>* DeduplicateGCMap(const ArrayRef<const uint8_t>& code);
432  SwapVector<uint8_t>* DeduplicateCFIInfo(const ArrayRef<const uint8_t>& cfi_info);
433
434  // Should the compiler run on this method given profile information?
435  bool SkipCompilation(const std::string& method_name);
436
437  // Get memory usage during compilation.
438  std::string GetMemoryUsageString(bool extended) const;
439
440  void SetHadHardVerifierFailure() {
441    had_hard_verifier_failure_ = true;
442  }
443
444 private:
445  // These flags are internal to CompilerDriver for collecting INVOKE resolution statistics.
446  // The only external contract is that unresolved method has flags 0 and resolved non-0.
447  enum {
448    kBitMethodResolved = 0,
449    kBitVirtualMadeDirect,
450    kBitPreciseTypeDevirtualization,
451    kBitDirectCallToBoot,
452    kBitDirectMethodToBoot
453  };
454  static constexpr int kFlagMethodResolved              = 1 << kBitMethodResolved;
455  static constexpr int kFlagVirtualMadeDirect           = 1 << kBitVirtualMadeDirect;
456  static constexpr int kFlagPreciseTypeDevirtualization = 1 << kBitPreciseTypeDevirtualization;
457  static constexpr int kFlagDirectCallToBoot            = 1 << kBitDirectCallToBoot;
458  static constexpr int kFlagDirectMethodToBoot          = 1 << kBitDirectMethodToBoot;
459  static constexpr int kFlagsMethodResolvedVirtualMadeDirect =
460      kFlagMethodResolved | kFlagVirtualMadeDirect;
461  static constexpr int kFlagsMethodResolvedPreciseTypeDevirtualization =
462      kFlagsMethodResolvedVirtualMadeDirect | kFlagPreciseTypeDevirtualization;
463
464 public:  // TODO make private or eliminate.
465  // Compute constant code and method pointers when possible.
466  void GetCodeAndMethodForDirectCall(/*out*/InvokeType* type,
467                                     InvokeType sharp_type,
468                                     bool no_guarantee_of_dex_cache_entry,
469                                     const mirror::Class* referrer_class,
470                                     mirror::ArtMethod* method,
471                                     /*out*/int* stats_flags,
472                                     MethodReference* target_method,
473                                     uintptr_t* direct_code, uintptr_t* direct_method)
474      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
475
476 private:
477  DexToDexCompilationLevel GetDexToDexCompilationlevel(
478      Thread* self, Handle<mirror::ClassLoader> class_loader, const DexFile& dex_file,
479      const DexFile::ClassDef& class_def) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
480
481  void PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
482                  ThreadPool* thread_pool, TimingLogger* timings)
483      LOCKS_EXCLUDED(Locks::mutator_lock_);
484
485  void LoadImageClasses(TimingLogger* timings);
486
487  // Attempt to resolve all type, methods, fields, and strings
488  // referenced from code in the dex file following PathClassLoader
489  // ordering semantics.
490  void Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files,
491               ThreadPool* thread_pool, TimingLogger* timings)
492      LOCKS_EXCLUDED(Locks::mutator_lock_);
493  void ResolveDexFile(jobject class_loader, const DexFile& dex_file,
494                      const std::vector<const DexFile*>& dex_files,
495                      ThreadPool* thread_pool, TimingLogger* timings)
496      LOCKS_EXCLUDED(Locks::mutator_lock_);
497
498  void Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files,
499              ThreadPool* thread_pool, TimingLogger* timings);
500  void VerifyDexFile(jobject class_loader, const DexFile& dex_file,
501                     const std::vector<const DexFile*>& dex_files,
502                     ThreadPool* thread_pool, TimingLogger* timings)
503      LOCKS_EXCLUDED(Locks::mutator_lock_);
504
505  void SetVerified(jobject class_loader, const std::vector<const DexFile*>& dex_files,
506                   ThreadPool* thread_pool, TimingLogger* timings);
507  void SetVerifiedDexFile(jobject class_loader, const DexFile& dex_file,
508                          const std::vector<const DexFile*>& dex_files,
509                          ThreadPool* thread_pool, TimingLogger* timings)
510      LOCKS_EXCLUDED(Locks::mutator_lock_);
511
512  void InitializeClasses(jobject class_loader, const std::vector<const DexFile*>& dex_files,
513                         ThreadPool* thread_pool, TimingLogger* timings)
514      LOCKS_EXCLUDED(Locks::mutator_lock_);
515  void InitializeClasses(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_, compiled_classes_lock_);
519
520  void UpdateImageClasses(TimingLogger* timings) LOCKS_EXCLUDED(Locks::mutator_lock_);
521  static void FindClinitImageClassesCallback(mirror::Object* object, void* arg)
522      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
523
524  void Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
525               ThreadPool* thread_pool, TimingLogger* timings);
526  void CompileDexFile(jobject class_loader, const DexFile& dex_file,
527                      const std::vector<const DexFile*>& dex_files,
528                      ThreadPool* thread_pool, TimingLogger* timings)
529      LOCKS_EXCLUDED(Locks::mutator_lock_);
530  void CompileMethod(Thread* self, const DexFile::CodeItem* code_item, uint32_t access_flags,
531                     InvokeType invoke_type, uint16_t class_def_idx, uint32_t method_idx,
532                     jobject class_loader, const DexFile& dex_file,
533                     DexToDexCompilationLevel dex_to_dex_compilation_level,
534                     bool compilation_enabled)
535      LOCKS_EXCLUDED(compiled_methods_lock_);
536
537  static void CompileClass(const ParallelCompilationManager* context, size_t class_def_index)
538      LOCKS_EXCLUDED(Locks::mutator_lock_);
539
540  // Swap pool and allocator used for native allocations. May be file-backed. Needs to be first
541  // as other fields rely on this.
542  std::unique_ptr<SwapSpace> swap_space_;
543  std::unique_ptr<SwapAllocator<void> > swap_space_allocator_;
544
545  ProfileFile profile_file_;
546  bool profile_present_;
547
548  const CompilerOptions* const compiler_options_;
549  VerificationResults* const verification_results_;
550  DexFileToMethodInlinerMap* const method_inliner_map_;
551
552  std::unique_ptr<Compiler> compiler_;
553
554  const InstructionSet instruction_set_;
555  const InstructionSetFeatures* const instruction_set_features_;
556
557  // All class references that require
558  mutable ReaderWriterMutex freezing_constructor_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
559  std::set<ClassReference> freezing_constructor_classes_ GUARDED_BY(freezing_constructor_lock_);
560
561  typedef SafeMap<const ClassReference, CompiledClass*> ClassTable;
562  // All class references that this compiler has compiled.
563  mutable Mutex compiled_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
564  ClassTable compiled_classes_ GUARDED_BY(compiled_classes_lock_);
565
566  typedef SafeMap<const MethodReference, CompiledMethod*, MethodReferenceComparator> MethodTable;
567  // All method references that this compiler has compiled.
568  mutable Mutex compiled_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
569  MethodTable compiled_methods_ GUARDED_BY(compiled_methods_lock_);
570  // Number of non-relative patches in all compiled methods. These patches need space
571  // in the .oat_patches ELF section if requested in the compiler options.
572  size_t non_relative_linker_patch_count_ GUARDED_BY(compiled_methods_lock_);
573
574  const bool image_;
575
576  // If image_ is true, specifies the classes that will be included in
577  // the image. Note if image_classes_ is nullptr, all classes are
578  // included in the image.
579  std::unique_ptr<std::set<std::string>> image_classes_;
580
581  // If image_ is true, specifies the classes that will be compiled in
582  // the image. Note if classes_to_compile_ is nullptr, all classes are
583  // included in the image.
584  std::unique_ptr<std::set<std::string>> classes_to_compile_;
585
586  bool had_hard_verifier_failure_;
587
588  size_t thread_count_;
589
590  class AOTCompilationStats;
591  std::unique_ptr<AOTCompilationStats> stats_;
592
593  bool dedupe_enabled_;
594  bool dump_stats_;
595  const bool dump_passes_;
596  const std::string& dump_cfg_file_name_;
597
598  CumulativeLogger* const timings_logger_;
599
600  typedef void (*CompilerCallbackFn)(CompilerDriver& driver);
601  typedef MutexLock* (*CompilerMutexLockFn)(CompilerDriver& driver);
602
603  typedef void (*DexToDexCompilerFn)(CompilerDriver& driver,
604                                     const DexFile::CodeItem* code_item,
605                                     uint32_t access_flags, InvokeType invoke_type,
606                                     uint32_t class_dex_idx, uint32_t method_idx,
607                                     jobject class_loader, const DexFile& dex_file,
608                                     DexToDexCompilationLevel dex_to_dex_compilation_level);
609  DexToDexCompilerFn dex_to_dex_compiler_;
610
611  void* compiler_context_;
612
613  bool support_boot_image_fixup_;
614
615  // DeDuplication data structures, these own the corresponding byte arrays.
616  template <typename ContentType>
617  class DedupeHashFunc {
618   public:
619    size_t operator()(const ArrayRef<ContentType>& array) const {
620      const uint8_t* data = reinterpret_cast<const uint8_t*>(array.data());
621      static_assert(IsPowerOfTwo(sizeof(ContentType)),
622          "ContentType is not power of two, don't know whether array layout is as assumed");
623      uint32_t len = sizeof(ContentType) * array.size();
624      if (kUseMurmur3Hash) {
625        static constexpr uint32_t c1 = 0xcc9e2d51;
626        static constexpr uint32_t c2 = 0x1b873593;
627        static constexpr uint32_t r1 = 15;
628        static constexpr uint32_t r2 = 13;
629        static constexpr uint32_t m = 5;
630        static constexpr uint32_t n = 0xe6546b64;
631
632        uint32_t hash = 0;
633
634        const int nblocks = len / 4;
635        typedef __attribute__((__aligned__(1))) uint32_t unaligned_uint32_t;
636        const unaligned_uint32_t *blocks = reinterpret_cast<const uint32_t*>(data);
637        int i;
638        for (i = 0; i < nblocks; i++) {
639          uint32_t k = blocks[i];
640          k *= c1;
641          k = (k << r1) | (k >> (32 - r1));
642          k *= c2;
643
644          hash ^= k;
645          hash = ((hash << r2) | (hash >> (32 - r2))) * m + n;
646        }
647
648        const uint8_t *tail = reinterpret_cast<const uint8_t*>(data + nblocks * 4);
649        uint32_t k1 = 0;
650
651        switch (len & 3) {
652          case 3:
653            k1 ^= tail[2] << 16;
654            FALLTHROUGH_INTENDED;
655          case 2:
656            k1 ^= tail[1] << 8;
657            FALLTHROUGH_INTENDED;
658          case 1:
659            k1 ^= tail[0];
660
661            k1 *= c1;
662            k1 = (k1 << r1) | (k1 >> (32 - r1));
663            k1 *= c2;
664            hash ^= k1;
665        }
666
667        hash ^= len;
668        hash ^= (hash >> 16);
669        hash *= 0x85ebca6b;
670        hash ^= (hash >> 13);
671        hash *= 0xc2b2ae35;
672        hash ^= (hash >> 16);
673
674        return hash;
675      } else {
676        size_t hash = 0x811c9dc5;
677        for (uint32_t i = 0; i < len; ++i) {
678          hash = (hash * 16777619) ^ data[i];
679        }
680        hash += hash << 13;
681        hash ^= hash >> 7;
682        hash += hash << 3;
683        hash ^= hash >> 17;
684        hash += hash << 5;
685        return hash;
686      }
687    }
688  };
689
690  DedupeSet<ArrayRef<const uint8_t>,
691            SwapVector<uint8_t>, size_t, DedupeHashFunc<const uint8_t>, 4> dedupe_code_;
692  DedupeSet<ArrayRef<SrcMapElem>,
693            SwapSrcMap, size_t, DedupeHashFunc<SrcMapElem>, 4> dedupe_src_mapping_table_;
694  DedupeSet<ArrayRef<const uint8_t>,
695            SwapVector<uint8_t>, size_t, DedupeHashFunc<const uint8_t>, 4> dedupe_mapping_table_;
696  DedupeSet<ArrayRef<const uint8_t>,
697            SwapVector<uint8_t>, size_t, DedupeHashFunc<const uint8_t>, 4> dedupe_vmap_table_;
698  DedupeSet<ArrayRef<const uint8_t>,
699            SwapVector<uint8_t>, size_t, DedupeHashFunc<const uint8_t>, 4> dedupe_gc_map_;
700  DedupeSet<ArrayRef<const uint8_t>,
701            SwapVector<uint8_t>, size_t, DedupeHashFunc<const uint8_t>, 4> dedupe_cfi_info_;
702
703  DISALLOW_COPY_AND_ASSIGN(CompilerDriver);
704};
705
706}  // namespace art
707
708#endif  // ART_COMPILER_DRIVER_COMPILER_DRIVER_H_
709