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