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