compiler_driver.h revision 9b297bfc588c7d38efd12a6f38cd2710fc513ee3 
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, size_t class_def_index);
149  bool RequiresConstructorBarrier(Thread* self, const DexFile* dex_file, size_t class_def_index);
150
151  // Callbacks from compiler to see what runtime checks must be generated.
152
153  bool CanAssumeTypeIsPresentInDexCache(const DexFile& dex_file, uint32_t type_idx)
154      LOCKS_EXCLUDED(Locks::mutator_lock_);
155
156  bool CanAssumeStringIsPresentInDexCache(const DexFile& dex_file, uint32_t string_idx)
157      LOCKS_EXCLUDED(Locks::mutator_lock_);
158
159  // Are runtime access checks necessary in the compiled code?
160  bool CanAccessTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
161                                  uint32_t type_idx, bool* type_known_final = NULL,
162                                  bool* type_known_abstract = NULL,
163                                  bool* equals_referrers_class = NULL)
164      LOCKS_EXCLUDED(Locks::mutator_lock_);
165
166  // Are runtime access and instantiable checks necessary in the code?
167  bool CanAccessInstantiableTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
168                                              uint32_t type_idx)
169     LOCKS_EXCLUDED(Locks::mutator_lock_);
170
171  // Can we fast path instance field access? Computes field's offset and volatility.
172  bool ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
173                                int* field_offset, bool* is_volatile)
174      LOCKS_EXCLUDED(Locks::mutator_lock_);
175
176  // Can we fastpath static field access? Computes field's offset, volatility and whether the
177  // field is within the referrer (which can avoid checking class initialization).
178  bool ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
179                              int* field_offset, int* ssb_index,
180                              bool* is_referrers_class, bool* is_volatile)
181      LOCKS_EXCLUDED(Locks::mutator_lock_);
182
183  // Can we fastpath a interface, super class or virtual method call? Computes method's vtable
184  // index.
185  bool ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
186                         bool update_stats, bool enable_devirtualization,
187                         InvokeType* type, MethodReference* target_method, int* vtable_idx,
188                         uintptr_t* direct_code, uintptr_t* direct_method)
189      LOCKS_EXCLUDED(Locks::mutator_lock_);
190
191  bool IsSafeCast(const MethodReference& mr, uint32_t dex_pc);
192
193  // Record patch information for later fix up.
194  void AddCodePatch(const DexFile* dex_file,
195                    uint32_t referrer_method_idx,
196                    InvokeType referrer_invoke_type,
197                    uint32_t target_method_idx,
198                    InvokeType target_invoke_type,
199                    size_t literal_offset)
200      LOCKS_EXCLUDED(compiled_methods_lock_);
201  void AddMethodPatch(const DexFile* dex_file,
202                      uint32_t referrer_method_idx,
203                      InvokeType referrer_invoke_type,
204                      uint32_t target_method_idx,
205                      InvokeType target_invoke_type,
206                      size_t literal_offset)
207      LOCKS_EXCLUDED(compiled_methods_lock_);
208
209  void SetBitcodeFileName(std::string const& filename);
210
211  bool GetSupportBootImageFixup() const {
212    return support_boot_image_fixup_;
213  }
214
215  void SetSupportBootImageFixup(bool support_boot_image_fixup) {
216    support_boot_image_fixup_ = support_boot_image_fixup;
217  }
218
219  ArenaPool& GetArenaPool() {
220    return arena_pool_;
221  }
222
223  bool WriteElf(const std::string& android_root,
224                bool is_host,
225                const std::vector<const DexFile*>& dex_files,
226                OatWriter& oat_writer,
227                File* file);
228
229  // TODO: move to a common home for llvm helpers once quick/portable are merged
230  static void InstructionSetToLLVMTarget(InstructionSet instruction_set,
231                                         std::string& target_triple,
232                                         std::string& target_cpu,
233                                         std::string& target_attr);
234
235  void SetCompilerContext(void* compiler_context) {
236    compiler_context_ = compiler_context;
237  }
238
239  void* GetCompilerContext() const {
240    return compiler_context_;
241  }
242
243  size_t GetThreadCount() const {
244    return thread_count_;
245  }
246
247  class PatchInformation {
248   public:
249    const DexFile& GetDexFile() const {
250      return *dex_file_;
251    }
252    uint32_t GetReferrerMethodIdx() const {
253      return referrer_method_idx_;
254    }
255    InvokeType GetReferrerInvokeType() const {
256      return referrer_invoke_type_;
257    }
258    uint32_t GetTargetMethodIdx() const {
259      return target_method_idx_;
260    }
261    InvokeType GetTargetInvokeType() const {
262      return target_invoke_type_;
263    }
264    size_t GetLiteralOffset() const {;
265      return literal_offset_;
266    }
267
268   private:
269    PatchInformation(const DexFile* dex_file,
270                     uint32_t referrer_method_idx,
271                     InvokeType referrer_invoke_type,
272                     uint32_t target_method_idx,
273                     InvokeType target_invoke_type,
274                     size_t literal_offset)
275      : dex_file_(dex_file),
276        referrer_method_idx_(referrer_method_idx),
277        referrer_invoke_type_(referrer_invoke_type),
278        target_method_idx_(target_method_idx),
279        target_invoke_type_(target_invoke_type),
280        literal_offset_(literal_offset) {
281      CHECK(dex_file_ != NULL);
282    }
283
284    const DexFile* dex_file_;
285    uint32_t referrer_method_idx_;
286    InvokeType referrer_invoke_type_;
287    uint32_t target_method_idx_;
288    InvokeType target_invoke_type_;
289    size_t literal_offset_;
290
291    friend class CompilerDriver;
292    DISALLOW_COPY_AND_ASSIGN(PatchInformation);
293  };
294
295  const std::vector<const PatchInformation*>& GetCodeToPatch() const {
296    return code_to_patch_;
297  }
298  const std::vector<const PatchInformation*>& GetMethodsToPatch() const {
299    return methods_to_patch_;
300  }
301
302  // Checks if class specified by type_idx is one of the image_classes_
303  bool IsImageClass(const char* descriptor) const;
304
305  void RecordClassStatus(ClassReference ref, mirror::Class::Status status)
306      LOCKS_EXCLUDED(compiled_classes_lock_);
307
308  std::vector<uint8_t>* DeduplicateCode(const std::vector<uint8_t>& code);
309  std::vector<uint8_t>* DeduplicateMappingTable(const std::vector<uint8_t>& code);
310  std::vector<uint8_t>* DeduplicateVMapTable(const std::vector<uint8_t>& code);
311  std::vector<uint8_t>* DeduplicateGCMap(const std::vector<uint8_t>& code);
312
313 private:
314  // Compute constant code and method pointers when possible
315  void GetCodeAndMethodForDirectCall(InvokeType type, InvokeType sharp_type,
316                                     mirror::Class* referrer_class,
317                                     mirror::ArtMethod* method,
318                                     bool update_stats,
319                                     uintptr_t* direct_code, uintptr_t* direct_method)
320      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
321
322  void PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
323                  ThreadPool& thread_pool, base::TimingLogger& timings)
324      LOCKS_EXCLUDED(Locks::mutator_lock_);
325
326  void LoadImageClasses(base::TimingLogger& timings);
327
328  // Attempt to resolve all type, methods, fields, and strings
329  // referenced from code in the dex file following PathClassLoader
330  // ordering semantics.
331  void Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files,
332               ThreadPool& thread_pool, base::TimingLogger& timings)
333      LOCKS_EXCLUDED(Locks::mutator_lock_);
334  void ResolveDexFile(jobject class_loader, const DexFile& dex_file,
335                      ThreadPool& thread_pool, base::TimingLogger& timings)
336      LOCKS_EXCLUDED(Locks::mutator_lock_);
337
338  void Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files,
339              ThreadPool& thread_pool, base::TimingLogger& timings);
340  void VerifyDexFile(jobject class_loader, const DexFile& dex_file,
341                     ThreadPool& thread_pool, base::TimingLogger& timings)
342      LOCKS_EXCLUDED(Locks::mutator_lock_);
343
344  void InitializeClasses(jobject class_loader, const std::vector<const DexFile*>& dex_files,
345                         ThreadPool& thread_pool, base::TimingLogger& timings)
346      LOCKS_EXCLUDED(Locks::mutator_lock_);
347  void InitializeClasses(jobject class_loader, const DexFile& dex_file,
348                         ThreadPool& thread_pool, base::TimingLogger& timings)
349      LOCKS_EXCLUDED(Locks::mutator_lock_, compiled_classes_lock_);
350
351  void UpdateImageClasses(base::TimingLogger& timings);
352  static void FindClinitImageClassesCallback(mirror::Object* object, void* arg)
353      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
354
355  void Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
356               ThreadPool& thread_pool, base::TimingLogger& timings);
357  void CompileDexFile(jobject class_loader, const DexFile& dex_file,
358                      ThreadPool& thread_pool, base::TimingLogger& timings)
359      LOCKS_EXCLUDED(Locks::mutator_lock_);
360  void CompileMethod(const DexFile::CodeItem* code_item, uint32_t access_flags,
361                     InvokeType invoke_type, uint32_t class_def_idx, uint32_t method_idx,
362                     jobject class_loader, const DexFile& dex_file,
363                     DexToDexCompilationLevel dex_to_dex_compilation_level)
364      LOCKS_EXCLUDED(compiled_methods_lock_);
365
366  static void CompileClass(const ParallelCompilationManager* context, size_t class_def_index)
367      LOCKS_EXCLUDED(Locks::mutator_lock_);
368
369  std::vector<const PatchInformation*> code_to_patch_;
370  std::vector<const PatchInformation*> methods_to_patch_;
371
372  CompilerBackend compiler_backend_;
373
374  InstructionSet instruction_set_;
375
376  // All class references that require
377  mutable ReaderWriterMutex freezing_constructor_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
378  std::set<ClassReference> freezing_constructor_classes_ GUARDED_BY(freezing_constructor_lock_);
379
380  typedef SafeMap<const ClassReference, CompiledClass*> ClassTable;
381  // All class references that this compiler has compiled.
382  mutable Mutex compiled_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
383  ClassTable compiled_classes_ GUARDED_BY(compiled_classes_lock_);
384
385  typedef SafeMap<const MethodReference, CompiledMethod*, MethodReferenceComparator> MethodTable;
386  // All method references that this compiler has compiled.
387  mutable Mutex compiled_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
388  MethodTable compiled_methods_ GUARDED_BY(compiled_methods_lock_);
389
390  const bool image_;
391
392  // If image_ is true, specifies the classes that will be included in
393  // the image. Note if image_classes_ is NULL, all classes are
394  // included in the image.
395  UniquePtr<DescriptorSet> image_classes_;
396
397  size_t thread_count_;
398  uint64_t start_ns_;
399
400  UniquePtr<AOTCompilationStats> stats_;
401
402  bool dump_stats_;
403
404  typedef void (*CompilerCallbackFn)(CompilerDriver& driver);
405  typedef MutexLock* (*CompilerMutexLockFn)(CompilerDriver& driver);
406
407  void* compiler_library_;
408
409  typedef CompiledMethod* (*CompilerFn)(CompilerDriver& driver,
410                                        const DexFile::CodeItem* code_item,
411                                        uint32_t access_flags, InvokeType invoke_type,
412                                        uint32_t class_dex_idx, uint32_t method_idx,
413                                        jobject class_loader, const DexFile& dex_file);
414
415  typedef void (*DexToDexCompilerFn)(CompilerDriver& driver,
416                                     const DexFile::CodeItem* code_item,
417                                     uint32_t access_flags, InvokeType invoke_type,
418                                     uint32_t class_dex_idx, uint32_t method_idx,
419                                     jobject class_loader, const DexFile& dex_file,
420                                     DexToDexCompilationLevel dex_to_dex_compilation_level);
421  CompilerFn compiler_;
422#ifdef ART_SEA_IR_MODE
423  CompilerFn sea_ir_compiler_;
424#endif
425
426  DexToDexCompilerFn dex_to_dex_compiler_;
427
428  void* compiler_context_;
429
430  typedef CompiledMethod* (*JniCompilerFn)(CompilerDriver& driver,
431                                           uint32_t access_flags, uint32_t method_idx,
432                                           const DexFile& dex_file);
433  JniCompilerFn jni_compiler_;
434
435  pthread_key_t tls_key_;
436
437  // Arena pool used by the compiler.
438  ArenaPool arena_pool_;
439
440  typedef void (*CompilerEnableAutoElfLoadingFn)(CompilerDriver& driver);
441  CompilerEnableAutoElfLoadingFn compiler_enable_auto_elf_loading_;
442
443  typedef const void* (*CompilerGetMethodCodeAddrFn)
444      (const CompilerDriver& driver, const CompiledMethod* cm, const mirror::ArtMethod* method);
445  CompilerGetMethodCodeAddrFn compiler_get_method_code_addr_;
446
447  bool support_boot_image_fixup_;
448
449  // DeDuplication data structures, these own the corresponding byte arrays.
450  class DedupeHashFunc {
451   public:
452    size_t operator()(const std::vector<uint8_t>& array) const {
453      // For small arrays compute a hash using every byte.
454      static const size_t kSmallArrayThreshold = 16;
455      size_t hash = 0x811c9dc5;
456      if (array.size() <= kSmallArrayThreshold) {
457        for (uint8_t b : array) {
458          hash = (hash * 16777619) ^ b;
459        }
460      } else {
461        // For larger arrays use the 2 bytes at 6 bytes (the location of a push registers
462        // instruction field for quick generated code on ARM) and then select a number of other
463        // values at random.
464        static const size_t kRandomHashCount = 16;
465        for (size_t i = 0; i < 2; ++i) {
466          uint8_t b = array[i + 6];
467          hash = (hash * 16777619) ^ b;
468        }
469        for (size_t i = 2; i < kRandomHashCount; ++i) {
470          size_t r = i * 1103515245 + 12345;
471          uint8_t b = array[r % array.size()];
472          hash = (hash * 16777619) ^ b;
473        }
474      }
475      hash += hash << 13;
476      hash ^= hash >> 7;
477      hash += hash << 3;
478      hash ^= hash >> 17;
479      hash += hash << 5;
480      return hash;
481    }
482  };
483  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_code_;
484  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_mapping_table_;
485  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_vmap_table_;
486  DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_gc_map_;
487
488  DISALLOW_COPY_AND_ASSIGN(CompilerDriver);
489};
490
491}  // namespace art
492
493#endif  // ART_COMPILER_DRIVER_COMPILER_DRIVER_H_
494