compiler_driver.h revision 8b2c0b9abc3f520495f4387ea040132ba85cae69 
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 "class_reference.h"
26#include "compiled_class.h"
27#include "compiled_method.h"
28#include "dex_file.h"
29#include "dex/arena_allocator.h"
30#include "instruction_set.h"
31#include "invoke_type.h"
32#include "method_reference.h"
33#include "os.h"
34#include "runtime.h"
35#include "safe_map.h"
36#include "thread_pool.h"
37#include "utils/dedupe_set.h"
38
39namespace art {
40
41class AOTCompilationStats;
42class ParallelCompilationManager;
43class DexCompilationUnit;
44class OatWriter;
45class TimingLogger;
46
47enum CompilerBackend {
48  kQuick,
49  kPortable,
50  kNoBackend
51};
52
53enum EntryPointCallingConvention {
54  // ABI of invocations to a method's interpreter entry point.
55  kInterpreterAbi,
56  // ABI of calls to a method's native code, only used for native methods.
57  kJniAbi,
58  // ABI of calls to a method's portable code entry point.
59  kPortableAbi,
60  // ABI of calls to a method's quick code entry point.
61  kQuickAbi
62};
63
64enum DexToDexCompilationLevel {
65  kDontDexToDexCompile,   // Only meaning wrt image time interpretation.
66  kRequired,              // Dex-to-dex compilation required for correctness.
67  kOptimize               // Perform required transformation and peep-hole optimizations.
68};
69
70// Thread-local storage compiler worker threads
71class CompilerTls {
72  public:
73    CompilerTls() : llvm_info_(NULL) {}
74    ~CompilerTls() {}
75
76    void* GetLLVMInfo() { return llvm_info_; }
77
78    void SetLLVMInfo(void* llvm_info) { llvm_info_ = llvm_info; }
79
80  private:
81    void* llvm_info_;
82};
83
84class CompilerDriver {
85 public:
86  typedef std::set<std::string> DescriptorSet;
87
88  // Create a compiler targeting the requested "instruction_set".
89  // "image" should be true if image specific optimizations should be
90  // enabled.  "image_classes" lets the compiler know what classes it
91  // can assume will be in the image, with NULL implying all available
92  // classes.
93  explicit CompilerDriver(CompilerBackend compiler_backend, InstructionSet instruction_set,
94                          bool image, DescriptorSet* image_classes,
95                          size_t thread_count, bool dump_stats);
96
97  ~CompilerDriver();
98
99  void CompileAll(jobject class_loader, const std::vector<const DexFile*>& dex_files,
100                  base::TimingLogger& timings)
101      LOCKS_EXCLUDED(Locks::mutator_lock_);
102
103  // Compile a single Method
104  void CompileOne(const mirror::ArtMethod* method, base::TimingLogger& timings)
105      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
106
107  InstructionSet GetInstructionSet() const {
108    return instruction_set_;
109  }
110
111  CompilerBackend GetCompilerBackend() const {
112    return compiler_backend_;
113  }
114
115  // Are we compiling and creating an image file?
116  bool IsImage() const {
117    return image_;
118  }
119
120  DescriptorSet* GetImageClasses() const {
121    return image_classes_.get();
122  }
123
124  CompilerTls* GetTls();
125
126  // Generate the trampolines that are invoked by unresolved direct methods.
127  const std::vector<uint8_t>* CreateInterpreterToInterpreterBridge() const
128      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
129  const std::vector<uint8_t>* CreateInterpreterToCompiledCodeBridge() const
130      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
131  const std::vector<uint8_t>* CreateJniDlsymLookup() const
132      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
133  const std::vector<uint8_t>* CreatePortableResolutionTrampoline() const
134      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
135  const std::vector<uint8_t>* CreatePortableToInterpreterBridge() const
136      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
137  const std::vector<uint8_t>* CreateQuickResolutionTrampoline() const
138      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
139  const std::vector<uint8_t>* CreateQuickToInterpreterBridge() const
140      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
141
142  CompiledClass* GetCompiledClass(ClassReference ref) const
143      LOCKS_EXCLUDED(compiled_classes_lock_);
144
145  CompiledMethod* GetCompiledMethod(MethodReference ref) const
146      LOCKS_EXCLUDED(compiled_methods_lock_);
147
148  void AddRequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
149                                     uint16_t class_def_index);
150  bool RequiresConstructorBarrier(Thread* self, const DexFile* dex_file, uint16_t class_def_index);
151
152  // Callbacks from compiler to see what runtime checks must be generated.
153
154  bool CanAssumeTypeIsPresentInDexCache(const DexFile& dex_file, uint32_t type_idx)
155      LOCKS_EXCLUDED(Locks::mutator_lock_);
156
157  bool CanAssumeStringIsPresentInDexCache(const DexFile& dex_file, uint32_t string_idx)
158      LOCKS_EXCLUDED(Locks::mutator_lock_);
159
160  // Are runtime access checks necessary in the compiled code?
161  bool CanAccessTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
162                                  uint32_t type_idx, bool* type_known_final = NULL,
163                                  bool* type_known_abstract = NULL,
164                                  bool* equals_referrers_class = NULL)
165      LOCKS_EXCLUDED(Locks::mutator_lock_);
166
167  // Are runtime access and instantiable checks necessary in the code?
168  bool CanAccessInstantiableTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
169                                              uint32_t type_idx)
170     LOCKS_EXCLUDED(Locks::mutator_lock_);
171
172  // Can we fast path instance field access? Computes field's offset and volatility.
173  bool ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
174                                int* field_offset, bool* is_volatile)
175      LOCKS_EXCLUDED(Locks::mutator_lock_);
176
177  // Can we fastpath static field access? Computes field's offset, volatility and whether the
178  // field is within the referrer (which can avoid checking class initialization).
179  bool ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
180                              int* field_offset, int* ssb_index,
181                              bool* is_referrers_class, bool* is_volatile)
182      LOCKS_EXCLUDED(Locks::mutator_lock_);
183
184  // Can we fastpath a interface, super class or virtual method call? Computes method's vtable
185  // index.
186  bool ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
187                         bool update_stats, bool enable_devirtualization,
188                         InvokeType* type, MethodReference* target_method, int* vtable_idx,
189                         uintptr_t* direct_code, uintptr_t* direct_method)
190      LOCKS_EXCLUDED(Locks::mutator_lock_);
191
192  bool IsSafeCast(const MethodReference& mr, uint32_t dex_pc);
193
194  // Record patch information for later fix up.
195  void AddCodePatch(const DexFile* dex_file,
196                    uint16_t referrer_class_def_idx,
197                    uint32_t referrer_method_idx,
198                    InvokeType referrer_invoke_type,
199                    uint32_t target_method_idx,
200                    InvokeType target_invoke_type,
201                    size_t literal_offset)
202      LOCKS_EXCLUDED(compiled_methods_lock_);
203  void AddMethodPatch(const DexFile* dex_file,
204                      uint16_t referrer_class_def_idx,
205                      uint32_t referrer_method_idx,
206                      InvokeType referrer_invoke_type,
207                      uint32_t target_method_idx,
208                      InvokeType target_invoke_type,
209                      size_t literal_offset)
210      LOCKS_EXCLUDED(compiled_methods_lock_);
211
212  void SetBitcodeFileName(std::string const& filename);
213
214  bool GetSupportBootImageFixup() const {
215    return support_boot_image_fixup_;
216  }
217
218  void SetSupportBootImageFixup(bool support_boot_image_fixup) {
219    support_boot_image_fixup_ = support_boot_image_fixup;
220  }
221
222  ArenaPool& GetArenaPool() {
223    return arena_pool_;
224  }
225
226  bool WriteElf(const std::string& android_root,
227                bool is_host,
228                const std::vector<const DexFile*>& dex_files,
229                OatWriter& oat_writer,
230                File* file);
231
232  // TODO: move to a common home for llvm helpers once quick/portable are merged
233  static void InstructionSetToLLVMTarget(InstructionSet instruction_set,
234                                         std::string& target_triple,
235                                         std::string& target_cpu,
236                                         std::string& target_attr);
237
238  void SetCompilerContext(void* compiler_context) {
239    compiler_context_ = compiler_context;
240  }
241
242  void* GetCompilerContext() const {
243    return compiler_context_;
244  }
245
246  size_t GetThreadCount() const {
247    return thread_count_;
248  }
249
250  class PatchInformation {
251   public:
252    const DexFile& GetDexFile() const {
253      return *dex_file_;
254    }
255    uint16_t GetReferrerClassDefIdx() const {
256      return referrer_class_def_idx_;
257    }
258    uint32_t GetReferrerMethodIdx() const {
259      return referrer_method_idx_;
260    }
261    InvokeType GetReferrerInvokeType() const {
262      return referrer_invoke_type_;
263    }
264    uint32_t GetTargetMethodIdx() const {
265      return target_method_idx_;
266    }
267    InvokeType GetTargetInvokeType() const {
268      return target_invoke_type_;
269    }
270    size_t GetLiteralOffset() const {;
271      return literal_offset_;
272    }
273
274   private:
275    PatchInformation(const DexFile* dex_file,
276                     uint16_t referrer_class_def_idx,
277                     uint32_t referrer_method_idx,
278                     InvokeType referrer_invoke_type,
279                     uint32_t target_method_idx,
280                     InvokeType target_invoke_type,
281                     size_t literal_offset)
282      : dex_file_(dex_file),
283        referrer_class_def_idx_(referrer_class_def_idx),
284        referrer_method_idx_(referrer_method_idx),
285        referrer_invoke_type_(referrer_invoke_type),
286        target_method_idx_(target_method_idx),
287        target_invoke_type_(target_invoke_type),
288        literal_offset_(literal_offset) {
289      CHECK(dex_file_ != NULL);
290    }
291
292    const DexFile* const dex_file_;
293    const uint16_t referrer_class_def_idx_;
294    const uint32_t referrer_method_idx_;
295    const InvokeType referrer_invoke_type_;
296    const uint32_t target_method_idx_;
297    const InvokeType target_invoke_type_;
298    const size_t literal_offset_;
299
300    friend class CompilerDriver;
301    DISALLOW_COPY_AND_ASSIGN(PatchInformation);
302  };
303
304  const std::vector<const PatchInformation*>& GetCodeToPatch() const {
305    return code_to_patch_;
306  }
307  const std::vector<const PatchInformation*>& GetMethodsToPatch() const {
308    return methods_to_patch_;
309  }
310
311  // Checks if class specified by type_idx is one of the image_classes_
312  bool IsImageClass(const char* descriptor) const;
313
314  void RecordClassStatus(ClassReference ref, mirror::Class::Status status)
315      LOCKS_EXCLUDED(compiled_classes_lock_);
316
317  std::vector<uint8_t>* DeduplicateCode(const std::vector<uint8_t>& code);
318  std::vector<uint8_t>* DeduplicateMappingTable(const std::vector<uint8_t>& code);
319  std::vector<uint8_t>* DeduplicateVMapTable(const std::vector<uint8_t>& code);
320  std::vector<uint8_t>* DeduplicateGCMap(const std::vector<uint8_t>& code);
321
322 private:
323  // Compute constant code and method pointers when possible
324  void GetCodeAndMethodForDirectCall(InvokeType type, InvokeType sharp_type,
325                                     mirror::Class* referrer_class,
326                                     mirror::ArtMethod* method,
327                                     bool update_stats,
328                                     uintptr_t* direct_code, uintptr_t* direct_method)
329      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
330
331  void PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
332                  ThreadPool& thread_pool, base::TimingLogger& timings)
333      LOCKS_EXCLUDED(Locks::mutator_lock_);
334
335  void LoadImageClasses(base::TimingLogger& timings);
336
337  // Attempt to resolve all type, methods, fields, and strings
338  // referenced from code in the dex file following PathClassLoader
339  // ordering semantics.
340  void Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files,
341               ThreadPool& thread_pool, base::TimingLogger& timings)
342      LOCKS_EXCLUDED(Locks::mutator_lock_);
343  void ResolveDexFile(jobject class_loader, const DexFile& dex_file,
344                      ThreadPool& thread_pool, base::TimingLogger& timings)
345      LOCKS_EXCLUDED(Locks::mutator_lock_);
346
347  void Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files,
348              ThreadPool& thread_pool, base::TimingLogger& timings);
349  void VerifyDexFile(jobject class_loader, const DexFile& dex_file,
350                     ThreadPool& thread_pool, base::TimingLogger& timings)
351      LOCKS_EXCLUDED(Locks::mutator_lock_);
352
353  void InitializeClasses(jobject class_loader, const std::vector<const DexFile*>& dex_files,
354                         ThreadPool& thread_pool, base::TimingLogger& timings)
355      LOCKS_EXCLUDED(Locks::mutator_lock_);
356  void InitializeClasses(jobject class_loader, const DexFile& dex_file,
357                         ThreadPool& thread_pool, base::TimingLogger& timings)
358      LOCKS_EXCLUDED(Locks::mutator_lock_, compiled_classes_lock_);
359
360  void UpdateImageClasses(base::TimingLogger& timings);
361  static void FindClinitImageClassesCallback(mirror::Object* object, void* arg)
362      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
363
364  void Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
365               ThreadPool& thread_pool, base::TimingLogger& timings);
366  void CompileDexFile(jobject class_loader, const DexFile& dex_file,
367                      ThreadPool& thread_pool, base::TimingLogger& timings)
368      LOCKS_EXCLUDED(Locks::mutator_lock_);
369  void CompileMethod(const DexFile::CodeItem* code_item, uint32_t access_flags,
370                     InvokeType invoke_type, uint16_t class_def_idx, uint32_t method_idx,
371                     jobject class_loader, const DexFile& dex_file,
372                     DexToDexCompilationLevel dex_to_dex_compilation_level)
373      LOCKS_EXCLUDED(compiled_methods_lock_);
374
375  static void CompileClass(const ParallelCompilationManager* context, size_t class_def_index)
376      LOCKS_EXCLUDED(Locks::mutator_lock_);
377
378  std::vector<const PatchInformation*> code_to_patch_;
379  std::vector<const PatchInformation*> methods_to_patch_;
380
381  CompilerBackend compiler_backend_;
382
383  InstructionSet instruction_set_;
384
385  // All class references that require
386  mutable ReaderWriterMutex freezing_constructor_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
387  std::set<ClassReference> freezing_constructor_classes_ GUARDED_BY(freezing_constructor_lock_);
388
389  typedef SafeMap<const ClassReference, CompiledClass*> ClassTable;
390  // All class references that this compiler has compiled.
391  mutable Mutex compiled_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
392  ClassTable compiled_classes_ GUARDED_BY(compiled_classes_lock_);
393
394  typedef SafeMap<const MethodReference, CompiledMethod*, MethodReferenceComparator> MethodTable;
395  // All method references that this compiler has compiled.
396  mutable Mutex compiled_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
397  MethodTable compiled_methods_ GUARDED_BY(compiled_methods_lock_);
398
399  const bool image_;
400
401  // If image_ is true, specifies the classes that will be included in
402  // the image. Note if image_classes_ is NULL, all classes are
403  // included in the image.
404  UniquePtr<DescriptorSet> image_classes_;
405
406  size_t thread_count_;
407  uint64_t start_ns_;
408
409  UniquePtr<AOTCompilationStats> stats_;
410
411  bool dump_stats_;
412
413  typedef void (*CompilerCallbackFn)(CompilerDriver& driver);
414  typedef MutexLock* (*CompilerMutexLockFn)(CompilerDriver& driver);
415
416  void* compiler_library_;
417
418  typedef CompiledMethod* (*CompilerFn)(CompilerDriver& driver,
419                                        const DexFile::CodeItem* code_item,
420                                        uint32_t access_flags, InvokeType invoke_type,
421                                        uint32_t class_dex_idx, uint32_t method_idx,
422                                        jobject class_loader, const DexFile& dex_file);
423
424  typedef void (*DexToDexCompilerFn)(CompilerDriver& driver,
425                                     const DexFile::CodeItem* code_item,
426                                     uint32_t access_flags, InvokeType invoke_type,
427                                     uint32_t class_dex_idx, uint32_t method_idx,
428                                     jobject class_loader, const DexFile& dex_file,
429                                     DexToDexCompilationLevel dex_to_dex_compilation_level);
430  CompilerFn compiler_;
431#ifdef ART_SEA_IR_MODE
432  CompilerFn sea_ir_compiler_;
433#endif
434
435  DexToDexCompilerFn dex_to_dex_compiler_;
436
437  void* compiler_context_;
438
439  typedef CompiledMethod* (*JniCompilerFn)(CompilerDriver& driver,
440                                           uint32_t access_flags, uint32_t method_idx,
441                                           const DexFile& dex_file);
442  JniCompilerFn jni_compiler_;
443
444  pthread_key_t tls_key_;
445
446  // Arena pool used by the compiler.
447  ArenaPool arena_pool_;
448
449  typedef void (*CompilerEnableAutoElfLoadingFn)(CompilerDriver& driver);
450  CompilerEnableAutoElfLoadingFn compiler_enable_auto_elf_loading_;
451
452  typedef const void* (*CompilerGetMethodCodeAddrFn)
453      (const CompilerDriver& driver, const CompiledMethod* cm, const mirror::ArtMethod* method);
454  CompilerGetMethodCodeAddrFn compiler_get_method_code_addr_;
455
456  bool support_boot_image_fixup_;
457
458  // DeDuplication data structures, these own the corresponding byte arrays.
459  class DedupeHashFunc {
460   public:
461    size_t operator()(const std::vector<uint8_t>& array) const {
462      // For small arrays compute a hash using every byte.
463      static const size_t kSmallArrayThreshold = 16;
464      size_t hash = 0x811c9dc5;
465      if (array.size() <= kSmallArrayThreshold) {
466        for (uint8_t b : array) {
467          hash = (hash * 16777619) ^ b;
468        }
469      } else {
470        // For larger arrays use the 2 bytes at 6 bytes (the location of a push registers
471        // instruction field for quick generated code on ARM) and then select a number of other
472        // values at random.
473        static const size_t kRandomHashCount = 16;
474        for (size_t i = 0; i < 2; ++i) {
475          uint8_t b = array[i + 6];
476          hash = (hash * 16777619) ^ b;
477        }
478        for (size_t i = 2; i < kRandomHashCount; ++i) {
479          size_t r = i * 1103515245 + 12345;
480          uint8_t b = array[r % array.size()];
481          hash = (hash * 16777619) ^ b;
482        }
483      }
484      hash += hash << 13;
485      hash ^= hash >> 7;
486      hash += hash << 3;
487      hash ^= hash >> 17;
488      hash += hash << 5;
489      return hash;
490    }
491  };
492  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_code_;
493  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_mapping_table_;
494  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_vmap_table_;
495  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_gc_map_;
496
497  DISALLOW_COPY_AND_ASSIGN(CompilerDriver);
498};
499
500}  // namespace art
501
502#endif  // ART_COMPILER_DRIVER_COMPILER_DRIVER_H_
503