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