compiler_driver.cc revision 4ef12f5b0e26c6016c87866f6a33da5ed8e98d74
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#include "compiler_driver.h"
18
19#define ATRACE_TAG ATRACE_TAG_DALVIK
20#include <utils/Trace.h>
21
22#include <vector>
23#include <unistd.h>
24
25#include "base/stl_util.h"
26#include "base/timing_logger.h"
27#include "class_linker.h"
28#include "compiled_class.h"
29#include "compiler.h"
30#include "compiler_driver-inl.h"
31#include "dex_compilation_unit.h"
32#include "dex_file-inl.h"
33#include "dex/verification_results.h"
34#include "dex/verified_method.h"
35#include "dex/quick/dex_file_method_inliner.h"
36#include "driver/compiler_options.h"
37#include "jni_internal.h"
38#include "object_lock.h"
39#include "profiler.h"
40#include "runtime.h"
41#include "gc/accounting/card_table-inl.h"
42#include "gc/accounting/heap_bitmap.h"
43#include "gc/space/space.h"
44#include "mirror/art_field-inl.h"
45#include "mirror/art_method-inl.h"
46#include "mirror/class_loader.h"
47#include "mirror/class-inl.h"
48#include "mirror/dex_cache-inl.h"
49#include "mirror/object-inl.h"
50#include "mirror/object_array-inl.h"
51#include "mirror/throwable.h"
52#include "scoped_thread_state_change.h"
53#include "ScopedLocalRef.h"
54#include "handle_scope-inl.h"
55#include "thread.h"
56#include "thread_pool.h"
57#include "trampolines/trampoline_compiler.h"
58#include "transaction.h"
59#include "verifier/method_verifier.h"
60#include "verifier/method_verifier-inl.h"
61
62namespace art {
63
64static double Percentage(size_t x, size_t y) {
65  return 100.0 * (static_cast<double>(x)) / (static_cast<double>(x + y));
66}
67
68static void DumpStat(size_t x, size_t y, const char* str) {
69  if (x == 0 && y == 0) {
70    return;
71  }
72  LOG(INFO) << Percentage(x, y) << "% of " << str << " for " << (x + y) << " cases";
73}
74
75class CompilerDriver::AOTCompilationStats {
76 public:
77  AOTCompilationStats()
78      : stats_lock_("AOT compilation statistics lock"),
79        types_in_dex_cache_(0), types_not_in_dex_cache_(0),
80        strings_in_dex_cache_(0), strings_not_in_dex_cache_(0),
81        resolved_types_(0), unresolved_types_(0),
82        resolved_instance_fields_(0), unresolved_instance_fields_(0),
83        resolved_local_static_fields_(0), resolved_static_fields_(0), unresolved_static_fields_(0),
84        type_based_devirtualization_(0),
85        safe_casts_(0), not_safe_casts_(0) {
86    for (size_t i = 0; i <= kMaxInvokeType; i++) {
87      resolved_methods_[i] = 0;
88      unresolved_methods_[i] = 0;
89      virtual_made_direct_[i] = 0;
90      direct_calls_to_boot_[i] = 0;
91      direct_methods_to_boot_[i] = 0;
92    }
93  }
94
95  void Dump() {
96    DumpStat(types_in_dex_cache_, types_not_in_dex_cache_, "types known to be in dex cache");
97    DumpStat(strings_in_dex_cache_, strings_not_in_dex_cache_, "strings known to be in dex cache");
98    DumpStat(resolved_types_, unresolved_types_, "types resolved");
99    DumpStat(resolved_instance_fields_, unresolved_instance_fields_, "instance fields resolved");
100    DumpStat(resolved_local_static_fields_ + resolved_static_fields_, unresolved_static_fields_,
101             "static fields resolved");
102    DumpStat(resolved_local_static_fields_, resolved_static_fields_ + unresolved_static_fields_,
103             "static fields local to a class");
104    DumpStat(safe_casts_, not_safe_casts_, "check-casts removed based on type information");
105    // Note, the code below subtracts the stat value so that when added to the stat value we have
106    // 100% of samples. TODO: clean this up.
107    DumpStat(type_based_devirtualization_,
108             resolved_methods_[kVirtual] + unresolved_methods_[kVirtual] +
109             resolved_methods_[kInterface] + unresolved_methods_[kInterface] -
110             type_based_devirtualization_,
111             "virtual/interface calls made direct based on type information");
112
113    for (size_t i = 0; i <= kMaxInvokeType; i++) {
114      std::ostringstream oss;
115      oss << static_cast<InvokeType>(i) << " methods were AOT resolved";
116      DumpStat(resolved_methods_[i], unresolved_methods_[i], oss.str().c_str());
117      if (virtual_made_direct_[i] > 0) {
118        std::ostringstream oss2;
119        oss2 << static_cast<InvokeType>(i) << " methods made direct";
120        DumpStat(virtual_made_direct_[i],
121                 resolved_methods_[i] + unresolved_methods_[i] - virtual_made_direct_[i],
122                 oss2.str().c_str());
123      }
124      if (direct_calls_to_boot_[i] > 0) {
125        std::ostringstream oss2;
126        oss2 << static_cast<InvokeType>(i) << " method calls are direct into boot";
127        DumpStat(direct_calls_to_boot_[i],
128                 resolved_methods_[i] + unresolved_methods_[i] - direct_calls_to_boot_[i],
129                 oss2.str().c_str());
130      }
131      if (direct_methods_to_boot_[i] > 0) {
132        std::ostringstream oss2;
133        oss2 << static_cast<InvokeType>(i) << " method calls have methods in boot";
134        DumpStat(direct_methods_to_boot_[i],
135                 resolved_methods_[i] + unresolved_methods_[i] - direct_methods_to_boot_[i],
136                 oss2.str().c_str());
137      }
138    }
139  }
140
141// Allow lossy statistics in non-debug builds.
142#ifndef NDEBUG
143#define STATS_LOCK() MutexLock mu(Thread::Current(), stats_lock_)
144#else
145#define STATS_LOCK()
146#endif
147
148  void TypeInDexCache() {
149    STATS_LOCK();
150    types_in_dex_cache_++;
151  }
152
153  void TypeNotInDexCache() {
154    STATS_LOCK();
155    types_not_in_dex_cache_++;
156  }
157
158  void StringInDexCache() {
159    STATS_LOCK();
160    strings_in_dex_cache_++;
161  }
162
163  void StringNotInDexCache() {
164    STATS_LOCK();
165    strings_not_in_dex_cache_++;
166  }
167
168  void TypeDoesntNeedAccessCheck() {
169    STATS_LOCK();
170    resolved_types_++;
171  }
172
173  void TypeNeedsAccessCheck() {
174    STATS_LOCK();
175    unresolved_types_++;
176  }
177
178  void ResolvedInstanceField() {
179    STATS_LOCK();
180    resolved_instance_fields_++;
181  }
182
183  void UnresolvedInstanceField() {
184    STATS_LOCK();
185    unresolved_instance_fields_++;
186  }
187
188  void ResolvedLocalStaticField() {
189    STATS_LOCK();
190    resolved_local_static_fields_++;
191  }
192
193  void ResolvedStaticField() {
194    STATS_LOCK();
195    resolved_static_fields_++;
196  }
197
198  void UnresolvedStaticField() {
199    STATS_LOCK();
200    unresolved_static_fields_++;
201  }
202
203  // Indicate that type information from the verifier led to devirtualization.
204  void PreciseTypeDevirtualization() {
205    STATS_LOCK();
206    type_based_devirtualization_++;
207  }
208
209  // Indicate that a method of the given type was resolved at compile time.
210  void ResolvedMethod(InvokeType type) {
211    DCHECK_LE(type, kMaxInvokeType);
212    STATS_LOCK();
213    resolved_methods_[type]++;
214  }
215
216  // Indicate that a method of the given type was unresolved at compile time as it was in an
217  // unknown dex file.
218  void UnresolvedMethod(InvokeType type) {
219    DCHECK_LE(type, kMaxInvokeType);
220    STATS_LOCK();
221    unresolved_methods_[type]++;
222  }
223
224  // Indicate that a type of virtual method dispatch has been converted into a direct method
225  // dispatch.
226  void VirtualMadeDirect(InvokeType type) {
227    DCHECK(type == kVirtual || type == kInterface || type == kSuper);
228    STATS_LOCK();
229    virtual_made_direct_[type]++;
230  }
231
232  // Indicate that a method of the given type was able to call directly into boot.
233  void DirectCallsToBoot(InvokeType type) {
234    DCHECK_LE(type, kMaxInvokeType);
235    STATS_LOCK();
236    direct_calls_to_boot_[type]++;
237  }
238
239  // Indicate that a method of the given type was able to be resolved directly from boot.
240  void DirectMethodsToBoot(InvokeType type) {
241    DCHECK_LE(type, kMaxInvokeType);
242    STATS_LOCK();
243    direct_methods_to_boot_[type]++;
244  }
245
246  void ProcessedInvoke(InvokeType type, int flags) {
247    STATS_LOCK();
248    if (flags == 0) {
249      unresolved_methods_[type]++;
250    } else {
251      DCHECK_NE((flags & kFlagMethodResolved), 0);
252      resolved_methods_[type]++;
253      if ((flags & kFlagVirtualMadeDirect) != 0) {
254        virtual_made_direct_[type]++;
255        if ((flags & kFlagPreciseTypeDevirtualization) != 0) {
256          type_based_devirtualization_++;
257        }
258      } else {
259        DCHECK_EQ((flags & kFlagPreciseTypeDevirtualization), 0);
260      }
261      if ((flags & kFlagDirectCallToBoot) != 0) {
262        direct_calls_to_boot_[type]++;
263      }
264      if ((flags & kFlagDirectMethodToBoot) != 0) {
265        direct_methods_to_boot_[type]++;
266      }
267    }
268  }
269
270  // A check-cast could be eliminated due to verifier type analysis.
271  void SafeCast() {
272    STATS_LOCK();
273    safe_casts_++;
274  }
275
276  // A check-cast couldn't be eliminated due to verifier type analysis.
277  void NotASafeCast() {
278    STATS_LOCK();
279    not_safe_casts_++;
280  }
281
282 private:
283  Mutex stats_lock_;
284
285  size_t types_in_dex_cache_;
286  size_t types_not_in_dex_cache_;
287
288  size_t strings_in_dex_cache_;
289  size_t strings_not_in_dex_cache_;
290
291  size_t resolved_types_;
292  size_t unresolved_types_;
293
294  size_t resolved_instance_fields_;
295  size_t unresolved_instance_fields_;
296
297  size_t resolved_local_static_fields_;
298  size_t resolved_static_fields_;
299  size_t unresolved_static_fields_;
300  // Type based devirtualization for invoke interface and virtual.
301  size_t type_based_devirtualization_;
302
303  size_t resolved_methods_[kMaxInvokeType + 1];
304  size_t unresolved_methods_[kMaxInvokeType + 1];
305  size_t virtual_made_direct_[kMaxInvokeType + 1];
306  size_t direct_calls_to_boot_[kMaxInvokeType + 1];
307  size_t direct_methods_to_boot_[kMaxInvokeType + 1];
308
309  size_t safe_casts_;
310  size_t not_safe_casts_;
311
312  DISALLOW_COPY_AND_ASSIGN(AOTCompilationStats);
313};
314
315
316extern "C" art::CompiledMethod* ArtCompileDEX(art::CompilerDriver& compiler,
317                                              const art::DexFile::CodeItem* code_item,
318                                              uint32_t access_flags,
319                                              art::InvokeType invoke_type,
320                                              uint16_t class_def_idx,
321                                              uint32_t method_idx,
322                                              jobject class_loader,
323                                              const art::DexFile& dex_file);
324
325CompilerDriver::CompilerDriver(const CompilerOptions* compiler_options,
326                               VerificationResults* verification_results,
327                               DexFileToMethodInlinerMap* method_inliner_map,
328                               Compiler::Kind compiler_kind,
329                               InstructionSet instruction_set,
330                               InstructionSetFeatures instruction_set_features,
331                               bool image, DescriptorSet* image_classes, size_t thread_count,
332                               bool dump_stats, bool dump_passes, CumulativeLogger* timer,
333                               std::string profile_file)
334    : profile_present_(false), compiler_options_(compiler_options),
335      verification_results_(verification_results),
336      method_inliner_map_(method_inliner_map),
337      compiler_(Compiler::Create(this, compiler_kind)),
338      instruction_set_(instruction_set),
339      instruction_set_features_(instruction_set_features),
340      freezing_constructor_lock_("freezing constructor lock"),
341      compiled_classes_lock_("compiled classes lock"),
342      compiled_methods_lock_("compiled method lock"),
343      image_(image),
344      image_classes_(image_classes),
345      thread_count_(thread_count),
346      start_ns_(0),
347      stats_(new AOTCompilationStats),
348      dump_stats_(dump_stats),
349      dump_passes_(dump_passes),
350      timings_logger_(timer),
351      compiler_library_(NULL),
352      compiler_context_(NULL),
353      compiler_enable_auto_elf_loading_(NULL),
354      compiler_get_method_code_addr_(NULL),
355      support_boot_image_fixup_(instruction_set != kMips),
356      cfi_info_(nullptr),
357      dedupe_code_("dedupe code"),
358      dedupe_mapping_table_("dedupe mapping table"),
359      dedupe_vmap_table_("dedupe vmap table"),
360      dedupe_gc_map_("dedupe gc map"),
361      dedupe_cfi_info_("dedupe cfi info") {
362  DCHECK(compiler_options_ != nullptr);
363  DCHECK(verification_results_ != nullptr);
364  DCHECK(method_inliner_map_ != nullptr);
365
366  CHECK_PTHREAD_CALL(pthread_key_create, (&tls_key_, NULL), "compiler tls key");
367
368  dex_to_dex_compiler_ = reinterpret_cast<DexToDexCompilerFn>(ArtCompileDEX);
369
370  compiler_->Init();
371
372  CHECK(!Runtime::Current()->IsStarted());
373  if (image_) {
374    CHECK(image_classes_.get() != nullptr);
375  } else {
376    CHECK(image_classes_.get() == nullptr);
377  }
378
379  // Are we generating CFI information?
380  if (compiler_options->GetGenerateGDBInformation()) {
381    cfi_info_.reset(compiler_->GetCallFrameInformationInitialization(*this));
382  }
383
384  // Read the profile file if one is provided.
385  if (!profile_file.empty()) {
386    profile_present_ = profile_file_.LoadFile(profile_file);
387    if (profile_present_) {
388      LOG(INFO) << "Using profile data form file " << profile_file;
389    } else {
390      LOG(INFO) << "Failed to load profile file " << profile_file;
391    }
392  }
393}
394
395std::vector<uint8_t>* CompilerDriver::DeduplicateCode(const std::vector<uint8_t>& code) {
396  return dedupe_code_.Add(Thread::Current(), code);
397}
398
399std::vector<uint8_t>* CompilerDriver::DeduplicateMappingTable(const std::vector<uint8_t>& code) {
400  return dedupe_mapping_table_.Add(Thread::Current(), code);
401}
402
403std::vector<uint8_t>* CompilerDriver::DeduplicateVMapTable(const std::vector<uint8_t>& code) {
404  return dedupe_vmap_table_.Add(Thread::Current(), code);
405}
406
407std::vector<uint8_t>* CompilerDriver::DeduplicateGCMap(const std::vector<uint8_t>& code) {
408  return dedupe_gc_map_.Add(Thread::Current(), code);
409}
410
411std::vector<uint8_t>* CompilerDriver::DeduplicateCFIInfo(const std::vector<uint8_t>* cfi_info) {
412  if (cfi_info == nullptr) {
413    return nullptr;
414  }
415  return dedupe_cfi_info_.Add(Thread::Current(), *cfi_info);
416}
417
418CompilerDriver::~CompilerDriver() {
419  Thread* self = Thread::Current();
420  {
421    MutexLock mu(self, compiled_classes_lock_);
422    STLDeleteValues(&compiled_classes_);
423  }
424  {
425    MutexLock mu(self, compiled_methods_lock_);
426    STLDeleteValues(&compiled_methods_);
427  }
428  {
429    MutexLock mu(self, compiled_methods_lock_);
430    STLDeleteElements(&code_to_patch_);
431  }
432  {
433    MutexLock mu(self, compiled_methods_lock_);
434    STLDeleteElements(&methods_to_patch_);
435  }
436  {
437    MutexLock mu(self, compiled_methods_lock_);
438    STLDeleteElements(&classes_to_patch_);
439  }
440  CHECK_PTHREAD_CALL(pthread_key_delete, (tls_key_), "delete tls key");
441  compiler_->UnInit();
442}
443
444CompilerTls* CompilerDriver::GetTls() {
445  // Lazily create thread-local storage
446  CompilerTls* res = static_cast<CompilerTls*>(pthread_getspecific(tls_key_));
447  if (res == NULL) {
448    res = new CompilerTls();
449    CHECK_PTHREAD_CALL(pthread_setspecific, (tls_key_, res), "compiler tls");
450  }
451  return res;
452}
453
454#define CREATE_TRAMPOLINE(type, abi, offset) \
455    if (Is64BitInstructionSet(instruction_set_)) { \
456      return CreateTrampoline64(instruction_set_, abi, \
457                                type ## _ENTRYPOINT_OFFSET(8, offset)); \
458    } else { \
459      return CreateTrampoline32(instruction_set_, abi, \
460                                type ## _ENTRYPOINT_OFFSET(4, offset)); \
461    }
462
463const std::vector<uint8_t>* CompilerDriver::CreateInterpreterToInterpreterBridge() const {
464  CREATE_TRAMPOLINE(INTERPRETER, kInterpreterAbi, pInterpreterToInterpreterBridge)
465}
466
467const std::vector<uint8_t>* CompilerDriver::CreateInterpreterToCompiledCodeBridge() const {
468  CREATE_TRAMPOLINE(INTERPRETER, kInterpreterAbi, pInterpreterToCompiledCodeBridge)
469}
470
471const std::vector<uint8_t>* CompilerDriver::CreateJniDlsymLookup() const {
472  CREATE_TRAMPOLINE(JNI, kJniAbi, pDlsymLookup)
473}
474
475const std::vector<uint8_t>* CompilerDriver::CreatePortableImtConflictTrampoline() const {
476  CREATE_TRAMPOLINE(PORTABLE, kPortableAbi, pPortableImtConflictTrampoline)
477}
478
479const std::vector<uint8_t>* CompilerDriver::CreatePortableResolutionTrampoline() const {
480  CREATE_TRAMPOLINE(PORTABLE, kPortableAbi, pPortableResolutionTrampoline)
481}
482
483const std::vector<uint8_t>* CompilerDriver::CreatePortableToInterpreterBridge() const {
484  CREATE_TRAMPOLINE(PORTABLE, kPortableAbi, pPortableToInterpreterBridge)
485}
486
487const std::vector<uint8_t>* CompilerDriver::CreateQuickGenericJniTrampoline() const {
488  CREATE_TRAMPOLINE(QUICK, kQuickAbi, pQuickGenericJniTrampoline)
489}
490
491const std::vector<uint8_t>* CompilerDriver::CreateQuickImtConflictTrampoline() const {
492  CREATE_TRAMPOLINE(QUICK, kQuickAbi, pQuickImtConflictTrampoline)
493}
494
495const std::vector<uint8_t>* CompilerDriver::CreateQuickResolutionTrampoline() const {
496  CREATE_TRAMPOLINE(QUICK, kQuickAbi, pQuickResolutionTrampoline)
497}
498
499const std::vector<uint8_t>* CompilerDriver::CreateQuickToInterpreterBridge() const {
500  CREATE_TRAMPOLINE(QUICK, kQuickAbi, pQuickToInterpreterBridge)
501}
502#undef CREATE_TRAMPOLINE
503
504void CompilerDriver::CompileAll(jobject class_loader,
505                                const std::vector<const DexFile*>& dex_files,
506                                TimingLogger* timings) {
507  DCHECK(!Runtime::Current()->IsStarted());
508  std::unique_ptr<ThreadPool> thread_pool(new ThreadPool("Compiler driver thread pool", thread_count_ - 1));
509  PreCompile(class_loader, dex_files, thread_pool.get(), timings);
510  Compile(class_loader, dex_files, thread_pool.get(), timings);
511  if (dump_stats_) {
512    stats_->Dump();
513  }
514}
515
516static DexToDexCompilationLevel GetDexToDexCompilationlevel(
517    Thread* self, Handle<mirror::ClassLoader> class_loader, const DexFile& dex_file,
518    const DexFile::ClassDef& class_def) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
519  const char* descriptor = dex_file.GetClassDescriptor(class_def);
520  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
521  mirror::Class* klass = class_linker->FindClass(self, descriptor, class_loader);
522  if (klass == NULL) {
523    CHECK(self->IsExceptionPending());
524    self->ClearException();
525    return kDontDexToDexCompile;
526  }
527  // The verifier can only run on "quick" instructions at runtime (see usage of
528  // FindAccessedFieldAtDexPc and FindInvokedMethodAtDexPc in ThrowNullPointerExceptionFromDexPC
529  // function). Since image classes can be verified again while compiling an application,
530  // we must prevent the DEX-to-DEX compiler from introducing them.
531  // TODO: find a way to enable "quick" instructions for image classes and remove this check.
532  bool compiling_image_classes = class_loader.Get() == nullptr;
533  if (compiling_image_classes) {
534    return kRequired;
535  } else if (klass->IsVerified()) {
536    // Class is verified so we can enable DEX-to-DEX compilation for performance.
537    return kOptimize;
538  } else if (klass->IsCompileTimeVerified()) {
539    // Class verification has soft-failed. Anyway, ensure at least correctness.
540    DCHECK_EQ(klass->GetStatus(), mirror::Class::kStatusRetryVerificationAtRuntime);
541    return kRequired;
542  } else {
543    // Class verification has failed: do not run DEX-to-DEX compilation.
544    return kDontDexToDexCompile;
545  }
546}
547
548void CompilerDriver::CompileOne(mirror::ArtMethod* method, TimingLogger* timings) {
549  DCHECK(!Runtime::Current()->IsStarted());
550  Thread* self = Thread::Current();
551  jobject jclass_loader;
552  const DexFile* dex_file;
553  uint16_t class_def_idx;
554  uint32_t method_idx = method->GetDexMethodIndex();
555  uint32_t access_flags = method->GetAccessFlags();
556  InvokeType invoke_type = method->GetInvokeType();
557  {
558    ScopedObjectAccessUnchecked soa(self);
559    ScopedLocalRef<jobject>
560      local_class_loader(soa.Env(),
561                    soa.AddLocalReference<jobject>(method->GetDeclaringClass()->GetClassLoader()));
562    jclass_loader = soa.Env()->NewGlobalRef(local_class_loader.get());
563    // Find the dex_file
564    dex_file = method->GetDexFile();
565    class_def_idx = method->GetClassDefIndex();
566  }
567  const DexFile::CodeItem* code_item = dex_file->GetCodeItem(method->GetCodeItemOffset());
568  self->TransitionFromRunnableToSuspended(kNative);
569
570  std::vector<const DexFile*> dex_files;
571  dex_files.push_back(dex_file);
572
573  std::unique_ptr<ThreadPool> thread_pool(new ThreadPool("Compiler driver thread pool", 0U));
574  PreCompile(jclass_loader, dex_files, thread_pool.get(), timings);
575
576  // Can we run DEX-to-DEX compiler on this class ?
577  DexToDexCompilationLevel dex_to_dex_compilation_level = kDontDexToDexCompile;
578  {
579    ScopedObjectAccess soa(Thread::Current());
580    const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_idx);
581    StackHandleScope<1> hs(soa.Self());
582    Handle<mirror::ClassLoader> class_loader(
583        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
584    dex_to_dex_compilation_level = GetDexToDexCompilationlevel(self, class_loader, *dex_file,
585                                                               class_def);
586  }
587  CompileMethod(code_item, access_flags, invoke_type, class_def_idx, method_idx, jclass_loader,
588                *dex_file, dex_to_dex_compilation_level);
589
590  self->GetJniEnv()->DeleteGlobalRef(jclass_loader);
591
592  self->TransitionFromSuspendedToRunnable();
593}
594
595void CompilerDriver::Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files,
596                             ThreadPool* thread_pool, TimingLogger* timings) {
597  for (size_t i = 0; i != dex_files.size(); ++i) {
598    const DexFile* dex_file = dex_files[i];
599    CHECK(dex_file != nullptr);
600    ResolveDexFile(class_loader, *dex_file, thread_pool, timings);
601  }
602}
603
604void CompilerDriver::PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
605                                ThreadPool* thread_pool, TimingLogger* timings) {
606  LoadImageClasses(timings);
607
608  if (!compiler_options_->IsVerificationEnabled()) {
609    VLOG(compiler) << "Verify none mode specified, skipping pre-compilation";
610    return;
611  }
612
613  Resolve(class_loader, dex_files, thread_pool, timings);
614
615  Verify(class_loader, dex_files, thread_pool, timings);
616
617  InitializeClasses(class_loader, dex_files, thread_pool, timings);
618
619  UpdateImageClasses(timings);
620}
621
622bool CompilerDriver::IsImageClass(const char* descriptor) const {
623  if (!IsImage()) {
624    return true;
625  } else {
626    return image_classes_->find(descriptor) != image_classes_->end();
627  }
628}
629
630static void ResolveExceptionsForMethod(MethodHelper* mh,
631    std::set<std::pair<uint16_t, const DexFile*>>& exceptions_to_resolve)
632    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
633  const DexFile::CodeItem* code_item = mh->GetMethod()->GetCodeItem();
634  if (code_item == NULL) {
635    return;  // native or abstract method
636  }
637  if (code_item->tries_size_ == 0) {
638    return;  // nothing to process
639  }
640  const byte* encoded_catch_handler_list = DexFile::GetCatchHandlerData(*code_item, 0);
641  size_t num_encoded_catch_handlers = DecodeUnsignedLeb128(&encoded_catch_handler_list);
642  for (size_t i = 0; i < num_encoded_catch_handlers; i++) {
643    int32_t encoded_catch_handler_size = DecodeSignedLeb128(&encoded_catch_handler_list);
644    bool has_catch_all = false;
645    if (encoded_catch_handler_size <= 0) {
646      encoded_catch_handler_size = -encoded_catch_handler_size;
647      has_catch_all = true;
648    }
649    for (int32_t j = 0; j < encoded_catch_handler_size; j++) {
650      uint16_t encoded_catch_handler_handlers_type_idx =
651          DecodeUnsignedLeb128(&encoded_catch_handler_list);
652      // Add to set of types to resolve if not already in the dex cache resolved types
653      if (!mh->GetMethod()->IsResolvedTypeIdx(encoded_catch_handler_handlers_type_idx)) {
654        exceptions_to_resolve.insert(
655            std::pair<uint16_t, const DexFile*>(encoded_catch_handler_handlers_type_idx,
656                                                mh->GetMethod()->GetDexFile()));
657      }
658      // ignore address associated with catch handler
659      DecodeUnsignedLeb128(&encoded_catch_handler_list);
660    }
661    if (has_catch_all) {
662      // ignore catch all address
663      DecodeUnsignedLeb128(&encoded_catch_handler_list);
664    }
665  }
666}
667
668static bool ResolveCatchBlockExceptionsClassVisitor(mirror::Class* c, void* arg)
669    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
670  std::set<std::pair<uint16_t, const DexFile*>>* exceptions_to_resolve =
671      reinterpret_cast<std::set<std::pair<uint16_t, const DexFile*>>*>(arg);
672  StackHandleScope<1> hs(Thread::Current());
673  MethodHelper mh(hs.NewHandle<mirror::ArtMethod>(nullptr));
674  for (size_t i = 0; i < c->NumVirtualMethods(); ++i) {
675    mh.ChangeMethod(c->GetVirtualMethod(i));
676    ResolveExceptionsForMethod(&mh, *exceptions_to_resolve);
677  }
678  for (size_t i = 0; i < c->NumDirectMethods(); ++i) {
679    mh.ChangeMethod(c->GetDirectMethod(i));
680    ResolveExceptionsForMethod(&mh, *exceptions_to_resolve);
681  }
682  return true;
683}
684
685static bool RecordImageClassesVisitor(mirror::Class* klass, void* arg)
686    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
687  CompilerDriver::DescriptorSet* image_classes =
688      reinterpret_cast<CompilerDriver::DescriptorSet*>(arg);
689  image_classes->insert(klass->GetDescriptor());
690  return true;
691}
692
693// Make a list of descriptors for classes to include in the image
694void CompilerDriver::LoadImageClasses(TimingLogger* timings)
695      LOCKS_EXCLUDED(Locks::mutator_lock_) {
696  CHECK(timings != nullptr);
697  if (!IsImage()) {
698    return;
699  }
700
701  TimingLogger::ScopedTiming t("LoadImageClasses", timings);
702  // Make a first class to load all classes explicitly listed in the file
703  Thread* self = Thread::Current();
704  ScopedObjectAccess soa(self);
705  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
706  CHECK(image_classes_.get() != nullptr);
707  for (auto it = image_classes_->begin(), end = image_classes_->end(); it != end;) {
708    const std::string& descriptor(*it);
709    StackHandleScope<1> hs(self);
710    Handle<mirror::Class> klass(
711        hs.NewHandle(class_linker->FindSystemClass(self, descriptor.c_str())));
712    if (klass.Get() == NULL) {
713      VLOG(compiler) << "Failed to find class " << descriptor;
714      image_classes_->erase(it++);
715      self->ClearException();
716    } else {
717      ++it;
718    }
719  }
720
721  // Resolve exception classes referenced by the loaded classes. The catch logic assumes
722  // exceptions are resolved by the verifier when there is a catch block in an interested method.
723  // Do this here so that exception classes appear to have been specified image classes.
724  std::set<std::pair<uint16_t, const DexFile*>> unresolved_exception_types;
725  StackHandleScope<1> hs(self);
726  Handle<mirror::Class> java_lang_Throwable(
727      hs.NewHandle(class_linker->FindSystemClass(self, "Ljava/lang/Throwable;")));
728  do {
729    unresolved_exception_types.clear();
730    class_linker->VisitClasses(ResolveCatchBlockExceptionsClassVisitor,
731                               &unresolved_exception_types);
732    for (const std::pair<uint16_t, const DexFile*>& exception_type : unresolved_exception_types) {
733      uint16_t exception_type_idx = exception_type.first;
734      const DexFile* dex_file = exception_type.second;
735      StackHandleScope<2> hs(self);
736      Handle<mirror::DexCache> dex_cache(hs.NewHandle(class_linker->FindDexCache(*dex_file)));
737      Handle<mirror::Class> klass(hs.NewHandle(
738          class_linker->ResolveType(*dex_file, exception_type_idx, dex_cache,
739                                    NullHandle<mirror::ClassLoader>())));
740      if (klass.Get() == NULL) {
741        const DexFile::TypeId& type_id = dex_file->GetTypeId(exception_type_idx);
742        const char* descriptor = dex_file->GetTypeDescriptor(type_id);
743        LOG(FATAL) << "Failed to resolve class " << descriptor;
744      }
745      DCHECK(java_lang_Throwable->IsAssignableFrom(klass.Get()));
746    }
747    // Resolving exceptions may load classes that reference more exceptions, iterate until no
748    // more are found
749  } while (!unresolved_exception_types.empty());
750
751  // We walk the roots looking for classes so that we'll pick up the
752  // above classes plus any classes them depend on such super
753  // classes, interfaces, and the required ClassLinker roots.
754  class_linker->VisitClasses(RecordImageClassesVisitor, image_classes_.get());
755
756  CHECK_NE(image_classes_->size(), 0U);
757}
758
759static void MaybeAddToImageClasses(Handle<mirror::Class> c,
760                                   CompilerDriver::DescriptorSet* image_classes)
761    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
762  Thread* self = Thread::Current();
763  StackHandleScope<1> hs(self);
764  // Make a copy of the handle so that we don't clobber it doing Assign.
765  Handle<mirror::Class> klass(hs.NewHandle(c.Get()));
766  while (!klass->IsObjectClass()) {
767    std::string descriptor(klass->GetDescriptor());
768    std::pair<CompilerDriver::DescriptorSet::iterator, bool> result =
769        image_classes->insert(descriptor);
770    if (result.second) {
771        VLOG(compiler) << "Adding " << descriptor << " to image classes";
772    } else {
773      return;
774    }
775    for (size_t i = 0; i < klass->NumDirectInterfaces(); ++i) {
776      StackHandleScope<1> hs(self);
777      MaybeAddToImageClasses(hs.NewHandle(mirror::Class::GetDirectInterface(self, klass, i)),
778                             image_classes);
779    }
780    if (klass->IsArrayClass()) {
781      StackHandleScope<1> hs(self);
782      MaybeAddToImageClasses(hs.NewHandle(klass->GetComponentType()), image_classes);
783    }
784    klass.Assign(klass->GetSuperClass());
785  }
786}
787
788void CompilerDriver::FindClinitImageClassesCallback(mirror::Object* object, void* arg) {
789  DCHECK(object != NULL);
790  DCHECK(arg != NULL);
791  CompilerDriver* compiler_driver = reinterpret_cast<CompilerDriver*>(arg);
792  StackHandleScope<1> hs(Thread::Current());
793  MaybeAddToImageClasses(hs.NewHandle(object->GetClass()), compiler_driver->image_classes_.get());
794}
795
796void CompilerDriver::UpdateImageClasses(TimingLogger* timings) {
797  if (IsImage()) {
798    TimingLogger::ScopedTiming t("UpdateImageClasses", timings);
799    // Update image_classes_ with classes for objects created by <clinit> methods.
800    Thread* self = Thread::Current();
801    const char* old_cause = self->StartAssertNoThreadSuspension("ImageWriter");
802    gc::Heap* heap = Runtime::Current()->GetHeap();
803    // TODO: Image spaces only?
804    ScopedObjectAccess soa(Thread::Current());
805    WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
806    heap->VisitObjects(FindClinitImageClassesCallback, this);
807    self->EndAssertNoThreadSuspension(old_cause);
808  }
809}
810
811bool CompilerDriver::CanAssumeTypeIsPresentInDexCache(const DexFile& dex_file, uint32_t type_idx) {
812  if (IsImage() &&
813      IsImageClass(dex_file.StringDataByIdx(dex_file.GetTypeId(type_idx).descriptor_idx_))) {
814    {
815      ScopedObjectAccess soa(Thread::Current());
816      mirror::DexCache* dex_cache = Runtime::Current()->GetClassLinker()->FindDexCache(dex_file);
817      mirror::Class* resolved_class = dex_cache->GetResolvedType(type_idx);
818      if (resolved_class == nullptr) {
819        // Erroneous class.
820        stats_->TypeNotInDexCache();
821        return false;
822      }
823    }
824    stats_->TypeInDexCache();
825    return true;
826  } else {
827    stats_->TypeNotInDexCache();
828    return false;
829  }
830}
831
832bool CompilerDriver::CanAssumeStringIsPresentInDexCache(const DexFile& dex_file,
833                                                        uint32_t string_idx) {
834  // See also Compiler::ResolveDexFile
835
836  bool result = false;
837  if (IsImage()) {
838    // We resolve all const-string strings when building for the image.
839    ScopedObjectAccess soa(Thread::Current());
840    StackHandleScope<1> hs(soa.Self());
841    Handle<mirror::DexCache> dex_cache(
842        hs.NewHandle(Runtime::Current()->GetClassLinker()->FindDexCache(dex_file)));
843    Runtime::Current()->GetClassLinker()->ResolveString(dex_file, string_idx, dex_cache);
844    result = true;
845  }
846  if (result) {
847    stats_->StringInDexCache();
848  } else {
849    stats_->StringNotInDexCache();
850  }
851  return result;
852}
853
854bool CompilerDriver::CanAccessTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
855                                                uint32_t type_idx,
856                                                bool* type_known_final, bool* type_known_abstract,
857                                                bool* equals_referrers_class) {
858  if (type_known_final != NULL) {
859    *type_known_final = false;
860  }
861  if (type_known_abstract != NULL) {
862    *type_known_abstract = false;
863  }
864  if (equals_referrers_class != NULL) {
865    *equals_referrers_class = false;
866  }
867  ScopedObjectAccess soa(Thread::Current());
868  mirror::DexCache* dex_cache = Runtime::Current()->GetClassLinker()->FindDexCache(dex_file);
869  // Get type from dex cache assuming it was populated by the verifier
870  mirror::Class* resolved_class = dex_cache->GetResolvedType(type_idx);
871  if (resolved_class == NULL) {
872    stats_->TypeNeedsAccessCheck();
873    return false;  // Unknown class needs access checks.
874  }
875  const DexFile::MethodId& method_id = dex_file.GetMethodId(referrer_idx);
876  if (equals_referrers_class != NULL) {
877    *equals_referrers_class = (method_id.class_idx_ == type_idx);
878  }
879  mirror::Class* referrer_class = dex_cache->GetResolvedType(method_id.class_idx_);
880  if (referrer_class == NULL) {
881    stats_->TypeNeedsAccessCheck();
882    return false;  // Incomplete referrer knowledge needs access check.
883  }
884  // Perform access check, will return true if access is ok or false if we're going to have to
885  // check this at runtime (for example for class loaders).
886  bool result = referrer_class->CanAccess(resolved_class);
887  if (result) {
888    stats_->TypeDoesntNeedAccessCheck();
889    if (type_known_final != NULL) {
890      *type_known_final = resolved_class->IsFinal() && !resolved_class->IsArrayClass();
891    }
892    if (type_known_abstract != NULL) {
893      *type_known_abstract = resolved_class->IsAbstract() && !resolved_class->IsArrayClass();
894    }
895  } else {
896    stats_->TypeNeedsAccessCheck();
897  }
898  return result;
899}
900
901bool CompilerDriver::CanAccessInstantiableTypeWithoutChecks(uint32_t referrer_idx,
902                                                            const DexFile& dex_file,
903                                                            uint32_t type_idx) {
904  ScopedObjectAccess soa(Thread::Current());
905  mirror::DexCache* dex_cache = Runtime::Current()->GetClassLinker()->FindDexCache(dex_file);
906  // Get type from dex cache assuming it was populated by the verifier.
907  mirror::Class* resolved_class = dex_cache->GetResolvedType(type_idx);
908  if (resolved_class == NULL) {
909    stats_->TypeNeedsAccessCheck();
910    return false;  // Unknown class needs access checks.
911  }
912  const DexFile::MethodId& method_id = dex_file.GetMethodId(referrer_idx);
913  mirror::Class* referrer_class = dex_cache->GetResolvedType(method_id.class_idx_);
914  if (referrer_class == NULL) {
915    stats_->TypeNeedsAccessCheck();
916    return false;  // Incomplete referrer knowledge needs access check.
917  }
918  // Perform access and instantiable checks, will return true if access is ok or false if we're
919  // going to have to check this at runtime (for example for class loaders).
920  bool result = referrer_class->CanAccess(resolved_class) && resolved_class->IsInstantiable();
921  if (result) {
922    stats_->TypeDoesntNeedAccessCheck();
923  } else {
924    stats_->TypeNeedsAccessCheck();
925  }
926  return result;
927}
928
929bool CompilerDriver::CanEmbedTypeInCode(const DexFile& dex_file, uint32_t type_idx,
930                                        bool* is_type_initialized, bool* use_direct_type_ptr,
931                                        uintptr_t* direct_type_ptr, bool* out_is_finalizable) {
932  ScopedObjectAccess soa(Thread::Current());
933  mirror::DexCache* dex_cache = Runtime::Current()->GetClassLinker()->FindDexCache(dex_file);
934  mirror::Class* resolved_class = dex_cache->GetResolvedType(type_idx);
935  if (resolved_class == nullptr) {
936    return false;
937  }
938  *out_is_finalizable = resolved_class->IsFinalizable();
939  const bool compiling_boot = Runtime::Current()->GetHeap()->IsCompilingBoot();
940  const bool support_boot_image_fixup = GetSupportBootImageFixup();
941  if (compiling_boot) {
942    // boot -> boot class pointers.
943    // True if the class is in the image at boot compiling time.
944    const bool is_image_class = IsImage() && IsImageClass(
945        dex_file.StringDataByIdx(dex_file.GetTypeId(type_idx).descriptor_idx_));
946    // True if pc relative load works.
947    if (is_image_class && support_boot_image_fixup) {
948      *is_type_initialized = resolved_class->IsInitialized();
949      *use_direct_type_ptr = false;
950      *direct_type_ptr = 0;
951      return true;
952    } else {
953      return false;
954    }
955  } else {
956    // True if the class is in the image at app compiling time.
957    const bool class_in_image =
958        Runtime::Current()->GetHeap()->FindSpaceFromObject(resolved_class, false)->IsImageSpace();
959    if (class_in_image && support_boot_image_fixup) {
960      // boot -> app class pointers.
961      *is_type_initialized = resolved_class->IsInitialized();
962      // TODO This is somewhat hacky. We should refactor all of this invoke codepath.
963      *use_direct_type_ptr = !GetCompilerOptions().GetIncludePatchInformation();
964      *direct_type_ptr = reinterpret_cast<uintptr_t>(resolved_class);
965      return true;
966    } else {
967      // app -> app class pointers.
968      // Give up because app does not have an image and class
969      // isn't created at compile time.  TODO: implement this
970      // if/when each app gets an image.
971      return false;
972    }
973  }
974}
975
976void CompilerDriver::ProcessedInstanceField(bool resolved) {
977  if (!resolved) {
978    stats_->UnresolvedInstanceField();
979  } else {
980    stats_->ResolvedInstanceField();
981  }
982}
983
984void CompilerDriver::ProcessedStaticField(bool resolved, bool local) {
985  if (!resolved) {
986    stats_->UnresolvedStaticField();
987  } else if (local) {
988    stats_->ResolvedLocalStaticField();
989  } else {
990    stats_->ResolvedStaticField();
991  }
992}
993
994void CompilerDriver::ProcessedInvoke(InvokeType invoke_type, int flags) {
995  stats_->ProcessedInvoke(invoke_type, flags);
996}
997
998mirror::ArtField* CompilerDriver::ComputeInstanceFieldInfo(uint32_t field_idx,
999                                                           const DexCompilationUnit* mUnit,
1000                                                           bool is_put,
1001                                                           const ScopedObjectAccess& soa) {
1002  // Try to resolve the field and compiling method's class.
1003  mirror::ArtField* resolved_field;
1004  mirror::Class* referrer_class;
1005  mirror::DexCache* dex_cache;
1006  {
1007    StackHandleScope<3> hs(soa.Self());
1008    Handle<mirror::DexCache> dex_cache_handle(
1009        hs.NewHandle(mUnit->GetClassLinker()->FindDexCache(*mUnit->GetDexFile())));
1010    Handle<mirror::ClassLoader> class_loader_handle(
1011        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(mUnit->GetClassLoader())));
1012    Handle<mirror::ArtField> resolved_field_handle(hs.NewHandle(
1013        ResolveField(soa, dex_cache_handle, class_loader_handle, mUnit, field_idx, false)));
1014    referrer_class = (resolved_field_handle.Get() != nullptr)
1015        ? ResolveCompilingMethodsClass(soa, dex_cache_handle, class_loader_handle, mUnit) : nullptr;
1016    resolved_field = resolved_field_handle.Get();
1017    dex_cache = dex_cache_handle.Get();
1018  }
1019  bool can_link = false;
1020  if (resolved_field != nullptr && referrer_class != nullptr) {
1021    std::pair<bool, bool> fast_path = IsFastInstanceField(
1022        dex_cache, referrer_class, resolved_field, field_idx);
1023    can_link = is_put ? fast_path.second : fast_path.first;
1024  }
1025  ProcessedInstanceField(can_link);
1026  return can_link ? resolved_field : nullptr;
1027}
1028
1029bool CompilerDriver::ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit,
1030                                              bool is_put, MemberOffset* field_offset,
1031                                              bool* is_volatile) {
1032  ScopedObjectAccess soa(Thread::Current());
1033  StackHandleScope<1> hs(soa.Self());
1034  Handle<mirror::ArtField> resolved_field =
1035      hs.NewHandle(ComputeInstanceFieldInfo(field_idx, mUnit, is_put, soa));
1036
1037  if (resolved_field.Get() == nullptr) {
1038    // Conservative defaults.
1039    *is_volatile = true;
1040    *field_offset = MemberOffset(static_cast<size_t>(-1));
1041    return false;
1042  } else {
1043    *is_volatile = resolved_field->IsVolatile();
1044    *field_offset = resolved_field->GetOffset();
1045    return true;
1046  }
1047}
1048
1049bool CompilerDriver::ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit,
1050                                            bool is_put, MemberOffset* field_offset,
1051                                            uint32_t* storage_index, bool* is_referrers_class,
1052                                            bool* is_volatile, bool* is_initialized) {
1053  ScopedObjectAccess soa(Thread::Current());
1054  // Try to resolve the field and compiling method's class.
1055  mirror::ArtField* resolved_field;
1056  mirror::Class* referrer_class;
1057  mirror::DexCache* dex_cache;
1058  {
1059    StackHandleScope<3> hs(soa.Self());
1060    Handle<mirror::DexCache> dex_cache_handle(
1061        hs.NewHandle(mUnit->GetClassLinker()->FindDexCache(*mUnit->GetDexFile())));
1062    Handle<mirror::ClassLoader> class_loader_handle(
1063        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(mUnit->GetClassLoader())));
1064    Handle<mirror::ArtField> resolved_field_handle(hs.NewHandle(
1065        ResolveField(soa, dex_cache_handle, class_loader_handle, mUnit, field_idx, true)));
1066    referrer_class = (resolved_field_handle.Get() != nullptr)
1067        ? ResolveCompilingMethodsClass(soa, dex_cache_handle, class_loader_handle, mUnit) : nullptr;
1068    resolved_field = resolved_field_handle.Get();
1069    dex_cache = dex_cache_handle.Get();
1070  }
1071  bool result = false;
1072  if (resolved_field != nullptr && referrer_class != nullptr) {
1073    *is_volatile = IsFieldVolatile(resolved_field);
1074    std::pair<bool, bool> fast_path = IsFastStaticField(
1075        dex_cache, referrer_class, resolved_field, field_idx, field_offset,
1076        storage_index, is_referrers_class, is_initialized);
1077    result = is_put ? fast_path.second : fast_path.first;
1078  }
1079  if (!result) {
1080    // Conservative defaults.
1081    *is_volatile = true;
1082    *field_offset = MemberOffset(static_cast<size_t>(-1));
1083    *storage_index = -1;
1084    *is_referrers_class = false;
1085    *is_initialized = false;
1086  }
1087  ProcessedStaticField(result, *is_referrers_class);
1088  return result;
1089}
1090
1091void CompilerDriver::GetCodeAndMethodForDirectCall(InvokeType* type, InvokeType sharp_type,
1092                                                   bool no_guarantee_of_dex_cache_entry,
1093                                                   mirror::Class* referrer_class,
1094                                                   mirror::ArtMethod* method,
1095                                                   int* stats_flags,
1096                                                   MethodReference* target_method,
1097                                                   uintptr_t* direct_code,
1098                                                   uintptr_t* direct_method) {
1099  // For direct and static methods compute possible direct_code and direct_method values, ie
1100  // an address for the Method* being invoked and an address of the code for that Method*.
1101  // For interface calls compute a value for direct_method that is the interface method being
1102  // invoked, so this can be passed to the out-of-line runtime support code.
1103  *direct_code = 0;
1104  *direct_method = 0;
1105  bool use_dex_cache = false;
1106  const bool compiling_boot = Runtime::Current()->GetHeap()->IsCompilingBoot();
1107  // TODO This is somewhat hacky. We should refactor all of this invoke codepath.
1108  const bool force_relocations = (compiling_boot ||
1109                                  GetCompilerOptions().GetIncludePatchInformation());
1110  if (compiler_->IsPortable()) {
1111    if (sharp_type != kStatic && sharp_type != kDirect) {
1112      return;
1113    }
1114    use_dex_cache = true;
1115  } else {
1116    if (sharp_type != kStatic && sharp_type != kDirect) {
1117      return;
1118    }
1119    // TODO: support patching on all architectures.
1120    use_dex_cache = force_relocations && !support_boot_image_fixup_;
1121  }
1122  bool method_code_in_boot = (method->GetDeclaringClass()->GetClassLoader() == nullptr);
1123  if (!use_dex_cache) {
1124    if (!method_code_in_boot) {
1125      use_dex_cache = true;
1126    } else {
1127      bool has_clinit_trampoline =
1128          method->IsStatic() && !method->GetDeclaringClass()->IsInitialized();
1129      if (has_clinit_trampoline && (method->GetDeclaringClass() != referrer_class)) {
1130        // Ensure we run the clinit trampoline unless we are invoking a static method in the same
1131        // class.
1132        use_dex_cache = true;
1133      }
1134    }
1135  }
1136  if (method_code_in_boot) {
1137    *stats_flags |= kFlagDirectCallToBoot | kFlagDirectMethodToBoot;
1138  }
1139  if (!use_dex_cache && force_relocations) {
1140    if (!IsImage() || !IsImageClass(method->GetDeclaringClassDescriptor())) {
1141      // We can only branch directly to Methods that are resolved in the DexCache.
1142      // Otherwise we won't invoke the resolution trampoline.
1143      use_dex_cache = true;
1144    }
1145  }
1146  // The method is defined not within this dex file. We need a dex cache slot within the current
1147  // dex file or direct pointers.
1148  bool must_use_direct_pointers = false;
1149  if (target_method->dex_file == method->GetDeclaringClass()->GetDexCache()->GetDexFile()) {
1150    target_method->dex_method_index = method->GetDexMethodIndex();
1151  } else {
1152    if (no_guarantee_of_dex_cache_entry) {
1153      StackHandleScope<1> hs(Thread::Current());
1154      MethodHelper mh(hs.NewHandle(method));
1155      // See if the method is also declared in this dex cache.
1156      uint32_t dex_method_idx = mh.FindDexMethodIndexInOtherDexFile(
1157          *target_method->dex_file, target_method->dex_method_index);
1158      if (dex_method_idx != DexFile::kDexNoIndex) {
1159        target_method->dex_method_index = dex_method_idx;
1160      } else {
1161        if (force_relocations && !use_dex_cache) {
1162          target_method->dex_method_index = method->GetDexMethodIndex();
1163          target_method->dex_file = method->GetDeclaringClass()->GetDexCache()->GetDexFile();
1164        }
1165        must_use_direct_pointers = true;
1166      }
1167    }
1168  }
1169  if (use_dex_cache) {
1170    if (must_use_direct_pointers) {
1171      // Fail. Test above showed the only safe dispatch was via the dex cache, however, the direct
1172      // pointers are required as the dex cache lacks an appropriate entry.
1173      VLOG(compiler) << "Dex cache devirtualization failed for: " << PrettyMethod(method);
1174    } else {
1175      *type = sharp_type;
1176    }
1177  } else {
1178    bool method_in_image =
1179        Runtime::Current()->GetHeap()->FindSpaceFromObject(method, false)->IsImageSpace();
1180    if (method_in_image || compiling_boot) {
1181      // We know we must be able to get to the method in the image, so use that pointer.
1182      CHECK(!method->IsAbstract());
1183      *type = sharp_type;
1184      *direct_method = force_relocations ? -1 : reinterpret_cast<uintptr_t>(method);
1185      *direct_code = force_relocations ? -1 : compiler_->GetEntryPointOf(method);
1186      target_method->dex_file = method->GetDeclaringClass()->GetDexCache()->GetDexFile();
1187      target_method->dex_method_index = method->GetDexMethodIndex();
1188    } else if (!must_use_direct_pointers) {
1189      // Set the code and rely on the dex cache for the method.
1190      *type = sharp_type;
1191      if (force_relocations) {
1192        *direct_code = -1;
1193        target_method->dex_file = method->GetDeclaringClass()->GetDexCache()->GetDexFile();
1194        target_method->dex_method_index = method->GetDexMethodIndex();
1195      } else {
1196        *direct_code = compiler_->GetEntryPointOf(method);
1197      }
1198    } else {
1199      // Direct pointers were required but none were available.
1200      VLOG(compiler) << "Dex cache devirtualization failed for: " << PrettyMethod(method);
1201    }
1202  }
1203}
1204
1205bool CompilerDriver::ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
1206                                       bool update_stats, bool enable_devirtualization,
1207                                       InvokeType* invoke_type, MethodReference* target_method,
1208                                       int* vtable_idx, uintptr_t* direct_code,
1209                                       uintptr_t* direct_method) {
1210  InvokeType orig_invoke_type = *invoke_type;
1211  int stats_flags = 0;
1212  ScopedObjectAccess soa(Thread::Current());
1213  // Try to resolve the method and compiling method's class.
1214  mirror::ArtMethod* resolved_method;
1215  mirror::Class* referrer_class;
1216  StackHandleScope<3> hs(soa.Self());
1217  Handle<mirror::DexCache> dex_cache(
1218      hs.NewHandle(mUnit->GetClassLinker()->FindDexCache(*mUnit->GetDexFile())));
1219  Handle<mirror::ClassLoader> class_loader(hs.NewHandle(
1220      soa.Decode<mirror::ClassLoader*>(mUnit->GetClassLoader())));
1221  {
1222    uint32_t method_idx = target_method->dex_method_index;
1223    Handle<mirror::ArtMethod> resolved_method_handle(hs.NewHandle(
1224        ResolveMethod(soa, dex_cache, class_loader, mUnit, method_idx, orig_invoke_type)));
1225    referrer_class = (resolved_method_handle.Get() != nullptr)
1226        ? ResolveCompilingMethodsClass(soa, dex_cache, class_loader, mUnit) : nullptr;
1227    resolved_method = resolved_method_handle.Get();
1228  }
1229  bool result = false;
1230  if (resolved_method != nullptr) {
1231    *vtable_idx = GetResolvedMethodVTableIndex(resolved_method, orig_invoke_type);
1232
1233    if (enable_devirtualization) {
1234      DCHECK(mUnit->GetVerifiedMethod() != nullptr);
1235      const MethodReference* devirt_target = mUnit->GetVerifiedMethod()->GetDevirtTarget(dex_pc);
1236
1237      stats_flags = IsFastInvoke(
1238          soa, dex_cache, class_loader, mUnit, referrer_class, resolved_method,
1239          invoke_type, target_method, devirt_target, direct_code, direct_method);
1240      result = stats_flags != 0;
1241    } else {
1242      // Devirtualization not enabled. Inline IsFastInvoke(), dropping the devirtualization parts.
1243      if (UNLIKELY(referrer_class == nullptr) ||
1244          UNLIKELY(!referrer_class->CanAccessResolvedMethod(resolved_method->GetDeclaringClass(),
1245                                                            resolved_method, dex_cache.Get(),
1246                                                            target_method->dex_method_index)) ||
1247          *invoke_type == kSuper) {
1248        // Slow path. (Without devirtualization, all super calls go slow path as well.)
1249      } else {
1250        // Sharpening failed so generate a regular resolved method dispatch.
1251        stats_flags = kFlagMethodResolved;
1252        GetCodeAndMethodForDirectCall(invoke_type, *invoke_type, false, referrer_class, resolved_method,
1253                                      &stats_flags, target_method, direct_code, direct_method);
1254        result = true;
1255      }
1256    }
1257  }
1258  if (!result) {
1259    // Conservative defaults.
1260    *vtable_idx = -1;
1261    *direct_code = 0u;
1262    *direct_method = 0u;
1263  }
1264  if (update_stats) {
1265    ProcessedInvoke(orig_invoke_type, stats_flags);
1266  }
1267  return result;
1268}
1269
1270const VerifiedMethod* CompilerDriver::GetVerifiedMethod(const DexFile* dex_file,
1271                                                        uint32_t method_idx) const {
1272  MethodReference ref(dex_file, method_idx);
1273  return verification_results_->GetVerifiedMethod(ref);
1274}
1275
1276bool CompilerDriver::IsSafeCast(const DexCompilationUnit* mUnit, uint32_t dex_pc) {
1277  DCHECK(mUnit->GetVerifiedMethod() != nullptr);
1278  bool result = mUnit->GetVerifiedMethod()->IsSafeCast(dex_pc);
1279  if (result) {
1280    stats_->SafeCast();
1281  } else {
1282    stats_->NotASafeCast();
1283  }
1284  return result;
1285}
1286
1287void CompilerDriver::AddCodePatch(const DexFile* dex_file,
1288                                  uint16_t referrer_class_def_idx,
1289                                  uint32_t referrer_method_idx,
1290                                  InvokeType referrer_invoke_type,
1291                                  uint32_t target_method_idx,
1292                                  const DexFile* target_dex_file,
1293                                  InvokeType target_invoke_type,
1294                                  size_t literal_offset) {
1295  MutexLock mu(Thread::Current(), compiled_methods_lock_);
1296  code_to_patch_.push_back(new CallPatchInformation(dex_file,
1297                                                    referrer_class_def_idx,
1298                                                    referrer_method_idx,
1299                                                    referrer_invoke_type,
1300                                                    target_method_idx,
1301                                                    target_dex_file,
1302                                                    target_invoke_type,
1303                                                    literal_offset));
1304}
1305void CompilerDriver::AddRelativeCodePatch(const DexFile* dex_file,
1306                                          uint16_t referrer_class_def_idx,
1307                                          uint32_t referrer_method_idx,
1308                                          InvokeType referrer_invoke_type,
1309                                          uint32_t target_method_idx,
1310                                          const DexFile* target_dex_file,
1311                                          InvokeType target_invoke_type,
1312                                          size_t literal_offset,
1313                                          int32_t pc_relative_offset) {
1314  MutexLock mu(Thread::Current(), compiled_methods_lock_);
1315  code_to_patch_.push_back(new RelativeCallPatchInformation(dex_file,
1316                                                            referrer_class_def_idx,
1317                                                            referrer_method_idx,
1318                                                            referrer_invoke_type,
1319                                                            target_method_idx,
1320                                                            target_dex_file,
1321                                                            target_invoke_type,
1322                                                            literal_offset,
1323                                                            pc_relative_offset));
1324}
1325void CompilerDriver::AddMethodPatch(const DexFile* dex_file,
1326                                    uint16_t referrer_class_def_idx,
1327                                    uint32_t referrer_method_idx,
1328                                    InvokeType referrer_invoke_type,
1329                                    uint32_t target_method_idx,
1330                                    const DexFile* target_dex_file,
1331                                    InvokeType target_invoke_type,
1332                                    size_t literal_offset) {
1333  MutexLock mu(Thread::Current(), compiled_methods_lock_);
1334  methods_to_patch_.push_back(new CallPatchInformation(dex_file,
1335                                                       referrer_class_def_idx,
1336                                                       referrer_method_idx,
1337                                                       referrer_invoke_type,
1338                                                       target_method_idx,
1339                                                       target_dex_file,
1340                                                       target_invoke_type,
1341                                                       literal_offset));
1342}
1343void CompilerDriver::AddClassPatch(const DexFile* dex_file,
1344                                    uint16_t referrer_class_def_idx,
1345                                    uint32_t referrer_method_idx,
1346                                    uint32_t target_type_idx,
1347                                    size_t literal_offset) {
1348  MutexLock mu(Thread::Current(), compiled_methods_lock_);
1349  classes_to_patch_.push_back(new TypePatchInformation(dex_file,
1350                                                       referrer_class_def_idx,
1351                                                       referrer_method_idx,
1352                                                       target_type_idx,
1353                                                       literal_offset));
1354}
1355
1356class ParallelCompilationManager {
1357 public:
1358  typedef void Callback(const ParallelCompilationManager* manager, size_t index);
1359
1360  ParallelCompilationManager(ClassLinker* class_linker,
1361                             jobject class_loader,
1362                             CompilerDriver* compiler,
1363                             const DexFile* dex_file,
1364                             ThreadPool* thread_pool)
1365    : index_(0),
1366      class_linker_(class_linker),
1367      class_loader_(class_loader),
1368      compiler_(compiler),
1369      dex_file_(dex_file),
1370      thread_pool_(thread_pool) {}
1371
1372  ClassLinker* GetClassLinker() const {
1373    CHECK(class_linker_ != NULL);
1374    return class_linker_;
1375  }
1376
1377  jobject GetClassLoader() const {
1378    return class_loader_;
1379  }
1380
1381  CompilerDriver* GetCompiler() const {
1382    CHECK(compiler_ != NULL);
1383    return compiler_;
1384  }
1385
1386  const DexFile* GetDexFile() const {
1387    CHECK(dex_file_ != NULL);
1388    return dex_file_;
1389  }
1390
1391  void ForAll(size_t begin, size_t end, Callback callback, size_t work_units) {
1392    Thread* self = Thread::Current();
1393    self->AssertNoPendingException();
1394    CHECK_GT(work_units, 0U);
1395
1396    index_.StoreRelaxed(begin);
1397    for (size_t i = 0; i < work_units; ++i) {
1398      thread_pool_->AddTask(self, new ForAllClosure(this, end, callback));
1399    }
1400    thread_pool_->StartWorkers(self);
1401
1402    // Ensure we're suspended while we're blocked waiting for the other threads to finish (worker
1403    // thread destructor's called below perform join).
1404    CHECK_NE(self->GetState(), kRunnable);
1405
1406    // Wait for all the worker threads to finish.
1407    thread_pool_->Wait(self, true, false);
1408  }
1409
1410  size_t NextIndex() {
1411    return index_.FetchAndAddSequentiallyConsistent(1);
1412  }
1413
1414 private:
1415  class ForAllClosure : public Task {
1416   public:
1417    ForAllClosure(ParallelCompilationManager* manager, size_t end, Callback* callback)
1418        : manager_(manager),
1419          end_(end),
1420          callback_(callback) {}
1421
1422    virtual void Run(Thread* self) {
1423      while (true) {
1424        const size_t index = manager_->NextIndex();
1425        if (UNLIKELY(index >= end_)) {
1426          break;
1427        }
1428        callback_(manager_, index);
1429        self->AssertNoPendingException();
1430      }
1431    }
1432
1433    virtual void Finalize() {
1434      delete this;
1435    }
1436
1437   private:
1438    ParallelCompilationManager* const manager_;
1439    const size_t end_;
1440    Callback* const callback_;
1441  };
1442
1443  AtomicInteger index_;
1444  ClassLinker* const class_linker_;
1445  const jobject class_loader_;
1446  CompilerDriver* const compiler_;
1447  const DexFile* const dex_file_;
1448  ThreadPool* const thread_pool_;
1449
1450  DISALLOW_COPY_AND_ASSIGN(ParallelCompilationManager);
1451};
1452
1453// Return true if the class should be skipped during compilation.
1454//
1455// The first case where we skip is for redundant class definitions in
1456// the boot classpath. We skip all but the first definition in that case.
1457//
1458// The second case where we skip is when an app bundles classes found
1459// in the boot classpath. Since at runtime we will select the class from
1460// the boot classpath, we ignore the one from the app.
1461static bool SkipClass(ClassLinker* class_linker, jobject class_loader, const DexFile& dex_file,
1462                      const DexFile::ClassDef& class_def) {
1463  const char* descriptor = dex_file.GetClassDescriptor(class_def);
1464  if (class_loader == NULL) {
1465    DexFile::ClassPathEntry pair = DexFile::FindInClassPath(descriptor, class_linker->GetBootClassPath());
1466    CHECK(pair.second != NULL);
1467    if (pair.first != &dex_file) {
1468      LOG(WARNING) << "Skipping class " << descriptor << " from " << dex_file.GetLocation()
1469                   << " previously found in " << pair.first->GetLocation();
1470      return true;
1471    }
1472    return false;
1473  }
1474  return class_linker->IsInBootClassPath(descriptor);
1475}
1476
1477// A fast version of SkipClass above if the class pointer is available
1478// that avoids the expensive FindInClassPath search.
1479static bool SkipClass(jobject class_loader, const DexFile& dex_file, mirror::Class* klass)
1480    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1481  DCHECK(klass != NULL);
1482  const DexFile& original_dex_file = *klass->GetDexCache()->GetDexFile();
1483  if (&dex_file != &original_dex_file) {
1484    if (class_loader == NULL) {
1485      LOG(WARNING) << "Skipping class " << PrettyDescriptor(klass) << " from "
1486                   << dex_file.GetLocation() << " previously found in "
1487                   << original_dex_file.GetLocation();
1488    }
1489    return true;
1490  }
1491  return false;
1492}
1493
1494static void CheckAndClearResolveException(Thread* self)
1495    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1496  CHECK(self->IsExceptionPending());
1497  mirror::Throwable* exception = self->GetException(nullptr);
1498  std::string descriptor = exception->GetClass()->GetDescriptor();
1499      if (descriptor != "Ljava/lang/IllegalAccessError;" &&
1500          descriptor != "Ljava/lang/IncompatibleClassChangeError;" &&
1501          descriptor != "Ljava/lang/InstantiationError;" &&
1502          descriptor != "Ljava/lang/NoClassDefFoundError;" &&
1503          descriptor != "Ljava/lang/NoSuchFieldError;" &&
1504          descriptor != "Ljava/lang/NoSuchMethodError;") {
1505    LOG(FATAL) << "Unexpected exeption " << exception->Dump();
1506  }
1507  self->ClearException();
1508}
1509
1510static void ResolveClassFieldsAndMethods(const ParallelCompilationManager* manager,
1511                                         size_t class_def_index)
1512    LOCKS_EXCLUDED(Locks::mutator_lock_) {
1513  ATRACE_CALL();
1514  Thread* self = Thread::Current();
1515  jobject jclass_loader = manager->GetClassLoader();
1516  const DexFile& dex_file = *manager->GetDexFile();
1517  ClassLinker* class_linker = manager->GetClassLinker();
1518
1519  // If an instance field is final then we need to have a barrier on the return, static final
1520  // fields are assigned within the lock held for class initialization. Conservatively assume
1521  // constructor barriers are always required.
1522  bool requires_constructor_barrier = true;
1523
1524  // Method and Field are the worst. We can't resolve without either
1525  // context from the code use (to disambiguate virtual vs direct
1526  // method and instance vs static field) or from class
1527  // definitions. While the compiler will resolve what it can as it
1528  // needs it, here we try to resolve fields and methods used in class
1529  // definitions, since many of them many never be referenced by
1530  // generated code.
1531  const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
1532  if (!SkipClass(class_linker, jclass_loader, dex_file, class_def)) {
1533    ScopedObjectAccess soa(self);
1534    StackHandleScope<2> hs(soa.Self());
1535    Handle<mirror::ClassLoader> class_loader(
1536        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
1537    Handle<mirror::DexCache> dex_cache(hs.NewHandle(class_linker->FindDexCache(dex_file)));
1538    // Resolve the class.
1539    mirror::Class* klass = class_linker->ResolveType(dex_file, class_def.class_idx_, dex_cache,
1540                                                     class_loader);
1541    bool resolve_fields_and_methods;
1542    if (klass == NULL) {
1543      // Class couldn't be resolved, for example, super-class is in a different dex file. Don't
1544      // attempt to resolve methods and fields when there is no declaring class.
1545      CheckAndClearResolveException(soa.Self());
1546      resolve_fields_and_methods = false;
1547    } else {
1548      resolve_fields_and_methods = manager->GetCompiler()->IsImage();
1549    }
1550    // Note the class_data pointer advances through the headers,
1551    // static fields, instance fields, direct methods, and virtual
1552    // methods.
1553    const byte* class_data = dex_file.GetClassData(class_def);
1554    if (class_data == NULL) {
1555      // Empty class such as a marker interface.
1556      requires_constructor_barrier = false;
1557    } else {
1558      ClassDataItemIterator it(dex_file, class_data);
1559      while (it.HasNextStaticField()) {
1560        if (resolve_fields_and_methods) {
1561          mirror::ArtField* field = class_linker->ResolveField(dex_file, it.GetMemberIndex(),
1562                                                               dex_cache, class_loader, true);
1563          if (field == NULL) {
1564            CheckAndClearResolveException(soa.Self());
1565          }
1566        }
1567        it.Next();
1568      }
1569      // We require a constructor barrier if there are final instance fields.
1570      requires_constructor_barrier = false;
1571      while (it.HasNextInstanceField()) {
1572        if ((it.GetMemberAccessFlags() & kAccFinal) != 0) {
1573          requires_constructor_barrier = true;
1574        }
1575        if (resolve_fields_and_methods) {
1576          mirror::ArtField* field = class_linker->ResolveField(dex_file, it.GetMemberIndex(),
1577                                                               dex_cache, class_loader, false);
1578          if (field == NULL) {
1579            CheckAndClearResolveException(soa.Self());
1580          }
1581        }
1582        it.Next();
1583      }
1584      if (resolve_fields_and_methods) {
1585        while (it.HasNextDirectMethod()) {
1586          mirror::ArtMethod* method = class_linker->ResolveMethod(dex_file, it.GetMemberIndex(),
1587                                                                  dex_cache, class_loader,
1588                                                                  NullHandle<mirror::ArtMethod>(),
1589                                                                  it.GetMethodInvokeType(class_def));
1590          if (method == NULL) {
1591            CheckAndClearResolveException(soa.Self());
1592          }
1593          it.Next();
1594        }
1595        while (it.HasNextVirtualMethod()) {
1596          mirror::ArtMethod* method = class_linker->ResolveMethod(dex_file, it.GetMemberIndex(),
1597                                                                  dex_cache, class_loader,
1598                                                                  NullHandle<mirror::ArtMethod>(),
1599                                                                  it.GetMethodInvokeType(class_def));
1600          if (method == NULL) {
1601            CheckAndClearResolveException(soa.Self());
1602          }
1603          it.Next();
1604        }
1605        DCHECK(!it.HasNext());
1606      }
1607    }
1608  }
1609  if (requires_constructor_barrier) {
1610    manager->GetCompiler()->AddRequiresConstructorBarrier(self, &dex_file, class_def_index);
1611  }
1612}
1613
1614static void ResolveType(const ParallelCompilationManager* manager, size_t type_idx)
1615    LOCKS_EXCLUDED(Locks::mutator_lock_) {
1616  // Class derived values are more complicated, they require the linker and loader.
1617  ScopedObjectAccess soa(Thread::Current());
1618  ClassLinker* class_linker = manager->GetClassLinker();
1619  const DexFile& dex_file = *manager->GetDexFile();
1620  StackHandleScope<2> hs(soa.Self());
1621  Handle<mirror::DexCache> dex_cache(hs.NewHandle(class_linker->FindDexCache(dex_file)));
1622  Handle<mirror::ClassLoader> class_loader(
1623      hs.NewHandle(soa.Decode<mirror::ClassLoader*>(manager->GetClassLoader())));
1624  mirror::Class* klass = class_linker->ResolveType(dex_file, type_idx, dex_cache, class_loader);
1625
1626  if (klass == NULL) {
1627    CHECK(soa.Self()->IsExceptionPending());
1628    mirror::Throwable* exception = soa.Self()->GetException(NULL);
1629    VLOG(compiler) << "Exception during type resolution: " << exception->Dump();
1630    if (exception->GetClass()->DescriptorEquals("Ljava/lang/OutOfMemoryError;")) {
1631      // There's little point continuing compilation if the heap is exhausted.
1632      LOG(FATAL) << "Out of memory during type resolution for compilation";
1633    }
1634    soa.Self()->ClearException();
1635  }
1636}
1637
1638void CompilerDriver::ResolveDexFile(jobject class_loader, const DexFile& dex_file,
1639                                    ThreadPool* thread_pool, TimingLogger* timings) {
1640  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1641
1642  // TODO: we could resolve strings here, although the string table is largely filled with class
1643  //       and method names.
1644
1645  ParallelCompilationManager context(class_linker, class_loader, this, &dex_file, thread_pool);
1646  if (IsImage()) {
1647    // For images we resolve all types, such as array, whereas for applications just those with
1648    // classdefs are resolved by ResolveClassFieldsAndMethods.
1649    TimingLogger::ScopedTiming t("Resolve Types", timings);
1650    context.ForAll(0, dex_file.NumTypeIds(), ResolveType, thread_count_);
1651  }
1652
1653  TimingLogger::ScopedTiming t("Resolve MethodsAndFields", timings);
1654  context.ForAll(0, dex_file.NumClassDefs(), ResolveClassFieldsAndMethods, thread_count_);
1655}
1656
1657void CompilerDriver::Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files,
1658                            ThreadPool* thread_pool, TimingLogger* timings) {
1659  for (size_t i = 0; i != dex_files.size(); ++i) {
1660    const DexFile* dex_file = dex_files[i];
1661    CHECK(dex_file != NULL);
1662    VerifyDexFile(class_loader, *dex_file, thread_pool, timings);
1663  }
1664}
1665
1666static void VerifyClass(const ParallelCompilationManager* manager, size_t class_def_index)
1667    LOCKS_EXCLUDED(Locks::mutator_lock_) {
1668  ATRACE_CALL();
1669  ScopedObjectAccess soa(Thread::Current());
1670  const DexFile& dex_file = *manager->GetDexFile();
1671  const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
1672  const char* descriptor = dex_file.GetClassDescriptor(class_def);
1673  ClassLinker* class_linker = manager->GetClassLinker();
1674  jobject jclass_loader = manager->GetClassLoader();
1675  StackHandleScope<3> hs(soa.Self());
1676  Handle<mirror::ClassLoader> class_loader(
1677      hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
1678  Handle<mirror::Class> klass(
1679      hs.NewHandle(class_linker->FindClass(soa.Self(), descriptor, class_loader)));
1680  if (klass.Get() == nullptr) {
1681    CHECK(soa.Self()->IsExceptionPending());
1682    soa.Self()->ClearException();
1683
1684    /*
1685     * At compile time, we can still structurally verify the class even if FindClass fails.
1686     * This is to ensure the class is structurally sound for compilation. An unsound class
1687     * will be rejected by the verifier and later skipped during compilation in the compiler.
1688     */
1689    Handle<mirror::DexCache> dex_cache(hs.NewHandle(class_linker->FindDexCache(dex_file)));
1690    std::string error_msg;
1691    if (verifier::MethodVerifier::VerifyClass(&dex_file, dex_cache, class_loader, &class_def, true,
1692                                              &error_msg) ==
1693                                                  verifier::MethodVerifier::kHardFailure) {
1694      LOG(ERROR) << "Verification failed on class " << PrettyDescriptor(descriptor)
1695                 << " because: " << error_msg;
1696    }
1697  } else if (!SkipClass(jclass_loader, dex_file, klass.Get())) {
1698    CHECK(klass->IsResolved()) << PrettyClass(klass.Get());
1699    class_linker->VerifyClass(klass);
1700
1701    if (klass->IsErroneous()) {
1702      // ClassLinker::VerifyClass throws, which isn't useful in the compiler.
1703      CHECK(soa.Self()->IsExceptionPending());
1704      soa.Self()->ClearException();
1705    }
1706
1707    CHECK(klass->IsCompileTimeVerified() || klass->IsErroneous())
1708        << PrettyDescriptor(klass.Get()) << ": state=" << klass->GetStatus();
1709  }
1710  soa.Self()->AssertNoPendingException();
1711}
1712
1713void CompilerDriver::VerifyDexFile(jobject class_loader, const DexFile& dex_file,
1714                                   ThreadPool* thread_pool, TimingLogger* timings) {
1715  TimingLogger::ScopedTiming t("Verify Dex File", timings);
1716  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1717  ParallelCompilationManager context(class_linker, class_loader, this, &dex_file, thread_pool);
1718  context.ForAll(0, dex_file.NumClassDefs(), VerifyClass, thread_count_);
1719}
1720
1721static void InitializeClass(const ParallelCompilationManager* manager, size_t class_def_index)
1722    LOCKS_EXCLUDED(Locks::mutator_lock_) {
1723  ATRACE_CALL();
1724  jobject jclass_loader = manager->GetClassLoader();
1725  const DexFile& dex_file = *manager->GetDexFile();
1726  const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
1727  const DexFile::TypeId& class_type_id = dex_file.GetTypeId(class_def.class_idx_);
1728  const char* descriptor = dex_file.StringDataByIdx(class_type_id.descriptor_idx_);
1729
1730  ScopedObjectAccess soa(Thread::Current());
1731  StackHandleScope<3> hs(soa.Self());
1732  Handle<mirror::ClassLoader> class_loader(
1733      hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
1734  Handle<mirror::Class> klass(
1735      hs.NewHandle(manager->GetClassLinker()->FindClass(soa.Self(), descriptor, class_loader)));
1736
1737  if (klass.Get() != nullptr && !SkipClass(jclass_loader, dex_file, klass.Get())) {
1738    // Only try to initialize classes that were successfully verified.
1739    if (klass->IsVerified()) {
1740      // Attempt to initialize the class but bail if we either need to initialize the super-class
1741      // or static fields.
1742      manager->GetClassLinker()->EnsureInitialized(klass, false, false);
1743      if (!klass->IsInitialized()) {
1744        // We don't want non-trivial class initialization occurring on multiple threads due to
1745        // deadlock problems. For example, a parent class is initialized (holding its lock) that
1746        // refers to a sub-class in its static/class initializer causing it to try to acquire the
1747        // sub-class' lock. While on a second thread the sub-class is initialized (holding its lock)
1748        // after first initializing its parents, whose locks are acquired. This leads to a
1749        // parent-to-child and a child-to-parent lock ordering and consequent potential deadlock.
1750        // We need to use an ObjectLock due to potential suspension in the interpreting code. Rather
1751        // than use a special Object for the purpose we use the Class of java.lang.Class.
1752        Handle<mirror::Class> h_klass(hs.NewHandle(klass->GetClass()));
1753        ObjectLock<mirror::Class> lock(soa.Self(), h_klass);
1754        // Attempt to initialize allowing initialization of parent classes but still not static
1755        // fields.
1756        manager->GetClassLinker()->EnsureInitialized(klass, false, true);
1757        if (!klass->IsInitialized()) {
1758          // We need to initialize static fields, we only do this for image classes that aren't
1759          // marked with the $NoPreloadHolder (which implies this should not be initialized early).
1760          bool can_init_static_fields = manager->GetCompiler()->IsImage() &&
1761              manager->GetCompiler()->IsImageClass(descriptor) &&
1762              !StringPiece(descriptor).ends_with("$NoPreloadHolder;");
1763          if (can_init_static_fields) {
1764            VLOG(compiler) << "Initializing: " << descriptor;
1765            // TODO multithreading support. We should ensure the current compilation thread has
1766            // exclusive access to the runtime and the transaction. To achieve this, we could use
1767            // a ReaderWriterMutex but we're holding the mutator lock so we fail mutex sanity
1768            // checks in Thread::AssertThreadSuspensionIsAllowable.
1769            Runtime* const runtime = Runtime::Current();
1770            Transaction transaction;
1771
1772            // Run the class initializer in transaction mode.
1773            runtime->EnterTransactionMode(&transaction);
1774            const mirror::Class::Status old_status = klass->GetStatus();
1775            bool success = manager->GetClassLinker()->EnsureInitialized(klass, true, true);
1776            // TODO we detach transaction from runtime to indicate we quit the transactional
1777            // mode which prevents the GC from visiting objects modified during the transaction.
1778            // Ensure GC is not run so don't access freed objects when aborting transaction.
1779            const char* old_casue = soa.Self()->StartAssertNoThreadSuspension("Transaction end");
1780            runtime->ExitTransactionMode();
1781
1782            if (!success) {
1783              CHECK(soa.Self()->IsExceptionPending());
1784              ThrowLocation throw_location;
1785              mirror::Throwable* exception = soa.Self()->GetException(&throw_location);
1786              VLOG(compiler) << "Initialization of " << descriptor << " aborted because of "
1787                  << exception->Dump();
1788              soa.Self()->ClearException();
1789              transaction.Abort();
1790              CHECK_EQ(old_status, klass->GetStatus()) << "Previous class status not restored";
1791            }
1792            soa.Self()->EndAssertNoThreadSuspension(old_casue);
1793          }
1794        }
1795        soa.Self()->AssertNoPendingException();
1796      }
1797    }
1798    // Record the final class status if necessary.
1799    ClassReference ref(manager->GetDexFile(), class_def_index);
1800    manager->GetCompiler()->RecordClassStatus(ref, klass->GetStatus());
1801  }
1802  // Clear any class not found or verification exceptions.
1803  soa.Self()->ClearException();
1804}
1805
1806void CompilerDriver::InitializeClasses(jobject jni_class_loader, const DexFile& dex_file,
1807                                       ThreadPool* thread_pool, TimingLogger* timings) {
1808  TimingLogger::ScopedTiming t("InitializeNoClinit", timings);
1809  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1810  ParallelCompilationManager context(class_linker, jni_class_loader, this, &dex_file, thread_pool);
1811  size_t thread_count;
1812  if (IsImage()) {
1813    // TODO: remove this when transactional mode supports multithreading.
1814    thread_count = 1U;
1815  } else {
1816    thread_count = thread_count_;
1817  }
1818  context.ForAll(0, dex_file.NumClassDefs(), InitializeClass, thread_count);
1819  if (IsImage()) {
1820    // Prune garbage objects created during aborted transactions.
1821    Runtime::Current()->GetHeap()->CollectGarbage(true);
1822  }
1823}
1824
1825void CompilerDriver::InitializeClasses(jobject class_loader,
1826                                       const std::vector<const DexFile*>& dex_files,
1827                                       ThreadPool* thread_pool, TimingLogger* timings) {
1828  for (size_t i = 0; i != dex_files.size(); ++i) {
1829    const DexFile* dex_file = dex_files[i];
1830    CHECK(dex_file != NULL);
1831    InitializeClasses(class_loader, *dex_file, thread_pool, timings);
1832  }
1833}
1834
1835void CompilerDriver::Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
1836                             ThreadPool* thread_pool, TimingLogger* timings) {
1837  for (size_t i = 0; i != dex_files.size(); ++i) {
1838    const DexFile* dex_file = dex_files[i];
1839    CHECK(dex_file != NULL);
1840    CompileDexFile(class_loader, *dex_file, thread_pool, timings);
1841  }
1842}
1843
1844void CompilerDriver::CompileClass(const ParallelCompilationManager* manager, size_t class_def_index) {
1845  ATRACE_CALL();
1846  jobject jclass_loader = manager->GetClassLoader();
1847  const DexFile& dex_file = *manager->GetDexFile();
1848  const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
1849  ClassLinker* class_linker = manager->GetClassLinker();
1850  if (SkipClass(class_linker, jclass_loader, dex_file, class_def)) {
1851    return;
1852  }
1853  ClassReference ref(&dex_file, class_def_index);
1854  // Skip compiling classes with generic verifier failures since they will still fail at runtime
1855  if (manager->GetCompiler()->verification_results_->IsClassRejected(ref)) {
1856    return;
1857  }
1858  const byte* class_data = dex_file.GetClassData(class_def);
1859  if (class_data == NULL) {
1860    // empty class, probably a marker interface
1861    return;
1862  }
1863
1864  // Can we run DEX-to-DEX compiler on this class ?
1865  DexToDexCompilationLevel dex_to_dex_compilation_level = kDontDexToDexCompile;
1866  {
1867    ScopedObjectAccess soa(Thread::Current());
1868    StackHandleScope<1> hs(soa.Self());
1869    Handle<mirror::ClassLoader> class_loader(
1870        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
1871    dex_to_dex_compilation_level = GetDexToDexCompilationlevel(soa.Self(), class_loader, dex_file,
1872                                                               class_def);
1873  }
1874  ClassDataItemIterator it(dex_file, class_data);
1875  // Skip fields
1876  while (it.HasNextStaticField()) {
1877    it.Next();
1878  }
1879  while (it.HasNextInstanceField()) {
1880    it.Next();
1881  }
1882  CompilerDriver* driver = manager->GetCompiler();
1883  // Compile direct methods
1884  int64_t previous_direct_method_idx = -1;
1885  while (it.HasNextDirectMethod()) {
1886    uint32_t method_idx = it.GetMemberIndex();
1887    if (method_idx == previous_direct_method_idx) {
1888      // smali can create dex files with two encoded_methods sharing the same method_idx
1889      // http://code.google.com/p/smali/issues/detail?id=119
1890      it.Next();
1891      continue;
1892    }
1893    previous_direct_method_idx = method_idx;
1894    driver->CompileMethod(it.GetMethodCodeItem(), it.GetMemberAccessFlags(),
1895                          it.GetMethodInvokeType(class_def), class_def_index,
1896                          method_idx, jclass_loader, dex_file, dex_to_dex_compilation_level);
1897    it.Next();
1898  }
1899  // Compile virtual methods
1900  int64_t previous_virtual_method_idx = -1;
1901  while (it.HasNextVirtualMethod()) {
1902    uint32_t method_idx = it.GetMemberIndex();
1903    if (method_idx == previous_virtual_method_idx) {
1904      // smali can create dex files with two encoded_methods sharing the same method_idx
1905      // http://code.google.com/p/smali/issues/detail?id=119
1906      it.Next();
1907      continue;
1908    }
1909    previous_virtual_method_idx = method_idx;
1910    driver->CompileMethod(it.GetMethodCodeItem(), it.GetMemberAccessFlags(),
1911                          it.GetMethodInvokeType(class_def), class_def_index,
1912                          method_idx, jclass_loader, dex_file, dex_to_dex_compilation_level);
1913    it.Next();
1914  }
1915  DCHECK(!it.HasNext());
1916}
1917
1918void CompilerDriver::CompileDexFile(jobject class_loader, const DexFile& dex_file,
1919                                    ThreadPool* thread_pool, TimingLogger* timings) {
1920  TimingLogger::ScopedTiming t("Compile Dex File", timings);
1921  ParallelCompilationManager context(Runtime::Current()->GetClassLinker(), class_loader, this,
1922                                     &dex_file, thread_pool);
1923  context.ForAll(0, dex_file.NumClassDefs(), CompilerDriver::CompileClass, thread_count_);
1924}
1925
1926void CompilerDriver::CompileMethod(const DexFile::CodeItem* code_item, uint32_t access_flags,
1927                                   InvokeType invoke_type, uint16_t class_def_idx,
1928                                   uint32_t method_idx, jobject class_loader,
1929                                   const DexFile& dex_file,
1930                                   DexToDexCompilationLevel dex_to_dex_compilation_level) {
1931  CompiledMethod* compiled_method = NULL;
1932  uint64_t start_ns = NanoTime();
1933
1934  if ((access_flags & kAccNative) != 0) {
1935    // Are we interpreting only and have support for generic JNI down calls?
1936    if (!compiler_options_->IsCompilationEnabled() &&
1937        (instruction_set_ == kX86_64 || instruction_set_ == kArm64)) {
1938      // Leaving this empty will trigger the generic JNI version
1939    } else {
1940      compiled_method = compiler_->JniCompile(access_flags, method_idx, dex_file);
1941      CHECK(compiled_method != NULL);
1942    }
1943  } else if ((access_flags & kAccAbstract) != 0) {
1944  } else {
1945    MethodReference method_ref(&dex_file, method_idx);
1946    bool compile = verification_results_->IsCandidateForCompilation(method_ref, access_flags);
1947    if (compile) {
1948      // NOTE: if compiler declines to compile this method, it will return NULL.
1949      compiled_method = compiler_->Compile(code_item, access_flags, invoke_type, class_def_idx,
1950                                           method_idx, class_loader, dex_file);
1951    }
1952    if (compiled_method == nullptr && dex_to_dex_compilation_level != kDontDexToDexCompile) {
1953      // TODO: add a command-line option to disable DEX-to-DEX compilation ?
1954      (*dex_to_dex_compiler_)(*this, code_item, access_flags,
1955                              invoke_type, class_def_idx,
1956                              method_idx, class_loader, dex_file,
1957                              dex_to_dex_compilation_level);
1958    }
1959  }
1960  uint64_t duration_ns = NanoTime() - start_ns;
1961  if (duration_ns > MsToNs(compiler_->GetMaximumCompilationTimeBeforeWarning()) && !kIsDebugBuild) {
1962    LOG(WARNING) << "Compilation of " << PrettyMethod(method_idx, dex_file)
1963                 << " took " << PrettyDuration(duration_ns);
1964  }
1965
1966  Thread* self = Thread::Current();
1967  if (compiled_method != NULL) {
1968    MethodReference ref(&dex_file, method_idx);
1969    DCHECK(GetCompiledMethod(ref) == NULL) << PrettyMethod(method_idx, dex_file);
1970    {
1971      MutexLock mu(self, compiled_methods_lock_);
1972      compiled_methods_.Put(ref, compiled_method);
1973    }
1974    DCHECK(GetCompiledMethod(ref) != NULL) << PrettyMethod(method_idx, dex_file);
1975  }
1976
1977  if (self->IsExceptionPending()) {
1978    ScopedObjectAccess soa(self);
1979    LOG(FATAL) << "Unexpected exception compiling: " << PrettyMethod(method_idx, dex_file) << "\n"
1980        << self->GetException(NULL)->Dump();
1981  }
1982}
1983
1984CompiledClass* CompilerDriver::GetCompiledClass(ClassReference ref) const {
1985  MutexLock mu(Thread::Current(), compiled_classes_lock_);
1986  ClassTable::const_iterator it = compiled_classes_.find(ref);
1987  if (it == compiled_classes_.end()) {
1988    return NULL;
1989  }
1990  CHECK(it->second != NULL);
1991  return it->second;
1992}
1993
1994void CompilerDriver::RecordClassStatus(ClassReference ref, mirror::Class::Status status) {
1995  MutexLock mu(Thread::Current(), compiled_classes_lock_);
1996  auto it = compiled_classes_.find(ref);
1997  if (it == compiled_classes_.end() || it->second->GetStatus() != status) {
1998    // An entry doesn't exist or the status is lower than the new status.
1999    if (it != compiled_classes_.end()) {
2000      CHECK_GT(status, it->second->GetStatus());
2001      delete it->second;
2002    }
2003    switch (status) {
2004      case mirror::Class::kStatusNotReady:
2005      case mirror::Class::kStatusError:
2006      case mirror::Class::kStatusRetryVerificationAtRuntime:
2007      case mirror::Class::kStatusVerified:
2008      case mirror::Class::kStatusInitialized:
2009        break;  // Expected states.
2010      default:
2011        LOG(FATAL) << "Unexpected class status for class "
2012            << PrettyDescriptor(ref.first->GetClassDescriptor(ref.first->GetClassDef(ref.second)))
2013            << " of " << status;
2014    }
2015    CompiledClass* compiled_class = new CompiledClass(status);
2016    compiled_classes_.Overwrite(ref, compiled_class);
2017  }
2018}
2019
2020CompiledMethod* CompilerDriver::GetCompiledMethod(MethodReference ref) const {
2021  MutexLock mu(Thread::Current(), compiled_methods_lock_);
2022  MethodTable::const_iterator it = compiled_methods_.find(ref);
2023  if (it == compiled_methods_.end()) {
2024    return NULL;
2025  }
2026  CHECK(it->second != NULL);
2027  return it->second;
2028}
2029
2030void CompilerDriver::AddRequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
2031                                                   uint16_t class_def_index) {
2032  WriterMutexLock mu(self, freezing_constructor_lock_);
2033  freezing_constructor_classes_.insert(ClassReference(dex_file, class_def_index));
2034}
2035
2036bool CompilerDriver::RequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
2037                                                uint16_t class_def_index) {
2038  ReaderMutexLock mu(self, freezing_constructor_lock_);
2039  return freezing_constructor_classes_.count(ClassReference(dex_file, class_def_index)) != 0;
2040}
2041
2042bool CompilerDriver::WriteElf(const std::string& android_root,
2043                              bool is_host,
2044                              const std::vector<const art::DexFile*>& dex_files,
2045                              OatWriter* oat_writer,
2046                              art::File* file)
2047    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2048  return compiler_->WriteElf(file, oat_writer, dex_files, android_root, is_host);
2049}
2050void CompilerDriver::InstructionSetToLLVMTarget(InstructionSet instruction_set,
2051                                                std::string* target_triple,
2052                                                std::string* target_cpu,
2053                                                std::string* target_attr) {
2054  switch (instruction_set) {
2055    case kThumb2:
2056      *target_triple = "thumb-none-linux-gnueabi";
2057      *target_cpu = "cortex-a9";
2058      *target_attr = "+thumb2,+neon,+neonfp,+vfp3,+db";
2059      break;
2060
2061    case kArm:
2062      *target_triple = "armv7-none-linux-gnueabi";
2063      // TODO: Fix for Nexus S.
2064      *target_cpu = "cortex-a9";
2065      // TODO: Fix for Xoom.
2066      *target_attr = "+v7,+neon,+neonfp,+vfp3,+db";
2067      break;
2068
2069    case kX86:
2070      *target_triple = "i386-pc-linux-gnu";
2071      *target_attr = "";
2072      break;
2073
2074    case kX86_64:
2075      *target_triple = "x86_64-pc-linux-gnu";
2076      *target_attr = "";
2077      break;
2078
2079    case kMips:
2080      *target_triple = "mipsel-unknown-linux";
2081      *target_attr = "mips32r2";
2082      break;
2083
2084    default:
2085      LOG(FATAL) << "Unknown instruction set: " << instruction_set;
2086    }
2087  }
2088
2089bool CompilerDriver::SkipCompilation(const std::string& method_name) {
2090  if (!profile_present_) {
2091    return false;
2092  }
2093  // First find the method in the profile file.
2094  ProfileFile::ProfileData data;
2095  if (!profile_file_.GetProfileData(&data, method_name)) {
2096    // Not in profile, no information can be determined.
2097    if (kIsDebugBuild) {
2098      VLOG(compiler) << "not compiling " << method_name << " because it's not in the profile";
2099    }
2100    return true;
2101  }
2102
2103  // Methods that comprise top_k_threshold % of the total samples will be compiled.
2104  // Compare against the start of the topK percentage bucket just in case the threshold
2105  // falls inside a bucket.
2106  bool compile = data.GetTopKUsedPercentage() - data.GetUsedPercent()
2107                 <= compiler_options_->GetTopKProfileThreshold();
2108  if (kIsDebugBuild) {
2109    if (compile) {
2110      LOG(INFO) << "compiling method " << method_name << " because its usage is part of top "
2111          << data.GetTopKUsedPercentage() << "% with a percent of " << data.GetUsedPercent() << "%"
2112          << " (topKThreshold=" << compiler_options_->GetTopKProfileThreshold() << ")";
2113    } else {
2114      VLOG(compiler) << "not compiling method " << method_name
2115          << " because it's not part of leading " << compiler_options_->GetTopKProfileThreshold()
2116          << "% samples)";
2117    }
2118  }
2119  return !compile;
2120}
2121}  // namespace art
2122