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