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