compiler_driver.h revision 98d1cc8033251c93786e2fa8c59a2e555a9493be 
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 "base/mutex.h"
25#include "base/timing_logger.h"
26#include "class_reference.h"
27#include "compiled_method.h"
28#include "compiler.h"
29#include "dex_file.h"
30#include "driver/compiler_options.h"
31#include "instruction_set.h"
32#include "invoke_type.h"
33#include "method_reference.h"
34#include "mirror/class.h"  // For mirror::Class::Status.
35#include "os.h"
36#include "profiler.h"
37#include "runtime.h"
38#include "safe_map.h"
39#include "thread_pool.h"
40#include "utils/arena_allocator.h"
41#include "utils/dedupe_set.h"
42
43namespace art {
44
45namespace verifier {
46class MethodVerifier;
47}  // namespace verifier
48
49class CompiledClass;
50class CompilerOptions;
51class DexCompilationUnit;
52class DexFileToMethodInlinerMap;
53struct InlineIGetIPutData;
54class OatWriter;
55class ParallelCompilationManager;
56class ScopedObjectAccess;
57template<class T> class Handle;
58class TimingLogger;
59class VerificationResults;
60class VerifiedMethod;
61
62enum EntryPointCallingConvention {
63  // ABI of invocations to a method's interpreter entry point.
64  kInterpreterAbi,
65  // ABI of calls to a method's native code, only used for native methods.
66  kJniAbi,
67  // ABI of calls to a method's portable code entry point.
68  kPortableAbi,
69  // ABI of calls to a method's quick code entry point.
70  kQuickAbi
71};
72
73enum DexToDexCompilationLevel {
74  kDontDexToDexCompile,   // Only meaning wrt image time interpretation.
75  kRequired,              // Dex-to-dex compilation required for correctness.
76  kOptimize               // Perform required transformation and peep-hole optimizations.
77};
78
79// Thread-local storage compiler worker threads
80class CompilerTls {
81  public:
82    CompilerTls() : llvm_info_(NULL) {}
83    ~CompilerTls() {}
84
85    void* GetLLVMInfo() { return llvm_info_; }
86
87    void SetLLVMInfo(void* llvm_info) { llvm_info_ = llvm_info; }
88
89  private:
90    void* llvm_info_;
91};
92
93class CompilerDriver {
94 public:
95  typedef std::set<std::string> DescriptorSet;
96
97  // Create a compiler targeting the requested "instruction_set".
98  // "image" should be true if image specific optimizations should be
99  // enabled.  "image_classes" lets the compiler know what classes it
100  // can assume will be in the image, with NULL implying all available
101  // classes.
102  explicit CompilerDriver(const CompilerOptions* compiler_options,
103                          VerificationResults* verification_results,
104                          DexFileToMethodInlinerMap* method_inliner_map,
105                          Compiler::Kind compiler_kind,
106                          InstructionSet instruction_set,
107                          InstructionSetFeatures instruction_set_features,
108                          bool image, DescriptorSet* image_classes,
109                          size_t thread_count, bool dump_stats, bool dump_passes,
110                          CumulativeLogger* timer, std::string profile_file = "");
111
112  ~CompilerDriver();
113
114  void CompileAll(jobject class_loader, const std::vector<const DexFile*>& dex_files,
115                  TimingLogger* timings)
116      LOCKS_EXCLUDED(Locks::mutator_lock_);
117
118  // Compile a single Method.
119  void CompileOne(mirror::ArtMethod* method, TimingLogger* timings)
120      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
121
122  VerificationResults* GetVerificationResults() const {
123    return verification_results_;
124  }
125
126  DexFileToMethodInlinerMap* GetMethodInlinerMap() const {
127    return method_inliner_map_;
128  }
129
130  InstructionSet GetInstructionSet() const {
131    return instruction_set_;
132  }
133
134  InstructionSetFeatures GetInstructionSetFeatures() const {
135    return instruction_set_features_;
136  }
137
138  const CompilerOptions& GetCompilerOptions() const {
139    return *compiler_options_;
140  }
141
142  Compiler* GetCompiler() const {
143    return compiler_.get();
144  }
145
146  bool ProfilePresent() const {
147    return profile_present_;
148  }
149
150  // Are we compiling and creating an image file?
151  bool IsImage() const {
152    return image_;
153  }
154
155  DescriptorSet* GetImageClasses() const {
156    return image_classes_.get();
157  }
158
159  CompilerTls* GetTls();
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>* CreatePortableImtConflictTrampoline() const
169      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
170  const std::vector<uint8_t>* CreatePortableResolutionTrampoline() const
171      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
172  const std::vector<uint8_t>* CreatePortableToInterpreterBridge() const
173      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
174  const std::vector<uint8_t>* CreateQuickGenericJniTrampoline() const
175      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
176  const std::vector<uint8_t>* CreateQuickImtConflictTrampoline() const
177      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
178  const std::vector<uint8_t>* CreateQuickResolutionTrampoline() const
179      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
180  const std::vector<uint8_t>* CreateQuickToInterpreterBridge() const
181      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
182
183  CompiledClass* GetCompiledClass(ClassReference ref) const
184      LOCKS_EXCLUDED(compiled_classes_lock_);
185
186  CompiledMethod* GetCompiledMethod(MethodReference ref) const
187      LOCKS_EXCLUDED(compiled_methods_lock_);
188
189  void AddRequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
190                                     uint16_t class_def_index);
191  bool RequiresConstructorBarrier(Thread* self, const DexFile* dex_file, uint16_t class_def_index);
192
193  // Callbacks from compiler to see what runtime checks must be generated.
194
195  bool CanAssumeTypeIsPresentInDexCache(const DexFile& dex_file, uint32_t type_idx);
196
197  bool CanAssumeStringIsPresentInDexCache(const DexFile& dex_file, uint32_t string_idx)
198      LOCKS_EXCLUDED(Locks::mutator_lock_);
199
200  // Are runtime access checks necessary in the compiled code?
201  bool CanAccessTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
202                                  uint32_t type_idx, bool* type_known_final = NULL,
203                                  bool* type_known_abstract = NULL,
204                                  bool* equals_referrers_class = NULL)
205      LOCKS_EXCLUDED(Locks::mutator_lock_);
206
207  // Are runtime access and instantiable checks necessary in the code?
208  bool CanAccessInstantiableTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
209                                              uint32_t type_idx)
210     LOCKS_EXCLUDED(Locks::mutator_lock_);
211
212  bool CanEmbedTypeInCode(const DexFile& dex_file, uint32_t type_idx,
213                          bool* is_type_initialized, bool* use_direct_type_ptr,
214                          uintptr_t* direct_type_ptr, bool* out_is_finalizable);
215
216  // Get the DexCache for the
217  mirror::DexCache* GetDexCache(const DexCompilationUnit* mUnit)
218    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
219
220  mirror::ClassLoader* GetClassLoader(ScopedObjectAccess& soa, const DexCompilationUnit* mUnit)
221    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
222
223  // Resolve compiling method's class. Returns nullptr on failure.
224  mirror::Class* ResolveCompilingMethodsClass(
225      ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
226      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit)
227    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
228
229  // Resolve a field. Returns nullptr on failure, including incompatible class change.
230  // NOTE: Unlike ClassLinker's ResolveField(), this method enforces is_static.
231  mirror::ArtField* ResolveField(
232      ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
233      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
234      uint32_t field_idx, bool is_static)
235    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
236
237  // Get declaration location of a resolved field.
238  void GetResolvedFieldDexFileLocation(
239      mirror::ArtField* resolved_field, const DexFile** declaring_dex_file,
240      uint16_t* declaring_class_idx, uint16_t* declaring_field_idx)
241    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
242
243  bool IsFieldVolatile(mirror::ArtField* field) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
244
245  // Can we fast-path an IGET/IPUT access to an instance field? If yes, compute the field offset.
246  std::pair<bool, bool> IsFastInstanceField(
247      mirror::DexCache* dex_cache, mirror::Class* referrer_class,
248      mirror::ArtField* resolved_field, uint16_t field_idx, MemberOffset* field_offset)
249    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
250
251  // Can we fast-path an SGET/SPUT access to a static field? If yes, compute the field offset,
252  // the type index of the declaring class in the referrer's dex file and whether the declaring
253  // class is the referrer's class or at least can be assumed to be initialized.
254  std::pair<bool, bool> IsFastStaticField(
255      mirror::DexCache* dex_cache, mirror::Class* referrer_class,
256      mirror::ArtField* resolved_field, uint16_t field_idx, MemberOffset* field_offset,
257      uint32_t* storage_index, bool* is_referrers_class, bool* is_initialized)
258    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
259
260  // Resolve a method. Returns nullptr on failure, including incompatible class change.
261  mirror::ArtMethod* ResolveMethod(
262      ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
263      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
264      uint32_t method_idx, InvokeType invoke_type)
265    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
266
267  // Get declaration location of a resolved field.
268  void GetResolvedMethodDexFileLocation(
269      mirror::ArtMethod* resolved_method, const DexFile** declaring_dex_file,
270      uint16_t* declaring_class_idx, uint16_t* declaring_method_idx)
271    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
272
273  // Get declaration location of a resolved field.
274  uint16_t GetResolvedMethodVTableIndex(
275      mirror::ArtMethod* resolved_method, InvokeType type)
276    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
277
278  // Can we fast-path an INVOKE? If no, returns 0. If yes, returns a non-zero opaque flags value
279  // for ProcessedInvoke() and computes the necessary lowering info.
280  int IsFastInvoke(
281      ScopedObjectAccess& soa, Handle<mirror::DexCache> dex_cache,
282      Handle<mirror::ClassLoader> class_loader, const DexCompilationUnit* mUnit,
283      mirror::Class* referrer_class, mirror::ArtMethod* resolved_method, InvokeType* invoke_type,
284      MethodReference* target_method, const MethodReference* devirt_target,
285      uintptr_t* direct_code, uintptr_t* direct_method)
286    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
287
288  // Does invokation of the resolved method need class initialization?
289  bool NeedsClassInitialization(mirror::Class* referrer_class, mirror::ArtMethod* resolved_method)
290    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
291
292  void ProcessedInstanceField(bool resolved);
293  void ProcessedStaticField(bool resolved, bool local);
294  void ProcessedInvoke(InvokeType invoke_type, int flags);
295
296  // Can we fast path instance field access? Computes field's offset and volatility.
297  bool ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
298                                MemberOffset* field_offset, bool* is_volatile)
299      LOCKS_EXCLUDED(Locks::mutator_lock_);
300
301  // Can we fastpath static field access? Computes field's offset, volatility and whether the
302  // field is within the referrer (which can avoid checking class initialization).
303  bool ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
304                              MemberOffset* field_offset, uint32_t* storage_index,
305                              bool* is_referrers_class, bool* is_volatile, bool* is_initialized)
306      LOCKS_EXCLUDED(Locks::mutator_lock_);
307
308  // Can we fastpath a interface, super class or virtual method call? Computes method's vtable
309  // index.
310  bool ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
311                         bool update_stats, bool enable_devirtualization,
312                         InvokeType* type, MethodReference* target_method, int* vtable_idx,
313                         uintptr_t* direct_code, uintptr_t* direct_method)
314      LOCKS_EXCLUDED(Locks::mutator_lock_);
315
316  const VerifiedMethod* GetVerifiedMethod(const DexFile* dex_file, uint32_t method_idx) const;
317  bool IsSafeCast(const DexCompilationUnit* mUnit, uint32_t dex_pc);
318
319  // Record patch information for later fix up.
320  void AddCodePatch(const DexFile* dex_file,
321                    uint16_t referrer_class_def_idx,
322                    uint32_t referrer_method_idx,
323                    InvokeType referrer_invoke_type,
324                    uint32_t target_method_idx,
325                    const DexFile* target_dex_file,
326                    InvokeType target_invoke_type,
327                    size_t literal_offset)
328      LOCKS_EXCLUDED(compiled_methods_lock_);
329  void AddRelativeCodePatch(const DexFile* dex_file,
330                            uint16_t referrer_class_def_idx,
331                            uint32_t referrer_method_idx,
332                            InvokeType referrer_invoke_type,
333                            uint32_t target_method_idx,
334                            const DexFile* target_dex_file,
335                            InvokeType target_invoke_type,
336                            size_t literal_offset,
337                            int32_t pc_relative_offset)
338      LOCKS_EXCLUDED(compiled_methods_lock_);
339  void AddMethodPatch(const DexFile* dex_file,
340                      uint16_t referrer_class_def_idx,
341                      uint32_t referrer_method_idx,
342                      InvokeType referrer_invoke_type,
343                      uint32_t target_method_idx,
344                      const DexFile* target_dex_file,
345                      InvokeType target_invoke_type,
346                      size_t literal_offset)
347      LOCKS_EXCLUDED(compiled_methods_lock_);
348  void AddClassPatch(const DexFile* dex_file,
349                     uint16_t referrer_class_def_idx,
350                     uint32_t referrer_method_idx,
351                     uint32_t target_method_idx,
352                     size_t literal_offset)
353      LOCKS_EXCLUDED(compiled_methods_lock_);
354
355  bool GetSupportBootImageFixup() const {
356    return support_boot_image_fixup_;
357  }
358
359  void SetSupportBootImageFixup(bool support_boot_image_fixup) {
360    support_boot_image_fixup_ = support_boot_image_fixup;
361  }
362
363  ArenaPool* GetArenaPool() {
364    return &arena_pool_;
365  }
366
367  bool WriteElf(const std::string& android_root,
368                bool is_host,
369                const std::vector<const DexFile*>& dex_files,
370                OatWriter* oat_writer,
371                File* file);
372
373  // TODO: move to a common home for llvm helpers once quick/portable are merged.
374  static void InstructionSetToLLVMTarget(InstructionSet instruction_set,
375                                         std::string* target_triple,
376                                         std::string* target_cpu,
377                                         std::string* target_attr);
378
379  void SetCompilerContext(void* compiler_context) {
380    compiler_context_ = compiler_context;
381  }
382
383  void* GetCompilerContext() const {
384    return compiler_context_;
385  }
386
387  size_t GetThreadCount() const {
388    return thread_count_;
389  }
390
391  class CallPatchInformation;
392  class TypePatchInformation;
393
394  bool GetDumpPasses() const {
395    return dump_passes_;
396  }
397
398  bool DidIncludeDebugSymbols() const {
399    return compiler_options_->GetIncludeDebugSymbols();
400  }
401
402  CumulativeLogger* GetTimingsLogger() const {
403    return timings_logger_;
404  }
405
406  class PatchInformation {
407   public:
408    const DexFile& GetDexFile() const {
409      return *dex_file_;
410    }
411    uint16_t GetReferrerClassDefIdx() const {
412      return referrer_class_def_idx_;
413    }
414    uint32_t GetReferrerMethodIdx() const {
415      return referrer_method_idx_;
416    }
417    size_t GetLiteralOffset() const {
418      return literal_offset_;
419    }
420
421    virtual bool IsCall() const {
422      return false;
423    }
424    virtual bool IsType() const {
425      return false;
426    }
427    virtual const CallPatchInformation* AsCall() const {
428      LOG(FATAL) << "Unreachable";
429      return nullptr;
430    }
431    virtual const TypePatchInformation* AsType() const {
432      LOG(FATAL) << "Unreachable";
433      return nullptr;
434    }
435
436   protected:
437    PatchInformation(const DexFile* dex_file,
438                     uint16_t referrer_class_def_idx,
439                     uint32_t referrer_method_idx,
440                     size_t literal_offset)
441      : dex_file_(dex_file),
442        referrer_class_def_idx_(referrer_class_def_idx),
443        referrer_method_idx_(referrer_method_idx),
444        literal_offset_(literal_offset) {
445      CHECK(dex_file_ != NULL);
446    }
447    virtual ~PatchInformation() {}
448
449    const DexFile* const dex_file_;
450    const uint16_t referrer_class_def_idx_;
451    const uint32_t referrer_method_idx_;
452    const size_t literal_offset_;
453
454    friend class CompilerDriver;
455  };
456
457  class CallPatchInformation : public PatchInformation {
458   public:
459    InvokeType GetReferrerInvokeType() const {
460      return referrer_invoke_type_;
461    }
462    uint32_t GetTargetMethodIdx() const {
463      return target_method_idx_;
464    }
465    const DexFile* GetTargetDexFile() const {
466      return target_dex_file_;
467    }
468    InvokeType GetTargetInvokeType() const {
469      return target_invoke_type_;
470    }
471
472    const CallPatchInformation* AsCall() const {
473      return this;
474    }
475    bool IsCall() const {
476      return true;
477    }
478    virtual bool IsRelative() const {
479      return false;
480    }
481    virtual int RelativeOffset() const {
482      return 0;
483    }
484
485   protected:
486    CallPatchInformation(const DexFile* dex_file,
487                         uint16_t referrer_class_def_idx,
488                         uint32_t referrer_method_idx,
489                         InvokeType referrer_invoke_type,
490                         uint32_t target_method_idx,
491                         const DexFile* target_dex_file,
492                         InvokeType target_invoke_type,
493                         size_t literal_offset)
494        : PatchInformation(dex_file, referrer_class_def_idx,
495                           referrer_method_idx, literal_offset),
496          referrer_invoke_type_(referrer_invoke_type),
497          target_method_idx_(target_method_idx),
498          target_dex_file_(target_dex_file),
499          target_invoke_type_(target_invoke_type) {
500    }
501
502   private:
503    const InvokeType referrer_invoke_type_;
504    const uint32_t target_method_idx_;
505    const DexFile* target_dex_file_;
506    const InvokeType target_invoke_type_;
507
508    friend class CompilerDriver;
509    DISALLOW_COPY_AND_ASSIGN(CallPatchInformation);
510  };
511
512  class RelativeCallPatchInformation : public CallPatchInformation {
513   public:
514    bool IsRelative() const {
515      return true;
516    }
517    int RelativeOffset() const {
518      return offset_;
519    }
520
521   private:
522    RelativeCallPatchInformation(const DexFile* dex_file,
523                                 uint16_t referrer_class_def_idx,
524                                 uint32_t referrer_method_idx,
525                                 InvokeType referrer_invoke_type,
526                                 uint32_t target_method_idx,
527                                 const DexFile* target_dex_file,
528                                 InvokeType target_invoke_type,
529                                 size_t literal_offset,
530                                 int32_t pc_relative_offset)
531        : CallPatchInformation(dex_file, referrer_class_def_idx,
532                           referrer_method_idx, referrer_invoke_type, target_method_idx,
533                           target_dex_file, target_invoke_type, literal_offset),
534          offset_(pc_relative_offset) {
535    }
536
537    const int offset_;
538
539    friend class CompilerDriver;
540    DISALLOW_COPY_AND_ASSIGN(RelativeCallPatchInformation);
541  };
542
543  class TypePatchInformation : public PatchInformation {
544   public:
545    uint32_t GetTargetTypeIdx() const {
546      return target_type_idx_;
547    }
548
549    bool IsType() const {
550      return true;
551    }
552    const TypePatchInformation* AsType() const {
553      return this;
554    }
555
556   private:
557    TypePatchInformation(const DexFile* dex_file,
558                         uint16_t referrer_class_def_idx,
559                         uint32_t referrer_method_idx,
560                         uint32_t target_type_idx,
561                         size_t literal_offset)
562        : PatchInformation(dex_file, referrer_class_def_idx,
563                           referrer_method_idx, literal_offset),
564          target_type_idx_(target_type_idx) {
565    }
566
567    const uint32_t target_type_idx_;
568
569    friend class CompilerDriver;
570    DISALLOW_COPY_AND_ASSIGN(TypePatchInformation);
571  };
572
573  const std::vector<const CallPatchInformation*>& GetCodeToPatch() const {
574    return code_to_patch_;
575  }
576  const std::vector<const CallPatchInformation*>& GetMethodsToPatch() const {
577    return methods_to_patch_;
578  }
579  const std::vector<const TypePatchInformation*>& GetClassesToPatch() const {
580    return classes_to_patch_;
581  }
582
583  // Checks if class specified by type_idx is one of the image_classes_
584  bool IsImageClass(const char* descriptor) const;
585
586  void RecordClassStatus(ClassReference ref, mirror::Class::Status status)
587      LOCKS_EXCLUDED(compiled_classes_lock_);
588
589  std::vector<uint8_t>* DeduplicateCode(const std::vector<uint8_t>& code);
590  std::vector<uint8_t>* DeduplicateMappingTable(const std::vector<uint8_t>& code);
591  std::vector<uint8_t>* DeduplicateVMapTable(const std::vector<uint8_t>& code);
592  std::vector<uint8_t>* DeduplicateGCMap(const std::vector<uint8_t>& code);
593  std::vector<uint8_t>* DeduplicateCFIInfo(const std::vector<uint8_t>* cfi_info);
594
595  /*
596   * @brief return the pointer to the Call Frame Information.
597   * @return pointer to call frame information for this compilation.
598   */
599  std::vector<uint8_t>* GetCallFrameInformation() const {
600    return cfi_info_.get();
601  }
602
603  ProfileFile profile_file_;
604  bool profile_present_;
605
606  // Should the compiler run on this method given profile information?
607  bool SkipCompilation(const std::string& method_name);
608
609 private:
610  // These flags are internal to CompilerDriver for collecting INVOKE resolution statistics.
611  // The only external contract is that unresolved method has flags 0 and resolved non-0.
612  enum {
613    kBitMethodResolved = 0,
614    kBitVirtualMadeDirect,
615    kBitPreciseTypeDevirtualization,
616    kBitDirectCallToBoot,
617    kBitDirectMethodToBoot
618  };
619  static constexpr int kFlagMethodResolved              = 1 << kBitMethodResolved;
620  static constexpr int kFlagVirtualMadeDirect           = 1 << kBitVirtualMadeDirect;
621  static constexpr int kFlagPreciseTypeDevirtualization = 1 << kBitPreciseTypeDevirtualization;
622  static constexpr int kFlagDirectCallToBoot            = 1 << kBitDirectCallToBoot;
623  static constexpr int kFlagDirectMethodToBoot          = 1 << kBitDirectMethodToBoot;
624  static constexpr int kFlagsMethodResolvedVirtualMadeDirect =
625      kFlagMethodResolved | kFlagVirtualMadeDirect;
626  static constexpr int kFlagsMethodResolvedPreciseTypeDevirtualization =
627      kFlagsMethodResolvedVirtualMadeDirect | kFlagPreciseTypeDevirtualization;
628
629 public:  // TODO make private or eliminate.
630  // Compute constant code and method pointers when possible.
631  void GetCodeAndMethodForDirectCall(InvokeType* type, InvokeType sharp_type,
632                                     bool no_guarantee_of_dex_cache_entry,
633                                     mirror::Class* referrer_class,
634                                     mirror::ArtMethod* method,
635                                     int* stats_flags,
636                                     MethodReference* target_method,
637                                     uintptr_t* direct_code, uintptr_t* direct_method)
638      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
639
640 private:
641  void PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
642                  ThreadPool* thread_pool, TimingLogger* timings)
643      LOCKS_EXCLUDED(Locks::mutator_lock_);
644
645  void LoadImageClasses(TimingLogger* timings);
646
647  // Attempt to resolve all type, methods, fields, and strings
648  // referenced from code in the dex file following PathClassLoader
649  // ordering semantics.
650  void Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files,
651               ThreadPool* thread_pool, TimingLogger* timings)
652      LOCKS_EXCLUDED(Locks::mutator_lock_);
653  void ResolveDexFile(jobject class_loader, const DexFile& dex_file,
654                      ThreadPool* thread_pool, TimingLogger* timings)
655      LOCKS_EXCLUDED(Locks::mutator_lock_);
656
657  void Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files,
658              ThreadPool* thread_pool, TimingLogger* timings);
659  void VerifyDexFile(jobject class_loader, const DexFile& dex_file,
660                     ThreadPool* thread_pool, TimingLogger* timings)
661      LOCKS_EXCLUDED(Locks::mutator_lock_);
662
663  void InitializeClasses(jobject class_loader, const std::vector<const DexFile*>& dex_files,
664                         ThreadPool* thread_pool, TimingLogger* timings)
665      LOCKS_EXCLUDED(Locks::mutator_lock_);
666  void InitializeClasses(jobject class_loader, const DexFile& dex_file,
667                         ThreadPool* thread_pool, TimingLogger* timings)
668      LOCKS_EXCLUDED(Locks::mutator_lock_, compiled_classes_lock_);
669
670  void UpdateImageClasses(TimingLogger* timings) LOCKS_EXCLUDED(Locks::mutator_lock_);
671  static void FindClinitImageClassesCallback(mirror::Object* object, void* arg)
672      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
673
674  void Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
675               ThreadPool* thread_pool, TimingLogger* timings);
676  void CompileDexFile(jobject class_loader, const DexFile& dex_file,
677                      ThreadPool* thread_pool, TimingLogger* timings)
678      LOCKS_EXCLUDED(Locks::mutator_lock_);
679  void CompileMethod(const DexFile::CodeItem* code_item, uint32_t access_flags,
680                     InvokeType invoke_type, uint16_t class_def_idx, uint32_t method_idx,
681                     jobject class_loader, const DexFile& dex_file,
682                     DexToDexCompilationLevel dex_to_dex_compilation_level)
683      LOCKS_EXCLUDED(compiled_methods_lock_);
684
685  static void CompileClass(const ParallelCompilationManager* context, size_t class_def_index)
686      LOCKS_EXCLUDED(Locks::mutator_lock_);
687
688  std::vector<const CallPatchInformation*> code_to_patch_;
689  std::vector<const CallPatchInformation*> methods_to_patch_;
690  std::vector<const TypePatchInformation*> classes_to_patch_;
691
692  const CompilerOptions* const compiler_options_;
693  VerificationResults* const verification_results_;
694  DexFileToMethodInlinerMap* const method_inliner_map_;
695
696  std::unique_ptr<Compiler> compiler_;
697
698  const InstructionSet instruction_set_;
699  const InstructionSetFeatures instruction_set_features_;
700
701  // All class references that require
702  mutable ReaderWriterMutex freezing_constructor_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
703  std::set<ClassReference> freezing_constructor_classes_ GUARDED_BY(freezing_constructor_lock_);
704
705  typedef SafeMap<const ClassReference, CompiledClass*> ClassTable;
706  // All class references that this compiler has compiled.
707  mutable Mutex compiled_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
708  ClassTable compiled_classes_ GUARDED_BY(compiled_classes_lock_);
709
710  typedef SafeMap<const MethodReference, CompiledMethod*, MethodReferenceComparator> MethodTable;
711  // All method references that this compiler has compiled.
712  mutable Mutex compiled_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
713  MethodTable compiled_methods_ GUARDED_BY(compiled_methods_lock_);
714
715  const bool image_;
716
717  // If image_ is true, specifies the classes that will be included in
718  // the image. Note if image_classes_ is NULL, all classes are
719  // included in the image.
720  std::unique_ptr<DescriptorSet> image_classes_;
721
722  size_t thread_count_;
723  uint64_t start_ns_;
724
725  class AOTCompilationStats;
726  std::unique_ptr<AOTCompilationStats> stats_;
727
728  bool dump_stats_;
729  const bool dump_passes_;
730
731  CumulativeLogger* const timings_logger_;
732
733  typedef void (*CompilerCallbackFn)(CompilerDriver& driver);
734  typedef MutexLock* (*CompilerMutexLockFn)(CompilerDriver& driver);
735
736  void* compiler_library_;
737
738  typedef void (*DexToDexCompilerFn)(CompilerDriver& driver,
739                                     const DexFile::CodeItem* code_item,
740                                     uint32_t access_flags, InvokeType invoke_type,
741                                     uint32_t class_dex_idx, uint32_t method_idx,
742                                     jobject class_loader, const DexFile& dex_file,
743                                     DexToDexCompilationLevel dex_to_dex_compilation_level);
744  DexToDexCompilerFn dex_to_dex_compiler_;
745
746  void* compiler_context_;
747
748  pthread_key_t tls_key_;
749
750  // Arena pool used by the compiler.
751  ArenaPool arena_pool_;
752
753  typedef void (*CompilerEnableAutoElfLoadingFn)(CompilerDriver& driver);
754  CompilerEnableAutoElfLoadingFn compiler_enable_auto_elf_loading_;
755
756  typedef const void* (*CompilerGetMethodCodeAddrFn)
757      (const CompilerDriver& driver, const CompiledMethod* cm, const mirror::ArtMethod* method);
758  CompilerGetMethodCodeAddrFn compiler_get_method_code_addr_;
759
760  bool support_boot_image_fixup_;
761
762  // Call Frame Information, which might be generated to help stack tracebacks.
763  std::unique_ptr<std::vector<uint8_t>> cfi_info_;
764
765  // DeDuplication data structures, these own the corresponding byte arrays.
766  class DedupeHashFunc {
767   public:
768    size_t operator()(const std::vector<uint8_t>& array) const {
769      // For small arrays compute a hash using every byte.
770      static const size_t kSmallArrayThreshold = 16;
771      size_t hash = 0x811c9dc5;
772      if (array.size() <= kSmallArrayThreshold) {
773        for (uint8_t b : array) {
774          hash = (hash * 16777619) ^ b;
775        }
776      } else {
777        // For larger arrays use the 2 bytes at 6 bytes (the location of a push registers
778        // instruction field for quick generated code on ARM) and then select a number of other
779        // values at random.
780        static const size_t kRandomHashCount = 16;
781        for (size_t i = 0; i < 2; ++i) {
782          uint8_t b = array[i + 6];
783          hash = (hash * 16777619) ^ b;
784        }
785        for (size_t i = 2; i < kRandomHashCount; ++i) {
786          size_t r = i * 1103515245 + 12345;
787          uint8_t b = array[r % array.size()];
788          hash = (hash * 16777619) ^ b;
789        }
790      }
791      hash += hash << 13;
792      hash ^= hash >> 7;
793      hash += hash << 3;
794      hash ^= hash >> 17;
795      hash += hash << 5;
796      return hash;
797    }
798  };
799  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_code_;
800  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_mapping_table_;
801  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_vmap_table_;
802  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_gc_map_;
803  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_cfi_info_;
804
805  DISALLOW_COPY_AND_ASSIGN(CompilerDriver);
806};
807
808}  // namespace art
809
810#endif  // ART_COMPILER_DRIVER_COMPILER_DRIVER_H_
811