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