compiler_driver.cc revision 9fdb129b90c9a985f606f9d95627b4852171dc11
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 <unordered_set>
23#include <vector>
24#include <unistd.h>
25
26#ifndef __APPLE__
27#include <malloc.h>  // For mallinfo
28#endif
29
30#include "art_field-inl.h"
31#include "art_method-inl.h"
32#include "base/stl_util.h"
33#include "base/time_utils.h"
34#include "base/timing_logger.h"
35#include "class_linker-inl.h"
36#include "compiled_class.h"
37#include "compiled_method.h"
38#include "compiler.h"
39#include "compiler_driver-inl.h"
40#include "dex_compilation_unit.h"
41#include "dex_file-inl.h"
42#include "dex/dex_to_dex_compiler.h"
43#include "dex/verification_results.h"
44#include "dex/verified_method.h"
45#include "dex/quick/dex_file_method_inliner.h"
46#include "dex/quick/dex_file_to_method_inliner_map.h"
47#include "driver/compiler_options.h"
48#include "jni_internal.h"
49#include "object_lock.h"
50#include "profiler.h"
51#include "runtime.h"
52#include "gc/accounting/card_table-inl.h"
53#include "gc/accounting/heap_bitmap.h"
54#include "gc/space/image_space.h"
55#include "gc/space/space.h"
56#include "mirror/class_loader.h"
57#include "mirror/class-inl.h"
58#include "mirror/dex_cache-inl.h"
59#include "mirror/object-inl.h"
60#include "mirror/object_array-inl.h"
61#include "mirror/throwable.h"
62#include "scoped_thread_state_change.h"
63#include "ScopedLocalRef.h"
64#include "handle_scope-inl.h"
65#include "thread.h"
66#include "thread_list.h"
67#include "thread_pool.h"
68#include "trampolines/trampoline_compiler.h"
69#include "transaction.h"
70#include "utils/dex_cache_arrays_layout-inl.h"
71#include "utils/swap_space.h"
72#include "verifier/method_verifier.h"
73#include "verifier/method_verifier-inl.h"
74
75namespace art {
76
77static constexpr bool kTimeCompileMethod = !kIsDebugBuild;
78
79// Whether classes-to-compile and methods-to-compile are only applied to the boot image, or, when
80// given, too all compilations.
81static constexpr bool kRestrictCompilationFiltersToImage = true;
82
83static double Percentage(size_t x, size_t y) {
84  return 100.0 * (static_cast<double>(x)) / (static_cast<double>(x + y));
85}
86
87static void DumpStat(size_t x, size_t y, const char* str) {
88  if (x == 0 && y == 0) {
89    return;
90  }
91  LOG(INFO) << Percentage(x, y) << "% of " << str << " for " << (x + y) << " cases";
92}
93
94class CompilerDriver::AOTCompilationStats {
95 public:
96  AOTCompilationStats()
97      : stats_lock_("AOT compilation statistics lock"),
98        types_in_dex_cache_(0), types_not_in_dex_cache_(0),
99        strings_in_dex_cache_(0), strings_not_in_dex_cache_(0),
100        resolved_types_(0), unresolved_types_(0),
101        resolved_instance_fields_(0), unresolved_instance_fields_(0),
102        resolved_local_static_fields_(0), resolved_static_fields_(0), unresolved_static_fields_(0),
103        type_based_devirtualization_(0),
104        safe_casts_(0), not_safe_casts_(0) {
105    for (size_t i = 0; i <= kMaxInvokeType; i++) {
106      resolved_methods_[i] = 0;
107      unresolved_methods_[i] = 0;
108      virtual_made_direct_[i] = 0;
109      direct_calls_to_boot_[i] = 0;
110      direct_methods_to_boot_[i] = 0;
111    }
112  }
113
114  void Dump() {
115    DumpStat(types_in_dex_cache_, types_not_in_dex_cache_, "types known to be in dex cache");
116    DumpStat(strings_in_dex_cache_, strings_not_in_dex_cache_, "strings known to be in dex cache");
117    DumpStat(resolved_types_, unresolved_types_, "types resolved");
118    DumpStat(resolved_instance_fields_, unresolved_instance_fields_, "instance fields resolved");
119    DumpStat(resolved_local_static_fields_ + resolved_static_fields_, unresolved_static_fields_,
120             "static fields resolved");
121    DumpStat(resolved_local_static_fields_, resolved_static_fields_ + unresolved_static_fields_,
122             "static fields local to a class");
123    DumpStat(safe_casts_, not_safe_casts_, "check-casts removed based on type information");
124    // Note, the code below subtracts the stat value so that when added to the stat value we have
125    // 100% of samples. TODO: clean this up.
126    DumpStat(type_based_devirtualization_,
127             resolved_methods_[kVirtual] + unresolved_methods_[kVirtual] +
128             resolved_methods_[kInterface] + unresolved_methods_[kInterface] -
129             type_based_devirtualization_,
130             "virtual/interface calls made direct based on type information");
131
132    for (size_t i = 0; i <= kMaxInvokeType; i++) {
133      std::ostringstream oss;
134      oss << static_cast<InvokeType>(i) << " methods were AOT resolved";
135      DumpStat(resolved_methods_[i], unresolved_methods_[i], oss.str().c_str());
136      if (virtual_made_direct_[i] > 0) {
137        std::ostringstream oss2;
138        oss2 << static_cast<InvokeType>(i) << " methods made direct";
139        DumpStat(virtual_made_direct_[i],
140                 resolved_methods_[i] + unresolved_methods_[i] - virtual_made_direct_[i],
141                 oss2.str().c_str());
142      }
143      if (direct_calls_to_boot_[i] > 0) {
144        std::ostringstream oss2;
145        oss2 << static_cast<InvokeType>(i) << " method calls are direct into boot";
146        DumpStat(direct_calls_to_boot_[i],
147                 resolved_methods_[i] + unresolved_methods_[i] - direct_calls_to_boot_[i],
148                 oss2.str().c_str());
149      }
150      if (direct_methods_to_boot_[i] > 0) {
151        std::ostringstream oss2;
152        oss2 << static_cast<InvokeType>(i) << " method calls have methods in boot";
153        DumpStat(direct_methods_to_boot_[i],
154                 resolved_methods_[i] + unresolved_methods_[i] - direct_methods_to_boot_[i],
155                 oss2.str().c_str());
156      }
157    }
158  }
159
160// Allow lossy statistics in non-debug builds.
161#ifndef NDEBUG
162#define STATS_LOCK() MutexLock mu(Thread::Current(), stats_lock_)
163#else
164#define STATS_LOCK()
165#endif
166
167  void TypeInDexCache() REQUIRES(!stats_lock_) {
168    STATS_LOCK();
169    types_in_dex_cache_++;
170  }
171
172  void TypeNotInDexCache() REQUIRES(!stats_lock_) {
173    STATS_LOCK();
174    types_not_in_dex_cache_++;
175  }
176
177  void StringInDexCache() REQUIRES(!stats_lock_) {
178    STATS_LOCK();
179    strings_in_dex_cache_++;
180  }
181
182  void StringNotInDexCache() REQUIRES(!stats_lock_) {
183    STATS_LOCK();
184    strings_not_in_dex_cache_++;
185  }
186
187  void TypeDoesntNeedAccessCheck() REQUIRES(!stats_lock_) {
188    STATS_LOCK();
189    resolved_types_++;
190  }
191
192  void TypeNeedsAccessCheck() REQUIRES(!stats_lock_) {
193    STATS_LOCK();
194    unresolved_types_++;
195  }
196
197  void ResolvedInstanceField() REQUIRES(!stats_lock_) {
198    STATS_LOCK();
199    resolved_instance_fields_++;
200  }
201
202  void UnresolvedInstanceField() REQUIRES(!stats_lock_) {
203    STATS_LOCK();
204    unresolved_instance_fields_++;
205  }
206
207  void ResolvedLocalStaticField() REQUIRES(!stats_lock_) {
208    STATS_LOCK();
209    resolved_local_static_fields_++;
210  }
211
212  void ResolvedStaticField() REQUIRES(!stats_lock_) {
213    STATS_LOCK();
214    resolved_static_fields_++;
215  }
216
217  void UnresolvedStaticField() REQUIRES(!stats_lock_) {
218    STATS_LOCK();
219    unresolved_static_fields_++;
220  }
221
222  // Indicate that type information from the verifier led to devirtualization.
223  void PreciseTypeDevirtualization() REQUIRES(!stats_lock_) {
224    STATS_LOCK();
225    type_based_devirtualization_++;
226  }
227
228  // Indicate that a method of the given type was resolved at compile time.
229  void ResolvedMethod(InvokeType type) REQUIRES(!stats_lock_) {
230    DCHECK_LE(type, kMaxInvokeType);
231    STATS_LOCK();
232    resolved_methods_[type]++;
233  }
234
235  // Indicate that a method of the given type was unresolved at compile time as it was in an
236  // unknown dex file.
237  void UnresolvedMethod(InvokeType type) REQUIRES(!stats_lock_) {
238    DCHECK_LE(type, kMaxInvokeType);
239    STATS_LOCK();
240    unresolved_methods_[type]++;
241  }
242
243  // Indicate that a type of virtual method dispatch has been converted into a direct method
244  // dispatch.
245  void VirtualMadeDirect(InvokeType type) REQUIRES(!stats_lock_) {
246    DCHECK(type == kVirtual || type == kInterface || type == kSuper);
247    STATS_LOCK();
248    virtual_made_direct_[type]++;
249  }
250
251  // Indicate that a method of the given type was able to call directly into boot.
252  void DirectCallsToBoot(InvokeType type) REQUIRES(!stats_lock_) {
253    DCHECK_LE(type, kMaxInvokeType);
254    STATS_LOCK();
255    direct_calls_to_boot_[type]++;
256  }
257
258  // Indicate that a method of the given type was able to be resolved directly from boot.
259  void DirectMethodsToBoot(InvokeType type) REQUIRES(!stats_lock_) {
260    DCHECK_LE(type, kMaxInvokeType);
261    STATS_LOCK();
262    direct_methods_to_boot_[type]++;
263  }
264
265  void ProcessedInvoke(InvokeType type, int flags) REQUIRES(!stats_lock_) {
266    STATS_LOCK();
267    if (flags == 0) {
268      unresolved_methods_[type]++;
269    } else {
270      DCHECK_NE((flags & kFlagMethodResolved), 0);
271      resolved_methods_[type]++;
272      if ((flags & kFlagVirtualMadeDirect) != 0) {
273        virtual_made_direct_[type]++;
274        if ((flags & kFlagPreciseTypeDevirtualization) != 0) {
275          type_based_devirtualization_++;
276        }
277      } else {
278        DCHECK_EQ((flags & kFlagPreciseTypeDevirtualization), 0);
279      }
280      if ((flags & kFlagDirectCallToBoot) != 0) {
281        direct_calls_to_boot_[type]++;
282      }
283      if ((flags & kFlagDirectMethodToBoot) != 0) {
284        direct_methods_to_boot_[type]++;
285      }
286    }
287  }
288
289  // A check-cast could be eliminated due to verifier type analysis.
290  void SafeCast() REQUIRES(!stats_lock_) {
291    STATS_LOCK();
292    safe_casts_++;
293  }
294
295  // A check-cast couldn't be eliminated due to verifier type analysis.
296  void NotASafeCast() REQUIRES(!stats_lock_) {
297    STATS_LOCK();
298    not_safe_casts_++;
299  }
300
301 private:
302  Mutex stats_lock_;
303
304  size_t types_in_dex_cache_;
305  size_t types_not_in_dex_cache_;
306
307  size_t strings_in_dex_cache_;
308  size_t strings_not_in_dex_cache_;
309
310  size_t resolved_types_;
311  size_t unresolved_types_;
312
313  size_t resolved_instance_fields_;
314  size_t unresolved_instance_fields_;
315
316  size_t resolved_local_static_fields_;
317  size_t resolved_static_fields_;
318  size_t unresolved_static_fields_;
319  // Type based devirtualization for invoke interface and virtual.
320  size_t type_based_devirtualization_;
321
322  size_t resolved_methods_[kMaxInvokeType + 1];
323  size_t unresolved_methods_[kMaxInvokeType + 1];
324  size_t virtual_made_direct_[kMaxInvokeType + 1];
325  size_t direct_calls_to_boot_[kMaxInvokeType + 1];
326  size_t direct_methods_to_boot_[kMaxInvokeType + 1];
327
328  size_t safe_casts_;
329  size_t not_safe_casts_;
330
331  DISALLOW_COPY_AND_ASSIGN(AOTCompilationStats);
332};
333
334CompilerDriver::CompilerDriver(const CompilerOptions* compiler_options,
335                               VerificationResults* verification_results,
336                               DexFileToMethodInlinerMap* method_inliner_map,
337                               Compiler::Kind compiler_kind,
338                               InstructionSet instruction_set,
339                               const InstructionSetFeatures* instruction_set_features,
340                               bool boot_image, std::unordered_set<std::string>* image_classes,
341                               std::unordered_set<std::string>* compiled_classes,
342                               std::unordered_set<std::string>* compiled_methods,
343                               size_t thread_count, bool dump_stats, bool dump_passes,
344                               const std::string& dump_cfg_file_name, bool dump_cfg_append,
345                               CumulativeLogger* timer, int swap_fd,
346                               const std::string& profile_file)
347    : profile_present_(false),
348      compiler_options_(compiler_options),
349      verification_results_(verification_results),
350      method_inliner_map_(method_inliner_map),
351      compiler_(Compiler::Create(this, compiler_kind)),
352      compiler_kind_(compiler_kind),
353      instruction_set_(instruction_set),
354      instruction_set_features_(instruction_set_features),
355      freezing_constructor_lock_("freezing constructor lock"),
356      compiled_classes_lock_("compiled classes lock"),
357      compiled_methods_lock_("compiled method lock"),
358      compiled_methods_(MethodTable::key_compare()),
359      non_relative_linker_patch_count_(0u),
360      boot_image_(boot_image),
361      image_classes_(image_classes),
362      classes_to_compile_(compiled_classes),
363      methods_to_compile_(compiled_methods),
364      had_hard_verifier_failure_(false),
365      thread_count_(thread_count),
366      stats_(new AOTCompilationStats),
367      dump_stats_(dump_stats),
368      dump_passes_(dump_passes),
369      dump_cfg_file_name_(dump_cfg_file_name),
370      dump_cfg_append_(dump_cfg_append),
371      timings_logger_(timer),
372      compiler_context_(nullptr),
373      support_boot_image_fixup_(instruction_set != kMips && instruction_set != kMips64),
374      dex_files_for_oat_file_(nullptr),
375      compiled_method_storage_(swap_fd) {
376  DCHECK(compiler_options_ != nullptr);
377  DCHECK(verification_results_ != nullptr);
378  DCHECK(method_inliner_map_ != nullptr);
379
380  compiler_->Init();
381
382  CHECK_EQ(boot_image_, image_classes_.get() != nullptr);
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
395CompilerDriver::~CompilerDriver() {
396  Thread* self = Thread::Current();
397  {
398    MutexLock mu(self, compiled_classes_lock_);
399    STLDeleteValues(&compiled_classes_);
400  }
401  {
402    MutexLock mu(self, compiled_methods_lock_);
403    for (auto& pair : compiled_methods_) {
404      CompiledMethod::ReleaseSwapAllocatedCompiledMethod(this, pair.second);
405    }
406  }
407  compiler_->UnInit();
408}
409
410
411#define CREATE_TRAMPOLINE(type, abi, offset) \
412    if (Is64BitInstructionSet(instruction_set_)) { \
413      return CreateTrampoline64(instruction_set_, abi, \
414                                type ## _ENTRYPOINT_OFFSET(8, offset)); \
415    } else { \
416      return CreateTrampoline32(instruction_set_, abi, \
417                                type ## _ENTRYPOINT_OFFSET(4, offset)); \
418    }
419
420const std::vector<uint8_t>* CompilerDriver::CreateJniDlsymLookup() const {
421  CREATE_TRAMPOLINE(JNI, kJniAbi, pDlsymLookup)
422}
423
424const std::vector<uint8_t>* CompilerDriver::CreateQuickGenericJniTrampoline() const {
425  CREATE_TRAMPOLINE(QUICK, kQuickAbi, pQuickGenericJniTrampoline)
426}
427
428const std::vector<uint8_t>* CompilerDriver::CreateQuickImtConflictTrampoline() const {
429  CREATE_TRAMPOLINE(QUICK, kQuickAbi, pQuickImtConflictTrampoline)
430}
431
432const std::vector<uint8_t>* CompilerDriver::CreateQuickResolutionTrampoline() const {
433  CREATE_TRAMPOLINE(QUICK, kQuickAbi, pQuickResolutionTrampoline)
434}
435
436const std::vector<uint8_t>* CompilerDriver::CreateQuickToInterpreterBridge() const {
437  CREATE_TRAMPOLINE(QUICK, kQuickAbi, pQuickToInterpreterBridge)
438}
439#undef CREATE_TRAMPOLINE
440
441void CompilerDriver::CompileAll(jobject class_loader,
442                                const std::vector<const DexFile*>& dex_files,
443                                TimingLogger* timings) {
444  DCHECK(!Runtime::Current()->IsStarted());
445  std::unique_ptr<ThreadPool> thread_pool(
446      new ThreadPool("Compiler driver thread pool", thread_count_ - 1));
447  VLOG(compiler) << "Before precompile " << GetMemoryUsageString(false);
448  // Precompile:
449  // 1) Load image classes
450  // 2) Resolve all classes
451  // 3) Attempt to verify all classes
452  // 4) Attempt to initialize image classes, and trivially initialized classes
453  PreCompile(class_loader, dex_files, thread_pool.get(), timings);
454  // Compile:
455  // 1) Compile all classes and methods enabled for compilation. May fall back to dex-to-dex
456  //    compilation.
457  if (!GetCompilerOptions().VerifyAtRuntime()) {
458    Compile(class_loader, dex_files, thread_pool.get(), timings);
459  }
460  if (dump_stats_) {
461    stats_->Dump();
462  }
463}
464
465static optimizer::DexToDexCompilationLevel GetDexToDexCompilationLevel(
466    Thread* self, const CompilerDriver& driver, Handle<mirror::ClassLoader> class_loader,
467    const DexFile& dex_file, const DexFile::ClassDef& class_def)
468    SHARED_REQUIRES(Locks::mutator_lock_) {
469  auto* const runtime = Runtime::Current();
470  if (runtime->UseJit() || driver.GetCompilerOptions().VerifyAtRuntime()) {
471    // Verify at runtime shouldn't dex to dex since we didn't resolve of verify.
472    return optimizer::DexToDexCompilationLevel::kDontDexToDexCompile;
473  }
474  const char* descriptor = dex_file.GetClassDescriptor(class_def);
475  ClassLinker* class_linker = runtime->GetClassLinker();
476  mirror::Class* klass = class_linker->FindClass(self, descriptor, class_loader);
477  if (klass == nullptr) {
478    CHECK(self->IsExceptionPending());
479    self->ClearException();
480    return optimizer::DexToDexCompilationLevel::kDontDexToDexCompile;
481  }
482  // DexToDex at the kOptimize level may introduce quickened opcodes, which replace symbolic
483  // references with actual offsets. We cannot re-verify such instructions.
484  //
485  // We store the verification information in the class status in the oat file, which the linker
486  // can validate (checksums) and use to skip load-time verification. It is thus safe to
487  // optimize when a class has been fully verified before.
488  if (klass->IsVerified()) {
489    // Class is verified so we can enable DEX-to-DEX compilation for performance.
490    return optimizer::DexToDexCompilationLevel::kOptimize;
491  } else if (klass->IsCompileTimeVerified()) {
492    // Class verification has soft-failed. Anyway, ensure at least correctness.
493    DCHECK_EQ(klass->GetStatus(), mirror::Class::kStatusRetryVerificationAtRuntime);
494    return optimizer::DexToDexCompilationLevel::kRequired;
495  } else {
496    // Class verification has failed: do not run DEX-to-DEX compilation.
497    return optimizer::DexToDexCompilationLevel::kDontDexToDexCompile;
498  }
499}
500
501static optimizer::DexToDexCompilationLevel GetDexToDexCompilationLevel(
502    Thread* self,
503    const CompilerDriver& driver,
504    jobject jclass_loader,
505    const DexFile& dex_file,
506    const DexFile::ClassDef& class_def) {
507  ScopedObjectAccess soa(self);
508  StackHandleScope<1> hs(soa.Self());
509  Handle<mirror::ClassLoader> class_loader(
510      hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
511  return GetDexToDexCompilationLevel(self, driver, class_loader, dex_file, class_def);
512}
513
514// Does the runtime for the InstructionSet provide an implementation returned by
515// GetQuickGenericJniStub allowing down calls that aren't compiled using a JNI compiler?
516static bool InstructionSetHasGenericJniStub(InstructionSet isa) {
517  switch (isa) {
518    case kArm:
519    case kArm64:
520    case kThumb2:
521    case kMips:
522    case kMips64:
523    case kX86:
524    case kX86_64: return true;
525    default: return false;
526  }
527}
528
529static void CompileMethod(Thread* self,
530                          CompilerDriver* driver,
531                          const DexFile::CodeItem* code_item,
532                          uint32_t access_flags,
533                          InvokeType invoke_type,
534                          uint16_t class_def_idx,
535                          uint32_t method_idx,
536                          jobject class_loader,
537                          const DexFile& dex_file,
538                          optimizer::DexToDexCompilationLevel dex_to_dex_compilation_level,
539                          bool compilation_enabled,
540                          Handle<mirror::DexCache> dex_cache)
541    REQUIRES(!driver->compiled_methods_lock_) {
542  DCHECK(driver != nullptr);
543  CompiledMethod* compiled_method = nullptr;
544  uint64_t start_ns = kTimeCompileMethod ? NanoTime() : 0;
545  MethodReference method_ref(&dex_file, method_idx);
546
547  if ((access_flags & kAccNative) != 0) {
548    // Are we interpreting only and have support for generic JNI down calls?
549    if (!driver->GetCompilerOptions().IsCompilationEnabled() &&
550        InstructionSetHasGenericJniStub(driver->GetInstructionSet())) {
551      // Leaving this empty will trigger the generic JNI version
552    } else {
553      compiled_method = driver->GetCompiler()->JniCompile(access_flags, method_idx, dex_file);
554      CHECK(compiled_method != nullptr);
555    }
556  } else if ((access_flags & kAccAbstract) != 0) {
557    // Abstract methods don't have code.
558  } else {
559    const VerifiedMethod* verified_method =
560        driver->GetVerificationResults()->GetVerifiedMethod(method_ref);
561    bool compile = compilation_enabled &&
562        // Basic checks, e.g., not <clinit>.
563        driver->GetVerificationResults()
564            ->IsCandidateForCompilation(method_ref, access_flags) &&
565        // Did not fail to create VerifiedMethod metadata.
566        verified_method != nullptr &&
567        // Do not have failures that should punt to the interpreter.
568        !verified_method->HasRuntimeThrow() &&
569        (verified_method->GetEncounteredVerificationFailures() &
570            (verifier::VERIFY_ERROR_FORCE_INTERPRETER | verifier::VERIFY_ERROR_LOCKING)) == 0 &&
571        // Is eligable for compilation by methods-to-compile filter.
572        driver->IsMethodToCompile(method_ref);
573    if (compile) {
574      // NOTE: if compiler declines to compile this method, it will return null.
575      compiled_method = driver->GetCompiler()->Compile(code_item, access_flags, invoke_type,
576                                                       class_def_idx, method_idx, class_loader,
577                                                       dex_file, dex_cache);
578    }
579    if (compiled_method == nullptr &&
580        dex_to_dex_compilation_level != optimizer::DexToDexCompilationLevel::kDontDexToDexCompile) {
581      // TODO: add a command-line option to disable DEX-to-DEX compilation ?
582      // Do not optimize if a VerifiedMethod is missing. SafeCast elision, for example, relies on
583      // it.
584      compiled_method = optimizer::ArtCompileDEX(
585          driver,
586          code_item,
587          access_flags,
588          invoke_type,
589          class_def_idx,
590          method_idx,
591          class_loader,
592          dex_file,
593          (verified_method != nullptr)
594              ? dex_to_dex_compilation_level
595              : optimizer::DexToDexCompilationLevel::kRequired);
596    }
597  }
598  if (kTimeCompileMethod) {
599    uint64_t duration_ns = NanoTime() - start_ns;
600    if (duration_ns > MsToNs(driver->GetCompiler()->GetMaximumCompilationTimeBeforeWarning())) {
601      LOG(WARNING) << "Compilation of " << PrettyMethod(method_idx, dex_file)
602                   << " took " << PrettyDuration(duration_ns);
603    }
604  }
605
606  if (compiled_method != nullptr) {
607    // Count non-relative linker patches.
608    size_t non_relative_linker_patch_count = 0u;
609    for (const LinkerPatch& patch : compiled_method->GetPatches()) {
610      if (!patch.IsPcRelative()) {
611        ++non_relative_linker_patch_count;
612      }
613    }
614    bool compile_pic = driver->GetCompilerOptions().GetCompilePic();  // Off by default
615    // When compiling with PIC, there should be zero non-relative linker patches
616    CHECK(!compile_pic || non_relative_linker_patch_count == 0u);
617
618    driver->AddCompiledMethod(method_ref, compiled_method, non_relative_linker_patch_count);
619  }
620
621  // Done compiling, delete the verified method to reduce native memory usage. Do not delete in
622  // optimizing compiler, which may need the verified method again for inlining.
623  if (driver->GetCompilerKind() != Compiler::kOptimizing) {
624    driver->GetVerificationResults()->RemoveVerifiedMethod(method_ref);
625  }
626
627  if (self->IsExceptionPending()) {
628    ScopedObjectAccess soa(self);
629    LOG(FATAL) << "Unexpected exception compiling: " << PrettyMethod(method_idx, dex_file) << "\n"
630        << self->GetException()->Dump();
631  }
632}
633
634void CompilerDriver::CompileOne(Thread* self, ArtMethod* method, TimingLogger* timings) {
635  DCHECK(!Runtime::Current()->IsStarted());
636  jobject jclass_loader;
637  const DexFile* dex_file;
638  uint16_t class_def_idx;
639  uint32_t method_idx = method->GetDexMethodIndex();
640  uint32_t access_flags = method->GetAccessFlags();
641  InvokeType invoke_type = method->GetInvokeType();
642  StackHandleScope<1> hs(self);
643  Handle<mirror::DexCache> dex_cache(hs.NewHandle(method->GetDexCache()));
644  {
645    ScopedObjectAccessUnchecked soa(self);
646    ScopedLocalRef<jobject> local_class_loader(
647        soa.Env(), soa.AddLocalReference<jobject>(method->GetDeclaringClass()->GetClassLoader()));
648    jclass_loader = soa.Env()->NewGlobalRef(local_class_loader.get());
649    // Find the dex_file
650    dex_file = method->GetDexFile();
651    class_def_idx = method->GetClassDefIndex();
652  }
653  const DexFile::CodeItem* code_item = dex_file->GetCodeItem(method->GetCodeItemOffset());
654
655  // Go to native so that we don't block GC during compilation.
656  ScopedThreadSuspension sts(self, kNative);
657
658  std::vector<const DexFile*> dex_files;
659  dex_files.push_back(dex_file);
660
661  std::unique_ptr<ThreadPool> thread_pool(new ThreadPool("Compiler driver thread pool", 0U));
662  PreCompile(jclass_loader, dex_files, thread_pool.get(), timings);
663
664  // Can we run DEX-to-DEX compiler on this class ?
665  optimizer::DexToDexCompilationLevel dex_to_dex_compilation_level =
666      GetDexToDexCompilationLevel(self,
667                                  *this,
668                                  jclass_loader,
669                                  *dex_file,
670                                  dex_file->GetClassDef(class_def_idx));
671
672  CompileMethod(self,
673                this,
674                code_item,
675                access_flags,
676                invoke_type,
677                class_def_idx,
678                method_idx,
679                jclass_loader,
680                *dex_file,
681                dex_to_dex_compilation_level,
682                true,
683                dex_cache);
684
685  self->GetJniEnv()->DeleteGlobalRef(jclass_loader);
686}
687
688void CompilerDriver::Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files,
689                             ThreadPool* thread_pool, TimingLogger* timings) {
690  for (size_t i = 0; i != dex_files.size(); ++i) {
691    const DexFile* dex_file = dex_files[i];
692    CHECK(dex_file != nullptr);
693    ResolveDexFile(class_loader, *dex_file, dex_files, thread_pool, timings);
694  }
695}
696
697void CompilerDriver::PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
698                                ThreadPool* thread_pool, TimingLogger* timings) {
699  LoadImageClasses(timings);
700  VLOG(compiler) << "LoadImageClasses: " << GetMemoryUsageString(false);
701
702  const bool verification_enabled = compiler_options_->IsVerificationEnabled();
703  const bool never_verify = compiler_options_->NeverVerify();
704
705  // We need to resolve for never_verify since it needs to run dex to dex to add the
706  // RETURN_VOID_NO_BARRIER.
707  if (never_verify || verification_enabled) {
708    Resolve(class_loader, dex_files, thread_pool, timings);
709    VLOG(compiler) << "Resolve: " << GetMemoryUsageString(false);
710  }
711
712  if (never_verify) {
713    VLOG(compiler) << "Verify none mode specified, skipping verification.";
714    SetVerified(class_loader, dex_files, thread_pool, timings);
715  }
716
717  if (!verification_enabled) {
718    return;
719  }
720
721  Verify(class_loader, dex_files, thread_pool, timings);
722  VLOG(compiler) << "Verify: " << GetMemoryUsageString(false);
723
724  if (had_hard_verifier_failure_ && GetCompilerOptions().AbortOnHardVerifierFailure()) {
725    LOG(FATAL) << "Had a hard failure verifying all classes, and was asked to abort in such "
726               << "situations. Please check the log.";
727  }
728
729  InitializeClasses(class_loader, dex_files, thread_pool, timings);
730  VLOG(compiler) << "InitializeClasses: " << GetMemoryUsageString(false);
731
732  UpdateImageClasses(timings);
733  VLOG(compiler) << "UpdateImageClasses: " << GetMemoryUsageString(false);
734}
735
736bool CompilerDriver::IsImageClass(const char* descriptor) const {
737  if (!IsBootImage()) {
738    // NOTE: Currently unreachable, all callers check IsImage().
739    return false;
740  } else {
741    return image_classes_->find(descriptor) != image_classes_->end();
742  }
743}
744
745bool CompilerDriver::IsClassToCompile(const char* descriptor) const {
746  if (kRestrictCompilationFiltersToImage && !IsBootImage()) {
747    return true;
748  }
749
750  if (classes_to_compile_ == nullptr) {
751    return true;
752  }
753  return classes_to_compile_->find(descriptor) != classes_to_compile_->end();
754}
755
756bool CompilerDriver::IsMethodToCompile(const MethodReference& method_ref) const {
757  if (kRestrictCompilationFiltersToImage && !IsBootImage()) {
758    return true;
759  }
760
761  if (methods_to_compile_ == nullptr) {
762    return true;
763  }
764
765  std::string tmp = PrettyMethod(method_ref.dex_method_index, *method_ref.dex_file, true);
766  return methods_to_compile_->find(tmp.c_str()) != methods_to_compile_->end();
767}
768
769class ResolveCatchBlockExceptionsClassVisitor : public ClassVisitor {
770 public:
771  ResolveCatchBlockExceptionsClassVisitor(
772      std::set<std::pair<uint16_t, const DexFile*>>& exceptions_to_resolve)
773     : exceptions_to_resolve_(exceptions_to_resolve) {}
774
775  virtual bool Visit(mirror::Class* c) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
776    const auto pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
777    for (auto& m : c->GetVirtualMethods(pointer_size)) {
778      ResolveExceptionsForMethod(&m, pointer_size);
779    }
780    for (auto& m : c->GetDirectMethods(pointer_size)) {
781      ResolveExceptionsForMethod(&m, pointer_size);
782    }
783    return true;
784  }
785
786 private:
787  void ResolveExceptionsForMethod(ArtMethod* method_handle, size_t pointer_size)
788      SHARED_REQUIRES(Locks::mutator_lock_) {
789    const DexFile::CodeItem* code_item = method_handle->GetCodeItem();
790    if (code_item == nullptr) {
791      return;  // native or abstract method
792    }
793    if (code_item->tries_size_ == 0) {
794      return;  // nothing to process
795    }
796    const uint8_t* encoded_catch_handler_list = DexFile::GetCatchHandlerData(*code_item, 0);
797    size_t num_encoded_catch_handlers = DecodeUnsignedLeb128(&encoded_catch_handler_list);
798    for (size_t i = 0; i < num_encoded_catch_handlers; i++) {
799      int32_t encoded_catch_handler_size = DecodeSignedLeb128(&encoded_catch_handler_list);
800      bool has_catch_all = false;
801      if (encoded_catch_handler_size <= 0) {
802        encoded_catch_handler_size = -encoded_catch_handler_size;
803        has_catch_all = true;
804      }
805      for (int32_t j = 0; j < encoded_catch_handler_size; j++) {
806        uint16_t encoded_catch_handler_handlers_type_idx =
807            DecodeUnsignedLeb128(&encoded_catch_handler_list);
808        // Add to set of types to resolve if not already in the dex cache resolved types
809        if (!method_handle->IsResolvedTypeIdx(encoded_catch_handler_handlers_type_idx,
810                                              pointer_size)) {
811          exceptions_to_resolve_.emplace(encoded_catch_handler_handlers_type_idx,
812                                         method_handle->GetDexFile());
813        }
814        // ignore address associated with catch handler
815        DecodeUnsignedLeb128(&encoded_catch_handler_list);
816      }
817      if (has_catch_all) {
818        // ignore catch all address
819        DecodeUnsignedLeb128(&encoded_catch_handler_list);
820      }
821    }
822  }
823
824  std::set<std::pair<uint16_t, const DexFile*>>& exceptions_to_resolve_;
825};
826
827class RecordImageClassesVisitor : public ClassVisitor {
828 public:
829  explicit RecordImageClassesVisitor(std::unordered_set<std::string>* image_classes)
830      : image_classes_(image_classes) {}
831
832  bool Visit(mirror::Class* klass) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
833    std::string temp;
834    image_classes_->insert(klass->GetDescriptor(&temp));
835    return true;
836  }
837
838 private:
839  std::unordered_set<std::string>* const image_classes_;
840};
841
842// Make a list of descriptors for classes to include in the image
843void CompilerDriver::LoadImageClasses(TimingLogger* timings) {
844  CHECK(timings != nullptr);
845  if (!IsBootImage()) {
846    return;
847  }
848
849  TimingLogger::ScopedTiming t("LoadImageClasses", timings);
850  // Make a first class to load all classes explicitly listed in the file
851  Thread* self = Thread::Current();
852  ScopedObjectAccess soa(self);
853  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
854  CHECK(image_classes_.get() != nullptr);
855  for (auto it = image_classes_->begin(), end = image_classes_->end(); it != end;) {
856    const std::string& descriptor(*it);
857    StackHandleScope<1> hs(self);
858    Handle<mirror::Class> klass(
859        hs.NewHandle(class_linker->FindSystemClass(self, descriptor.c_str())));
860    if (klass.Get() == nullptr) {
861      VLOG(compiler) << "Failed to find class " << descriptor;
862      image_classes_->erase(it++);
863      self->ClearException();
864    } else {
865      ++it;
866    }
867  }
868
869  // Resolve exception classes referenced by the loaded classes. The catch logic assumes
870  // exceptions are resolved by the verifier when there is a catch block in an interested method.
871  // Do this here so that exception classes appear to have been specified image classes.
872  std::set<std::pair<uint16_t, const DexFile*>> unresolved_exception_types;
873  StackHandleScope<1> hs(self);
874  Handle<mirror::Class> java_lang_Throwable(
875      hs.NewHandle(class_linker->FindSystemClass(self, "Ljava/lang/Throwable;")));
876  do {
877    unresolved_exception_types.clear();
878    ResolveCatchBlockExceptionsClassVisitor visitor(unresolved_exception_types);
879    class_linker->VisitClasses(&visitor);
880    for (const std::pair<uint16_t, const DexFile*>& exception_type : unresolved_exception_types) {
881      uint16_t exception_type_idx = exception_type.first;
882      const DexFile* dex_file = exception_type.second;
883      StackHandleScope<2> hs2(self);
884      Handle<mirror::DexCache> dex_cache(hs2.NewHandle(class_linker->RegisterDexFile(
885          *dex_file,
886          Runtime::Current()->GetLinearAlloc())));
887      Handle<mirror::Class> klass(hs2.NewHandle(
888          class_linker->ResolveType(*dex_file, exception_type_idx, dex_cache,
889                                    NullHandle<mirror::ClassLoader>())));
890      if (klass.Get() == nullptr) {
891        const DexFile::TypeId& type_id = dex_file->GetTypeId(exception_type_idx);
892        const char* descriptor = dex_file->GetTypeDescriptor(type_id);
893        LOG(FATAL) << "Failed to resolve class " << descriptor;
894      }
895      DCHECK(java_lang_Throwable->IsAssignableFrom(klass.Get()));
896    }
897    // Resolving exceptions may load classes that reference more exceptions, iterate until no
898    // more are found
899  } while (!unresolved_exception_types.empty());
900
901  // We walk the roots looking for classes so that we'll pick up the
902  // above classes plus any classes them depend on such super
903  // classes, interfaces, and the required ClassLinker roots.
904  RecordImageClassesVisitor visitor(image_classes_.get());
905  class_linker->VisitClasses(&visitor);
906
907  CHECK_NE(image_classes_->size(), 0U);
908}
909
910static void MaybeAddToImageClasses(Handle<mirror::Class> c,
911                                   std::unordered_set<std::string>* image_classes)
912    SHARED_REQUIRES(Locks::mutator_lock_) {
913  Thread* self = Thread::Current();
914  StackHandleScope<1> hs(self);
915  // Make a copy of the handle so that we don't clobber it doing Assign.
916  MutableHandle<mirror::Class> klass(hs.NewHandle(c.Get()));
917  std::string temp;
918  const size_t pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
919  while (!klass->IsObjectClass()) {
920    const char* descriptor = klass->GetDescriptor(&temp);
921    std::pair<std::unordered_set<std::string>::iterator, bool> result =
922        image_classes->insert(descriptor);
923    if (!result.second) {  // Previously inserted.
924      break;
925    }
926    VLOG(compiler) << "Adding " << descriptor << " to image classes";
927    for (size_t i = 0; i < klass->NumDirectInterfaces(); ++i) {
928      StackHandleScope<1> hs2(self);
929      MaybeAddToImageClasses(hs2.NewHandle(mirror::Class::GetDirectInterface(self, klass, i)),
930                             image_classes);
931    }
932    for (auto& m : c->GetVirtualMethods(pointer_size)) {
933      if (m.IsMiranda() || (true)) {
934        StackHandleScope<1> hs2(self);
935        MaybeAddToImageClasses(hs2.NewHandle(m.GetDeclaringClass()), image_classes);
936      }
937    }
938    if (klass->IsArrayClass()) {
939      StackHandleScope<1> hs2(self);
940      MaybeAddToImageClasses(hs2.NewHandle(klass->GetComponentType()), image_classes);
941    }
942    klass.Assign(klass->GetSuperClass());
943  }
944}
945
946// Keeps all the data for the update together. Also doubles as the reference visitor.
947// Note: we can use object pointers because we suspend all threads.
948class ClinitImageUpdate {
949 public:
950  static ClinitImageUpdate* Create(std::unordered_set<std::string>* image_class_descriptors,
951                                   Thread* self, ClassLinker* linker, std::string* error_msg) {
952    std::unique_ptr<ClinitImageUpdate> res(new ClinitImageUpdate(image_class_descriptors, self,
953                                                                 linker));
954    if (res->dex_cache_class_ == nullptr) {
955      *error_msg = "Could not find DexCache class.";
956      return nullptr;
957    }
958
959    return res.release();
960  }
961
962  ~ClinitImageUpdate() {
963    // Allow others to suspend again.
964    self_->EndAssertNoThreadSuspension(old_cause_);
965  }
966
967  // Visitor for VisitReferences.
968  void operator()(mirror::Object* object, MemberOffset field_offset, bool /* is_static */) const
969      SHARED_REQUIRES(Locks::mutator_lock_) {
970    mirror::Object* ref = object->GetFieldObject<mirror::Object>(field_offset);
971    if (ref != nullptr) {
972      VisitClinitClassesObject(ref);
973    }
974  }
975
976  // java.lang.Reference visitor for VisitReferences.
977  void operator()(mirror::Class* klass ATTRIBUTE_UNUSED, mirror::Reference* ref ATTRIBUTE_UNUSED)
978      const {}
979
980  // Ignore class native roots.
981  void VisitRootIfNonNull(mirror::CompressedReference<mirror::Object>* root ATTRIBUTE_UNUSED)
982      const {}
983  void VisitRoot(mirror::CompressedReference<mirror::Object>* root ATTRIBUTE_UNUSED) const {}
984
985  void Walk() SHARED_REQUIRES(Locks::mutator_lock_) {
986    // Use the initial classes as roots for a search.
987    for (mirror::Class* klass_root : image_classes_) {
988      VisitClinitClassesObject(klass_root);
989    }
990  }
991
992 private:
993  class FindImageClassesVisitor : public ClassVisitor {
994   public:
995    explicit FindImageClassesVisitor(ClinitImageUpdate* data) : data_(data) {}
996
997    bool Visit(mirror::Class* klass) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
998      std::string temp;
999      const char* name = klass->GetDescriptor(&temp);
1000      if (data_->image_class_descriptors_->find(name) != data_->image_class_descriptors_->end()) {
1001        data_->image_classes_.push_back(klass);
1002      } else {
1003        // Check whether it is initialized and has a clinit. They must be kept, too.
1004        if (klass->IsInitialized() && klass->FindClassInitializer(
1005            Runtime::Current()->GetClassLinker()->GetImagePointerSize()) != nullptr) {
1006          data_->image_classes_.push_back(klass);
1007        }
1008      }
1009      return true;
1010    }
1011
1012   private:
1013    ClinitImageUpdate* const data_;
1014  };
1015
1016  ClinitImageUpdate(std::unordered_set<std::string>* image_class_descriptors, Thread* self,
1017                    ClassLinker* linker)
1018      SHARED_REQUIRES(Locks::mutator_lock_) :
1019      image_class_descriptors_(image_class_descriptors), self_(self) {
1020    CHECK(linker != nullptr);
1021    CHECK(image_class_descriptors != nullptr);
1022
1023    // Make sure nobody interferes with us.
1024    old_cause_ = self->StartAssertNoThreadSuspension("Boot image closure");
1025
1026    // Find the interesting classes.
1027    dex_cache_class_ = linker->LookupClass(self, "Ljava/lang/DexCache;",
1028        ComputeModifiedUtf8Hash("Ljava/lang/DexCache;"), nullptr);
1029
1030    // Find all the already-marked classes.
1031    WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
1032    FindImageClassesVisitor visitor(this);
1033    linker->VisitClasses(&visitor);
1034  }
1035
1036  void VisitClinitClassesObject(mirror::Object* object) const
1037      SHARED_REQUIRES(Locks::mutator_lock_) {
1038    DCHECK(object != nullptr);
1039    if (marked_objects_.find(object) != marked_objects_.end()) {
1040      // Already processed.
1041      return;
1042    }
1043
1044    // Mark it.
1045    marked_objects_.insert(object);
1046
1047    if (object->IsClass()) {
1048      // If it is a class, add it.
1049      StackHandleScope<1> hs(self_);
1050      MaybeAddToImageClasses(hs.NewHandle(object->AsClass()), image_class_descriptors_);
1051    } else {
1052      // Else visit the object's class.
1053      VisitClinitClassesObject(object->GetClass());
1054    }
1055
1056    // If it is not a DexCache, visit all references.
1057    mirror::Class* klass = object->GetClass();
1058    if (klass != dex_cache_class_) {
1059      object->VisitReferences(*this, *this);
1060    }
1061  }
1062
1063  mutable std::unordered_set<mirror::Object*> marked_objects_;
1064  std::unordered_set<std::string>* const image_class_descriptors_;
1065  std::vector<mirror::Class*> image_classes_;
1066  const mirror::Class* dex_cache_class_;
1067  Thread* const self_;
1068  const char* old_cause_;
1069
1070  DISALLOW_COPY_AND_ASSIGN(ClinitImageUpdate);
1071};
1072
1073void CompilerDriver::UpdateImageClasses(TimingLogger* timings) {
1074  if (IsBootImage()) {
1075    TimingLogger::ScopedTiming t("UpdateImageClasses", timings);
1076
1077    Runtime* runtime = Runtime::Current();
1078
1079    // Suspend all threads.
1080    ScopedSuspendAll ssa(__FUNCTION__);
1081
1082    std::string error_msg;
1083    std::unique_ptr<ClinitImageUpdate> update(ClinitImageUpdate::Create(image_classes_.get(),
1084                                                                        Thread::Current(),
1085                                                                        runtime->GetClassLinker(),
1086                                                                        &error_msg));
1087    CHECK(update.get() != nullptr) << error_msg;  // TODO: Soft failure?
1088
1089    // Do the marking.
1090    update->Walk();
1091  }
1092}
1093
1094bool CompilerDriver::CanAssumeClassIsLoaded(mirror::Class* klass) {
1095  Runtime* runtime = Runtime::Current();
1096  if (!runtime->IsAotCompiler()) {
1097    DCHECK(runtime->UseJit());
1098    // Having the klass reference here implies that the klass is already loaded.
1099    return true;
1100  }
1101  if (!IsBootImage()) {
1102    // Assume loaded only if klass is in the boot image. App classes cannot be assumed
1103    // loaded because we don't even know what class loader will be used to load them.
1104    bool class_in_image = runtime->GetHeap()->FindSpaceFromObject(klass, false)->IsImageSpace();
1105    return class_in_image;
1106  }
1107  std::string temp;
1108  const char* descriptor = klass->GetDescriptor(&temp);
1109  return IsImageClass(descriptor);
1110}
1111
1112bool CompilerDriver::CanAssumeTypeIsPresentInDexCache(const DexFile& dex_file, uint32_t type_idx) {
1113  bool result = false;
1114  if ((IsBootImage() &&
1115       IsImageClass(dex_file.StringDataByIdx(dex_file.GetTypeId(type_idx).descriptor_idx_))) ||
1116      Runtime::Current()->UseJit()) {
1117    ScopedObjectAccess soa(Thread::Current());
1118    mirror::DexCache* dex_cache = Runtime::Current()->GetClassLinker()->FindDexCache(
1119        soa.Self(), dex_file, false);
1120    mirror::Class* resolved_class = dex_cache->GetResolvedType(type_idx);
1121    result = (resolved_class != nullptr);
1122  }
1123
1124  if (result) {
1125    stats_->TypeInDexCache();
1126  } else {
1127    stats_->TypeNotInDexCache();
1128  }
1129  return result;
1130}
1131
1132bool CompilerDriver::CanAssumeStringIsPresentInDexCache(const DexFile& dex_file,
1133                                                        uint32_t string_idx) {
1134  // See also Compiler::ResolveDexFile
1135
1136  bool result = false;
1137  if (IsBootImage()) {
1138    // We resolve all const-string strings when building for the image.
1139    ScopedObjectAccess soa(Thread::Current());
1140    StackHandleScope<1> hs(soa.Self());
1141    ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1142    Handle<mirror::DexCache> dex_cache(hs.NewHandle(class_linker->FindDexCache(
1143        soa.Self(), dex_file, false)));
1144    class_linker->ResolveString(dex_file, string_idx, dex_cache);
1145    result = true;
1146  }
1147  if (result) {
1148    stats_->StringInDexCache();
1149  } else {
1150    stats_->StringNotInDexCache();
1151  }
1152  return result;
1153}
1154
1155bool CompilerDriver::CanAccessTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
1156                                                uint32_t type_idx,
1157                                                bool* type_known_final, bool* type_known_abstract,
1158                                                bool* equals_referrers_class) {
1159  if (type_known_final != nullptr) {
1160    *type_known_final = false;
1161  }
1162  if (type_known_abstract != nullptr) {
1163    *type_known_abstract = false;
1164  }
1165  if (equals_referrers_class != nullptr) {
1166    *equals_referrers_class = false;
1167  }
1168  ScopedObjectAccess soa(Thread::Current());
1169  mirror::DexCache* dex_cache = Runtime::Current()->GetClassLinker()->FindDexCache(
1170      soa.Self(), dex_file, false);
1171  // Get type from dex cache assuming it was populated by the verifier
1172  mirror::Class* resolved_class = dex_cache->GetResolvedType(type_idx);
1173  if (resolved_class == nullptr) {
1174    stats_->TypeNeedsAccessCheck();
1175    return false;  // Unknown class needs access checks.
1176  }
1177  const DexFile::MethodId& method_id = dex_file.GetMethodId(referrer_idx);
1178  if (equals_referrers_class != nullptr) {
1179    *equals_referrers_class = (method_id.class_idx_ == type_idx);
1180  }
1181  mirror::Class* referrer_class = dex_cache->GetResolvedType(method_id.class_idx_);
1182  if (referrer_class == nullptr) {
1183    stats_->TypeNeedsAccessCheck();
1184    return false;  // Incomplete referrer knowledge needs access check.
1185  }
1186  // Perform access check, will return true if access is ok or false if we're going to have to
1187  // check this at runtime (for example for class loaders).
1188  bool result = referrer_class->CanAccess(resolved_class);
1189  if (result) {
1190    stats_->TypeDoesntNeedAccessCheck();
1191    if (type_known_final != nullptr) {
1192      *type_known_final = resolved_class->IsFinal() && !resolved_class->IsArrayClass();
1193    }
1194    if (type_known_abstract != nullptr) {
1195      *type_known_abstract = resolved_class->IsAbstract() && !resolved_class->IsArrayClass();
1196    }
1197  } else {
1198    stats_->TypeNeedsAccessCheck();
1199  }
1200  return result;
1201}
1202
1203bool CompilerDriver::CanAccessInstantiableTypeWithoutChecks(uint32_t referrer_idx,
1204                                                            const DexFile& dex_file,
1205                                                            uint32_t type_idx,
1206                                                            bool* finalizable) {
1207  ScopedObjectAccess soa(Thread::Current());
1208  mirror::DexCache* dex_cache = Runtime::Current()->GetClassLinker()->FindDexCache(
1209      soa.Self(), dex_file, false);
1210  // Get type from dex cache assuming it was populated by the verifier.
1211  mirror::Class* resolved_class = dex_cache->GetResolvedType(type_idx);
1212  if (resolved_class == nullptr) {
1213    stats_->TypeNeedsAccessCheck();
1214    // Be conservative.
1215    *finalizable = true;
1216    return false;  // Unknown class needs access checks.
1217  }
1218  *finalizable = resolved_class->IsFinalizable();
1219  const DexFile::MethodId& method_id = dex_file.GetMethodId(referrer_idx);
1220  mirror::Class* referrer_class = dex_cache->GetResolvedType(method_id.class_idx_);
1221  if (referrer_class == nullptr) {
1222    stats_->TypeNeedsAccessCheck();
1223    return false;  // Incomplete referrer knowledge needs access check.
1224  }
1225  // Perform access and instantiable checks, will return true if access is ok or false if we're
1226  // going to have to check this at runtime (for example for class loaders).
1227  bool result = referrer_class->CanAccess(resolved_class) && resolved_class->IsInstantiable();
1228  if (result) {
1229    stats_->TypeDoesntNeedAccessCheck();
1230  } else {
1231    stats_->TypeNeedsAccessCheck();
1232  }
1233  return result;
1234}
1235
1236bool CompilerDriver::CanEmbedTypeInCode(const DexFile& dex_file, uint32_t type_idx,
1237                                        bool* is_type_initialized, bool* use_direct_type_ptr,
1238                                        uintptr_t* direct_type_ptr, bool* out_is_finalizable) {
1239  ScopedObjectAccess soa(Thread::Current());
1240  Runtime* runtime = Runtime::Current();
1241  mirror::DexCache* dex_cache = runtime->GetClassLinker()->FindDexCache(
1242      soa.Self(), dex_file, false);
1243  mirror::Class* resolved_class = dex_cache->GetResolvedType(type_idx);
1244  if (resolved_class == nullptr) {
1245    return false;
1246  }
1247  if (GetCompilerOptions().GetCompilePic()) {
1248    // Do not allow a direct class pointer to be used when compiling for position-independent
1249    return false;
1250  }
1251  *out_is_finalizable = resolved_class->IsFinalizable();
1252  gc::Heap* heap = runtime->GetHeap();
1253  const bool compiling_boot = heap->IsCompilingBoot();
1254  const bool support_boot_image_fixup = GetSupportBootImageFixup();
1255  if (compiling_boot) {
1256    // boot -> boot class pointers.
1257    // True if the class is in the image at boot compiling time.
1258    const bool is_image_class = IsBootImage() && IsImageClass(
1259        dex_file.StringDataByIdx(dex_file.GetTypeId(type_idx).descriptor_idx_));
1260    // True if pc relative load works.
1261    if (is_image_class && support_boot_image_fixup) {
1262      *is_type_initialized = resolved_class->IsInitialized();
1263      *use_direct_type_ptr = false;
1264      *direct_type_ptr = 0;
1265      return true;
1266    } else {
1267      return false;
1268    }
1269  } else if (runtime->UseJit() && !heap->IsMovableObject(resolved_class)) {
1270    *is_type_initialized = resolved_class->IsInitialized();
1271    // If the class may move around, then don't embed it as a direct pointer.
1272    *use_direct_type_ptr = true;
1273    *direct_type_ptr = reinterpret_cast<uintptr_t>(resolved_class);
1274    return true;
1275  } else {
1276    // True if the class is in the image at app compiling time.
1277    const bool class_in_image = heap->FindSpaceFromObject(resolved_class, false)->IsImageSpace();
1278    if (class_in_image && support_boot_image_fixup) {
1279      // boot -> app class pointers.
1280      *is_type_initialized = resolved_class->IsInitialized();
1281      // TODO This is somewhat hacky. We should refactor all of this invoke codepath.
1282      *use_direct_type_ptr = !GetCompilerOptions().GetIncludePatchInformation();
1283      *direct_type_ptr = reinterpret_cast<uintptr_t>(resolved_class);
1284      return true;
1285    } else {
1286      // app -> app class pointers.
1287      // Give up because app does not have an image and class
1288      // isn't created at compile time.  TODO: implement this
1289      // if/when each app gets an image.
1290      return false;
1291    }
1292  }
1293}
1294
1295bool CompilerDriver::CanEmbedReferenceTypeInCode(ClassReference* ref,
1296                                                 bool* use_direct_ptr,
1297                                                 uintptr_t* direct_type_ptr) {
1298  CHECK(ref != nullptr);
1299  CHECK(use_direct_ptr != nullptr);
1300  CHECK(direct_type_ptr != nullptr);
1301
1302  ScopedObjectAccess soa(Thread::Current());
1303  mirror::Class* reference_class = mirror::Reference::GetJavaLangRefReference();
1304  bool is_initialized = false;
1305  bool unused_finalizable;
1306  // Make sure we have a finished Reference class object before attempting to use it.
1307  if (!CanEmbedTypeInCode(*reference_class->GetDexCache()->GetDexFile(),
1308                          reference_class->GetDexTypeIndex(), &is_initialized,
1309                          use_direct_ptr, direct_type_ptr, &unused_finalizable) ||
1310      !is_initialized) {
1311    return false;
1312  }
1313  ref->first = &reference_class->GetDexFile();
1314  ref->second = reference_class->GetDexClassDefIndex();
1315  return true;
1316}
1317
1318uint32_t CompilerDriver::GetReferenceSlowFlagOffset() const {
1319  ScopedObjectAccess soa(Thread::Current());
1320  mirror::Class* klass = mirror::Reference::GetJavaLangRefReference();
1321  DCHECK(klass->IsInitialized());
1322  return klass->GetSlowPathFlagOffset().Uint32Value();
1323}
1324
1325uint32_t CompilerDriver::GetReferenceDisableFlagOffset() const {
1326  ScopedObjectAccess soa(Thread::Current());
1327  mirror::Class* klass = mirror::Reference::GetJavaLangRefReference();
1328  DCHECK(klass->IsInitialized());
1329  return klass->GetDisableIntrinsicFlagOffset().Uint32Value();
1330}
1331
1332DexCacheArraysLayout CompilerDriver::GetDexCacheArraysLayout(const DexFile* dex_file) {
1333  return ContainsElement(GetDexFilesForOatFile(), dex_file)
1334      ? DexCacheArraysLayout(GetInstructionSetPointerSize(instruction_set_), dex_file)
1335      : DexCacheArraysLayout();
1336}
1337
1338void CompilerDriver::ProcessedInstanceField(bool resolved) {
1339  if (!resolved) {
1340    stats_->UnresolvedInstanceField();
1341  } else {
1342    stats_->ResolvedInstanceField();
1343  }
1344}
1345
1346void CompilerDriver::ProcessedStaticField(bool resolved, bool local) {
1347  if (!resolved) {
1348    stats_->UnresolvedStaticField();
1349  } else if (local) {
1350    stats_->ResolvedLocalStaticField();
1351  } else {
1352    stats_->ResolvedStaticField();
1353  }
1354}
1355
1356void CompilerDriver::ProcessedInvoke(InvokeType invoke_type, int flags) {
1357  stats_->ProcessedInvoke(invoke_type, flags);
1358}
1359
1360ArtField* CompilerDriver::ComputeInstanceFieldInfo(uint32_t field_idx,
1361                                                   const DexCompilationUnit* mUnit, bool is_put,
1362                                                   const ScopedObjectAccess& soa) {
1363  // Try to resolve the field and compiling method's class.
1364  ArtField* resolved_field;
1365  mirror::Class* referrer_class;
1366  Handle<mirror::DexCache> dex_cache(mUnit->GetDexCache());
1367  {
1368    StackHandleScope<1> hs(soa.Self());
1369    Handle<mirror::ClassLoader> class_loader_handle(
1370        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(mUnit->GetClassLoader())));
1371    resolved_field = ResolveField(soa, dex_cache, class_loader_handle, mUnit, field_idx, false);
1372    referrer_class = resolved_field != nullptr
1373        ? ResolveCompilingMethodsClass(soa, dex_cache, class_loader_handle, mUnit) : nullptr;
1374  }
1375  bool can_link = false;
1376  if (resolved_field != nullptr && referrer_class != nullptr) {
1377    std::pair<bool, bool> fast_path = IsFastInstanceField(
1378        dex_cache.Get(), referrer_class, resolved_field, field_idx);
1379    can_link = is_put ? fast_path.second : fast_path.first;
1380  }
1381  ProcessedInstanceField(can_link);
1382  return can_link ? resolved_field : nullptr;
1383}
1384
1385bool CompilerDriver::ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit,
1386                                              bool is_put, MemberOffset* field_offset,
1387                                              bool* is_volatile) {
1388  ScopedObjectAccess soa(Thread::Current());
1389  ArtField* resolved_field = ComputeInstanceFieldInfo(field_idx, mUnit, is_put, soa);
1390
1391  if (resolved_field == nullptr) {
1392    // Conservative defaults.
1393    *is_volatile = true;
1394    *field_offset = MemberOffset(static_cast<size_t>(-1));
1395    return false;
1396  } else {
1397    *is_volatile = resolved_field->IsVolatile();
1398    *field_offset = resolved_field->GetOffset();
1399    return true;
1400  }
1401}
1402
1403bool CompilerDriver::ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit,
1404                                            bool is_put, MemberOffset* field_offset,
1405                                            uint32_t* storage_index, bool* is_referrers_class,
1406                                            bool* is_volatile, bool* is_initialized,
1407                                            Primitive::Type* type) {
1408  ScopedObjectAccess soa(Thread::Current());
1409  // Try to resolve the field and compiling method's class.
1410  ArtField* resolved_field;
1411  mirror::Class* referrer_class;
1412  Handle<mirror::DexCache> dex_cache(mUnit->GetDexCache());
1413  {
1414    StackHandleScope<1> hs(soa.Self());
1415    Handle<mirror::ClassLoader> class_loader_handle(
1416        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(mUnit->GetClassLoader())));
1417    resolved_field =
1418        ResolveField(soa, dex_cache, class_loader_handle, mUnit, field_idx, true);
1419    referrer_class = resolved_field != nullptr
1420        ? ResolveCompilingMethodsClass(soa, dex_cache, class_loader_handle, mUnit) : nullptr;
1421  }
1422  bool result = false;
1423  if (resolved_field != nullptr && referrer_class != nullptr) {
1424    *is_volatile = IsFieldVolatile(resolved_field);
1425    std::pair<bool, bool> fast_path = IsFastStaticField(
1426        dex_cache.Get(), referrer_class, resolved_field, field_idx, storage_index);
1427    result = is_put ? fast_path.second : fast_path.first;
1428  }
1429  if (result) {
1430    *field_offset = GetFieldOffset(resolved_field);
1431    *is_referrers_class = IsStaticFieldInReferrerClass(referrer_class, resolved_field);
1432    // *is_referrers_class == true implies no worrying about class initialization.
1433    *is_initialized = (*is_referrers_class) ||
1434        (IsStaticFieldsClassInitialized(referrer_class, resolved_field) &&
1435         CanAssumeTypeIsPresentInDexCache(*mUnit->GetDexFile(), *storage_index));
1436    *type = resolved_field->GetTypeAsPrimitiveType();
1437  } else {
1438    // Conservative defaults.
1439    *is_volatile = true;
1440    *field_offset = MemberOffset(static_cast<size_t>(-1));
1441    *storage_index = -1;
1442    *is_referrers_class = false;
1443    *is_initialized = false;
1444    *type = Primitive::kPrimVoid;
1445  }
1446  ProcessedStaticField(result, *is_referrers_class);
1447  return result;
1448}
1449
1450void CompilerDriver::GetCodeAndMethodForDirectCall(InvokeType* type, InvokeType sharp_type,
1451                                                   bool no_guarantee_of_dex_cache_entry,
1452                                                   const mirror::Class* referrer_class,
1453                                                   ArtMethod* method,
1454                                                   int* stats_flags,
1455                                                   MethodReference* target_method,
1456                                                   uintptr_t* direct_code,
1457                                                   uintptr_t* direct_method) {
1458  // For direct and static methods compute possible direct_code and direct_method values, ie
1459  // an address for the Method* being invoked and an address of the code for that Method*.
1460  // For interface calls compute a value for direct_method that is the interface method being
1461  // invoked, so this can be passed to the out-of-line runtime support code.
1462  *direct_code = 0;
1463  *direct_method = 0;
1464  Runtime* const runtime = Runtime::Current();
1465  gc::Heap* const heap = runtime->GetHeap();
1466  auto* cl = runtime->GetClassLinker();
1467  const auto pointer_size = cl->GetImagePointerSize();
1468  bool use_dex_cache = GetCompilerOptions().GetCompilePic();  // Off by default
1469  const bool compiling_boot = heap->IsCompilingBoot();
1470  // TODO This is somewhat hacky. We should refactor all of this invoke codepath.
1471  const bool force_relocations = (compiling_boot ||
1472                                  GetCompilerOptions().GetIncludePatchInformation());
1473  if (sharp_type != kStatic && sharp_type != kDirect) {
1474    return;
1475  }
1476  // TODO: support patching on all architectures.
1477  use_dex_cache = use_dex_cache || (force_relocations && !support_boot_image_fixup_);
1478  mirror::Class* declaring_class = method->GetDeclaringClass();
1479  bool method_code_in_boot = declaring_class->GetClassLoader() == nullptr;
1480  if (!use_dex_cache) {
1481    if (!method_code_in_boot) {
1482      use_dex_cache = true;
1483    } else {
1484      bool has_clinit_trampoline =
1485          method->IsStatic() && !declaring_class->IsInitialized();
1486      if (has_clinit_trampoline && declaring_class != referrer_class) {
1487        // Ensure we run the clinit trampoline unless we are invoking a static method in the same
1488        // class.
1489        use_dex_cache = true;
1490      }
1491    }
1492  }
1493  if (runtime->UseJit()) {
1494    // If we are the JIT, then don't allow a direct call to the interpreter bridge since this will
1495    // never be updated even after we compile the method.
1496    if (cl->IsQuickToInterpreterBridge(
1497        reinterpret_cast<const void*>(compiler_->GetEntryPointOf(method)))) {
1498      use_dex_cache = true;
1499    }
1500  }
1501  if (method_code_in_boot) {
1502    *stats_flags |= kFlagDirectCallToBoot | kFlagDirectMethodToBoot;
1503  }
1504  if (!use_dex_cache && force_relocations) {
1505    bool is_in_image;
1506    if (IsBootImage()) {
1507      is_in_image = IsImageClass(method->GetDeclaringClassDescriptor());
1508    } else {
1509      is_in_image = instruction_set_ != kX86 && instruction_set_ != kX86_64 &&
1510                    heap->FindSpaceFromObject(method->GetDeclaringClass(), false)->IsImageSpace() &&
1511                    !cl->IsQuickToInterpreterBridge(
1512                        reinterpret_cast<const void*>(compiler_->GetEntryPointOf(method)));
1513    }
1514    if (!is_in_image) {
1515      // We can only branch directly to Methods that are resolved in the DexCache.
1516      // Otherwise we won't invoke the resolution trampoline.
1517      use_dex_cache = true;
1518    }
1519  }
1520  // The method is defined not within this dex file. We need a dex cache slot within the current
1521  // dex file or direct pointers.
1522  bool must_use_direct_pointers = false;
1523  mirror::DexCache* dex_cache = declaring_class->GetDexCache();
1524  if (target_method->dex_file == dex_cache->GetDexFile() &&
1525    !(runtime->UseJit() && dex_cache->GetResolvedMethod(
1526        method->GetDexMethodIndex(), pointer_size) == nullptr)) {
1527    target_method->dex_method_index = method->GetDexMethodIndex();
1528  } else {
1529    if (no_guarantee_of_dex_cache_entry) {
1530      // See if the method is also declared in this dex cache.
1531      uint32_t dex_method_idx = method->FindDexMethodIndexInOtherDexFile(
1532          *target_method->dex_file, target_method->dex_method_index);
1533      if (dex_method_idx != DexFile::kDexNoIndex) {
1534        target_method->dex_method_index = dex_method_idx;
1535      } else {
1536        if (force_relocations && !use_dex_cache) {
1537          target_method->dex_method_index = method->GetDexMethodIndex();
1538          target_method->dex_file = dex_cache->GetDexFile();
1539        }
1540        must_use_direct_pointers = true;
1541      }
1542    }
1543  }
1544  if (use_dex_cache) {
1545    if (must_use_direct_pointers) {
1546      // Fail. Test above showed the only safe dispatch was via the dex cache, however, the direct
1547      // pointers are required as the dex cache lacks an appropriate entry.
1548      VLOG(compiler) << "Dex cache devirtualization failed for: " << PrettyMethod(method);
1549    } else {
1550      *type = sharp_type;
1551    }
1552  } else {
1553    auto* image_space = heap->GetBootImageSpace();
1554    bool method_in_image = false;
1555    if (image_space != nullptr) {
1556      const auto& method_section = image_space->GetImageHeader().GetMethodsSection();
1557      method_in_image = method_section.Contains(
1558          reinterpret_cast<uint8_t*>(method) - image_space->Begin());
1559    }
1560    if (method_in_image || compiling_boot || runtime->UseJit()) {
1561      // We know we must be able to get to the method in the image, so use that pointer.
1562      // In the case where we are the JIT, we can always use direct pointers since we know where
1563      // the method and its code are / will be. We don't sharpen to interpreter bridge since we
1564      // check IsQuickToInterpreterBridge above.
1565      CHECK(!method->IsAbstract());
1566      *type = sharp_type;
1567      *direct_method = force_relocations ? -1 : reinterpret_cast<uintptr_t>(method);
1568      *direct_code = force_relocations ? -1 : compiler_->GetEntryPointOf(method);
1569      target_method->dex_file = method->GetDeclaringClass()->GetDexCache()->GetDexFile();
1570      target_method->dex_method_index = method->GetDexMethodIndex();
1571    } else if (!must_use_direct_pointers) {
1572      // Set the code and rely on the dex cache for the method.
1573      *type = sharp_type;
1574      if (force_relocations) {
1575        *direct_code = -1;
1576        target_method->dex_file = method->GetDeclaringClass()->GetDexCache()->GetDexFile();
1577        target_method->dex_method_index = method->GetDexMethodIndex();
1578      } else {
1579        *direct_code = compiler_->GetEntryPointOf(method);
1580      }
1581    } else {
1582      // Direct pointers were required but none were available.
1583      VLOG(compiler) << "Dex cache devirtualization failed for: " << PrettyMethod(method);
1584    }
1585  }
1586}
1587
1588bool CompilerDriver::ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
1589                                       bool update_stats, bool enable_devirtualization,
1590                                       InvokeType* invoke_type, MethodReference* target_method,
1591                                       int* vtable_idx, uintptr_t* direct_code,
1592                                       uintptr_t* direct_method) {
1593  InvokeType orig_invoke_type = *invoke_type;
1594  int stats_flags = 0;
1595  ScopedObjectAccess soa(Thread::Current());
1596  // Try to resolve the method and compiling method's class.
1597  StackHandleScope<2> hs(soa.Self());
1598  Handle<mirror::DexCache> dex_cache(mUnit->GetDexCache());
1599  Handle<mirror::ClassLoader> class_loader(hs.NewHandle(
1600      soa.Decode<mirror::ClassLoader*>(mUnit->GetClassLoader())));
1601  uint32_t method_idx = target_method->dex_method_index;
1602  ArtMethod* resolved_method = ResolveMethod(
1603      soa, dex_cache, class_loader, mUnit, method_idx, orig_invoke_type);
1604  auto h_referrer_class = hs.NewHandle(resolved_method != nullptr ?
1605      ResolveCompilingMethodsClass(soa, dex_cache, class_loader, mUnit) : nullptr);
1606  bool result = false;
1607  if (resolved_method != nullptr) {
1608    *vtable_idx = GetResolvedMethodVTableIndex(resolved_method, orig_invoke_type);
1609
1610    if (enable_devirtualization && mUnit->GetVerifiedMethod() != nullptr) {
1611      const MethodReference* devirt_target = mUnit->GetVerifiedMethod()->GetDevirtTarget(dex_pc);
1612
1613      stats_flags = IsFastInvoke(
1614          soa, dex_cache, class_loader, mUnit, h_referrer_class.Get(), resolved_method,
1615          invoke_type, target_method, devirt_target, direct_code, direct_method);
1616      result = stats_flags != 0;
1617    } else {
1618      // Devirtualization not enabled. Inline IsFastInvoke(), dropping the devirtualization parts.
1619      if (UNLIKELY(h_referrer_class.Get() == nullptr) ||
1620          UNLIKELY(!h_referrer_class->CanAccessResolvedMethod(resolved_method->GetDeclaringClass(),
1621                                                            resolved_method, dex_cache.Get(),
1622                                                            target_method->dex_method_index)) ||
1623          *invoke_type == kSuper) {
1624        // Slow path. (Without devirtualization, all super calls go slow path as well.)
1625      } else {
1626        // Sharpening failed so generate a regular resolved method dispatch.
1627        stats_flags = kFlagMethodResolved;
1628        GetCodeAndMethodForDirectCall(
1629            invoke_type, *invoke_type, false, h_referrer_class.Get(), resolved_method, &stats_flags,
1630            target_method, direct_code, direct_method);
1631        result = true;
1632      }
1633    }
1634  }
1635  if (!result) {
1636    // Conservative defaults.
1637    *vtable_idx = -1;
1638    *direct_code = 0u;
1639    *direct_method = 0u;
1640  }
1641  if (update_stats) {
1642    ProcessedInvoke(orig_invoke_type, stats_flags);
1643  }
1644  return result;
1645}
1646
1647const VerifiedMethod* CompilerDriver::GetVerifiedMethod(const DexFile* dex_file,
1648                                                        uint32_t method_idx) const {
1649  MethodReference ref(dex_file, method_idx);
1650  return verification_results_->GetVerifiedMethod(ref);
1651}
1652
1653bool CompilerDriver::IsSafeCast(const DexCompilationUnit* mUnit, uint32_t dex_pc) {
1654  if (!compiler_options_->IsVerificationEnabled()) {
1655    // If we didn't verify, every cast has to be treated as non-safe.
1656    return false;
1657  }
1658  DCHECK(mUnit->GetVerifiedMethod() != nullptr);
1659  bool result = mUnit->GetVerifiedMethod()->IsSafeCast(dex_pc);
1660  if (result) {
1661    stats_->SafeCast();
1662  } else {
1663    stats_->NotASafeCast();
1664  }
1665  return result;
1666}
1667
1668class CompilationVisitor {
1669 public:
1670  virtual ~CompilationVisitor() {}
1671  virtual void Visit(size_t index) = 0;
1672};
1673
1674class ParallelCompilationManager {
1675 public:
1676  ParallelCompilationManager(ClassLinker* class_linker,
1677                             jobject class_loader,
1678                             CompilerDriver* compiler,
1679                             const DexFile* dex_file,
1680                             const std::vector<const DexFile*>& dex_files,
1681                             ThreadPool* thread_pool)
1682    : index_(0),
1683      class_linker_(class_linker),
1684      class_loader_(class_loader),
1685      compiler_(compiler),
1686      dex_file_(dex_file),
1687      dex_files_(dex_files),
1688      thread_pool_(thread_pool) {}
1689
1690  ClassLinker* GetClassLinker() const {
1691    CHECK(class_linker_ != nullptr);
1692    return class_linker_;
1693  }
1694
1695  jobject GetClassLoader() const {
1696    return class_loader_;
1697  }
1698
1699  CompilerDriver* GetCompiler() const {
1700    CHECK(compiler_ != nullptr);
1701    return compiler_;
1702  }
1703
1704  const DexFile* GetDexFile() const {
1705    CHECK(dex_file_ != nullptr);
1706    return dex_file_;
1707  }
1708
1709  const std::vector<const DexFile*>& GetDexFiles() const {
1710    return dex_files_;
1711  }
1712
1713  void ForAll(size_t begin, size_t end, CompilationVisitor* visitor, size_t work_units)
1714      REQUIRES(!*Locks::mutator_lock_) {
1715    Thread* self = Thread::Current();
1716    self->AssertNoPendingException();
1717    CHECK_GT(work_units, 0U);
1718
1719    index_.StoreRelaxed(begin);
1720    for (size_t i = 0; i < work_units; ++i) {
1721      thread_pool_->AddTask(self, new ForAllClosure(this, end, visitor));
1722    }
1723    thread_pool_->StartWorkers(self);
1724
1725    // Ensure we're suspended while we're blocked waiting for the other threads to finish (worker
1726    // thread destructor's called below perform join).
1727    CHECK_NE(self->GetState(), kRunnable);
1728
1729    // Wait for all the worker threads to finish.
1730    thread_pool_->Wait(self, true, false);
1731  }
1732
1733  size_t NextIndex() {
1734    return index_.FetchAndAddSequentiallyConsistent(1);
1735  }
1736
1737 private:
1738  class ForAllClosure : public Task {
1739   public:
1740    ForAllClosure(ParallelCompilationManager* manager, size_t end, CompilationVisitor* visitor)
1741        : manager_(manager),
1742          end_(end),
1743          visitor_(visitor) {}
1744
1745    virtual void Run(Thread* self) {
1746      while (true) {
1747        const size_t index = manager_->NextIndex();
1748        if (UNLIKELY(index >= end_)) {
1749          break;
1750        }
1751        visitor_->Visit(index);
1752        self->AssertNoPendingException();
1753      }
1754    }
1755
1756    virtual void Finalize() {
1757      delete this;
1758    }
1759
1760   private:
1761    ParallelCompilationManager* const manager_;
1762    const size_t end_;
1763    CompilationVisitor* const visitor_;
1764  };
1765
1766  AtomicInteger index_;
1767  ClassLinker* const class_linker_;
1768  const jobject class_loader_;
1769  CompilerDriver* const compiler_;
1770  const DexFile* const dex_file_;
1771  const std::vector<const DexFile*>& dex_files_;
1772  ThreadPool* const thread_pool_;
1773
1774  DISALLOW_COPY_AND_ASSIGN(ParallelCompilationManager);
1775};
1776
1777// A fast version of SkipClass above if the class pointer is available
1778// that avoids the expensive FindInClassPath search.
1779static bool SkipClass(jobject class_loader, const DexFile& dex_file, mirror::Class* klass)
1780    SHARED_REQUIRES(Locks::mutator_lock_) {
1781  DCHECK(klass != nullptr);
1782  const DexFile& original_dex_file = *klass->GetDexCache()->GetDexFile();
1783  if (&dex_file != &original_dex_file) {
1784    if (class_loader == nullptr) {
1785      LOG(WARNING) << "Skipping class " << PrettyDescriptor(klass) << " from "
1786                   << dex_file.GetLocation() << " previously found in "
1787                   << original_dex_file.GetLocation();
1788    }
1789    return true;
1790  }
1791  return false;
1792}
1793
1794static void CheckAndClearResolveException(Thread* self)
1795    SHARED_REQUIRES(Locks::mutator_lock_) {
1796  CHECK(self->IsExceptionPending());
1797  mirror::Throwable* exception = self->GetException();
1798  std::string temp;
1799  const char* descriptor = exception->GetClass()->GetDescriptor(&temp);
1800  const char* expected_exceptions[] = {
1801      "Ljava/lang/IllegalAccessError;",
1802      "Ljava/lang/IncompatibleClassChangeError;",
1803      "Ljava/lang/InstantiationError;",
1804      "Ljava/lang/LinkageError;",
1805      "Ljava/lang/NoClassDefFoundError;",
1806      "Ljava/lang/NoSuchFieldError;",
1807      "Ljava/lang/NoSuchMethodError;"
1808  };
1809  bool found = false;
1810  for (size_t i = 0; (found == false) && (i < arraysize(expected_exceptions)); ++i) {
1811    if (strcmp(descriptor, expected_exceptions[i]) == 0) {
1812      found = true;
1813    }
1814  }
1815  if (!found) {
1816    LOG(FATAL) << "Unexpected exception " << exception->Dump();
1817  }
1818  self->ClearException();
1819}
1820
1821class ResolveClassFieldsAndMethodsVisitor : public CompilationVisitor {
1822 public:
1823  explicit ResolveClassFieldsAndMethodsVisitor(const ParallelCompilationManager* manager)
1824      : manager_(manager) {}
1825
1826  void Visit(size_t class_def_index) OVERRIDE REQUIRES(!Locks::mutator_lock_) {
1827    ATRACE_CALL();
1828    Thread* const self = Thread::Current();
1829    jobject jclass_loader = manager_->GetClassLoader();
1830    const DexFile& dex_file = *manager_->GetDexFile();
1831    ClassLinker* class_linker = manager_->GetClassLinker();
1832
1833    // If an instance field is final then we need to have a barrier on the return, static final
1834    // fields are assigned within the lock held for class initialization. Conservatively assume
1835    // constructor barriers are always required.
1836    bool requires_constructor_barrier = true;
1837
1838    // Method and Field are the worst. We can't resolve without either
1839    // context from the code use (to disambiguate virtual vs direct
1840    // method and instance vs static field) or from class
1841    // definitions. While the compiler will resolve what it can as it
1842    // needs it, here we try to resolve fields and methods used in class
1843    // definitions, since many of them many never be referenced by
1844    // generated code.
1845    const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
1846    ScopedObjectAccess soa(self);
1847    StackHandleScope<2> hs(soa.Self());
1848    Handle<mirror::ClassLoader> class_loader(
1849        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
1850    Handle<mirror::DexCache> dex_cache(hs.NewHandle(class_linker->FindDexCache(
1851        soa.Self(), dex_file, false)));
1852    // Resolve the class.
1853    mirror::Class* klass = class_linker->ResolveType(dex_file, class_def.class_idx_, dex_cache,
1854                                                     class_loader);
1855    bool resolve_fields_and_methods;
1856    if (klass == nullptr) {
1857      // Class couldn't be resolved, for example, super-class is in a different dex file. Don't
1858      // attempt to resolve methods and fields when there is no declaring class.
1859      CheckAndClearResolveException(soa.Self());
1860      resolve_fields_and_methods = false;
1861    } else {
1862      // We successfully resolved a class, should we skip it?
1863      if (SkipClass(jclass_loader, dex_file, klass)) {
1864        return;
1865      }
1866      // We want to resolve the methods and fields eagerly.
1867      resolve_fields_and_methods = true;
1868    }
1869    // Note the class_data pointer advances through the headers,
1870    // static fields, instance fields, direct methods, and virtual
1871    // methods.
1872    const uint8_t* class_data = dex_file.GetClassData(class_def);
1873    if (class_data == nullptr) {
1874      // Empty class such as a marker interface.
1875      requires_constructor_barrier = false;
1876    } else {
1877      ClassDataItemIterator it(dex_file, class_data);
1878      while (it.HasNextStaticField()) {
1879        if (resolve_fields_and_methods) {
1880          ArtField* field = class_linker->ResolveField(dex_file, it.GetMemberIndex(),
1881                                                               dex_cache, class_loader, true);
1882          if (field == nullptr) {
1883            CheckAndClearResolveException(soa.Self());
1884          }
1885        }
1886        it.Next();
1887      }
1888      // We require a constructor barrier if there are final instance fields.
1889      requires_constructor_barrier = false;
1890      while (it.HasNextInstanceField()) {
1891        if (it.MemberIsFinal()) {
1892          requires_constructor_barrier = true;
1893        }
1894        if (resolve_fields_and_methods) {
1895          ArtField* field = class_linker->ResolveField(dex_file, it.GetMemberIndex(),
1896                                                               dex_cache, class_loader, false);
1897          if (field == nullptr) {
1898            CheckAndClearResolveException(soa.Self());
1899          }
1900        }
1901        it.Next();
1902      }
1903      if (resolve_fields_and_methods) {
1904        while (it.HasNextDirectMethod()) {
1905          ArtMethod* method = class_linker->ResolveMethod(
1906              dex_file, it.GetMemberIndex(), dex_cache, class_loader, nullptr,
1907              it.GetMethodInvokeType(class_def));
1908          if (method == nullptr) {
1909            CheckAndClearResolveException(soa.Self());
1910          }
1911          it.Next();
1912        }
1913        while (it.HasNextVirtualMethod()) {
1914          ArtMethod* method = class_linker->ResolveMethod(
1915              dex_file, it.GetMemberIndex(), dex_cache, class_loader, nullptr,
1916              it.GetMethodInvokeType(class_def));
1917          if (method == nullptr) {
1918            CheckAndClearResolveException(soa.Self());
1919          }
1920          it.Next();
1921        }
1922        DCHECK(!it.HasNext());
1923      }
1924    }
1925    if (requires_constructor_barrier) {
1926      manager_->GetCompiler()->AddRequiresConstructorBarrier(self, &dex_file, class_def_index);
1927    }
1928  }
1929
1930 private:
1931  const ParallelCompilationManager* const manager_;
1932};
1933
1934class ResolveTypeVisitor : public CompilationVisitor {
1935 public:
1936  explicit ResolveTypeVisitor(const ParallelCompilationManager* manager) : manager_(manager) {
1937  }
1938  virtual void Visit(size_t type_idx) OVERRIDE REQUIRES(!Locks::mutator_lock_) {
1939  // Class derived values are more complicated, they require the linker and loader.
1940    ScopedObjectAccess soa(Thread::Current());
1941    ClassLinker* class_linker = manager_->GetClassLinker();
1942    const DexFile& dex_file = *manager_->GetDexFile();
1943    StackHandleScope<2> hs(soa.Self());
1944    Handle<mirror::ClassLoader> class_loader(
1945        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(manager_->GetClassLoader())));
1946    Handle<mirror::DexCache> dex_cache(hs.NewHandle(class_linker->RegisterDexFile(
1947        dex_file,
1948        class_linker->GetOrCreateAllocatorForClassLoader(class_loader.Get()))));
1949    mirror::Class* klass = class_linker->ResolveType(dex_file, type_idx, dex_cache, class_loader);
1950
1951    if (klass == nullptr) {
1952      soa.Self()->AssertPendingException();
1953      mirror::Throwable* exception = soa.Self()->GetException();
1954      VLOG(compiler) << "Exception during type resolution: " << exception->Dump();
1955      if (exception->GetClass()->DescriptorEquals("Ljava/lang/OutOfMemoryError;")) {
1956        // There's little point continuing compilation if the heap is exhausted.
1957        LOG(FATAL) << "Out of memory during type resolution for compilation";
1958      }
1959      soa.Self()->ClearException();
1960    }
1961  }
1962
1963 private:
1964  const ParallelCompilationManager* const manager_;
1965};
1966
1967void CompilerDriver::ResolveDexFile(jobject class_loader, const DexFile& dex_file,
1968                                    const std::vector<const DexFile*>& dex_files,
1969                                    ThreadPool* thread_pool, TimingLogger* timings) {
1970  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1971
1972  // TODO: we could resolve strings here, although the string table is largely filled with class
1973  //       and method names.
1974
1975  ParallelCompilationManager context(class_linker, class_loader, this, &dex_file, dex_files,
1976                                     thread_pool);
1977  if (IsBootImage()) {
1978    // For images we resolve all types, such as array, whereas for applications just those with
1979    // classdefs are resolved by ResolveClassFieldsAndMethods.
1980    TimingLogger::ScopedTiming t("Resolve Types", timings);
1981    ResolveTypeVisitor visitor(&context);
1982    context.ForAll(0, dex_file.NumTypeIds(), &visitor, thread_count_);
1983  }
1984
1985  TimingLogger::ScopedTiming t("Resolve MethodsAndFields", timings);
1986  ResolveClassFieldsAndMethodsVisitor visitor(&context);
1987  context.ForAll(0, dex_file.NumClassDefs(), &visitor, thread_count_);
1988}
1989
1990void CompilerDriver::SetVerified(jobject class_loader, const std::vector<const DexFile*>& dex_files,
1991                                 ThreadPool* thread_pool, TimingLogger* timings) {
1992  for (const DexFile* dex_file : dex_files) {
1993    CHECK(dex_file != nullptr);
1994    SetVerifiedDexFile(class_loader, *dex_file, dex_files, thread_pool, timings);
1995  }
1996}
1997
1998void CompilerDriver::Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files,
1999                            ThreadPool* thread_pool, TimingLogger* timings) {
2000  for (const DexFile* dex_file : dex_files) {
2001    CHECK(dex_file != nullptr);
2002    VerifyDexFile(class_loader, *dex_file, dex_files, thread_pool, timings);
2003  }
2004}
2005
2006class VerifyClassVisitor : public CompilationVisitor {
2007 public:
2008  explicit VerifyClassVisitor(const ParallelCompilationManager* manager) : manager_(manager) {}
2009
2010  virtual void Visit(size_t class_def_index) REQUIRES(!Locks::mutator_lock_) OVERRIDE {
2011    ATRACE_CALL();
2012    ScopedObjectAccess soa(Thread::Current());
2013    const DexFile& dex_file = *manager_->GetDexFile();
2014    const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
2015    const char* descriptor = dex_file.GetClassDescriptor(class_def);
2016    ClassLinker* class_linker = manager_->GetClassLinker();
2017    jobject jclass_loader = manager_->GetClassLoader();
2018    StackHandleScope<3> hs(soa.Self());
2019    Handle<mirror::ClassLoader> class_loader(
2020        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
2021    Handle<mirror::Class> klass(
2022        hs.NewHandle(class_linker->FindClass(soa.Self(), descriptor, class_loader)));
2023    if (klass.Get() == nullptr) {
2024      CHECK(soa.Self()->IsExceptionPending());
2025      soa.Self()->ClearException();
2026
2027      /*
2028       * At compile time, we can still structurally verify the class even if FindClass fails.
2029       * This is to ensure the class is structurally sound for compilation. An unsound class
2030       * will be rejected by the verifier and later skipped during compilation in the compiler.
2031       */
2032      Handle<mirror::DexCache> dex_cache(hs.NewHandle(class_linker->FindDexCache(
2033          soa.Self(), dex_file, false)));
2034      std::string error_msg;
2035      if (verifier::MethodVerifier::VerifyClass(soa.Self(),
2036                                                &dex_file,
2037                                                dex_cache,
2038                                                class_loader,
2039                                                &class_def,
2040                                                true /* allow soft failures */,
2041                                                true /* log hard failures */,
2042                                                &error_msg) ==
2043                                                    verifier::MethodVerifier::kHardFailure) {
2044        LOG(ERROR) << "Verification failed on class " << PrettyDescriptor(descriptor)
2045                   << " because: " << error_msg;
2046        manager_->GetCompiler()->SetHadHardVerifierFailure();
2047      }
2048    } else if (!SkipClass(jclass_loader, dex_file, klass.Get())) {
2049      CHECK(klass->IsResolved()) << PrettyClass(klass.Get());
2050      class_linker->VerifyClass(soa.Self(), klass);
2051
2052      if (klass->IsErroneous()) {
2053        // ClassLinker::VerifyClass throws, which isn't useful in the compiler.
2054        CHECK(soa.Self()->IsExceptionPending());
2055        soa.Self()->ClearException();
2056        manager_->GetCompiler()->SetHadHardVerifierFailure();
2057      }
2058
2059      CHECK(klass->IsCompileTimeVerified() || klass->IsErroneous())
2060          << PrettyDescriptor(klass.Get()) << ": state=" << klass->GetStatus();
2061
2062      // It is *very* problematic if there are verification errors in the boot classpath. For example,
2063      // we rely on things working OK without verification when the decryption dialog is brought up.
2064      // So abort in a debug build if we find this violated.
2065      DCHECK(!manager_->GetCompiler()->IsBootImage() || klass->IsVerified())
2066          << "Boot classpath class " << PrettyClass(klass.Get()) << " failed to fully verify.";
2067    }
2068    soa.Self()->AssertNoPendingException();
2069  }
2070
2071 private:
2072  const ParallelCompilationManager* const manager_;
2073};
2074
2075void CompilerDriver::VerifyDexFile(jobject class_loader, const DexFile& dex_file,
2076                                   const std::vector<const DexFile*>& dex_files,
2077                                   ThreadPool* thread_pool, TimingLogger* timings) {
2078  TimingLogger::ScopedTiming t("Verify Dex File", timings);
2079  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2080  ParallelCompilationManager context(class_linker, class_loader, this, &dex_file, dex_files,
2081                                     thread_pool);
2082  VerifyClassVisitor visitor(&context);
2083  context.ForAll(0, dex_file.NumClassDefs(), &visitor, thread_count_);
2084}
2085
2086class SetVerifiedClassVisitor : public CompilationVisitor {
2087 public:
2088  explicit SetVerifiedClassVisitor(const ParallelCompilationManager* manager) : manager_(manager) {}
2089
2090  virtual void Visit(size_t class_def_index) REQUIRES(!Locks::mutator_lock_) OVERRIDE {
2091    ATRACE_CALL();
2092    ScopedObjectAccess soa(Thread::Current());
2093    const DexFile& dex_file = *manager_->GetDexFile();
2094    const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
2095    const char* descriptor = dex_file.GetClassDescriptor(class_def);
2096    ClassLinker* class_linker = manager_->GetClassLinker();
2097    jobject jclass_loader = manager_->GetClassLoader();
2098    StackHandleScope<3> hs(soa.Self());
2099    Handle<mirror::ClassLoader> class_loader(
2100        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
2101    Handle<mirror::Class> klass(
2102        hs.NewHandle(class_linker->FindClass(soa.Self(), descriptor, class_loader)));
2103    // Class might have failed resolution. Then don't set it to verified.
2104    if (klass.Get() != nullptr) {
2105      // Only do this if the class is resolved. If even resolution fails, quickening will go very,
2106      // very wrong.
2107      if (klass->IsResolved()) {
2108        if (klass->GetStatus() < mirror::Class::kStatusVerified) {
2109          ObjectLock<mirror::Class> lock(soa.Self(), klass);
2110          // Set class status to verified.
2111          mirror::Class::SetStatus(klass, mirror::Class::kStatusVerified, soa.Self());
2112          // Mark methods as pre-verified. If we don't do this, the interpreter will run with
2113          // access checks.
2114          klass->SetPreverifiedFlagOnAllMethods(
2115              GetInstructionSetPointerSize(manager_->GetCompiler()->GetInstructionSet()));
2116          klass->SetPreverified();
2117        }
2118        // Record the final class status if necessary.
2119        ClassReference ref(manager_->GetDexFile(), class_def_index);
2120        manager_->GetCompiler()->RecordClassStatus(ref, klass->GetStatus());
2121      }
2122    } else {
2123      Thread* self = soa.Self();
2124      DCHECK(self->IsExceptionPending());
2125      self->ClearException();
2126    }
2127  }
2128
2129 private:
2130  const ParallelCompilationManager* const manager_;
2131};
2132
2133void CompilerDriver::SetVerifiedDexFile(jobject class_loader, const DexFile& dex_file,
2134                                        const std::vector<const DexFile*>& dex_files,
2135                                        ThreadPool* thread_pool, TimingLogger* timings) {
2136  TimingLogger::ScopedTiming t("Verify Dex File", timings);
2137  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2138  ParallelCompilationManager context(class_linker, class_loader, this, &dex_file, dex_files,
2139                                     thread_pool);
2140  SetVerifiedClassVisitor visitor(&context);
2141  context.ForAll(0, dex_file.NumClassDefs(), &visitor, thread_count_);
2142}
2143
2144class InitializeClassVisitor : public CompilationVisitor {
2145 public:
2146  explicit InitializeClassVisitor(const ParallelCompilationManager* manager) : manager_(manager) {}
2147
2148  virtual void Visit(size_t class_def_index) REQUIRES(!Locks::mutator_lock_) OVERRIDE {
2149    ATRACE_CALL();
2150    jobject jclass_loader = manager_->GetClassLoader();
2151    const DexFile& dex_file = *manager_->GetDexFile();
2152    const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
2153    const DexFile::TypeId& class_type_id = dex_file.GetTypeId(class_def.class_idx_);
2154    const char* descriptor = dex_file.StringDataByIdx(class_type_id.descriptor_idx_);
2155
2156    ScopedObjectAccess soa(Thread::Current());
2157    StackHandleScope<3> hs(soa.Self());
2158    Handle<mirror::ClassLoader> class_loader(
2159        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
2160    Handle<mirror::Class> klass(
2161        hs.NewHandle(manager_->GetClassLinker()->FindClass(soa.Self(), descriptor, class_loader)));
2162
2163    if (klass.Get() != nullptr && !SkipClass(jclass_loader, dex_file, klass.Get())) {
2164      // Only try to initialize classes that were successfully verified.
2165      if (klass->IsVerified()) {
2166        // Attempt to initialize the class but bail if we either need to initialize the super-class
2167        // or static fields.
2168        manager_->GetClassLinker()->EnsureInitialized(soa.Self(), klass, false, false);
2169        if (!klass->IsInitialized()) {
2170          // We don't want non-trivial class initialization occurring on multiple threads due to
2171          // deadlock problems. For example, a parent class is initialized (holding its lock) that
2172          // refers to a sub-class in its static/class initializer causing it to try to acquire the
2173          // sub-class' lock. While on a second thread the sub-class is initialized (holding its lock)
2174          // after first initializing its parents, whose locks are acquired. This leads to a
2175          // parent-to-child and a child-to-parent lock ordering and consequent potential deadlock.
2176          // We need to use an ObjectLock due to potential suspension in the interpreting code. Rather
2177          // than use a special Object for the purpose we use the Class of java.lang.Class.
2178          Handle<mirror::Class> h_klass(hs.NewHandle(klass->GetClass()));
2179          ObjectLock<mirror::Class> lock(soa.Self(), h_klass);
2180          // Attempt to initialize allowing initialization of parent classes but still not static
2181          // fields.
2182          manager_->GetClassLinker()->EnsureInitialized(soa.Self(), klass, false, true);
2183          if (!klass->IsInitialized()) {
2184            // We need to initialize static fields, we only do this for image classes that aren't
2185            // marked with the $NoPreloadHolder (which implies this should not be initialized early).
2186            bool can_init_static_fields = manager_->GetCompiler()->IsBootImage() &&
2187                manager_->GetCompiler()->IsImageClass(descriptor) &&
2188                !StringPiece(descriptor).ends_with("$NoPreloadHolder;");
2189            if (can_init_static_fields) {
2190              VLOG(compiler) << "Initializing: " << descriptor;
2191              // TODO multithreading support. We should ensure the current compilation thread has
2192              // exclusive access to the runtime and the transaction. To achieve this, we could use
2193              // a ReaderWriterMutex but we're holding the mutator lock so we fail mutex sanity
2194              // checks in Thread::AssertThreadSuspensionIsAllowable.
2195              Runtime* const runtime = Runtime::Current();
2196              Transaction transaction;
2197
2198              // Run the class initializer in transaction mode.
2199              runtime->EnterTransactionMode(&transaction);
2200              const mirror::Class::Status old_status = klass->GetStatus();
2201              bool success = manager_->GetClassLinker()->EnsureInitialized(soa.Self(), klass, true,
2202                                                                           true);
2203              // TODO we detach transaction from runtime to indicate we quit the transactional
2204              // mode which prevents the GC from visiting objects modified during the transaction.
2205              // Ensure GC is not run so don't access freed objects when aborting transaction.
2206
2207              ScopedAssertNoThreadSuspension ants(soa.Self(), "Transaction end");
2208              runtime->ExitTransactionMode();
2209
2210              if (!success) {
2211                CHECK(soa.Self()->IsExceptionPending());
2212                mirror::Throwable* exception = soa.Self()->GetException();
2213                VLOG(compiler) << "Initialization of " << descriptor << " aborted because of "
2214                    << exception->Dump();
2215                std::ostream* file_log = manager_->GetCompiler()->
2216                    GetCompilerOptions().GetInitFailureOutput();
2217                if (file_log != nullptr) {
2218                  *file_log << descriptor << "\n";
2219                  *file_log << exception->Dump() << "\n";
2220                }
2221                soa.Self()->ClearException();
2222                transaction.Rollback();
2223                CHECK_EQ(old_status, klass->GetStatus()) << "Previous class status not restored";
2224              }
2225            }
2226          }
2227          soa.Self()->AssertNoPendingException();
2228        }
2229      }
2230      // Record the final class status if necessary.
2231      ClassReference ref(manager_->GetDexFile(), class_def_index);
2232      manager_->GetCompiler()->RecordClassStatus(ref, klass->GetStatus());
2233    }
2234    // Clear any class not found or verification exceptions.
2235    soa.Self()->ClearException();
2236  }
2237
2238 private:
2239  const ParallelCompilationManager* const manager_;
2240};
2241
2242void CompilerDriver::InitializeClasses(jobject jni_class_loader, const DexFile& dex_file,
2243                                       const std::vector<const DexFile*>& dex_files,
2244                                       ThreadPool* thread_pool, TimingLogger* timings) {
2245  TimingLogger::ScopedTiming t("InitializeNoClinit", timings);
2246  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2247  ParallelCompilationManager context(class_linker, jni_class_loader, this, &dex_file, dex_files,
2248                                     thread_pool);
2249  size_t thread_count;
2250  if (IsBootImage()) {
2251    // TODO: remove this when transactional mode supports multithreading.
2252    thread_count = 1U;
2253  } else {
2254    thread_count = thread_count_;
2255  }
2256  InitializeClassVisitor visitor(&context);
2257  context.ForAll(0, dex_file.NumClassDefs(), &visitor, thread_count);
2258}
2259
2260void CompilerDriver::InitializeClasses(jobject class_loader,
2261                                       const std::vector<const DexFile*>& dex_files,
2262                                       ThreadPool* thread_pool, TimingLogger* timings) {
2263  for (size_t i = 0; i != dex_files.size(); ++i) {
2264    const DexFile* dex_file = dex_files[i];
2265    CHECK(dex_file != nullptr);
2266    InitializeClasses(class_loader, *dex_file, dex_files, thread_pool, timings);
2267  }
2268  if (IsBootImage()) {
2269    // Prune garbage objects created during aborted transactions.
2270    Runtime::Current()->GetHeap()->CollectGarbage(true);
2271  }
2272}
2273
2274void CompilerDriver::Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
2275                             ThreadPool* thread_pool, TimingLogger* timings) {
2276  for (size_t i = 0; i != dex_files.size(); ++i) {
2277    const DexFile* dex_file = dex_files[i];
2278    CHECK(dex_file != nullptr);
2279    CompileDexFile(class_loader, *dex_file, dex_files, thread_pool, timings);
2280  }
2281  VLOG(compiler) << "Compile: " << GetMemoryUsageString(false);
2282}
2283
2284class CompileClassVisitor : public CompilationVisitor {
2285 public:
2286  explicit CompileClassVisitor(const ParallelCompilationManager* manager) : manager_(manager) {}
2287
2288  virtual void Visit(size_t class_def_index) REQUIRES(!Locks::mutator_lock_) OVERRIDE {
2289    ATRACE_CALL();
2290    const DexFile& dex_file = *manager_->GetDexFile();
2291    const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
2292    ClassLinker* class_linker = manager_->GetClassLinker();
2293    jobject jclass_loader = manager_->GetClassLoader();
2294    ClassReference ref(&dex_file, class_def_index);
2295    // Skip compiling classes with generic verifier failures since they will still fail at runtime
2296    if (manager_->GetCompiler()->verification_results_->IsClassRejected(ref)) {
2297      return;
2298    }
2299    // Use a scoped object access to perform to the quick SkipClass check.
2300    const char* descriptor = dex_file.GetClassDescriptor(class_def);
2301    ScopedObjectAccess soa(Thread::Current());
2302    StackHandleScope<3> hs(soa.Self());
2303    Handle<mirror::ClassLoader> class_loader(
2304        hs.NewHandle(soa.Decode<mirror::ClassLoader*>(jclass_loader)));
2305    Handle<mirror::Class> klass(
2306        hs.NewHandle(class_linker->FindClass(soa.Self(), descriptor, class_loader)));
2307    Handle<mirror::DexCache> dex_cache;
2308    if (klass.Get() == nullptr) {
2309      soa.Self()->AssertPendingException();
2310      soa.Self()->ClearException();
2311      dex_cache = hs.NewHandle(class_linker->FindDexCache(soa.Self(), dex_file));
2312    } else if (SkipClass(jclass_loader, dex_file, klass.Get())) {
2313      return;
2314    } else {
2315      dex_cache = hs.NewHandle(klass->GetDexCache());
2316    }
2317
2318    const uint8_t* class_data = dex_file.GetClassData(class_def);
2319    if (class_data == nullptr) {
2320      // empty class, probably a marker interface
2321      return;
2322    }
2323
2324    // Go to native so that we don't block GC during compilation.
2325    ScopedThreadSuspension sts(soa.Self(), kNative);
2326
2327    CompilerDriver* const driver = manager_->GetCompiler();
2328
2329    // Can we run DEX-to-DEX compiler on this class ?
2330    optimizer::DexToDexCompilationLevel dex_to_dex_compilation_level =
2331        GetDexToDexCompilationLevel(soa.Self(), *driver, jclass_loader, dex_file, class_def);
2332
2333    ClassDataItemIterator it(dex_file, class_data);
2334    // Skip fields
2335    while (it.HasNextStaticField()) {
2336      it.Next();
2337    }
2338    while (it.HasNextInstanceField()) {
2339      it.Next();
2340    }
2341
2342    bool compilation_enabled = driver->IsClassToCompile(
2343        dex_file.StringByTypeIdx(class_def.class_idx_));
2344
2345    // Compile direct methods
2346    int64_t previous_direct_method_idx = -1;
2347    while (it.HasNextDirectMethod()) {
2348      uint32_t method_idx = it.GetMemberIndex();
2349      if (method_idx == previous_direct_method_idx) {
2350        // smali can create dex files with two encoded_methods sharing the same method_idx
2351        // http://code.google.com/p/smali/issues/detail?id=119
2352        it.Next();
2353        continue;
2354      }
2355      previous_direct_method_idx = method_idx;
2356      CompileMethod(soa.Self(), driver, it.GetMethodCodeItem(), it.GetMethodAccessFlags(),
2357                    it.GetMethodInvokeType(class_def), class_def_index,
2358                    method_idx, jclass_loader, dex_file, dex_to_dex_compilation_level,
2359                    compilation_enabled, dex_cache);
2360      it.Next();
2361    }
2362    // Compile virtual methods
2363    int64_t previous_virtual_method_idx = -1;
2364    while (it.HasNextVirtualMethod()) {
2365      uint32_t method_idx = it.GetMemberIndex();
2366      if (method_idx == previous_virtual_method_idx) {
2367        // smali can create dex files with two encoded_methods sharing the same method_idx
2368        // http://code.google.com/p/smali/issues/detail?id=119
2369        it.Next();
2370        continue;
2371      }
2372      previous_virtual_method_idx = method_idx;
2373      CompileMethod(soa.Self(), driver, it.GetMethodCodeItem(), it.GetMethodAccessFlags(),
2374                    it.GetMethodInvokeType(class_def), class_def_index,
2375                    method_idx, jclass_loader, dex_file, dex_to_dex_compilation_level,
2376                    compilation_enabled, dex_cache);
2377      it.Next();
2378    }
2379    DCHECK(!it.HasNext());
2380  }
2381
2382 private:
2383  const ParallelCompilationManager* const manager_;
2384};
2385
2386void CompilerDriver::CompileDexFile(jobject class_loader, const DexFile& dex_file,
2387                                    const std::vector<const DexFile*>& dex_files,
2388                                    ThreadPool* thread_pool, TimingLogger* timings) {
2389  TimingLogger::ScopedTiming t("Compile Dex File", timings);
2390  ParallelCompilationManager context(Runtime::Current()->GetClassLinker(), class_loader, this,
2391                                     &dex_file, dex_files, thread_pool);
2392  CompileClassVisitor visitor(&context);
2393  context.ForAll(0, dex_file.NumClassDefs(), &visitor, thread_count_);
2394}
2395
2396void CompilerDriver::AddCompiledMethod(const MethodReference& method_ref,
2397                                       CompiledMethod* const compiled_method,
2398                                       size_t non_relative_linker_patch_count) {
2399  DCHECK(GetCompiledMethod(method_ref) == nullptr)
2400      << PrettyMethod(method_ref.dex_method_index, *method_ref.dex_file);
2401  {
2402    MutexLock mu(Thread::Current(), compiled_methods_lock_);
2403    compiled_methods_.Put(method_ref, compiled_method);
2404    non_relative_linker_patch_count_ += non_relative_linker_patch_count;
2405  }
2406  DCHECK(GetCompiledMethod(method_ref) != nullptr)
2407      << PrettyMethod(method_ref.dex_method_index, *method_ref.dex_file);
2408}
2409
2410void CompilerDriver::RemoveCompiledMethod(const MethodReference& method_ref) {
2411  CompiledMethod* compiled_method = nullptr;
2412  {
2413    MutexLock mu(Thread::Current(), compiled_methods_lock_);
2414    auto it = compiled_methods_.find(method_ref);
2415    if (it != compiled_methods_.end()) {
2416      compiled_method = it->second;
2417      compiled_methods_.erase(it);
2418    }
2419  }
2420  if (compiled_method != nullptr) {
2421    CompiledMethod::ReleaseSwapAllocatedCompiledMethod(this, compiled_method);
2422  }
2423}
2424
2425CompiledClass* CompilerDriver::GetCompiledClass(ClassReference ref) const {
2426  MutexLock mu(Thread::Current(), compiled_classes_lock_);
2427  ClassTable::const_iterator it = compiled_classes_.find(ref);
2428  if (it == compiled_classes_.end()) {
2429    return nullptr;
2430  }
2431  CHECK(it->second != nullptr);
2432  return it->second;
2433}
2434
2435void CompilerDriver::RecordClassStatus(ClassReference ref, mirror::Class::Status status) {
2436  MutexLock mu(Thread::Current(), compiled_classes_lock_);
2437  auto it = compiled_classes_.find(ref);
2438  if (it == compiled_classes_.end() || it->second->GetStatus() != status) {
2439    // An entry doesn't exist or the status is lower than the new status.
2440    if (it != compiled_classes_.end()) {
2441      CHECK_GT(status, it->second->GetStatus());
2442      delete it->second;
2443    }
2444    switch (status) {
2445      case mirror::Class::kStatusNotReady:
2446      case mirror::Class::kStatusError:
2447      case mirror::Class::kStatusRetryVerificationAtRuntime:
2448      case mirror::Class::kStatusVerified:
2449      case mirror::Class::kStatusInitialized:
2450        break;  // Expected states.
2451      default:
2452        LOG(FATAL) << "Unexpected class status for class "
2453            << PrettyDescriptor(ref.first->GetClassDescriptor(ref.first->GetClassDef(ref.second)))
2454            << " of " << status;
2455    }
2456    CompiledClass* compiled_class = new CompiledClass(status);
2457    compiled_classes_.Overwrite(ref, compiled_class);
2458  }
2459}
2460
2461CompiledMethod* CompilerDriver::GetCompiledMethod(MethodReference ref) const {
2462  MutexLock mu(Thread::Current(), compiled_methods_lock_);
2463  MethodTable::const_iterator it = compiled_methods_.find(ref);
2464  if (it == compiled_methods_.end()) {
2465    return nullptr;
2466  }
2467  CHECK(it->second != nullptr);
2468  return it->second;
2469}
2470
2471bool CompilerDriver::IsMethodVerifiedWithoutFailures(uint32_t method_idx,
2472                                                     uint16_t class_def_idx,
2473                                                     const DexFile& dex_file) const {
2474  const VerifiedMethod* verified_method = GetVerifiedMethod(&dex_file, method_idx);
2475  if (verified_method != nullptr) {
2476    return !verified_method->HasVerificationFailures();
2477  }
2478
2479  // If we can't find verification metadata, check if this is a system class (we trust that system
2480  // classes have their methods verified). If it's not, be conservative and assume the method
2481  // has not been verified successfully.
2482
2483  // TODO: When compiling the boot image it should be safe to assume that everything is verified,
2484  // even if methods are not found in the verification cache.
2485  const char* descriptor = dex_file.GetClassDescriptor(dex_file.GetClassDef(class_def_idx));
2486  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2487  Thread* self = Thread::Current();
2488  ScopedObjectAccess soa(self);
2489  bool is_system_class = class_linker->FindSystemClass(self, descriptor) != nullptr;
2490  if (!is_system_class) {
2491    self->ClearException();
2492  }
2493  return is_system_class;
2494}
2495
2496size_t CompilerDriver::GetNonRelativeLinkerPatchCount() const {
2497  MutexLock mu(Thread::Current(), compiled_methods_lock_);
2498  return non_relative_linker_patch_count_;
2499}
2500
2501void CompilerDriver::AddRequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
2502                                                   uint16_t class_def_index) {
2503  WriterMutexLock mu(self, freezing_constructor_lock_);
2504  freezing_constructor_classes_.insert(ClassReference(dex_file, class_def_index));
2505}
2506
2507bool CompilerDriver::RequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
2508                                                uint16_t class_def_index) const {
2509  ReaderMutexLock mu(self, freezing_constructor_lock_);
2510  return freezing_constructor_classes_.count(ClassReference(dex_file, class_def_index)) != 0;
2511}
2512
2513bool CompilerDriver::SkipCompilation(const std::string& method_name) {
2514  if (!profile_present_) {
2515    return false;
2516  }
2517  // First find the method in the profile file.
2518  ProfileFile::ProfileData data;
2519  if (!profile_file_.GetProfileData(&data, method_name)) {
2520    // Not in profile, no information can be determined.
2521    if (kIsDebugBuild) {
2522      VLOG(compiler) << "not compiling " << method_name << " because it's not in the profile";
2523    }
2524    return true;
2525  }
2526
2527  // Methods that comprise top_k_threshold % of the total samples will be compiled.
2528  // Compare against the start of the topK percentage bucket just in case the threshold
2529  // falls inside a bucket.
2530  bool compile = data.GetTopKUsedPercentage() - data.GetUsedPercent()
2531                 <= compiler_options_->GetTopKProfileThreshold();
2532  if (kIsDebugBuild) {
2533    if (compile) {
2534      LOG(INFO) << "compiling method " << method_name << " because its usage is part of top "
2535          << data.GetTopKUsedPercentage() << "% with a percent of " << data.GetUsedPercent() << "%"
2536          << " (topKThreshold=" << compiler_options_->GetTopKProfileThreshold() << ")";
2537    } else {
2538      VLOG(compiler) << "not compiling method " << method_name
2539          << " because it's not part of leading " << compiler_options_->GetTopKProfileThreshold()
2540          << "% samples)";
2541    }
2542  }
2543  return !compile;
2544}
2545
2546std::string CompilerDriver::GetMemoryUsageString(bool extended) const {
2547  std::ostringstream oss;
2548  Runtime* const runtime = Runtime::Current();
2549  const ArenaPool* arena_pool = runtime->GetArenaPool();
2550  gc::Heap* const heap = runtime->GetHeap();
2551  oss << "arena alloc=" << PrettySize(arena_pool->GetBytesAllocated());
2552  oss << " java alloc=" << PrettySize(heap->GetBytesAllocated());
2553#if defined(__BIONIC__) || defined(__GLIBC__)
2554  struct mallinfo info = mallinfo();
2555  const size_t allocated_space = static_cast<size_t>(info.uordblks);
2556  const size_t free_space = static_cast<size_t>(info.fordblks);
2557  oss << " native alloc=" << PrettySize(allocated_space) << " free="
2558      << PrettySize(free_space);
2559#endif
2560  compiled_method_storage_.DumpMemoryUsage(oss, extended);
2561  return oss.str();
2562}
2563
2564bool CompilerDriver::IsStringTypeIndex(uint16_t type_index, const DexFile* dex_file) {
2565  const char* type = dex_file->GetTypeDescriptor(dex_file->GetTypeId(type_index));
2566  return strcmp(type, "Ljava/lang/String;") == 0;
2567}
2568
2569bool CompilerDriver::IsStringInit(uint32_t method_index, const DexFile* dex_file, int32_t* offset) {
2570  DexFileMethodInliner* inliner = GetMethodInlinerMap()->GetMethodInliner(dex_file);
2571  size_t pointer_size = InstructionSetPointerSize(GetInstructionSet());
2572  *offset = inliner->GetOffsetForStringInit(method_index, pointer_size);
2573  return inliner->IsStringInitMethodIndex(method_index);
2574}
2575
2576}  // namespace art
2577