compiler_driver.h revision e3e0260c23d8999b9433715ac7ee5296ee2fd633 
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_backend.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                          CompilerBackend::Kind compiler_backend_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  CompilerBackend* GetCompilerBackend() const {
141    return compiler_backend_.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  void ProcessedInstanceField(bool resolved);
287  void ProcessedStaticField(bool resolved, bool local);
288  void ProcessedInvoke(InvokeType invoke_type, int flags);
289
290  // Can we fast path instance field access? Computes field's offset and volatility.
291  bool ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
292                                MemberOffset* field_offset, bool* is_volatile)
293      LOCKS_EXCLUDED(Locks::mutator_lock_);
294
295  // Can we fastpath static field access? Computes field's offset, volatility and whether the
296  // field is within the referrer (which can avoid checking class initialization).
297  bool ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
298                              MemberOffset* field_offset, uint32_t* storage_index,
299                              bool* is_referrers_class, bool* is_volatile, bool* is_initialized)
300      LOCKS_EXCLUDED(Locks::mutator_lock_);
301
302  // Can we fastpath a interface, super class or virtual method call? Computes method's vtable
303  // index.
304  bool ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
305                         bool update_stats, bool enable_devirtualization,
306                         InvokeType* type, MethodReference* target_method, int* vtable_idx,
307                         uintptr_t* direct_code, uintptr_t* direct_method)
308      LOCKS_EXCLUDED(Locks::mutator_lock_);
309
310  const VerifiedMethod* GetVerifiedMethod(const DexFile* dex_file, uint32_t method_idx) const;
311  bool IsSafeCast(const DexCompilationUnit* mUnit, uint32_t dex_pc);
312
313  // Record patch information for later fix up.
314  void AddCodePatch(const DexFile* dex_file,
315                    uint16_t referrer_class_def_idx,
316                    uint32_t referrer_method_idx,
317                    InvokeType referrer_invoke_type,
318                    uint32_t target_method_idx,
319                    InvokeType target_invoke_type,
320                    size_t literal_offset)
321      LOCKS_EXCLUDED(compiled_methods_lock_);
322  void AddRelativeCodePatch(const DexFile* dex_file,
323                            uint16_t referrer_class_def_idx,
324                            uint32_t referrer_method_idx,
325                            InvokeType referrer_invoke_type,
326                            uint32_t target_method_idx,
327                            InvokeType target_invoke_type,
328                            size_t literal_offset,
329                            int32_t pc_relative_offset)
330      LOCKS_EXCLUDED(compiled_methods_lock_);
331  void AddMethodPatch(const DexFile* dex_file,
332                      uint16_t referrer_class_def_idx,
333                      uint32_t referrer_method_idx,
334                      InvokeType referrer_invoke_type,
335                      uint32_t target_method_idx,
336                      InvokeType target_invoke_type,
337                      size_t literal_offset)
338      LOCKS_EXCLUDED(compiled_methods_lock_);
339  void AddClassPatch(const DexFile* dex_file,
340                     uint16_t referrer_class_def_idx,
341                     uint32_t referrer_method_idx,
342                     uint32_t target_method_idx,
343                     size_t literal_offset)
344      LOCKS_EXCLUDED(compiled_methods_lock_);
345
346  bool GetSupportBootImageFixup() const {
347    return support_boot_image_fixup_;
348  }
349
350  void SetSupportBootImageFixup(bool support_boot_image_fixup) {
351    support_boot_image_fixup_ = support_boot_image_fixup;
352  }
353
354  ArenaPool* GetArenaPool() {
355    return &arena_pool_;
356  }
357
358  bool WriteElf(const std::string& android_root,
359                bool is_host,
360                const std::vector<const DexFile*>& dex_files,
361                OatWriter* oat_writer,
362                File* file);
363
364  // TODO: move to a common home for llvm helpers once quick/portable are merged.
365  static void InstructionSetToLLVMTarget(InstructionSet instruction_set,
366                                         std::string* target_triple,
367                                         std::string* target_cpu,
368                                         std::string* target_attr);
369
370  void SetCompilerContext(void* compiler_context) {
371    compiler_context_ = compiler_context;
372  }
373
374  void* GetCompilerContext() const {
375    return compiler_context_;
376  }
377
378  size_t GetThreadCount() const {
379    return thread_count_;
380  }
381
382  class CallPatchInformation;
383  class TypePatchInformation;
384
385  bool GetDumpPasses() const {
386    return dump_passes_;
387  }
388
389  CumulativeLogger* GetTimingsLogger() const {
390    return timings_logger_;
391  }
392
393  class PatchInformation {
394   public:
395    const DexFile& GetDexFile() const {
396      return *dex_file_;
397    }
398    uint16_t GetReferrerClassDefIdx() const {
399      return referrer_class_def_idx_;
400    }
401    uint32_t GetReferrerMethodIdx() const {
402      return referrer_method_idx_;
403    }
404    size_t GetLiteralOffset() const {
405      return literal_offset_;
406    }
407
408    virtual bool IsCall() const {
409      return false;
410    }
411    virtual bool IsType() const {
412      return false;
413    }
414    virtual const CallPatchInformation* AsCall() const {
415      LOG(FATAL) << "Unreachable";
416      return nullptr;
417    }
418    virtual const TypePatchInformation* AsType() const {
419      LOG(FATAL) << "Unreachable";
420      return nullptr;
421    }
422
423   protected:
424    PatchInformation(const DexFile* dex_file,
425                     uint16_t referrer_class_def_idx,
426                     uint32_t referrer_method_idx,
427                     size_t literal_offset)
428      : dex_file_(dex_file),
429        referrer_class_def_idx_(referrer_class_def_idx),
430        referrer_method_idx_(referrer_method_idx),
431        literal_offset_(literal_offset) {
432      CHECK(dex_file_ != NULL);
433    }
434    virtual ~PatchInformation() {}
435
436    const DexFile* const dex_file_;
437    const uint16_t referrer_class_def_idx_;
438    const uint32_t referrer_method_idx_;
439    const size_t literal_offset_;
440
441    friend class CompilerDriver;
442  };
443
444  class CallPatchInformation : public PatchInformation {
445   public:
446    InvokeType GetReferrerInvokeType() const {
447      return referrer_invoke_type_;
448    }
449    uint32_t GetTargetMethodIdx() const {
450      return target_method_idx_;
451    }
452    InvokeType GetTargetInvokeType() const {
453      return target_invoke_type_;
454    }
455
456    const CallPatchInformation* AsCall() const {
457      return this;
458    }
459    bool IsCall() const {
460      return true;
461    }
462    virtual bool IsRelative() const {
463      return false;
464    }
465    virtual int RelativeOffset() const {
466      return 0;
467    }
468
469   protected:
470    CallPatchInformation(const DexFile* dex_file,
471                         uint16_t referrer_class_def_idx,
472                         uint32_t referrer_method_idx,
473                         InvokeType referrer_invoke_type,
474                         uint32_t target_method_idx,
475                         InvokeType target_invoke_type,
476                         size_t literal_offset)
477        : PatchInformation(dex_file, referrer_class_def_idx,
478                           referrer_method_idx, literal_offset),
479          referrer_invoke_type_(referrer_invoke_type),
480          target_method_idx_(target_method_idx),
481          target_invoke_type_(target_invoke_type) {
482    }
483
484   private:
485    const InvokeType referrer_invoke_type_;
486    const uint32_t target_method_idx_;
487    const InvokeType target_invoke_type_;
488
489    friend class CompilerDriver;
490    DISALLOW_COPY_AND_ASSIGN(CallPatchInformation);
491  };
492
493  class RelativeCallPatchInformation : public CallPatchInformation {
494   public:
495    bool IsRelative() const {
496      return true;
497    }
498    int RelativeOffset() const {
499      return offset_;
500    }
501
502   private:
503    RelativeCallPatchInformation(const DexFile* dex_file,
504                                 uint16_t referrer_class_def_idx,
505                                 uint32_t referrer_method_idx,
506                                 InvokeType referrer_invoke_type,
507                                 uint32_t target_method_idx,
508                                 InvokeType target_invoke_type,
509                                 size_t literal_offset,
510                                 int32_t pc_relative_offset)
511        : CallPatchInformation(dex_file, referrer_class_def_idx,
512                           referrer_method_idx, referrer_invoke_type,
513                           target_method_idx, target_invoke_type, literal_offset),
514          offset_(pc_relative_offset) {
515    }
516
517    const int offset_;
518
519    friend class CompilerDriver;
520    DISALLOW_COPY_AND_ASSIGN(RelativeCallPatchInformation);
521  };
522
523  class TypePatchInformation : public PatchInformation {
524   public:
525    uint32_t GetTargetTypeIdx() const {
526      return target_type_idx_;
527    }
528
529    bool IsType() const {
530      return true;
531    }
532    const TypePatchInformation* AsType() const {
533      return this;
534    }
535
536   private:
537    TypePatchInformation(const DexFile* dex_file,
538                         uint16_t referrer_class_def_idx,
539                         uint32_t referrer_method_idx,
540                         uint32_t target_type_idx,
541                         size_t literal_offset)
542        : PatchInformation(dex_file, referrer_class_def_idx,
543                           referrer_method_idx, literal_offset),
544          target_type_idx_(target_type_idx) {
545    }
546
547    const uint32_t target_type_idx_;
548
549    friend class CompilerDriver;
550    DISALLOW_COPY_AND_ASSIGN(TypePatchInformation);
551  };
552
553  const std::vector<const CallPatchInformation*>& GetCodeToPatch() const {
554    return code_to_patch_;
555  }
556  const std::vector<const CallPatchInformation*>& GetMethodsToPatch() const {
557    return methods_to_patch_;
558  }
559  const std::vector<const TypePatchInformation*>& GetClassesToPatch() const {
560    return classes_to_patch_;
561  }
562
563  // Checks if class specified by type_idx is one of the image_classes_
564  bool IsImageClass(const char* descriptor) const;
565
566  void RecordClassStatus(ClassReference ref, mirror::Class::Status status)
567      LOCKS_EXCLUDED(compiled_classes_lock_);
568
569  std::vector<uint8_t>* DeduplicateCode(const std::vector<uint8_t>& code);
570  std::vector<uint8_t>* DeduplicateMappingTable(const std::vector<uint8_t>& code);
571  std::vector<uint8_t>* DeduplicateVMapTable(const std::vector<uint8_t>& code);
572  std::vector<uint8_t>* DeduplicateGCMap(const std::vector<uint8_t>& code);
573  std::vector<uint8_t>* DeduplicateCFIInfo(const std::vector<uint8_t>* cfi_info);
574
575  /*
576   * @brief return the pointer to the Call Frame Information.
577   * @return pointer to call frame information for this compilation.
578   */
579  std::vector<uint8_t>* GetCallFrameInformation() const {
580    return cfi_info_.get();
581  }
582
583  // Profile data.  This is generated from previous runs of the program and stored
584  // in a file.  It is used to determine whether to compile a particular method or not.
585  class ProfileData {
586   public:
587    ProfileData() : count_(0), method_size_(0), percent_(0) {}
588    ProfileData(const std::string& method_name, uint32_t count, uint32_t method_size, double percent) :
589      method_name_(method_name), count_(count), method_size_(method_size), percent_(percent) {
590      // TODO: currently method_size_ and count_ are unused.
591      UNUSED(method_size_);
592      UNUSED(count_);
593    }
594
595    bool IsAbove(double v) const { return percent_ >= v; }
596    double GetPercent() const { return percent_; }
597
598   private:
599    std::string method_name_;   // Method name.
600    uint32_t count_;            // Number number of times it has been called.
601    uint32_t method_size_;      // Size of the method on dex instructions.
602    double percent_;            // Percentage of time spent in this method.
603  };
604
605  // Profile data is stored in a map, indexed by the full method name.
606  typedef std::map<const std::string, ProfileData> ProfileMap;
607  ProfileMap profile_map_;
608  bool profile_ok_;
609
610  // Read the profile data from the given file.  Calculates the percentage for each method.
611  // Returns false if there was no profile file or it was malformed.
612  bool ReadProfile(const std::string& filename);
613
614  // Should the compiler run on this method given profile information?
615  bool SkipCompilation(const std::string& method_name);
616
617 private:
618  // These flags are internal to CompilerDriver for collecting INVOKE resolution statistics.
619  // The only external contract is that unresolved method has flags 0 and resolved non-0.
620  enum {
621    kBitMethodResolved = 0,
622    kBitVirtualMadeDirect,
623    kBitPreciseTypeDevirtualization,
624    kBitDirectCallToBoot,
625    kBitDirectMethodToBoot
626  };
627  static constexpr int kFlagMethodResolved              = 1 << kBitMethodResolved;
628  static constexpr int kFlagVirtualMadeDirect           = 1 << kBitVirtualMadeDirect;
629  static constexpr int kFlagPreciseTypeDevirtualization = 1 << kBitPreciseTypeDevirtualization;
630  static constexpr int kFlagDirectCallToBoot            = 1 << kBitDirectCallToBoot;
631  static constexpr int kFlagDirectMethodToBoot          = 1 << kBitDirectMethodToBoot;
632  static constexpr int kFlagsMethodResolvedVirtualMadeDirect =
633      kFlagMethodResolved | kFlagVirtualMadeDirect;
634  static constexpr int kFlagsMethodResolvedPreciseTypeDevirtualization =
635      kFlagsMethodResolvedVirtualMadeDirect | kFlagPreciseTypeDevirtualization;
636
637 public:  // TODO make private or eliminate.
638  // Compute constant code and method pointers when possible.
639  void GetCodeAndMethodForDirectCall(InvokeType* type, InvokeType sharp_type,
640                                     bool no_guarantee_of_dex_cache_entry,
641                                     mirror::Class* referrer_class,
642                                     mirror::ArtMethod* method,
643                                     int* stats_flags,
644                                     MethodReference* target_method,
645                                     uintptr_t* direct_code, uintptr_t* direct_method)
646      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
647
648 private:
649  void PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
650                  ThreadPool* thread_pool, TimingLogger* timings)
651      LOCKS_EXCLUDED(Locks::mutator_lock_);
652
653  void LoadImageClasses(TimingLogger* timings);
654
655  // Attempt to resolve all type, methods, fields, and strings
656  // referenced from code in the dex file following PathClassLoader
657  // ordering semantics.
658  void Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files,
659               ThreadPool* thread_pool, TimingLogger* timings)
660      LOCKS_EXCLUDED(Locks::mutator_lock_);
661  void ResolveDexFile(jobject class_loader, const DexFile& dex_file,
662                      ThreadPool* thread_pool, TimingLogger* timings)
663      LOCKS_EXCLUDED(Locks::mutator_lock_);
664
665  void Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files,
666              ThreadPool* thread_pool, TimingLogger* timings);
667  void VerifyDexFile(jobject class_loader, const DexFile& dex_file,
668                     ThreadPool* thread_pool, TimingLogger* timings)
669      LOCKS_EXCLUDED(Locks::mutator_lock_);
670
671  void InitializeClasses(jobject class_loader, const std::vector<const DexFile*>& dex_files,
672                         ThreadPool* thread_pool, TimingLogger* timings)
673      LOCKS_EXCLUDED(Locks::mutator_lock_);
674  void InitializeClasses(jobject class_loader, const DexFile& dex_file,
675                         ThreadPool* thread_pool, TimingLogger* timings)
676      LOCKS_EXCLUDED(Locks::mutator_lock_, compiled_classes_lock_);
677
678  void UpdateImageClasses(TimingLogger* timings) LOCKS_EXCLUDED(Locks::mutator_lock_);
679  static void FindClinitImageClassesCallback(mirror::Object* object, void* arg)
680      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
681
682  void Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
683               ThreadPool* thread_pool, TimingLogger* timings);
684  void CompileDexFile(jobject class_loader, const DexFile& dex_file,
685                      ThreadPool* thread_pool, TimingLogger* timings)
686      LOCKS_EXCLUDED(Locks::mutator_lock_);
687  void CompileMethod(const DexFile::CodeItem* code_item, uint32_t access_flags,
688                     InvokeType invoke_type, uint16_t class_def_idx, uint32_t method_idx,
689                     jobject class_loader, const DexFile& dex_file,
690                     DexToDexCompilationLevel dex_to_dex_compilation_level)
691      LOCKS_EXCLUDED(compiled_methods_lock_);
692
693  static void CompileClass(const ParallelCompilationManager* context, size_t class_def_index)
694      LOCKS_EXCLUDED(Locks::mutator_lock_);
695
696  std::vector<const CallPatchInformation*> code_to_patch_;
697  std::vector<const CallPatchInformation*> methods_to_patch_;
698  std::vector<const TypePatchInformation*> classes_to_patch_;
699
700  const CompilerOptions* const compiler_options_;
701  VerificationResults* const verification_results_;
702  DexFileToMethodInlinerMap* const method_inliner_map_;
703
704  UniquePtr<CompilerBackend> compiler_backend_;
705
706  const InstructionSet instruction_set_;
707  const InstructionSetFeatures instruction_set_features_;
708
709  // All class references that require
710  mutable ReaderWriterMutex freezing_constructor_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
711  std::set<ClassReference> freezing_constructor_classes_ GUARDED_BY(freezing_constructor_lock_);
712
713  typedef SafeMap<const ClassReference, CompiledClass*> ClassTable;
714  // All class references that this compiler has compiled.
715  mutable Mutex compiled_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
716  ClassTable compiled_classes_ GUARDED_BY(compiled_classes_lock_);
717
718  typedef SafeMap<const MethodReference, CompiledMethod*, MethodReferenceComparator> MethodTable;
719  // All method references that this compiler has compiled.
720  mutable Mutex compiled_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
721  MethodTable compiled_methods_ GUARDED_BY(compiled_methods_lock_);
722
723  const bool image_;
724
725  // If image_ is true, specifies the classes that will be included in
726  // the image. Note if image_classes_ is NULL, all classes are
727  // included in the image.
728  UniquePtr<DescriptorSet> image_classes_;
729
730  size_t thread_count_;
731  uint64_t start_ns_;
732
733  class AOTCompilationStats;
734  UniquePtr<AOTCompilationStats> stats_;
735
736  bool dump_stats_;
737  const bool dump_passes_;
738
739  CumulativeLogger* const timings_logger_;
740
741  typedef void (*CompilerCallbackFn)(CompilerDriver& driver);
742  typedef MutexLock* (*CompilerMutexLockFn)(CompilerDriver& driver);
743
744  void* compiler_library_;
745
746  typedef void (*DexToDexCompilerFn)(CompilerDriver& driver,
747                                     const DexFile::CodeItem* code_item,
748                                     uint32_t access_flags, InvokeType invoke_type,
749                                     uint32_t class_dex_idx, uint32_t method_idx,
750                                     jobject class_loader, const DexFile& dex_file,
751                                     DexToDexCompilationLevel dex_to_dex_compilation_level);
752  DexToDexCompilerFn dex_to_dex_compiler_;
753
754  void* compiler_context_;
755
756  pthread_key_t tls_key_;
757
758  // Arena pool used by the compiler.
759  ArenaPool arena_pool_;
760
761  typedef void (*CompilerEnableAutoElfLoadingFn)(CompilerDriver& driver);
762  CompilerEnableAutoElfLoadingFn compiler_enable_auto_elf_loading_;
763
764  typedef const void* (*CompilerGetMethodCodeAddrFn)
765      (const CompilerDriver& driver, const CompiledMethod* cm, const mirror::ArtMethod* method);
766  CompilerGetMethodCodeAddrFn compiler_get_method_code_addr_;
767
768  bool support_boot_image_fixup_;
769
770  // Call Frame Information, which might be generated to help stack tracebacks.
771  UniquePtr<std::vector<uint8_t> > cfi_info_;
772
773  // DeDuplication data structures, these own the corresponding byte arrays.
774  class DedupeHashFunc {
775   public:
776    size_t operator()(const std::vector<uint8_t>& array) const {
777      // For small arrays compute a hash using every byte.
778      static const size_t kSmallArrayThreshold = 16;
779      size_t hash = 0x811c9dc5;
780      if (array.size() <= kSmallArrayThreshold) {
781        for (uint8_t b : array) {
782          hash = (hash * 16777619) ^ b;
783        }
784      } else {
785        // For larger arrays use the 2 bytes at 6 bytes (the location of a push registers
786        // instruction field for quick generated code on ARM) and then select a number of other
787        // values at random.
788        static const size_t kRandomHashCount = 16;
789        for (size_t i = 0; i < 2; ++i) {
790          uint8_t b = array[i + 6];
791          hash = (hash * 16777619) ^ b;
792        }
793        for (size_t i = 2; i < kRandomHashCount; ++i) {
794          size_t r = i * 1103515245 + 12345;
795          uint8_t b = array[r % array.size()];
796          hash = (hash * 16777619) ^ b;
797        }
798      }
799      hash += hash << 13;
800      hash ^= hash >> 7;
801      hash += hash << 3;
802      hash ^= hash >> 17;
803      hash += hash << 5;
804      return hash;
805    }
806  };
807  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_code_;
808  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_mapping_table_;
809  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_vmap_table_;
810  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_gc_map_;
811  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_cfi_info_;
812
813  DISALLOW_COPY_AND_ASSIGN(CompilerDriver);
814};
815
816}  // namespace art
817
818#endif  // ART_COMPILER_DRIVER_COMPILER_DRIVER_H_
819