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 "class_linker.h"
18
19#include <deque>
20#include <iostream>
21#include <memory>
22#include <queue>
23#include <string>
24#include <unistd.h>
25#include <utility>
26#include <vector>
27
28#include "art_field-inl.h"
29#include "art_method-inl.h"
30#include "base/arena_allocator.h"
31#include "base/casts.h"
32#include "base/logging.h"
33#include "base/scoped_arena_containers.h"
34#include "base/scoped_flock.h"
35#include "base/stl_util.h"
36#include "base/time_utils.h"
37#include "base/unix_file/fd_file.h"
38#include "base/value_object.h"
39#include "class_linker-inl.h"
40#include "compiler_callbacks.h"
41#include "debugger.h"
42#include "dex_file-inl.h"
43#include "entrypoints/runtime_asm_entrypoints.h"
44#include "gc_root-inl.h"
45#include "gc/accounting/card_table-inl.h"
46#include "gc/accounting/heap_bitmap.h"
47#include "gc/heap.h"
48#include "gc/space/image_space.h"
49#include "handle_scope.h"
50#include "intern_table.h"
51#include "interpreter/interpreter.h"
52#include "jit/jit.h"
53#include "jit/jit_code_cache.h"
54#include "leb128.h"
55#include "linear_alloc.h"
56#include "oat.h"
57#include "oat_file.h"
58#include "oat_file_assistant.h"
59#include "object_lock.h"
60#include "mirror/class.h"
61#include "mirror/class-inl.h"
62#include "mirror/class_loader.h"
63#include "mirror/dex_cache-inl.h"
64#include "mirror/field.h"
65#include "mirror/iftable-inl.h"
66#include "mirror/method.h"
67#include "mirror/object-inl.h"
68#include "mirror/object_array-inl.h"
69#include "mirror/proxy.h"
70#include "mirror/reference-inl.h"
71#include "mirror/stack_trace_element.h"
72#include "mirror/string-inl.h"
73#include "os.h"
74#include "runtime.h"
75#include "entrypoints/entrypoint_utils.h"
76#include "ScopedLocalRef.h"
77#include "scoped_thread_state_change.h"
78#include "handle_scope-inl.h"
79#include "thread-inl.h"
80#include "utils.h"
81#include "verifier/method_verifier.h"
82#include "well_known_classes.h"
83
84namespace art {
85
86static constexpr bool kSanityCheckObjects = kIsDebugBuild;
87
88// For b/21333911.
89static constexpr bool kDuplicateClassesCheck = false;
90
91static void ThrowNoClassDefFoundError(const char* fmt, ...)
92    __attribute__((__format__(__printf__, 1, 2)))
93    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
94static void ThrowNoClassDefFoundError(const char* fmt, ...) {
95  va_list args;
96  va_start(args, fmt);
97  Thread* self = Thread::Current();
98  self->ThrowNewExceptionV("Ljava/lang/NoClassDefFoundError;", fmt, args);
99  va_end(args);
100}
101
102bool ClassLinker::HasInitWithString(
103    Thread* self, ClassLinker* class_linker, const char* descriptor) {
104  ArtMethod* method = self->GetCurrentMethod(nullptr);
105  StackHandleScope<1> hs(self);
106  Handle<mirror::ClassLoader> class_loader(hs.NewHandle(method != nullptr ?
107      method->GetDeclaringClass()->GetClassLoader()
108      : nullptr));
109  mirror::Class* exception_class = class_linker->FindClass(self, descriptor, class_loader);
110
111  if (exception_class == nullptr) {
112    // No exc class ~ no <init>-with-string.
113    CHECK(self->IsExceptionPending());
114    self->ClearException();
115    return false;
116  }
117
118  ArtMethod* exception_init_method = exception_class->FindDeclaredDirectMethod(
119      "<init>", "(Ljava/lang/String;)V", image_pointer_size_);
120  return exception_init_method != nullptr;
121}
122
123void ClassLinker::ThrowEarlierClassFailure(mirror::Class* c) {
124  // The class failed to initialize on a previous attempt, so we want to throw
125  // a NoClassDefFoundError (v2 2.17.5).  The exception to this rule is if we
126  // failed in verification, in which case v2 5.4.1 says we need to re-throw
127  // the previous error.
128  Runtime* const runtime = Runtime::Current();
129  if (!runtime->IsAotCompiler()) {  // Give info if this occurs at runtime.
130    LOG(INFO) << "Rejecting re-init on previously-failed class " << PrettyClass(c);
131  }
132
133  CHECK(c->IsErroneous()) << PrettyClass(c) << " " << c->GetStatus();
134  Thread* self = Thread::Current();
135  if (runtime->IsAotCompiler()) {
136    // At compile time, accurate errors and NCDFE are disabled to speed compilation.
137    mirror::Throwable* pre_allocated = runtime->GetPreAllocatedNoClassDefFoundError();
138    self->SetException(pre_allocated);
139  } else {
140    if (c->GetVerifyErrorClass() != nullptr) {
141      // TODO: change the verifier to store an _instance_, with a useful detail message?
142      // It's possible the exception doesn't have a <init>(String).
143      std::string temp;
144      const char* descriptor = c->GetVerifyErrorClass()->GetDescriptor(&temp);
145
146      if (HasInitWithString(self, this, descriptor)) {
147        self->ThrowNewException(descriptor, PrettyDescriptor(c).c_str());
148      } else {
149        self->ThrowNewException(descriptor, nullptr);
150      }
151    } else {
152      self->ThrowNewException("Ljava/lang/NoClassDefFoundError;",
153                              PrettyDescriptor(c).c_str());
154    }
155  }
156}
157
158static void VlogClassInitializationFailure(Handle<mirror::Class> klass)
159    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
160  if (VLOG_IS_ON(class_linker)) {
161    std::string temp;
162    LOG(INFO) << "Failed to initialize class " << klass->GetDescriptor(&temp) << " from "
163              << klass->GetLocation() << "\n" << Thread::Current()->GetException()->Dump();
164  }
165}
166
167static void WrapExceptionInInitializer(Handle<mirror::Class> klass)
168    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
169  Thread* self = Thread::Current();
170  JNIEnv* env = self->GetJniEnv();
171
172  ScopedLocalRef<jthrowable> cause(env, env->ExceptionOccurred());
173  CHECK(cause.get() != nullptr);
174
175  env->ExceptionClear();
176  bool is_error = env->IsInstanceOf(cause.get(), WellKnownClasses::java_lang_Error);
177  env->Throw(cause.get());
178
179  // We only wrap non-Error exceptions; an Error can just be used as-is.
180  if (!is_error) {
181    self->ThrowNewWrappedException("Ljava/lang/ExceptionInInitializerError;", nullptr);
182  }
183  VlogClassInitializationFailure(klass);
184}
185
186// Gap between two fields in object layout.
187struct FieldGap {
188  uint32_t start_offset;  // The offset from the start of the object.
189  uint32_t size;  // The gap size of 1, 2, or 4 bytes.
190};
191struct FieldGapsComparator {
192  explicit FieldGapsComparator() {
193  }
194  bool operator() (const FieldGap& lhs, const FieldGap& rhs)
195      NO_THREAD_SAFETY_ANALYSIS {
196    // Sort by gap size, largest first. Secondary sort by starting offset.
197    return lhs.size > rhs.size || (lhs.size == rhs.size && lhs.start_offset < rhs.start_offset);
198  }
199};
200typedef std::priority_queue<FieldGap, std::vector<FieldGap>, FieldGapsComparator> FieldGaps;
201
202// Adds largest aligned gaps to queue of gaps.
203static void AddFieldGap(uint32_t gap_start, uint32_t gap_end, FieldGaps* gaps) {
204  DCHECK(gaps != nullptr);
205
206  uint32_t current_offset = gap_start;
207  while (current_offset != gap_end) {
208    size_t remaining = gap_end - current_offset;
209    if (remaining >= sizeof(uint32_t) && IsAligned<4>(current_offset)) {
210      gaps->push(FieldGap {current_offset, sizeof(uint32_t)});
211      current_offset += sizeof(uint32_t);
212    } else if (remaining >= sizeof(uint16_t) && IsAligned<2>(current_offset)) {
213      gaps->push(FieldGap {current_offset, sizeof(uint16_t)});
214      current_offset += sizeof(uint16_t);
215    } else {
216      gaps->push(FieldGap {current_offset, sizeof(uint8_t)});
217      current_offset += sizeof(uint8_t);
218    }
219    DCHECK_LE(current_offset, gap_end) << "Overran gap";
220  }
221}
222// Shuffle fields forward, making use of gaps whenever possible.
223template<int n>
224static void ShuffleForward(size_t* current_field_idx,
225                           MemberOffset* field_offset,
226                           std::deque<ArtField*>* grouped_and_sorted_fields,
227                           FieldGaps* gaps)
228    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
229  DCHECK(current_field_idx != nullptr);
230  DCHECK(grouped_and_sorted_fields != nullptr);
231  DCHECK(gaps != nullptr);
232  DCHECK(field_offset != nullptr);
233
234  DCHECK(IsPowerOfTwo(n));
235  while (!grouped_and_sorted_fields->empty()) {
236    ArtField* field = grouped_and_sorted_fields->front();
237    Primitive::Type type = field->GetTypeAsPrimitiveType();
238    if (Primitive::ComponentSize(type) < n) {
239      break;
240    }
241    if (!IsAligned<n>(field_offset->Uint32Value())) {
242      MemberOffset old_offset = *field_offset;
243      *field_offset = MemberOffset(RoundUp(field_offset->Uint32Value(), n));
244      AddFieldGap(old_offset.Uint32Value(), field_offset->Uint32Value(), gaps);
245    }
246    CHECK(type != Primitive::kPrimNot) << PrettyField(field);  // should be primitive types
247    grouped_and_sorted_fields->pop_front();
248    if (!gaps->empty() && gaps->top().size >= n) {
249      FieldGap gap = gaps->top();
250      gaps->pop();
251      DCHECK(IsAligned<n>(gap.start_offset));
252      field->SetOffset(MemberOffset(gap.start_offset));
253      if (gap.size > n) {
254        AddFieldGap(gap.start_offset + n, gap.start_offset + gap.size, gaps);
255      }
256    } else {
257      DCHECK(IsAligned<n>(field_offset->Uint32Value()));
258      field->SetOffset(*field_offset);
259      *field_offset = MemberOffset(field_offset->Uint32Value() + n);
260    }
261    ++(*current_field_idx);
262  }
263}
264
265ClassLinker::ClassLinker(InternTable* intern_table)
266    // dex_lock_ is recursive as it may be used in stack dumping.
267    : dex_lock_("ClassLinker dex lock", kDefaultMutexLevel),
268      dex_cache_image_class_lookup_required_(false),
269      failed_dex_cache_class_lookups_(0),
270      class_roots_(nullptr),
271      array_iftable_(nullptr),
272      find_array_class_cache_next_victim_(0),
273      init_done_(false),
274      log_new_dex_caches_roots_(false),
275      log_new_class_table_roots_(false),
276      intern_table_(intern_table),
277      quick_resolution_trampoline_(nullptr),
278      quick_imt_conflict_trampoline_(nullptr),
279      quick_generic_jni_trampoline_(nullptr),
280      quick_to_interpreter_bridge_trampoline_(nullptr),
281      image_pointer_size_(sizeof(void*)) {
282  CHECK(intern_table_ != nullptr);
283  static_assert(kFindArrayCacheSize == arraysize(find_array_class_cache_),
284                "Array cache size wrong.");
285  std::fill_n(find_array_class_cache_, kFindArrayCacheSize, GcRoot<mirror::Class>(nullptr));
286}
287
288void ClassLinker::InitWithoutImage(std::vector<std::unique_ptr<const DexFile>> boot_class_path) {
289  VLOG(startup) << "ClassLinker::Init";
290
291  Thread* const self = Thread::Current();
292  Runtime* const runtime = Runtime::Current();
293  gc::Heap* const heap = runtime->GetHeap();
294
295  CHECK(!heap->HasImageSpace()) << "Runtime has image. We should use it.";
296  CHECK(!init_done_);
297
298  // Use the pointer size from the runtime since we are probably creating the image.
299  image_pointer_size_ = InstructionSetPointerSize(runtime->GetInstructionSet());
300
301  // java_lang_Class comes first, it's needed for AllocClass
302  // The GC can't handle an object with a null class since we can't get the size of this object.
303  heap->IncrementDisableMovingGC(self);
304  StackHandleScope<64> hs(self);  // 64 is picked arbitrarily.
305  auto class_class_size = mirror::Class::ClassClassSize(image_pointer_size_);
306  Handle<mirror::Class> java_lang_Class(hs.NewHandle(down_cast<mirror::Class*>(
307      heap->AllocNonMovableObject<true>(self, nullptr, class_class_size, VoidFunctor()))));
308  CHECK(java_lang_Class.Get() != nullptr);
309  mirror::Class::SetClassClass(java_lang_Class.Get());
310  java_lang_Class->SetClass(java_lang_Class.Get());
311  if (kUseBakerOrBrooksReadBarrier) {
312    java_lang_Class->AssertReadBarrierPointer();
313  }
314  java_lang_Class->SetClassSize(class_class_size);
315  java_lang_Class->SetPrimitiveType(Primitive::kPrimNot);
316  heap->DecrementDisableMovingGC(self);
317  // AllocClass(mirror::Class*) can now be used
318
319  // Class[] is used for reflection support.
320  auto class_array_class_size = mirror::ObjectArray<mirror::Class>::ClassSize(image_pointer_size_);
321  Handle<mirror::Class> class_array_class(hs.NewHandle(
322      AllocClass(self, java_lang_Class.Get(), class_array_class_size)));
323  class_array_class->SetComponentType(java_lang_Class.Get());
324
325  // java_lang_Object comes next so that object_array_class can be created.
326  Handle<mirror::Class> java_lang_Object(hs.NewHandle(
327      AllocClass(self, java_lang_Class.Get(), mirror::Object::ClassSize(image_pointer_size_))));
328  CHECK(java_lang_Object.Get() != nullptr);
329  // backfill Object as the super class of Class.
330  java_lang_Class->SetSuperClass(java_lang_Object.Get());
331  mirror::Class::SetStatus(java_lang_Object, mirror::Class::kStatusLoaded, self);
332
333  // Object[] next to hold class roots.
334  Handle<mirror::Class> object_array_class(hs.NewHandle(
335      AllocClass(self, java_lang_Class.Get(),
336                 mirror::ObjectArray<mirror::Object>::ClassSize(image_pointer_size_))));
337  object_array_class->SetComponentType(java_lang_Object.Get());
338
339  // Setup the char (primitive) class to be used for char[].
340  Handle<mirror::Class> char_class(hs.NewHandle(
341      AllocClass(self, java_lang_Class.Get(),
342                 mirror::Class::PrimitiveClassSize(image_pointer_size_))));
343  // The primitive char class won't be initialized by
344  // InitializePrimitiveClass until line 459, but strings (and
345  // internal char arrays) will be allocated before that and the
346  // component size, which is computed from the primitive type, needs
347  // to be set here.
348  char_class->SetPrimitiveType(Primitive::kPrimChar);
349
350  // Setup the char[] class to be used for String.
351  Handle<mirror::Class> char_array_class(hs.NewHandle(
352      AllocClass(self, java_lang_Class.Get(), mirror::Array::ClassSize(image_pointer_size_))));
353  char_array_class->SetComponentType(char_class.Get());
354  mirror::CharArray::SetArrayClass(char_array_class.Get());
355
356  // Setup String.
357  Handle<mirror::Class> java_lang_String(hs.NewHandle(
358      AllocClass(self, java_lang_Class.Get(), mirror::String::ClassSize(image_pointer_size_))));
359  mirror::String::SetClass(java_lang_String.Get());
360  mirror::Class::SetStatus(java_lang_String, mirror::Class::kStatusResolved, self);
361  java_lang_String->SetStringClass();
362
363  // Setup java.lang.ref.Reference.
364  Handle<mirror::Class> java_lang_ref_Reference(hs.NewHandle(
365      AllocClass(self, java_lang_Class.Get(), mirror::Reference::ClassSize(image_pointer_size_))));
366  mirror::Reference::SetClass(java_lang_ref_Reference.Get());
367  java_lang_ref_Reference->SetObjectSize(mirror::Reference::InstanceSize());
368  mirror::Class::SetStatus(java_lang_ref_Reference, mirror::Class::kStatusResolved, self);
369
370  // Create storage for root classes, save away our work so far (requires descriptors).
371  class_roots_ = GcRoot<mirror::ObjectArray<mirror::Class>>(
372      mirror::ObjectArray<mirror::Class>::Alloc(self, object_array_class.Get(),
373                                                kClassRootsMax));
374  CHECK(!class_roots_.IsNull());
375  SetClassRoot(kJavaLangClass, java_lang_Class.Get());
376  SetClassRoot(kJavaLangObject, java_lang_Object.Get());
377  SetClassRoot(kClassArrayClass, class_array_class.Get());
378  SetClassRoot(kObjectArrayClass, object_array_class.Get());
379  SetClassRoot(kCharArrayClass, char_array_class.Get());
380  SetClassRoot(kJavaLangString, java_lang_String.Get());
381  SetClassRoot(kJavaLangRefReference, java_lang_ref_Reference.Get());
382
383  // Setup the primitive type classes.
384  SetClassRoot(kPrimitiveBoolean, CreatePrimitiveClass(self, Primitive::kPrimBoolean));
385  SetClassRoot(kPrimitiveByte, CreatePrimitiveClass(self, Primitive::kPrimByte));
386  SetClassRoot(kPrimitiveShort, CreatePrimitiveClass(self, Primitive::kPrimShort));
387  SetClassRoot(kPrimitiveInt, CreatePrimitiveClass(self, Primitive::kPrimInt));
388  SetClassRoot(kPrimitiveLong, CreatePrimitiveClass(self, Primitive::kPrimLong));
389  SetClassRoot(kPrimitiveFloat, CreatePrimitiveClass(self, Primitive::kPrimFloat));
390  SetClassRoot(kPrimitiveDouble, CreatePrimitiveClass(self, Primitive::kPrimDouble));
391  SetClassRoot(kPrimitiveVoid, CreatePrimitiveClass(self, Primitive::kPrimVoid));
392
393  // Create array interface entries to populate once we can load system classes.
394  array_iftable_ = GcRoot<mirror::IfTable>(AllocIfTable(self, 2));
395
396  // Create int array type for AllocDexCache (done in AppendToBootClassPath).
397  Handle<mirror::Class> int_array_class(hs.NewHandle(
398      AllocClass(self, java_lang_Class.Get(), mirror::Array::ClassSize(image_pointer_size_))));
399  int_array_class->SetComponentType(GetClassRoot(kPrimitiveInt));
400  mirror::IntArray::SetArrayClass(int_array_class.Get());
401  SetClassRoot(kIntArrayClass, int_array_class.Get());
402
403  // Create long array type for AllocDexCache (done in AppendToBootClassPath).
404  Handle<mirror::Class> long_array_class(hs.NewHandle(
405      AllocClass(self, java_lang_Class.Get(), mirror::Array::ClassSize(image_pointer_size_))));
406  long_array_class->SetComponentType(GetClassRoot(kPrimitiveLong));
407  mirror::LongArray::SetArrayClass(long_array_class.Get());
408  SetClassRoot(kLongArrayClass, long_array_class.Get());
409
410  // now that these are registered, we can use AllocClass() and AllocObjectArray
411
412  // Set up DexCache. This cannot be done later since AppendToBootClassPath calls AllocDexCache.
413  Handle<mirror::Class> java_lang_DexCache(hs.NewHandle(
414      AllocClass(self, java_lang_Class.Get(), mirror::DexCache::ClassSize(image_pointer_size_))));
415  SetClassRoot(kJavaLangDexCache, java_lang_DexCache.Get());
416  java_lang_DexCache->SetObjectSize(mirror::DexCache::InstanceSize());
417  mirror::Class::SetStatus(java_lang_DexCache, mirror::Class::kStatusResolved, self);
418
419  // Set up array classes for string, field, method
420  Handle<mirror::Class> object_array_string(hs.NewHandle(
421      AllocClass(self, java_lang_Class.Get(),
422                 mirror::ObjectArray<mirror::String>::ClassSize(image_pointer_size_))));
423  object_array_string->SetComponentType(java_lang_String.Get());
424  SetClassRoot(kJavaLangStringArrayClass, object_array_string.Get());
425
426  // Create runtime resolution and imt conflict methods.
427  runtime->SetResolutionMethod(runtime->CreateResolutionMethod());
428  runtime->SetImtConflictMethod(runtime->CreateImtConflictMethod());
429  runtime->SetImtUnimplementedMethod(runtime->CreateImtConflictMethod());
430
431  // Setup boot_class_path_ and register class_path now that we can use AllocObjectArray to create
432  // DexCache instances. Needs to be after String, Field, Method arrays since AllocDexCache uses
433  // these roots.
434  CHECK_NE(0U, boot_class_path.size());
435  for (auto& dex_file : boot_class_path) {
436    CHECK(dex_file.get() != nullptr);
437    AppendToBootClassPath(self, *dex_file);
438    opened_dex_files_.push_back(std::move(dex_file));
439  }
440
441  // now we can use FindSystemClass
442
443  // run char class through InitializePrimitiveClass to finish init
444  InitializePrimitiveClass(char_class.Get(), Primitive::kPrimChar);
445  SetClassRoot(kPrimitiveChar, char_class.Get());  // needs descriptor
446
447  // Set up GenericJNI entrypoint. That is mainly a hack for common_compiler_test.h so that
448  // we do not need friend classes or a publicly exposed setter.
449  quick_generic_jni_trampoline_ = GetQuickGenericJniStub();
450  if (!runtime->IsAotCompiler()) {
451    // We need to set up the generic trampolines since we don't have an image.
452    quick_resolution_trampoline_ = GetQuickResolutionStub();
453    quick_imt_conflict_trampoline_ = GetQuickImtConflictStub();
454    quick_to_interpreter_bridge_trampoline_ = GetQuickToInterpreterBridge();
455  }
456
457  // Object, String and DexCache need to be rerun through FindSystemClass to finish init
458  mirror::Class::SetStatus(java_lang_Object, mirror::Class::kStatusNotReady, self);
459  CHECK_EQ(java_lang_Object.Get(), FindSystemClass(self, "Ljava/lang/Object;"));
460  CHECK_EQ(java_lang_Object->GetObjectSize(), mirror::Object::InstanceSize());
461  mirror::Class::SetStatus(java_lang_String, mirror::Class::kStatusNotReady, self);
462  mirror::Class* String_class = FindSystemClass(self, "Ljava/lang/String;");
463  if (java_lang_String.Get() != String_class) {
464    std::ostringstream os1, os2;
465    java_lang_String->DumpClass(os1, mirror::Class::kDumpClassFullDetail);
466    String_class->DumpClass(os2, mirror::Class::kDumpClassFullDetail);
467    LOG(FATAL) << os1.str() << "\n\n" << os2.str();
468  }
469  mirror::Class::SetStatus(java_lang_DexCache, mirror::Class::kStatusNotReady, self);
470  CHECK_EQ(java_lang_DexCache.Get(), FindSystemClass(self, "Ljava/lang/DexCache;"));
471  CHECK_EQ(java_lang_DexCache->GetObjectSize(), mirror::DexCache::InstanceSize());
472
473  // Setup the primitive array type classes - can't be done until Object has a vtable.
474  SetClassRoot(kBooleanArrayClass, FindSystemClass(self, "[Z"));
475  mirror::BooleanArray::SetArrayClass(GetClassRoot(kBooleanArrayClass));
476
477  SetClassRoot(kByteArrayClass, FindSystemClass(self, "[B"));
478  mirror::ByteArray::SetArrayClass(GetClassRoot(kByteArrayClass));
479
480  CHECK_EQ(char_array_class.Get(), FindSystemClass(self, "[C"));
481
482  SetClassRoot(kShortArrayClass, FindSystemClass(self, "[S"));
483  mirror::ShortArray::SetArrayClass(GetClassRoot(kShortArrayClass));
484
485  CHECK_EQ(int_array_class.Get(), FindSystemClass(self, "[I"));
486
487  CHECK_EQ(long_array_class.Get(), FindSystemClass(self, "[J"));
488
489  SetClassRoot(kFloatArrayClass, FindSystemClass(self, "[F"));
490  mirror::FloatArray::SetArrayClass(GetClassRoot(kFloatArrayClass));
491
492  SetClassRoot(kDoubleArrayClass, FindSystemClass(self, "[D"));
493  mirror::DoubleArray::SetArrayClass(GetClassRoot(kDoubleArrayClass));
494
495  CHECK_EQ(class_array_class.Get(), FindSystemClass(self, "[Ljava/lang/Class;"));
496
497  CHECK_EQ(object_array_class.Get(), FindSystemClass(self, "[Ljava/lang/Object;"));
498
499  // Setup the single, global copy of "iftable".
500  auto java_lang_Cloneable = hs.NewHandle(FindSystemClass(self, "Ljava/lang/Cloneable;"));
501  CHECK(java_lang_Cloneable.Get() != nullptr);
502  auto java_io_Serializable = hs.NewHandle(FindSystemClass(self, "Ljava/io/Serializable;"));
503  CHECK(java_io_Serializable.Get() != nullptr);
504  // We assume that Cloneable/Serializable don't have superinterfaces -- normally we'd have to
505  // crawl up and explicitly list all of the supers as well.
506  array_iftable_.Read()->SetInterface(0, java_lang_Cloneable.Get());
507  array_iftable_.Read()->SetInterface(1, java_io_Serializable.Get());
508
509  // Sanity check Class[] and Object[]'s interfaces. GetDirectInterface may cause thread
510  // suspension.
511  CHECK_EQ(java_lang_Cloneable.Get(),
512           mirror::Class::GetDirectInterface(self, class_array_class, 0));
513  CHECK_EQ(java_io_Serializable.Get(),
514           mirror::Class::GetDirectInterface(self, class_array_class, 1));
515  CHECK_EQ(java_lang_Cloneable.Get(),
516           mirror::Class::GetDirectInterface(self, object_array_class, 0));
517  CHECK_EQ(java_io_Serializable.Get(),
518           mirror::Class::GetDirectInterface(self, object_array_class, 1));
519  // Run Class, ArtField, and ArtMethod through FindSystemClass. This initializes their
520  // dex_cache_ fields and register them in class_table_.
521  CHECK_EQ(java_lang_Class.Get(), FindSystemClass(self, "Ljava/lang/Class;"));
522
523  CHECK_EQ(object_array_string.Get(),
524           FindSystemClass(self, GetClassRootDescriptor(kJavaLangStringArrayClass)));
525
526  // End of special init trickery, subsequent classes may be loaded via FindSystemClass.
527
528  // Create java.lang.reflect.Proxy root.
529  SetClassRoot(kJavaLangReflectProxy, FindSystemClass(self, "Ljava/lang/reflect/Proxy;"));
530
531  // Create java.lang.reflect.Field.class root.
532  auto* class_root = FindSystemClass(self, "Ljava/lang/reflect/Field;");
533  CHECK(class_root != nullptr);
534  SetClassRoot(kJavaLangReflectField, class_root);
535  mirror::Field::SetClass(class_root);
536
537  // Create java.lang.reflect.Field array root.
538  class_root = FindSystemClass(self, "[Ljava/lang/reflect/Field;");
539  CHECK(class_root != nullptr);
540  SetClassRoot(kJavaLangReflectFieldArrayClass, class_root);
541  mirror::Field::SetArrayClass(class_root);
542
543  // Create java.lang.reflect.Constructor.class root and array root.
544  class_root = FindSystemClass(self, "Ljava/lang/reflect/Constructor;");
545  CHECK(class_root != nullptr);
546  SetClassRoot(kJavaLangReflectConstructor, class_root);
547  mirror::Constructor::SetClass(class_root);
548  class_root = FindSystemClass(self, "[Ljava/lang/reflect/Constructor;");
549  CHECK(class_root != nullptr);
550  SetClassRoot(kJavaLangReflectConstructorArrayClass, class_root);
551  mirror::Constructor::SetArrayClass(class_root);
552
553  // Create java.lang.reflect.Method.class root and array root.
554  class_root = FindSystemClass(self, "Ljava/lang/reflect/Method;");
555  CHECK(class_root != nullptr);
556  SetClassRoot(kJavaLangReflectMethod, class_root);
557  mirror::Method::SetClass(class_root);
558  class_root = FindSystemClass(self, "[Ljava/lang/reflect/Method;");
559  CHECK(class_root != nullptr);
560  SetClassRoot(kJavaLangReflectMethodArrayClass, class_root);
561  mirror::Method::SetArrayClass(class_root);
562
563  // java.lang.ref classes need to be specially flagged, but otherwise are normal classes
564  // finish initializing Reference class
565  mirror::Class::SetStatus(java_lang_ref_Reference, mirror::Class::kStatusNotReady, self);
566  CHECK_EQ(java_lang_ref_Reference.Get(), FindSystemClass(self, "Ljava/lang/ref/Reference;"));
567  CHECK_EQ(java_lang_ref_Reference->GetObjectSize(), mirror::Reference::InstanceSize());
568  CHECK_EQ(java_lang_ref_Reference->GetClassSize(),
569           mirror::Reference::ClassSize(image_pointer_size_));
570  class_root = FindSystemClass(self, "Ljava/lang/ref/FinalizerReference;");
571  class_root->SetAccessFlags(class_root->GetAccessFlags() |
572                             kAccClassIsReference | kAccClassIsFinalizerReference);
573  class_root = FindSystemClass(self, "Ljava/lang/ref/PhantomReference;");
574  class_root->SetAccessFlags(class_root->GetAccessFlags() | kAccClassIsReference |
575                             kAccClassIsPhantomReference);
576  class_root = FindSystemClass(self, "Ljava/lang/ref/SoftReference;");
577  class_root->SetAccessFlags(class_root->GetAccessFlags() | kAccClassIsReference);
578  class_root = FindSystemClass(self, "Ljava/lang/ref/WeakReference;");
579  class_root->SetAccessFlags(class_root->GetAccessFlags() | kAccClassIsReference |
580                             kAccClassIsWeakReference);
581
582  // Setup the ClassLoader, verifying the object_size_.
583  class_root = FindSystemClass(self, "Ljava/lang/ClassLoader;");
584  CHECK_EQ(class_root->GetObjectSize(), mirror::ClassLoader::InstanceSize());
585  SetClassRoot(kJavaLangClassLoader, class_root);
586
587  // Set up java.lang.Throwable, java.lang.ClassNotFoundException, and
588  // java.lang.StackTraceElement as a convenience.
589  SetClassRoot(kJavaLangThrowable, FindSystemClass(self, "Ljava/lang/Throwable;"));
590  mirror::Throwable::SetClass(GetClassRoot(kJavaLangThrowable));
591  SetClassRoot(kJavaLangClassNotFoundException,
592               FindSystemClass(self, "Ljava/lang/ClassNotFoundException;"));
593  SetClassRoot(kJavaLangStackTraceElement, FindSystemClass(self, "Ljava/lang/StackTraceElement;"));
594  SetClassRoot(kJavaLangStackTraceElementArrayClass,
595               FindSystemClass(self, "[Ljava/lang/StackTraceElement;"));
596  mirror::StackTraceElement::SetClass(GetClassRoot(kJavaLangStackTraceElement));
597
598  // Ensure void type is resolved in the core's dex cache so java.lang.Void is correctly
599  // initialized.
600  {
601    const DexFile& dex_file = java_lang_Object->GetDexFile();
602    const DexFile::StringId* void_string_id = dex_file.FindStringId("V");
603    CHECK(void_string_id != nullptr);
604    uint32_t void_string_index = dex_file.GetIndexForStringId(*void_string_id);
605    const DexFile::TypeId* void_type_id = dex_file.FindTypeId(void_string_index);
606    CHECK(void_type_id != nullptr);
607    uint16_t void_type_idx = dex_file.GetIndexForTypeId(*void_type_id);
608    // Now we resolve void type so the dex cache contains it. We use java.lang.Object class
609    // as referrer so the used dex cache is core's one.
610    mirror::Class* resolved_type = ResolveType(dex_file, void_type_idx, java_lang_Object.Get());
611    CHECK_EQ(resolved_type, GetClassRoot(kPrimitiveVoid));
612    self->AssertNoPendingException();
613  }
614
615  FinishInit(self);
616
617  VLOG(startup) << "ClassLinker::InitFromCompiler exiting";
618}
619
620void ClassLinker::FinishInit(Thread* self) {
621  VLOG(startup) << "ClassLinker::FinishInit entering";
622
623  // Let the heap know some key offsets into java.lang.ref instances
624  // Note: we hard code the field indexes here rather than using FindInstanceField
625  // as the types of the field can't be resolved prior to the runtime being
626  // fully initialized
627  mirror::Class* java_lang_ref_Reference = GetClassRoot(kJavaLangRefReference);
628  mirror::Class* java_lang_ref_FinalizerReference =
629      FindSystemClass(self, "Ljava/lang/ref/FinalizerReference;");
630
631  ArtField* pendingNext = java_lang_ref_Reference->GetInstanceField(0);
632  CHECK_STREQ(pendingNext->GetName(), "pendingNext");
633  CHECK_STREQ(pendingNext->GetTypeDescriptor(), "Ljava/lang/ref/Reference;");
634
635  ArtField* queue = java_lang_ref_Reference->GetInstanceField(1);
636  CHECK_STREQ(queue->GetName(), "queue");
637  CHECK_STREQ(queue->GetTypeDescriptor(), "Ljava/lang/ref/ReferenceQueue;");
638
639  ArtField* queueNext = java_lang_ref_Reference->GetInstanceField(2);
640  CHECK_STREQ(queueNext->GetName(), "queueNext");
641  CHECK_STREQ(queueNext->GetTypeDescriptor(), "Ljava/lang/ref/Reference;");
642
643  ArtField* referent = java_lang_ref_Reference->GetInstanceField(3);
644  CHECK_STREQ(referent->GetName(), "referent");
645  CHECK_STREQ(referent->GetTypeDescriptor(), "Ljava/lang/Object;");
646
647  ArtField* zombie = java_lang_ref_FinalizerReference->GetInstanceField(2);
648  CHECK_STREQ(zombie->GetName(), "zombie");
649  CHECK_STREQ(zombie->GetTypeDescriptor(), "Ljava/lang/Object;");
650
651  // ensure all class_roots_ are initialized
652  for (size_t i = 0; i < kClassRootsMax; i++) {
653    ClassRoot class_root = static_cast<ClassRoot>(i);
654    mirror::Class* klass = GetClassRoot(class_root);
655    CHECK(klass != nullptr);
656    DCHECK(klass->IsArrayClass() || klass->IsPrimitive() || klass->GetDexCache() != nullptr);
657    // note SetClassRoot does additional validation.
658    // if possible add new checks there to catch errors early
659  }
660
661  CHECK(!array_iftable_.IsNull());
662
663  // disable the slow paths in FindClass and CreatePrimitiveClass now
664  // that Object, Class, and Object[] are setup
665  init_done_ = true;
666
667  VLOG(startup) << "ClassLinker::FinishInit exiting";
668}
669
670void ClassLinker::RunRootClinits() {
671  Thread* self = Thread::Current();
672  for (size_t i = 0; i < ClassLinker::kClassRootsMax; ++i) {
673    mirror::Class* c = GetClassRoot(ClassRoot(i));
674    if (!c->IsArrayClass() && !c->IsPrimitive()) {
675      StackHandleScope<1> hs(self);
676      Handle<mirror::Class> h_class(hs.NewHandle(GetClassRoot(ClassRoot(i))));
677      EnsureInitialized(self, h_class, true, true);
678      self->AssertNoPendingException();
679    }
680  }
681}
682
683const OatFile* ClassLinker::RegisterOatFile(const OatFile* oat_file) {
684  WriterMutexLock mu(Thread::Current(), dex_lock_);
685  if (kIsDebugBuild) {
686    for (size_t i = 0; i < oat_files_.size(); ++i) {
687      CHECK_NE(oat_file, oat_files_[i]) << oat_file->GetLocation();
688    }
689  }
690  VLOG(class_linker) << "Registering " << oat_file->GetLocation();
691  oat_files_.push_back(oat_file);
692  return oat_file;
693}
694
695OatFile& ClassLinker::GetImageOatFile(gc::space::ImageSpace* space) {
696  VLOG(startup) << "ClassLinker::GetImageOatFile entering";
697  OatFile* oat_file = space->ReleaseOatFile();
698  CHECK_EQ(RegisterOatFile(oat_file), oat_file);
699  VLOG(startup) << "ClassLinker::GetImageOatFile exiting";
700  return *oat_file;
701}
702
703class DexFileAndClassPair : ValueObject {
704 public:
705  DexFileAndClassPair(const DexFile* dex_file, size_t current_class_index, bool from_loaded_oat)
706     : cached_descriptor_(GetClassDescriptor(dex_file, current_class_index)),
707       dex_file_(dex_file),
708       current_class_index_(current_class_index),
709       from_loaded_oat_(from_loaded_oat) {}
710
711  DexFileAndClassPair(const DexFileAndClassPair&) = default;
712
713  DexFileAndClassPair& operator=(const DexFileAndClassPair& rhs) {
714    cached_descriptor_ = rhs.cached_descriptor_;
715    dex_file_ = rhs.dex_file_;
716    current_class_index_ = rhs.current_class_index_;
717    from_loaded_oat_ = rhs.from_loaded_oat_;
718    return *this;
719  }
720
721  const char* GetCachedDescriptor() const {
722    return cached_descriptor_;
723  }
724
725  bool operator<(const DexFileAndClassPair& rhs) const {
726    const char* lhsDescriptor = cached_descriptor_;
727    const char* rhsDescriptor = rhs.cached_descriptor_;
728    int cmp = strcmp(lhsDescriptor, rhsDescriptor);
729    if (cmp != 0) {
730      // Note that the order must be reversed. We want to iterate over the classes in dex files.
731      // They are sorted lexicographically. Thus, the priority-queue must be a min-queue.
732      return cmp > 0;
733    }
734    return dex_file_ < rhs.dex_file_;
735  }
736
737  bool DexFileHasMoreClasses() const {
738    return current_class_index_ + 1 < dex_file_->NumClassDefs();
739  }
740
741  DexFileAndClassPair GetNext() const {
742    return DexFileAndClassPair(dex_file_, current_class_index_ + 1, from_loaded_oat_);
743  }
744
745  size_t GetCurrentClassIndex() const {
746    return current_class_index_;
747  }
748
749  bool FromLoadedOat() const {
750    return from_loaded_oat_;
751  }
752
753  const DexFile* GetDexFile() const {
754    return dex_file_;
755  }
756
757  void DeleteDexFile() {
758    delete dex_file_;
759    dex_file_ = nullptr;
760  }
761
762 private:
763  static const char* GetClassDescriptor(const DexFile* dex_file, size_t index) {
764    const DexFile::ClassDef& class_def = dex_file->GetClassDef(static_cast<uint16_t>(index));
765    return dex_file->StringByTypeIdx(class_def.class_idx_);
766  }
767
768  const char* cached_descriptor_;
769  const DexFile* dex_file_;
770  size_t current_class_index_;
771  bool from_loaded_oat_;  // We only need to compare mismatches between what we load now
772                          // and what was loaded before. Any old duplicates must have been
773                          // OK, and any new "internal" duplicates are as well (they must
774                          // be from multidex, which resolves correctly).
775};
776
777static void AddDexFilesFromOat(const OatFile* oat_file, bool already_loaded,
778                               std::priority_queue<DexFileAndClassPair>* heap) {
779  const std::vector<const OatDexFile*>& oat_dex_files = oat_file->GetOatDexFiles();
780  for (const OatDexFile* oat_dex_file : oat_dex_files) {
781    std::string error;
782    std::unique_ptr<const DexFile> dex_file = oat_dex_file->OpenDexFile(&error);
783    if (dex_file.get() == nullptr) {
784      LOG(WARNING) << "Could not create dex file from oat file: " << error;
785    } else {
786      if (dex_file->NumClassDefs() > 0U) {
787        heap->emplace(dex_file.release(), 0U, already_loaded);
788      }
789    }
790  }
791}
792
793static void AddNext(DexFileAndClassPair* original,
794                    std::priority_queue<DexFileAndClassPair>* heap) {
795  if (original->DexFileHasMoreClasses()) {
796    heap->push(original->GetNext());
797  } else {
798    // Need to delete the dex file.
799    original->DeleteDexFile();
800  }
801}
802
803static void FreeDexFilesInHeap(std::priority_queue<DexFileAndClassPair>* heap) {
804  while (!heap->empty()) {
805    delete heap->top().GetDexFile();
806    heap->pop();
807  }
808}
809
810const OatFile* ClassLinker::GetBootOatFile() {
811  gc::space::ImageSpace* image_space = Runtime::Current()->GetHeap()->GetImageSpace();
812  if (image_space == nullptr) {
813    return nullptr;
814  }
815  return image_space->GetOatFile();
816}
817
818const OatFile* ClassLinker::GetPrimaryOatFile() {
819  ReaderMutexLock mu(Thread::Current(), dex_lock_);
820  const OatFile* boot_oat_file = GetBootOatFile();
821  if (boot_oat_file != nullptr) {
822    for (const OatFile* oat_file : oat_files_) {
823      if (oat_file != boot_oat_file) {
824        return oat_file;
825      }
826    }
827  }
828  return nullptr;
829}
830
831// Check for class-def collisions in dex files.
832//
833// This works by maintaining a heap with one class from each dex file, sorted by the class
834// descriptor. Then a dex-file/class pair is continually removed from the heap and compared
835// against the following top element. If the descriptor is the same, it is now checked whether
836// the two elements agree on whether their dex file was from an already-loaded oat-file or the
837// new oat file. Any disagreement indicates a collision.
838bool ClassLinker::HasCollisions(const OatFile* oat_file, std::string* error_msg) {
839  if (!kDuplicateClassesCheck) {
840    return false;
841  }
842
843  // Dex files are registered late - once a class is actually being loaded. We have to compare
844  // against the open oat files. Take the dex_lock_ that protects oat_files_ accesses.
845  ReaderMutexLock mu(Thread::Current(), dex_lock_);
846
847  std::priority_queue<DexFileAndClassPair> queue;
848
849  // Add dex files from already loaded oat files, but skip boot.
850  {
851    const OatFile* boot_oat = GetBootOatFile();
852    for (const OatFile* loaded_oat_file : oat_files_) {
853      if (loaded_oat_file == boot_oat) {
854        continue;
855      }
856      AddDexFilesFromOat(loaded_oat_file, true, &queue);
857    }
858  }
859
860  if (queue.empty()) {
861    // No other oat files, return early.
862    return false;
863  }
864
865  // Add dex files from the oat file to check.
866  AddDexFilesFromOat(oat_file, false, &queue);
867
868  // Now drain the queue.
869  while (!queue.empty()) {
870    DexFileAndClassPair compare_pop = queue.top();
871    queue.pop();
872
873    // Compare against the following elements.
874    while (!queue.empty()) {
875      DexFileAndClassPair top = queue.top();
876
877      if (strcmp(compare_pop.GetCachedDescriptor(), top.GetCachedDescriptor()) == 0) {
878        // Same descriptor. Check whether it's crossing old-oat-files to new-oat-files.
879        if (compare_pop.FromLoadedOat() != top.FromLoadedOat()) {
880          *error_msg =
881              StringPrintf("Found duplicated class when checking oat files: '%s' in %s and %s",
882                           compare_pop.GetCachedDescriptor(),
883                           compare_pop.GetDexFile()->GetLocation().c_str(),
884                           top.GetDexFile()->GetLocation().c_str());
885          FreeDexFilesInHeap(&queue);
886          return true;
887        }
888        // Pop it.
889        queue.pop();
890        AddNext(&top, &queue);
891      } else {
892        // Something else. Done here.
893        break;
894      }
895    }
896    AddNext(&compare_pop, &queue);
897  }
898
899  return false;
900}
901
902std::vector<std::unique_ptr<const DexFile>> ClassLinker::OpenDexFilesFromOat(
903    const char* dex_location, const char* oat_location,
904    std::vector<std::string>* error_msgs) {
905  CHECK(error_msgs != nullptr);
906
907  // Verify we aren't holding the mutator lock, which could starve GC if we
908  // have to generate or relocate an oat file.
909  Locks::mutator_lock_->AssertNotHeld(Thread::Current());
910
911  OatFileAssistant oat_file_assistant(dex_location, oat_location, kRuntimeISA,
912     !Runtime::Current()->IsAotCompiler());
913
914  // Lock the target oat location to avoid races generating and loading the
915  // oat file.
916  std::string error_msg;
917  if (!oat_file_assistant.Lock(&error_msg)) {
918    // Don't worry too much if this fails. If it does fail, it's unlikely we
919    // can generate an oat file anyway.
920    VLOG(class_linker) << "OatFileAssistant::Lock: " << error_msg;
921  }
922
923  // Check if we already have an up-to-date oat file open.
924  const OatFile* source_oat_file = nullptr;
925  {
926    ReaderMutexLock mu(Thread::Current(), dex_lock_);
927    for (const OatFile* oat_file : oat_files_) {
928      CHECK(oat_file != nullptr);
929      if (oat_file_assistant.GivenOatFileIsUpToDate(*oat_file)) {
930        source_oat_file = oat_file;
931        break;
932      }
933    }
934  }
935
936  // If we didn't have an up-to-date oat file open, try to load one from disk.
937  if (source_oat_file == nullptr) {
938    // Update the oat file on disk if we can. This may fail, but that's okay.
939    // Best effort is all that matters here.
940    if (!oat_file_assistant.MakeUpToDate(&error_msg)) {
941      LOG(WARNING) << error_msg;
942    }
943
944    // Get the oat file on disk.
945    std::unique_ptr<OatFile> oat_file = oat_file_assistant.GetBestOatFile();
946    if (oat_file.get() != nullptr) {
947      // Take the file only if it has no collisions, or we must take it because of preopting.
948      bool accept_oat_file = !HasCollisions(oat_file.get(), &error_msg);
949      if (!accept_oat_file) {
950        // Failed the collision check. Print warning.
951        if (Runtime::Current()->IsDexFileFallbackEnabled()) {
952          LOG(WARNING) << "Found duplicate classes, falling back to interpreter mode for "
953                       << dex_location;
954        } else {
955          LOG(WARNING) << "Found duplicate classes, dex-file-fallback disabled, will be failing to "
956                          " load classes for " << dex_location;
957        }
958        LOG(WARNING) << error_msg;
959
960        // However, if the app was part of /system and preopted, there is no original dex file
961        // available. In that case grudgingly accept the oat file.
962        if (!DexFile::MaybeDex(dex_location)) {
963          accept_oat_file = true;
964          LOG(WARNING) << "Dex location " << dex_location << " does not seem to include dex file. "
965                       << "Allow oat file use. This is potentially dangerous.";
966        }
967      }
968
969      if (accept_oat_file) {
970        source_oat_file = oat_file.release();
971        RegisterOatFile(source_oat_file);
972      }
973    }
974  }
975
976  std::vector<std::unique_ptr<const DexFile>> dex_files;
977
978  // Load the dex files from the oat file.
979  if (source_oat_file != nullptr) {
980    dex_files = oat_file_assistant.LoadDexFiles(*source_oat_file, dex_location);
981    if (dex_files.empty()) {
982      error_msgs->push_back("Failed to open dex files from "
983          + source_oat_file->GetLocation());
984    }
985  }
986
987  // Fall back to running out of the original dex file if we couldn't load any
988  // dex_files from the oat file.
989  if (dex_files.empty()) {
990    if (oat_file_assistant.HasOriginalDexFiles()) {
991      if (Runtime::Current()->IsDexFileFallbackEnabled()) {
992        if (!DexFile::Open(dex_location, dex_location, &error_msg, &dex_files)) {
993          LOG(WARNING) << error_msg;
994          error_msgs->push_back("Failed to open dex files from " + std::string(dex_location));
995        }
996      } else {
997        error_msgs->push_back("Fallback mode disabled, skipping dex files.");
998      }
999    } else {
1000      error_msgs->push_back("No original dex files found for dex location "
1001          + std::string(dex_location));
1002    }
1003  }
1004  return dex_files;
1005}
1006
1007const OatFile* ClassLinker::FindOpenedOatFileFromOatLocation(const std::string& oat_location) {
1008  ReaderMutexLock mu(Thread::Current(), dex_lock_);
1009  for (size_t i = 0; i < oat_files_.size(); i++) {
1010    const OatFile* oat_file = oat_files_[i];
1011    DCHECK(oat_file != nullptr);
1012    if (oat_file->GetLocation() == oat_location) {
1013      return oat_file;
1014    }
1015  }
1016  return nullptr;
1017}
1018
1019static void SanityCheckArtMethod(ArtMethod* m, mirror::Class* expected_class,
1020                                 gc::space::ImageSpace* space)
1021    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1022  if (m->IsRuntimeMethod()) {
1023    CHECK(m->GetDeclaringClass() == nullptr) << PrettyMethod(m);
1024  } else if (m->IsMiranda()) {
1025    CHECK(m->GetDeclaringClass() != nullptr) << PrettyMethod(m);
1026  } else if (expected_class != nullptr) {
1027    CHECK_EQ(m->GetDeclaringClassUnchecked(), expected_class) << PrettyMethod(m);
1028  }
1029  if (space != nullptr) {
1030    auto& header = space->GetImageHeader();
1031    auto& methods = header.GetMethodsSection();
1032    auto offset = reinterpret_cast<uint8_t*>(m) - space->Begin();
1033    CHECK(methods.Contains(offset)) << m << " not in " << methods;
1034  }
1035}
1036
1037static void SanityCheckArtMethodPointerArray(
1038    mirror::PointerArray* arr, mirror::Class* expected_class, size_t pointer_size,
1039    gc::space::ImageSpace* space) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1040  CHECK(arr != nullptr);
1041  for (int32_t j = 0; j < arr->GetLength(); ++j) {
1042    auto* method = arr->GetElementPtrSize<ArtMethod*>(j, pointer_size);
1043    // expected_class == null means we are a dex cache.
1044    if (expected_class != nullptr) {
1045      CHECK(method != nullptr);
1046    }
1047    if (method != nullptr) {
1048      SanityCheckArtMethod(method, expected_class, space);
1049    }
1050  }
1051}
1052
1053static void SanityCheckObjectsCallback(mirror::Object* obj, void* arg ATTRIBUTE_UNUSED)
1054    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1055  DCHECK(obj != nullptr);
1056  CHECK(obj->GetClass() != nullptr) << "Null class in object " << obj;
1057  CHECK(obj->GetClass()->GetClass() != nullptr) << "Null class class " << obj;
1058  if (obj->IsClass()) {
1059    auto klass = obj->AsClass();
1060    ArtField* fields[2] = { klass->GetSFields(), klass->GetIFields() };
1061    size_t num_fields[2] = { klass->NumStaticFields(), klass->NumInstanceFields() };
1062    for (size_t i = 0; i < 2; ++i) {
1063      for (size_t j = 0; j < num_fields[i]; ++j) {
1064        CHECK_EQ(fields[i][j].GetDeclaringClass(), klass);
1065      }
1066    }
1067    auto* runtime = Runtime::Current();
1068    auto* image_space = runtime->GetHeap()->GetImageSpace();
1069    auto pointer_size = runtime->GetClassLinker()->GetImagePointerSize();
1070    for (auto& m : klass->GetDirectMethods(pointer_size)) {
1071      SanityCheckArtMethod(&m, klass, image_space);
1072    }
1073    for (auto& m : klass->GetVirtualMethods(pointer_size)) {
1074      SanityCheckArtMethod(&m, klass, image_space);
1075    }
1076    auto* vtable = klass->GetVTable();
1077    if (vtable != nullptr) {
1078      SanityCheckArtMethodPointerArray(vtable, nullptr, pointer_size, image_space);
1079    }
1080    if (klass->ShouldHaveEmbeddedImtAndVTable()) {
1081      for (size_t i = 0; i < mirror::Class::kImtSize; ++i) {
1082        SanityCheckArtMethod(klass->GetEmbeddedImTableEntry(i, pointer_size), nullptr, image_space);
1083      }
1084      for (int32_t i = 0; i < klass->GetEmbeddedVTableLength(); ++i) {
1085        SanityCheckArtMethod(klass->GetEmbeddedVTableEntry(i, pointer_size), nullptr, image_space);
1086      }
1087    }
1088    auto* iftable = klass->GetIfTable();
1089    if (iftable != nullptr) {
1090      for (int32_t i = 0; i < klass->GetIfTableCount(); ++i) {
1091        if (iftable->GetMethodArrayCount(i) > 0) {
1092          SanityCheckArtMethodPointerArray(iftable->GetMethodArray(i), nullptr, pointer_size,
1093                                           image_space);
1094        }
1095      }
1096    }
1097  }
1098}
1099
1100void ClassLinker::InitFromImage() {
1101  VLOG(startup) << "ClassLinker::InitFromImage entering";
1102  CHECK(!init_done_);
1103
1104  Runtime* const runtime = Runtime::Current();
1105  Thread* const self = Thread::Current();
1106  gc::Heap* const heap = runtime->GetHeap();
1107  gc::space::ImageSpace* const space = heap->GetImageSpace();
1108  CHECK(space != nullptr);
1109  image_pointer_size_ = space->GetImageHeader().GetPointerSize();
1110  dex_cache_image_class_lookup_required_ = true;
1111  OatFile& oat_file = GetImageOatFile(space);
1112  CHECK_EQ(oat_file.GetOatHeader().GetImageFileLocationOatChecksum(), 0U);
1113  CHECK_EQ(oat_file.GetOatHeader().GetImageFileLocationOatDataBegin(), 0U);
1114  const char* image_file_location = oat_file.GetOatHeader().
1115      GetStoreValueByKey(OatHeader::kImageLocationKey);
1116  CHECK(image_file_location == nullptr || *image_file_location == 0);
1117  quick_resolution_trampoline_ = oat_file.GetOatHeader().GetQuickResolutionTrampoline();
1118  quick_imt_conflict_trampoline_ = oat_file.GetOatHeader().GetQuickImtConflictTrampoline();
1119  quick_generic_jni_trampoline_ = oat_file.GetOatHeader().GetQuickGenericJniTrampoline();
1120  quick_to_interpreter_bridge_trampoline_ = oat_file.GetOatHeader().GetQuickToInterpreterBridge();
1121  mirror::Object* dex_caches_object = space->GetImageHeader().GetImageRoot(ImageHeader::kDexCaches);
1122  mirror::ObjectArray<mirror::DexCache>* dex_caches =
1123      dex_caches_object->AsObjectArray<mirror::DexCache>();
1124
1125  StackHandleScope<1> hs(self);
1126  Handle<mirror::ObjectArray<mirror::Class>> class_roots(hs.NewHandle(
1127          space->GetImageHeader().GetImageRoot(ImageHeader::kClassRoots)->
1128          AsObjectArray<mirror::Class>()));
1129  class_roots_ = GcRoot<mirror::ObjectArray<mirror::Class>>(class_roots.Get());
1130
1131  // Special case of setting up the String class early so that we can test arbitrary objects
1132  // as being Strings or not
1133  mirror::String::SetClass(GetClassRoot(kJavaLangString));
1134
1135  CHECK_EQ(oat_file.GetOatHeader().GetDexFileCount(),
1136           static_cast<uint32_t>(dex_caches->GetLength()));
1137  for (int32_t i = 0; i < dex_caches->GetLength(); i++) {
1138    StackHandleScope<1> hs2(self);
1139    Handle<mirror::DexCache> dex_cache(hs2.NewHandle(dex_caches->Get(i)));
1140    const std::string& dex_file_location(dex_cache->GetLocation()->ToModifiedUtf8());
1141    const OatFile::OatDexFile* oat_dex_file = oat_file.GetOatDexFile(dex_file_location.c_str(),
1142                                                                     nullptr);
1143    CHECK(oat_dex_file != nullptr) << oat_file.GetLocation() << " " << dex_file_location;
1144    std::string error_msg;
1145    std::unique_ptr<const DexFile> dex_file = oat_dex_file->OpenDexFile(&error_msg);
1146    if (dex_file.get() == nullptr) {
1147      LOG(FATAL) << "Failed to open dex file " << dex_file_location
1148                 << " from within oat file " << oat_file.GetLocation()
1149                 << " error '" << error_msg << "'";
1150      UNREACHABLE();
1151    }
1152
1153    if (kSanityCheckObjects) {
1154      SanityCheckArtMethodPointerArray(dex_cache->GetResolvedMethods(), nullptr,
1155                                       image_pointer_size_, space);
1156    }
1157
1158    CHECK_EQ(dex_file->GetLocationChecksum(), oat_dex_file->GetDexFileLocationChecksum());
1159
1160    AppendToBootClassPath(*dex_file.get(), dex_cache);
1161    opened_dex_files_.push_back(std::move(dex_file));
1162  }
1163
1164  CHECK(ValidPointerSize(image_pointer_size_)) << image_pointer_size_;
1165
1166  // Set classes on AbstractMethod early so that IsMethod tests can be performed during the live
1167  // bitmap walk.
1168  if (!runtime->IsAotCompiler()) {
1169    // Only the Aot compiler supports having an image with a different pointer size than the
1170    // runtime. This happens on the host for compile 32 bit tests since we use a 64 bit libart
1171    // compiler. We may also use 32 bit dex2oat on a system with 64 bit apps.
1172    CHECK_EQ(image_pointer_size_, sizeof(void*));
1173  }
1174
1175  if (kSanityCheckObjects) {
1176    for (int32_t i = 0; i < dex_caches->GetLength(); i++) {
1177      auto* dex_cache = dex_caches->Get(i);
1178      for (size_t j = 0; j < dex_cache->NumResolvedFields(); ++j) {
1179        auto* field = dex_cache->GetResolvedField(j, image_pointer_size_);
1180        if (field != nullptr) {
1181          CHECK(field->GetDeclaringClass()->GetClass() != nullptr);
1182        }
1183      }
1184    }
1185    heap->VisitObjects(SanityCheckObjectsCallback, nullptr);
1186  }
1187
1188  // Set entry point to interpreter if in InterpretOnly mode.
1189  if (!runtime->IsAotCompiler() && runtime->GetInstrumentation()->InterpretOnly()) {
1190    const auto& header = space->GetImageHeader();
1191    const auto& methods = header.GetMethodsSection();
1192    const auto art_method_size = ArtMethod::ObjectSize(image_pointer_size_);
1193    for (uintptr_t pos = 0; pos < methods.Size(); pos += art_method_size) {
1194      auto* method = reinterpret_cast<ArtMethod*>(space->Begin() + pos + methods.Offset());
1195      if (kIsDebugBuild && !method->IsRuntimeMethod()) {
1196        CHECK(method->GetDeclaringClass() != nullptr);
1197      }
1198      if (!method->IsNative()) {
1199        method->SetEntryPointFromInterpreterPtrSize(
1200            artInterpreterToInterpreterBridge, image_pointer_size_);
1201        if (!method->IsRuntimeMethod() && method != runtime->GetResolutionMethod()) {
1202          method->SetEntryPointFromQuickCompiledCodePtrSize(GetQuickToInterpreterBridge(),
1203                                                            image_pointer_size_);
1204        }
1205      }
1206    }
1207  }
1208
1209  // reinit class_roots_
1210  mirror::Class::SetClassClass(class_roots->Get(kJavaLangClass));
1211  class_roots_ = GcRoot<mirror::ObjectArray<mirror::Class>>(class_roots.Get());
1212
1213  // reinit array_iftable_ from any array class instance, they should be ==
1214  array_iftable_ = GcRoot<mirror::IfTable>(GetClassRoot(kObjectArrayClass)->GetIfTable());
1215  DCHECK_EQ(array_iftable_.Read(), GetClassRoot(kBooleanArrayClass)->GetIfTable());
1216  // String class root was set above
1217  mirror::Field::SetClass(GetClassRoot(kJavaLangReflectField));
1218  mirror::Field::SetArrayClass(GetClassRoot(kJavaLangReflectFieldArrayClass));
1219  mirror::Constructor::SetClass(GetClassRoot(kJavaLangReflectConstructor));
1220  mirror::Constructor::SetArrayClass(GetClassRoot(kJavaLangReflectConstructorArrayClass));
1221  mirror::Method::SetClass(GetClassRoot(kJavaLangReflectMethod));
1222  mirror::Method::SetArrayClass(GetClassRoot(kJavaLangReflectMethodArrayClass));
1223  mirror::Reference::SetClass(GetClassRoot(kJavaLangRefReference));
1224  mirror::BooleanArray::SetArrayClass(GetClassRoot(kBooleanArrayClass));
1225  mirror::ByteArray::SetArrayClass(GetClassRoot(kByteArrayClass));
1226  mirror::CharArray::SetArrayClass(GetClassRoot(kCharArrayClass));
1227  mirror::DoubleArray::SetArrayClass(GetClassRoot(kDoubleArrayClass));
1228  mirror::FloatArray::SetArrayClass(GetClassRoot(kFloatArrayClass));
1229  mirror::IntArray::SetArrayClass(GetClassRoot(kIntArrayClass));
1230  mirror::LongArray::SetArrayClass(GetClassRoot(kLongArrayClass));
1231  mirror::ShortArray::SetArrayClass(GetClassRoot(kShortArrayClass));
1232  mirror::Throwable::SetClass(GetClassRoot(kJavaLangThrowable));
1233  mirror::StackTraceElement::SetClass(GetClassRoot(kJavaLangStackTraceElement));
1234
1235  FinishInit(self);
1236
1237  VLOG(startup) << "ClassLinker::InitFromImage exiting";
1238}
1239
1240bool ClassLinker::ClassInClassTable(mirror::Class* klass) {
1241  ReaderMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
1242  auto it = class_table_.Find(GcRoot<mirror::Class>(klass));
1243  if (it == class_table_.end()) {
1244    return false;
1245  }
1246  return it->Read() == klass;
1247}
1248
1249void ClassLinker::VisitClassRoots(RootVisitor* visitor, VisitRootFlags flags) {
1250  WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
1251  BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
1252      visitor, RootInfo(kRootStickyClass));
1253  if ((flags & kVisitRootFlagAllRoots) != 0) {
1254    // Argument for how root visiting deals with ArtField and ArtMethod roots.
1255    // There is 3 GC cases to handle:
1256    // Non moving concurrent:
1257    // This case is easy to handle since the reference members of ArtMethod and ArtFields are held
1258    // live by the class and class roots. In this case we probably don't even need to call
1259    // VisitNativeRoots.
1260    //
1261    // Moving non-concurrent:
1262    // This case needs to call visit VisitNativeRoots in case the classes or dex cache arrays move.
1263    // To prevent missing roots, this case needs to ensure that there is no
1264    // suspend points between the point which we allocate ArtMethod arrays and place them in a
1265    // class which is in the class table.
1266    //
1267    // Moving concurrent:
1268    // Need to make sure to not copy ArtMethods without doing read barriers since the roots are
1269    // marked concurrently and we don't hold the classlinker_classes_lock_ when we do the copy.
1270    for (GcRoot<mirror::Class>& root : class_table_) {
1271      buffered_visitor.VisitRoot(root);
1272      if ((flags & kVisitRootFlagNonMoving) == 0) {
1273        // Don't bother visiting ArtField and ArtMethod if kVisitRootFlagNonMoving is set since
1274        // these roots are all reachable from the class or dex cache.
1275        root.Read()->VisitNativeRoots(buffered_visitor, image_pointer_size_);
1276      }
1277    }
1278    // PreZygote classes can't move so we won't need to update fields' declaring classes.
1279    for (GcRoot<mirror::Class>& root : pre_zygote_class_table_) {
1280      buffered_visitor.VisitRoot(root);
1281      if ((flags & kVisitRootFlagNonMoving) == 0) {
1282        root.Read()->VisitNativeRoots(buffered_visitor, image_pointer_size_);
1283      }
1284    }
1285  } else if ((flags & kVisitRootFlagNewRoots) != 0) {
1286    for (auto& root : new_class_roots_) {
1287      mirror::Class* old_ref = root.Read<kWithoutReadBarrier>();
1288      old_ref->VisitNativeRoots(buffered_visitor, image_pointer_size_);
1289      root.VisitRoot(visitor, RootInfo(kRootStickyClass));
1290      mirror::Class* new_ref = root.Read<kWithoutReadBarrier>();
1291      if (UNLIKELY(new_ref != old_ref)) {
1292        // Uh ohes, GC moved a root in the log. Need to search the class_table and update the
1293        // corresponding object. This is slow, but luckily for us, this may only happen with a
1294        // concurrent moving GC.
1295        auto it = class_table_.Find(GcRoot<mirror::Class>(old_ref));
1296        DCHECK(it != class_table_.end());
1297        *it = GcRoot<mirror::Class>(new_ref);
1298      }
1299    }
1300  }
1301  buffered_visitor.Flush();  // Flush before clearing new_class_roots_.
1302  if ((flags & kVisitRootFlagClearRootLog) != 0) {
1303    new_class_roots_.clear();
1304  }
1305  if ((flags & kVisitRootFlagStartLoggingNewRoots) != 0) {
1306    log_new_class_table_roots_ = true;
1307  } else if ((flags & kVisitRootFlagStopLoggingNewRoots) != 0) {
1308    log_new_class_table_roots_ = false;
1309  }
1310  // We deliberately ignore the class roots in the image since we
1311  // handle image roots by using the MS/CMS rescanning of dirty cards.
1312}
1313
1314// Keep in sync with InitCallback. Anything we visit, we need to
1315// reinit references to when reinitializing a ClassLinker from a
1316// mapped image.
1317void ClassLinker::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
1318  class_roots_.VisitRootIfNonNull(visitor, RootInfo(kRootVMInternal));
1319  Thread* const self = Thread::Current();
1320  {
1321    ReaderMutexLock mu(self, dex_lock_);
1322    if ((flags & kVisitRootFlagAllRoots) != 0) {
1323      for (GcRoot<mirror::DexCache>& dex_cache : dex_caches_) {
1324        dex_cache.VisitRoot(visitor, RootInfo(kRootVMInternal));
1325      }
1326    } else if ((flags & kVisitRootFlagNewRoots) != 0) {
1327      for (size_t index : new_dex_cache_roots_) {
1328        dex_caches_[index].VisitRoot(visitor, RootInfo(kRootVMInternal));
1329      }
1330    }
1331    if ((flags & kVisitRootFlagClearRootLog) != 0) {
1332      new_dex_cache_roots_.clear();
1333    }
1334    if ((flags & kVisitRootFlagStartLoggingNewRoots) != 0) {
1335      log_new_dex_caches_roots_ = true;
1336    } else if ((flags & kVisitRootFlagStopLoggingNewRoots) != 0) {
1337      log_new_dex_caches_roots_ = false;
1338    }
1339  }
1340  VisitClassRoots(visitor, flags);
1341  array_iftable_.VisitRootIfNonNull(visitor, RootInfo(kRootVMInternal));
1342  for (GcRoot<mirror::Class>& root : find_array_class_cache_) {
1343    root.VisitRootIfNonNull(visitor, RootInfo(kRootVMInternal));
1344  }
1345}
1346
1347void ClassLinker::VisitClasses(ClassVisitor* visitor, void* arg) {
1348  if (dex_cache_image_class_lookup_required_) {
1349    MoveImageClassesToClassTable();
1350  }
1351  // TODO: why isn't this a ReaderMutexLock?
1352  WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
1353  for (GcRoot<mirror::Class>& root : class_table_) {
1354    if (!visitor(root.Read(), arg)) {
1355      return;
1356    }
1357  }
1358  for (GcRoot<mirror::Class>& root : pre_zygote_class_table_) {
1359    if (!visitor(root.Read(), arg)) {
1360      return;
1361    }
1362  }
1363}
1364
1365static bool GetClassesVisitorSet(mirror::Class* c, void* arg) {
1366  std::set<mirror::Class*>* classes = reinterpret_cast<std::set<mirror::Class*>*>(arg);
1367  classes->insert(c);
1368  return true;
1369}
1370
1371struct GetClassesVisitorArrayArg {
1372  Handle<mirror::ObjectArray<mirror::Class>>* classes;
1373  int32_t index;
1374  bool success;
1375};
1376
1377static bool GetClassesVisitorArray(mirror::Class* c, void* varg)
1378    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1379  GetClassesVisitorArrayArg* arg = reinterpret_cast<GetClassesVisitorArrayArg*>(varg);
1380  if (arg->index < (*arg->classes)->GetLength()) {
1381    (*arg->classes)->Set(arg->index, c);
1382    arg->index++;
1383    return true;
1384  } else {
1385    arg->success = false;
1386    return false;
1387  }
1388}
1389
1390void ClassLinker::VisitClassesWithoutClassesLock(ClassVisitor* visitor, void* arg) {
1391  // TODO: it may be possible to avoid secondary storage if we iterate over dex caches. The problem
1392  // is avoiding duplicates.
1393  if (!kMovingClasses) {
1394    std::set<mirror::Class*> classes;
1395    VisitClasses(GetClassesVisitorSet, &classes);
1396    for (mirror::Class* klass : classes) {
1397      if (!visitor(klass, arg)) {
1398        return;
1399      }
1400    }
1401  } else {
1402    Thread* self = Thread::Current();
1403    StackHandleScope<1> hs(self);
1404    MutableHandle<mirror::ObjectArray<mirror::Class>> classes =
1405        hs.NewHandle<mirror::ObjectArray<mirror::Class>>(nullptr);
1406    GetClassesVisitorArrayArg local_arg;
1407    local_arg.classes = &classes;
1408    local_arg.success = false;
1409    // We size the array assuming classes won't be added to the class table during the visit.
1410    // If this assumption fails we iterate again.
1411    while (!local_arg.success) {
1412      size_t class_table_size;
1413      {
1414        ReaderMutexLock mu(self, *Locks::classlinker_classes_lock_);
1415        class_table_size = class_table_.Size() + pre_zygote_class_table_.Size();
1416      }
1417      mirror::Class* class_type = mirror::Class::GetJavaLangClass();
1418      mirror::Class* array_of_class = FindArrayClass(self, &class_type);
1419      classes.Assign(
1420          mirror::ObjectArray<mirror::Class>::Alloc(self, array_of_class, class_table_size));
1421      CHECK(classes.Get() != nullptr);  // OOME.
1422      local_arg.index = 0;
1423      local_arg.success = true;
1424      VisitClasses(GetClassesVisitorArray, &local_arg);
1425    }
1426    for (int32_t i = 0; i < classes->GetLength(); ++i) {
1427      // If the class table shrank during creation of the clases array we expect null elements. If
1428      // the class table grew then the loop repeats. If classes are created after the loop has
1429      // finished then we don't visit.
1430      mirror::Class* klass = classes->Get(i);
1431      if (klass != nullptr && !visitor(klass, arg)) {
1432        return;
1433      }
1434    }
1435  }
1436}
1437
1438ClassLinker::~ClassLinker() {
1439  mirror::Class::ResetClass();
1440  mirror::Constructor::ResetClass();
1441  mirror::Field::ResetClass();
1442  mirror::Method::ResetClass();
1443  mirror::Reference::ResetClass();
1444  mirror::StackTraceElement::ResetClass();
1445  mirror::String::ResetClass();
1446  mirror::Throwable::ResetClass();
1447  mirror::BooleanArray::ResetArrayClass();
1448  mirror::ByteArray::ResetArrayClass();
1449  mirror::CharArray::ResetArrayClass();
1450  mirror::Constructor::ResetArrayClass();
1451  mirror::DoubleArray::ResetArrayClass();
1452  mirror::Field::ResetArrayClass();
1453  mirror::FloatArray::ResetArrayClass();
1454  mirror::Method::ResetArrayClass();
1455  mirror::IntArray::ResetArrayClass();
1456  mirror::LongArray::ResetArrayClass();
1457  mirror::ShortArray::ResetArrayClass();
1458  STLDeleteElements(&oat_files_);
1459}
1460
1461mirror::PointerArray* ClassLinker::AllocPointerArray(Thread* self, size_t length) {
1462  return down_cast<mirror::PointerArray*>(image_pointer_size_ == 8u ?
1463      static_cast<mirror::Array*>(mirror::LongArray::Alloc(self, length)) :
1464      static_cast<mirror::Array*>(mirror::IntArray::Alloc(self, length)));
1465}
1466
1467mirror::DexCache* ClassLinker::AllocDexCache(Thread* self, const DexFile& dex_file) {
1468  StackHandleScope<6> hs(self);
1469  auto dex_cache(hs.NewHandle(down_cast<mirror::DexCache*>(
1470      GetClassRoot(kJavaLangDexCache)->AllocObject(self))));
1471  if (dex_cache.Get() == nullptr) {
1472    self->AssertPendingOOMException();
1473    return nullptr;
1474  }
1475  auto location(hs.NewHandle(intern_table_->InternStrong(dex_file.GetLocation().c_str())));
1476  if (location.Get() == nullptr) {
1477    self->AssertPendingOOMException();
1478    return nullptr;
1479  }
1480  auto strings(hs.NewHandle(AllocStringArray(self, dex_file.NumStringIds())));
1481  if (strings.Get() == nullptr) {
1482    self->AssertPendingOOMException();
1483    return nullptr;
1484  }
1485  auto types(hs.NewHandle(AllocClassArray(self, dex_file.NumTypeIds())));
1486  if (types.Get() == nullptr) {
1487    self->AssertPendingOOMException();
1488    return nullptr;
1489  }
1490  auto methods(hs.NewHandle(AllocPointerArray(self, dex_file.NumMethodIds())));
1491  if (methods.Get() == nullptr) {
1492    self->AssertPendingOOMException();
1493    return nullptr;
1494  }
1495  auto fields(hs.NewHandle(AllocPointerArray(self, dex_file.NumFieldIds())));
1496  if (fields.Get() == nullptr) {
1497    self->AssertPendingOOMException();
1498    return nullptr;
1499  }
1500  dex_cache->Init(&dex_file, location.Get(), strings.Get(), types.Get(), methods.Get(),
1501                  fields.Get(), image_pointer_size_);
1502  return dex_cache.Get();
1503}
1504
1505mirror::Class* ClassLinker::AllocClass(Thread* self, mirror::Class* java_lang_Class,
1506                                       uint32_t class_size) {
1507  DCHECK_GE(class_size, sizeof(mirror::Class));
1508  gc::Heap* heap = Runtime::Current()->GetHeap();
1509  mirror::Class::InitializeClassVisitor visitor(class_size);
1510  mirror::Object* k = kMovingClasses ?
1511      heap->AllocObject<true>(self, java_lang_Class, class_size, visitor) :
1512      heap->AllocNonMovableObject<true>(self, java_lang_Class, class_size, visitor);
1513  if (UNLIKELY(k == nullptr)) {
1514    self->AssertPendingOOMException();
1515    return nullptr;
1516  }
1517  return k->AsClass();
1518}
1519
1520mirror::Class* ClassLinker::AllocClass(Thread* self, uint32_t class_size) {
1521  return AllocClass(self, GetClassRoot(kJavaLangClass), class_size);
1522}
1523
1524mirror::ObjectArray<mirror::StackTraceElement>* ClassLinker::AllocStackTraceElementArray(
1525    Thread* self, size_t length) {
1526  return mirror::ObjectArray<mirror::StackTraceElement>::Alloc(
1527      self, GetClassRoot(kJavaLangStackTraceElementArrayClass), length);
1528}
1529
1530mirror::Class* ClassLinker::EnsureResolved(Thread* self, const char* descriptor,
1531                                           mirror::Class* klass) {
1532  DCHECK(klass != nullptr);
1533
1534  // For temporary classes we must wait for them to be retired.
1535  if (init_done_ && klass->IsTemp()) {
1536    CHECK(!klass->IsResolved());
1537    if (klass->IsErroneous()) {
1538      ThrowEarlierClassFailure(klass);
1539      return nullptr;
1540    }
1541    StackHandleScope<1> hs(self);
1542    Handle<mirror::Class> h_class(hs.NewHandle(klass));
1543    ObjectLock<mirror::Class> lock(self, h_class);
1544    // Loop and wait for the resolving thread to retire this class.
1545    while (!h_class->IsRetired() && !h_class->IsErroneous()) {
1546      lock.WaitIgnoringInterrupts();
1547    }
1548    if (h_class->IsErroneous()) {
1549      ThrowEarlierClassFailure(h_class.Get());
1550      return nullptr;
1551    }
1552    CHECK(h_class->IsRetired());
1553    // Get the updated class from class table.
1554    klass = LookupClass(self, descriptor, ComputeModifiedUtf8Hash(descriptor),
1555                        h_class.Get()->GetClassLoader());
1556  }
1557
1558  // Wait for the class if it has not already been linked.
1559  if (!klass->IsResolved() && !klass->IsErroneous()) {
1560    StackHandleScope<1> hs(self);
1561    HandleWrapper<mirror::Class> h_class(hs.NewHandleWrapper(&klass));
1562    ObjectLock<mirror::Class> lock(self, h_class);
1563    // Check for circular dependencies between classes.
1564    if (!h_class->IsResolved() && h_class->GetClinitThreadId() == self->GetTid()) {
1565      ThrowClassCircularityError(h_class.Get());
1566      mirror::Class::SetStatus(h_class, mirror::Class::kStatusError, self);
1567      return nullptr;
1568    }
1569    // Wait for the pending initialization to complete.
1570    while (!h_class->IsResolved() && !h_class->IsErroneous()) {
1571      lock.WaitIgnoringInterrupts();
1572    }
1573  }
1574
1575  if (klass->IsErroneous()) {
1576    ThrowEarlierClassFailure(klass);
1577    return nullptr;
1578  }
1579  // Return the loaded class.  No exceptions should be pending.
1580  CHECK(klass->IsResolved()) << PrettyClass(klass);
1581  self->AssertNoPendingException();
1582  return klass;
1583}
1584
1585typedef std::pair<const DexFile*, const DexFile::ClassDef*> ClassPathEntry;
1586
1587// Search a collection of DexFiles for a descriptor
1588ClassPathEntry FindInClassPath(const char* descriptor,
1589                               size_t hash, const std::vector<const DexFile*>& class_path) {
1590  for (const DexFile* dex_file : class_path) {
1591    const DexFile::ClassDef* dex_class_def = dex_file->FindClassDef(descriptor, hash);
1592    if (dex_class_def != nullptr) {
1593      return ClassPathEntry(dex_file, dex_class_def);
1594    }
1595  }
1596  return ClassPathEntry(nullptr, nullptr);
1597}
1598
1599static bool IsBootClassLoader(ScopedObjectAccessAlreadyRunnable& soa,
1600                              mirror::ClassLoader* class_loader)
1601    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1602  return class_loader == nullptr ||
1603      class_loader->GetClass() ==
1604          soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_BootClassLoader);
1605}
1606
1607bool ClassLinker::FindClassInPathClassLoader(ScopedObjectAccessAlreadyRunnable& soa,
1608                                             Thread* self, const char* descriptor,
1609                                             size_t hash,
1610                                             Handle<mirror::ClassLoader> class_loader,
1611                                             mirror::Class** result) {
1612  // Termination case: boot class-loader.
1613  if (IsBootClassLoader(soa, class_loader.Get())) {
1614    // The boot class loader, search the boot class path.
1615    ClassPathEntry pair = FindInClassPath(descriptor, hash, boot_class_path_);
1616    if (pair.second != nullptr) {
1617      mirror::Class* klass = LookupClass(self, descriptor, hash, nullptr);
1618      if (klass != nullptr) {
1619        *result = EnsureResolved(self, descriptor, klass);
1620      } else {
1621        *result = DefineClass(self, descriptor, hash, NullHandle<mirror::ClassLoader>(),
1622                              *pair.first, *pair.second);
1623      }
1624      if (*result == nullptr) {
1625        CHECK(self->IsExceptionPending()) << descriptor;
1626        self->ClearException();
1627      }
1628    } else {
1629      *result = nullptr;
1630    }
1631    return true;
1632  }
1633
1634  // Unsupported class-loader?
1635  if (class_loader->GetClass() !=
1636      soa.Decode<mirror::Class*>(WellKnownClasses::dalvik_system_PathClassLoader)) {
1637    *result = nullptr;
1638    return false;
1639  }
1640
1641  // Handles as RegisterDexFile may allocate dex caches (and cause thread suspension).
1642  StackHandleScope<4> hs(self);
1643  Handle<mirror::ClassLoader> h_parent(hs.NewHandle(class_loader->GetParent()));
1644  bool recursive_result = FindClassInPathClassLoader(soa, self, descriptor, hash, h_parent, result);
1645
1646  if (!recursive_result) {
1647    // Something wrong up the chain.
1648    return false;
1649  }
1650
1651  if (*result != nullptr) {
1652    // Found the class up the chain.
1653    return true;
1654  }
1655
1656  // Handle this step.
1657  // Handle as if this is the child PathClassLoader.
1658  // The class loader is a PathClassLoader which inherits from BaseDexClassLoader.
1659  // We need to get the DexPathList and loop through it.
1660  ArtField* const cookie_field = soa.DecodeField(WellKnownClasses::dalvik_system_DexFile_cookie);
1661  ArtField* const dex_file_field =
1662      soa.DecodeField(WellKnownClasses::dalvik_system_DexPathList__Element_dexFile);
1663  mirror::Object* dex_path_list =
1664      soa.DecodeField(WellKnownClasses::dalvik_system_PathClassLoader_pathList)->
1665      GetObject(class_loader.Get());
1666  if (dex_path_list != nullptr && dex_file_field != nullptr && cookie_field != nullptr) {
1667    // DexPathList has an array dexElements of Elements[] which each contain a dex file.
1668    mirror::Object* dex_elements_obj =
1669        soa.DecodeField(WellKnownClasses::dalvik_system_DexPathList_dexElements)->
1670        GetObject(dex_path_list);
1671    // Loop through each dalvik.system.DexPathList$Element's dalvik.system.DexFile and look
1672    // at the mCookie which is a DexFile vector.
1673    if (dex_elements_obj != nullptr) {
1674      Handle<mirror::ObjectArray<mirror::Object>> dex_elements =
1675          hs.NewHandle(dex_elements_obj->AsObjectArray<mirror::Object>());
1676      for (int32_t i = 0; i < dex_elements->GetLength(); ++i) {
1677        mirror::Object* element = dex_elements->GetWithoutChecks(i);
1678        if (element == nullptr) {
1679          // Should never happen, fall back to java code to throw a NPE.
1680          break;
1681        }
1682        mirror::Object* dex_file = dex_file_field->GetObject(element);
1683        if (dex_file != nullptr) {
1684          mirror::LongArray* long_array = cookie_field->GetObject(dex_file)->AsLongArray();
1685          if (long_array == nullptr) {
1686            // This should never happen so log a warning.
1687            LOG(WARNING) << "Null DexFile::mCookie for " << descriptor;
1688            break;
1689          }
1690          int32_t long_array_size = long_array->GetLength();
1691          for (int32_t j = 0; j < long_array_size; ++j) {
1692            const DexFile* cp_dex_file = reinterpret_cast<const DexFile*>(static_cast<uintptr_t>(
1693                long_array->GetWithoutChecks(j)));
1694            const DexFile::ClassDef* dex_class_def = cp_dex_file->FindClassDef(descriptor, hash);
1695            if (dex_class_def != nullptr) {
1696              RegisterDexFile(*cp_dex_file);
1697              mirror::Class* klass = DefineClass(self, descriptor, hash, class_loader,
1698                                                 *cp_dex_file, *dex_class_def);
1699              if (klass == nullptr) {
1700                CHECK(self->IsExceptionPending()) << descriptor;
1701                self->ClearException();
1702                // TODO: Is it really right to break here, and not check the other dex files?
1703                return true;
1704              }
1705              *result = klass;
1706              return true;
1707            }
1708          }
1709        }
1710      }
1711    }
1712    self->AssertNoPendingException();
1713  }
1714
1715  // Result is still null from the parent call, no need to set it again...
1716  return true;
1717}
1718
1719mirror::Class* ClassLinker::FindClass(Thread* self, const char* descriptor,
1720                                      Handle<mirror::ClassLoader> class_loader) {
1721  DCHECK_NE(*descriptor, '\0') << "descriptor is empty string";
1722  DCHECK(self != nullptr);
1723  self->AssertNoPendingException();
1724  if (descriptor[1] == '\0') {
1725    // only the descriptors of primitive types should be 1 character long, also avoid class lookup
1726    // for primitive classes that aren't backed by dex files.
1727    return FindPrimitiveClass(descriptor[0]);
1728  }
1729  const size_t hash = ComputeModifiedUtf8Hash(descriptor);
1730  // Find the class in the loaded classes table.
1731  mirror::Class* klass = LookupClass(self, descriptor, hash, class_loader.Get());
1732  if (klass != nullptr) {
1733    return EnsureResolved(self, descriptor, klass);
1734  }
1735  // Class is not yet loaded.
1736  if (descriptor[0] == '[') {
1737    return CreateArrayClass(self, descriptor, hash, class_loader);
1738  } else if (class_loader.Get() == nullptr) {
1739    // The boot class loader, search the boot class path.
1740    ClassPathEntry pair = FindInClassPath(descriptor, hash, boot_class_path_);
1741    if (pair.second != nullptr) {
1742      return DefineClass(self, descriptor, hash, NullHandle<mirror::ClassLoader>(), *pair.first,
1743                         *pair.second);
1744    } else {
1745      // The boot class loader is searched ahead of the application class loader, failures are
1746      // expected and will be wrapped in a ClassNotFoundException. Use the pre-allocated error to
1747      // trigger the chaining with a proper stack trace.
1748      mirror::Throwable* pre_allocated = Runtime::Current()->GetPreAllocatedNoClassDefFoundError();
1749      self->SetException(pre_allocated);
1750      return nullptr;
1751    }
1752  } else {
1753    ScopedObjectAccessUnchecked soa(self);
1754    mirror::Class* cp_klass;
1755    if (FindClassInPathClassLoader(soa, self, descriptor, hash, class_loader, &cp_klass)) {
1756      // The chain was understood. So the value in cp_klass is either the class we were looking
1757      // for, or not found.
1758      if (cp_klass != nullptr) {
1759        return cp_klass;
1760      }
1761      // TODO: We handle the boot classpath loader in FindClassInPathClassLoader. Try to unify this
1762      //       and the branch above. TODO: throw the right exception here.
1763
1764      // We'll let the Java-side rediscover all this and throw the exception with the right stack
1765      // trace.
1766    }
1767
1768    if (Runtime::Current()->IsAotCompiler()) {
1769      // Oops, compile-time, can't run actual class-loader code.
1770      mirror::Throwable* pre_allocated = Runtime::Current()->GetPreAllocatedNoClassDefFoundError();
1771      self->SetException(pre_allocated);
1772      return nullptr;
1773    }
1774
1775    ScopedLocalRef<jobject> class_loader_object(soa.Env(),
1776                                                soa.AddLocalReference<jobject>(class_loader.Get()));
1777    std::string class_name_string(DescriptorToDot(descriptor));
1778    ScopedLocalRef<jobject> result(soa.Env(), nullptr);
1779    {
1780      ScopedThreadStateChange tsc(self, kNative);
1781      ScopedLocalRef<jobject> class_name_object(soa.Env(),
1782                                                soa.Env()->NewStringUTF(class_name_string.c_str()));
1783      if (class_name_object.get() == nullptr) {
1784        DCHECK(self->IsExceptionPending());  // OOME.
1785        return nullptr;
1786      }
1787      CHECK(class_loader_object.get() != nullptr);
1788      result.reset(soa.Env()->CallObjectMethod(class_loader_object.get(),
1789                                               WellKnownClasses::java_lang_ClassLoader_loadClass,
1790                                               class_name_object.get()));
1791    }
1792    if (self->IsExceptionPending()) {
1793      // If the ClassLoader threw, pass that exception up.
1794      return nullptr;
1795    } else if (result.get() == nullptr) {
1796      // broken loader - throw NPE to be compatible with Dalvik
1797      ThrowNullPointerException(StringPrintf("ClassLoader.loadClass returned null for %s",
1798                                             class_name_string.c_str()).c_str());
1799      return nullptr;
1800    } else {
1801      // success, return mirror::Class*
1802      return soa.Decode<mirror::Class*>(result.get());
1803    }
1804  }
1805  UNREACHABLE();
1806}
1807
1808mirror::Class* ClassLinker::DefineClass(Thread* self, const char* descriptor, size_t hash,
1809                                        Handle<mirror::ClassLoader> class_loader,
1810                                        const DexFile& dex_file,
1811                                        const DexFile::ClassDef& dex_class_def) {
1812  StackHandleScope<3> hs(self);
1813  auto klass = hs.NewHandle<mirror::Class>(nullptr);
1814
1815  // Load the class from the dex file.
1816  if (UNLIKELY(!init_done_)) {
1817    // finish up init of hand crafted class_roots_
1818    if (strcmp(descriptor, "Ljava/lang/Object;") == 0) {
1819      klass.Assign(GetClassRoot(kJavaLangObject));
1820    } else if (strcmp(descriptor, "Ljava/lang/Class;") == 0) {
1821      klass.Assign(GetClassRoot(kJavaLangClass));
1822    } else if (strcmp(descriptor, "Ljava/lang/String;") == 0) {
1823      klass.Assign(GetClassRoot(kJavaLangString));
1824    } else if (strcmp(descriptor, "Ljava/lang/ref/Reference;") == 0) {
1825      klass.Assign(GetClassRoot(kJavaLangRefReference));
1826    } else if (strcmp(descriptor, "Ljava/lang/DexCache;") == 0) {
1827      klass.Assign(GetClassRoot(kJavaLangDexCache));
1828    }
1829  }
1830
1831  if (klass.Get() == nullptr) {
1832    // Allocate a class with the status of not ready.
1833    // Interface object should get the right size here. Regular class will
1834    // figure out the right size later and be replaced with one of the right
1835    // size when the class becomes resolved.
1836    klass.Assign(AllocClass(self, SizeOfClassWithoutEmbeddedTables(dex_file, dex_class_def)));
1837  }
1838  if (UNLIKELY(klass.Get() == nullptr)) {
1839    CHECK(self->IsExceptionPending());  // Expect an OOME.
1840    return nullptr;
1841  }
1842  klass->SetDexCache(FindDexCache(dex_file));
1843
1844  SetupClass(dex_file, dex_class_def, klass, class_loader.Get());
1845
1846  // Mark the string class by setting its access flag.
1847  if (UNLIKELY(!init_done_)) {
1848    if (strcmp(descriptor, "Ljava/lang/String;") == 0) {
1849      klass->SetStringClass();
1850    }
1851  }
1852
1853  ObjectLock<mirror::Class> lock(self, klass);
1854  klass->SetClinitThreadId(self->GetTid());
1855
1856  // Add the newly loaded class to the loaded classes table.
1857  mirror::Class* existing = InsertClass(descriptor, klass.Get(), hash);
1858  if (existing != nullptr) {
1859    // We failed to insert because we raced with another thread. Calling EnsureResolved may cause
1860    // this thread to block.
1861    return EnsureResolved(self, descriptor, existing);
1862  }
1863
1864  // Load the fields and other things after we are inserted in the table. This is so that we don't
1865  // end up allocating unfree-able linear alloc resources and then lose the race condition. The
1866  // other reason is that the field roots are only visited from the class table. So we need to be
1867  // inserted before we allocate / fill in these fields.
1868  LoadClass(self, dex_file, dex_class_def, klass);
1869  if (self->IsExceptionPending()) {
1870    // An exception occured during load, set status to erroneous while holding klass' lock in case
1871    // notification is necessary.
1872    if (!klass->IsErroneous()) {
1873      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
1874    }
1875    return nullptr;
1876  }
1877
1878  // Finish loading (if necessary) by finding parents
1879  CHECK(!klass->IsLoaded());
1880  if (!LoadSuperAndInterfaces(klass, dex_file)) {
1881    // Loading failed.
1882    if (!klass->IsErroneous()) {
1883      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
1884    }
1885    return nullptr;
1886  }
1887  CHECK(klass->IsLoaded());
1888  // Link the class (if necessary)
1889  CHECK(!klass->IsResolved());
1890  // TODO: Use fast jobjects?
1891  auto interfaces = hs.NewHandle<mirror::ObjectArray<mirror::Class>>(nullptr);
1892
1893  MutableHandle<mirror::Class> h_new_class = hs.NewHandle<mirror::Class>(nullptr);
1894  if (!LinkClass(self, descriptor, klass, interfaces, &h_new_class)) {
1895    // Linking failed.
1896    if (!klass->IsErroneous()) {
1897      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
1898    }
1899    return nullptr;
1900  }
1901  self->AssertNoPendingException();
1902  CHECK(h_new_class.Get() != nullptr) << descriptor;
1903  CHECK(h_new_class->IsResolved()) << descriptor;
1904
1905  // Instrumentation may have updated entrypoints for all methods of all
1906  // classes. However it could not update methods of this class while we
1907  // were loading it. Now the class is resolved, we can update entrypoints
1908  // as required by instrumentation.
1909  if (Runtime::Current()->GetInstrumentation()->AreExitStubsInstalled()) {
1910    // We must be in the kRunnable state to prevent instrumentation from
1911    // suspending all threads to update entrypoints while we are doing it
1912    // for this class.
1913    DCHECK_EQ(self->GetState(), kRunnable);
1914    Runtime::Current()->GetInstrumentation()->InstallStubsForClass(h_new_class.Get());
1915  }
1916
1917  /*
1918   * We send CLASS_PREPARE events to the debugger from here.  The
1919   * definition of "preparation" is creating the static fields for a
1920   * class and initializing them to the standard default values, but not
1921   * executing any code (that comes later, during "initialization").
1922   *
1923   * We did the static preparation in LinkClass.
1924   *
1925   * The class has been prepared and resolved but possibly not yet verified
1926   * at this point.
1927   */
1928  Dbg::PostClassPrepare(h_new_class.Get());
1929
1930  return h_new_class.Get();
1931}
1932
1933uint32_t ClassLinker::SizeOfClassWithoutEmbeddedTables(const DexFile& dex_file,
1934                                                       const DexFile::ClassDef& dex_class_def) {
1935  const uint8_t* class_data = dex_file.GetClassData(dex_class_def);
1936  size_t num_ref = 0;
1937  size_t num_8 = 0;
1938  size_t num_16 = 0;
1939  size_t num_32 = 0;
1940  size_t num_64 = 0;
1941  if (class_data != nullptr) {
1942    for (ClassDataItemIterator it(dex_file, class_data); it.HasNextStaticField(); it.Next()) {
1943      const DexFile::FieldId& field_id = dex_file.GetFieldId(it.GetMemberIndex());
1944      const char* descriptor = dex_file.GetFieldTypeDescriptor(field_id);
1945      char c = descriptor[0];
1946      switch (c) {
1947        case 'L':
1948        case '[':
1949          num_ref++;
1950          break;
1951        case 'J':
1952        case 'D':
1953          num_64++;
1954          break;
1955        case 'I':
1956        case 'F':
1957          num_32++;
1958          break;
1959        case 'S':
1960        case 'C':
1961          num_16++;
1962          break;
1963        case 'B':
1964        case 'Z':
1965          num_8++;
1966          break;
1967        default:
1968          LOG(FATAL) << "Unknown descriptor: " << c;
1969          UNREACHABLE();
1970      }
1971    }
1972  }
1973  return mirror::Class::ComputeClassSize(false, 0, num_8, num_16, num_32, num_64, num_ref,
1974                                         image_pointer_size_);
1975}
1976
1977OatFile::OatClass ClassLinker::FindOatClass(const DexFile& dex_file, uint16_t class_def_idx,
1978                                            bool* found) {
1979  DCHECK_NE(class_def_idx, DexFile::kDexNoIndex16);
1980  const OatFile::OatDexFile* oat_dex_file = dex_file.GetOatDexFile();
1981  if (oat_dex_file == nullptr) {
1982    *found = false;
1983    return OatFile::OatClass::Invalid();
1984  }
1985  *found = true;
1986  return oat_dex_file->GetOatClass(class_def_idx);
1987}
1988
1989static uint32_t GetOatMethodIndexFromMethodIndex(const DexFile& dex_file, uint16_t class_def_idx,
1990                                                 uint32_t method_idx) {
1991  const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_idx);
1992  const uint8_t* class_data = dex_file.GetClassData(class_def);
1993  CHECK(class_data != nullptr);
1994  ClassDataItemIterator it(dex_file, class_data);
1995  // Skip fields
1996  while (it.HasNextStaticField()) {
1997    it.Next();
1998  }
1999  while (it.HasNextInstanceField()) {
2000    it.Next();
2001  }
2002  // Process methods
2003  size_t class_def_method_index = 0;
2004  while (it.HasNextDirectMethod()) {
2005    if (it.GetMemberIndex() == method_idx) {
2006      return class_def_method_index;
2007    }
2008    class_def_method_index++;
2009    it.Next();
2010  }
2011  while (it.HasNextVirtualMethod()) {
2012    if (it.GetMemberIndex() == method_idx) {
2013      return class_def_method_index;
2014    }
2015    class_def_method_index++;
2016    it.Next();
2017  }
2018  DCHECK(!it.HasNext());
2019  LOG(FATAL) << "Failed to find method index " << method_idx << " in " << dex_file.GetLocation();
2020  UNREACHABLE();
2021}
2022
2023const OatFile::OatMethod ClassLinker::FindOatMethodFor(ArtMethod* method, bool* found) {
2024  // Although we overwrite the trampoline of non-static methods, we may get here via the resolution
2025  // method for direct methods (or virtual methods made direct).
2026  mirror::Class* declaring_class = method->GetDeclaringClass();
2027  size_t oat_method_index;
2028  if (method->IsStatic() || method->IsDirect()) {
2029    // Simple case where the oat method index was stashed at load time.
2030    oat_method_index = method->GetMethodIndex();
2031  } else {
2032    // We're invoking a virtual method directly (thanks to sharpening), compute the oat_method_index
2033    // by search for its position in the declared virtual methods.
2034    oat_method_index = declaring_class->NumDirectMethods();
2035    size_t end = declaring_class->NumVirtualMethods();
2036    bool found_virtual = false;
2037    for (size_t i = 0; i < end; i++) {
2038      // Check method index instead of identity in case of duplicate method definitions.
2039      if (method->GetDexMethodIndex() ==
2040          declaring_class->GetVirtualMethod(i, image_pointer_size_)->GetDexMethodIndex()) {
2041        found_virtual = true;
2042        break;
2043      }
2044      oat_method_index++;
2045    }
2046    CHECK(found_virtual) << "Didn't find oat method index for virtual method: "
2047                         << PrettyMethod(method);
2048  }
2049  DCHECK_EQ(oat_method_index,
2050            GetOatMethodIndexFromMethodIndex(*declaring_class->GetDexCache()->GetDexFile(),
2051                                             method->GetDeclaringClass()->GetDexClassDefIndex(),
2052                                             method->GetDexMethodIndex()));
2053  OatFile::OatClass oat_class = FindOatClass(*declaring_class->GetDexCache()->GetDexFile(),
2054                                             declaring_class->GetDexClassDefIndex(),
2055                                             found);
2056  if (!(*found)) {
2057    return OatFile::OatMethod::Invalid();
2058  }
2059  return oat_class.GetOatMethod(oat_method_index);
2060}
2061
2062// Special case to get oat code without overwriting a trampoline.
2063const void* ClassLinker::GetQuickOatCodeFor(ArtMethod* method) {
2064  CHECK(!method->IsAbstract()) << PrettyMethod(method);
2065  if (method->IsProxyMethod()) {
2066    return GetQuickProxyInvokeHandler();
2067  }
2068  bool found;
2069  OatFile::OatMethod oat_method = FindOatMethodFor(method, &found);
2070  if (found) {
2071    auto* code = oat_method.GetQuickCode();
2072    if (code != nullptr) {
2073      return code;
2074    }
2075  }
2076  jit::Jit* const jit = Runtime::Current()->GetJit();
2077  if (jit != nullptr) {
2078    auto* code = jit->GetCodeCache()->GetCodeFor(method);
2079    if (code != nullptr) {
2080      return code;
2081    }
2082  }
2083  if (method->IsNative()) {
2084    // No code and native? Use generic trampoline.
2085    return GetQuickGenericJniStub();
2086  }
2087  return GetQuickToInterpreterBridge();
2088}
2089
2090const void* ClassLinker::GetOatMethodQuickCodeFor(ArtMethod* method) {
2091  if (method->IsNative() || method->IsAbstract() || method->IsProxyMethod()) {
2092    return nullptr;
2093  }
2094  bool found;
2095  OatFile::OatMethod oat_method = FindOatMethodFor(method, &found);
2096  if (found) {
2097    return oat_method.GetQuickCode();
2098  }
2099  jit::Jit* jit = Runtime::Current()->GetJit();
2100  if (jit != nullptr) {
2101    auto* code = jit->GetCodeCache()->GetCodeFor(method);
2102    if (code != nullptr) {
2103      return code;
2104    }
2105  }
2106  return nullptr;
2107}
2108
2109const void* ClassLinker::GetQuickOatCodeFor(const DexFile& dex_file, uint16_t class_def_idx,
2110                                            uint32_t method_idx) {
2111  bool found;
2112  OatFile::OatClass oat_class = FindOatClass(dex_file, class_def_idx, &found);
2113  if (!found) {
2114    return nullptr;
2115  }
2116  uint32_t oat_method_idx = GetOatMethodIndexFromMethodIndex(dex_file, class_def_idx, method_idx);
2117  return oat_class.GetOatMethod(oat_method_idx).GetQuickCode();
2118}
2119
2120// Returns true if the method must run with interpreter, false otherwise.
2121static bool NeedsInterpreter(ArtMethod* method, const void* quick_code)
2122    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2123  if (quick_code == nullptr) {
2124    // No code: need interpreter.
2125    // May return true for native code, in the case of generic JNI
2126    // DCHECK(!method->IsNative());
2127    return true;
2128  }
2129  // If interpreter mode is enabled, every method (except native and proxy) must
2130  // be run with interpreter.
2131  return Runtime::Current()->GetInstrumentation()->InterpretOnly() &&
2132         !method->IsNative() && !method->IsProxyMethod();
2133}
2134
2135void ClassLinker::FixupStaticTrampolines(mirror::Class* klass) {
2136  DCHECK(klass->IsInitialized()) << PrettyDescriptor(klass);
2137  if (klass->NumDirectMethods() == 0) {
2138    return;  // No direct methods => no static methods.
2139  }
2140  Runtime* runtime = Runtime::Current();
2141  if (!runtime->IsStarted()) {
2142    if (runtime->IsAotCompiler() || runtime->GetHeap()->HasImageSpace()) {
2143      return;  // OAT file unavailable.
2144    }
2145  }
2146
2147  const DexFile& dex_file = klass->GetDexFile();
2148  const DexFile::ClassDef* dex_class_def = klass->GetClassDef();
2149  CHECK(dex_class_def != nullptr);
2150  const uint8_t* class_data = dex_file.GetClassData(*dex_class_def);
2151  // There should always be class data if there were direct methods.
2152  CHECK(class_data != nullptr) << PrettyDescriptor(klass);
2153  ClassDataItemIterator it(dex_file, class_data);
2154  // Skip fields
2155  while (it.HasNextStaticField()) {
2156    it.Next();
2157  }
2158  while (it.HasNextInstanceField()) {
2159    it.Next();
2160  }
2161  bool has_oat_class;
2162  OatFile::OatClass oat_class = FindOatClass(dex_file, klass->GetDexClassDefIndex(),
2163                                             &has_oat_class);
2164  // Link the code of methods skipped by LinkCode.
2165  for (size_t method_index = 0; it.HasNextDirectMethod(); ++method_index, it.Next()) {
2166    ArtMethod* method = klass->GetDirectMethod(method_index, image_pointer_size_);
2167    if (!method->IsStatic()) {
2168      // Only update static methods.
2169      continue;
2170    }
2171    const void* quick_code = nullptr;
2172    if (has_oat_class) {
2173      OatFile::OatMethod oat_method = oat_class.GetOatMethod(method_index);
2174      quick_code = oat_method.GetQuickCode();
2175    }
2176    const bool enter_interpreter = NeedsInterpreter(method, quick_code);
2177    if (enter_interpreter) {
2178      // Use interpreter entry point.
2179      // Check whether the method is native, in which case it's generic JNI.
2180      if (quick_code == nullptr && method->IsNative()) {
2181        quick_code = GetQuickGenericJniStub();
2182      } else {
2183        quick_code = GetQuickToInterpreterBridge();
2184      }
2185    }
2186    runtime->GetInstrumentation()->UpdateMethodsCode(method, quick_code);
2187  }
2188  // Ignore virtual methods on the iterator.
2189}
2190
2191void ClassLinker::LinkCode(ArtMethod* method, const OatFile::OatClass* oat_class,
2192                           uint32_t class_def_method_index) {
2193  Runtime* const runtime = Runtime::Current();
2194  if (runtime->IsAotCompiler()) {
2195    // The following code only applies to a non-compiler runtime.
2196    return;
2197  }
2198  // Method shouldn't have already been linked.
2199  DCHECK(method->GetEntryPointFromQuickCompiledCode() == nullptr);
2200  if (oat_class != nullptr) {
2201    // Every kind of method should at least get an invoke stub from the oat_method.
2202    // non-abstract methods also get their code pointers.
2203    const OatFile::OatMethod oat_method = oat_class->GetOatMethod(class_def_method_index);
2204    oat_method.LinkMethod(method);
2205  }
2206
2207  // Install entry point from interpreter.
2208  bool enter_interpreter = NeedsInterpreter(method, method->GetEntryPointFromQuickCompiledCode());
2209  if (enter_interpreter && !method->IsNative()) {
2210    method->SetEntryPointFromInterpreter(artInterpreterToInterpreterBridge);
2211  } else {
2212    method->SetEntryPointFromInterpreter(artInterpreterToCompiledCodeBridge);
2213  }
2214
2215  if (method->IsAbstract()) {
2216    method->SetEntryPointFromQuickCompiledCode(GetQuickToInterpreterBridge());
2217    return;
2218  }
2219
2220  if (method->IsStatic() && !method->IsConstructor()) {
2221    // For static methods excluding the class initializer, install the trampoline.
2222    // It will be replaced by the proper entry point by ClassLinker::FixupStaticTrampolines
2223    // after initializing class (see ClassLinker::InitializeClass method).
2224    method->SetEntryPointFromQuickCompiledCode(GetQuickResolutionStub());
2225  } else if (enter_interpreter) {
2226    if (!method->IsNative()) {
2227      // Set entry point from compiled code if there's no code or in interpreter only mode.
2228      method->SetEntryPointFromQuickCompiledCode(GetQuickToInterpreterBridge());
2229    } else {
2230      method->SetEntryPointFromQuickCompiledCode(GetQuickGenericJniStub());
2231    }
2232  }
2233
2234  if (method->IsNative()) {
2235    // Unregistering restores the dlsym lookup stub.
2236    method->UnregisterNative();
2237
2238    if (enter_interpreter) {
2239      // We have a native method here without code. Then it should have either the generic JNI
2240      // trampoline as entrypoint (non-static), or the resolution trampoline (static).
2241      // TODO: this doesn't handle all the cases where trampolines may be installed.
2242      const void* entry_point = method->GetEntryPointFromQuickCompiledCode();
2243      DCHECK(IsQuickGenericJniStub(entry_point) || IsQuickResolutionStub(entry_point));
2244    }
2245  }
2246}
2247
2248void ClassLinker::SetupClass(const DexFile& dex_file, const DexFile::ClassDef& dex_class_def,
2249                             Handle<mirror::Class> klass, mirror::ClassLoader* class_loader) {
2250  CHECK(klass.Get() != nullptr);
2251  CHECK(klass->GetDexCache() != nullptr);
2252  CHECK_EQ(mirror::Class::kStatusNotReady, klass->GetStatus());
2253  const char* descriptor = dex_file.GetClassDescriptor(dex_class_def);
2254  CHECK(descriptor != nullptr);
2255
2256  klass->SetClass(GetClassRoot(kJavaLangClass));
2257  uint32_t access_flags = dex_class_def.GetJavaAccessFlags();
2258  CHECK_EQ(access_flags & ~kAccJavaFlagsMask, 0U);
2259  klass->SetAccessFlags(access_flags);
2260  klass->SetClassLoader(class_loader);
2261  DCHECK_EQ(klass->GetPrimitiveType(), Primitive::kPrimNot);
2262  mirror::Class::SetStatus(klass, mirror::Class::kStatusIdx, nullptr);
2263
2264  klass->SetDexClassDefIndex(dex_file.GetIndexForClassDef(dex_class_def));
2265  klass->SetDexTypeIndex(dex_class_def.class_idx_);
2266  CHECK(klass->GetDexCacheStrings() != nullptr);
2267}
2268
2269void ClassLinker::LoadClass(Thread* self, const DexFile& dex_file,
2270                            const DexFile::ClassDef& dex_class_def,
2271                            Handle<mirror::Class> klass) {
2272  const uint8_t* class_data = dex_file.GetClassData(dex_class_def);
2273  if (class_data == nullptr) {
2274    return;  // no fields or methods - for example a marker interface
2275  }
2276  bool has_oat_class = false;
2277  if (Runtime::Current()->IsStarted() && !Runtime::Current()->IsAotCompiler()) {
2278    OatFile::OatClass oat_class = FindOatClass(dex_file, klass->GetDexClassDefIndex(),
2279                                               &has_oat_class);
2280    if (has_oat_class) {
2281      LoadClassMembers(self, dex_file, class_data, klass, &oat_class);
2282    }
2283  }
2284  if (!has_oat_class) {
2285    LoadClassMembers(self, dex_file, class_data, klass, nullptr);
2286  }
2287}
2288
2289ArtField* ClassLinker::AllocArtFieldArray(Thread* self, size_t length) {
2290  auto* const la = Runtime::Current()->GetLinearAlloc();
2291  auto* ptr = reinterpret_cast<ArtField*>(la->AllocArray<ArtField>(self, length));
2292  CHECK(ptr!= nullptr);
2293  std::uninitialized_fill_n(ptr, length, ArtField());
2294  return ptr;
2295}
2296
2297ArtMethod* ClassLinker::AllocArtMethodArray(Thread* self, size_t length) {
2298  const size_t method_size = ArtMethod::ObjectSize(image_pointer_size_);
2299  uintptr_t ptr = reinterpret_cast<uintptr_t>(
2300      Runtime::Current()->GetLinearAlloc()->Alloc(self, method_size * length));
2301  CHECK_NE(ptr, 0u);
2302  for (size_t i = 0; i < length; ++i) {
2303    new(reinterpret_cast<void*>(ptr + i * method_size)) ArtMethod;
2304  }
2305  return reinterpret_cast<ArtMethod*>(ptr);
2306}
2307
2308void ClassLinker::LoadClassMembers(Thread* self, const DexFile& dex_file,
2309                                   const uint8_t* class_data,
2310                                   Handle<mirror::Class> klass,
2311                                   const OatFile::OatClass* oat_class) {
2312  {
2313    // Note: We cannot have thread suspension until the field and method arrays are setup or else
2314    // Class::VisitFieldRoots may miss some fields or methods.
2315    ScopedAssertNoThreadSuspension nts(self, __FUNCTION__);
2316    // Load static fields.
2317    ClassDataItemIterator it(dex_file, class_data);
2318    const size_t num_sfields = it.NumStaticFields();
2319    ArtField* sfields = num_sfields != 0 ? AllocArtFieldArray(self, num_sfields) : nullptr;
2320    for (size_t i = 0; it.HasNextStaticField(); i++, it.Next()) {
2321      CHECK_LT(i, num_sfields);
2322      LoadField(it, klass, &sfields[i]);
2323    }
2324    klass->SetSFields(sfields);
2325    klass->SetNumStaticFields(num_sfields);
2326    DCHECK_EQ(klass->NumStaticFields(), num_sfields);
2327    // Load instance fields.
2328    const size_t num_ifields = it.NumInstanceFields();
2329    ArtField* ifields = num_ifields != 0 ? AllocArtFieldArray(self, num_ifields) : nullptr;
2330    for (size_t i = 0; it.HasNextInstanceField(); i++, it.Next()) {
2331      CHECK_LT(i, num_ifields);
2332      LoadField(it, klass, &ifields[i]);
2333    }
2334    klass->SetIFields(ifields);
2335    klass->SetNumInstanceFields(num_ifields);
2336    DCHECK_EQ(klass->NumInstanceFields(), num_ifields);
2337    // Load methods.
2338    if (it.NumDirectMethods() != 0) {
2339      klass->SetDirectMethodsPtr(AllocArtMethodArray(self, it.NumDirectMethods()));
2340    }
2341    klass->SetNumDirectMethods(it.NumDirectMethods());
2342    if (it.NumVirtualMethods() != 0) {
2343      klass->SetVirtualMethodsPtr(AllocArtMethodArray(self, it.NumVirtualMethods()));
2344    }
2345    klass->SetNumVirtualMethods(it.NumVirtualMethods());
2346    size_t class_def_method_index = 0;
2347    uint32_t last_dex_method_index = DexFile::kDexNoIndex;
2348    size_t last_class_def_method_index = 0;
2349    for (size_t i = 0; it.HasNextDirectMethod(); i++, it.Next()) {
2350      ArtMethod* method = klass->GetDirectMethodUnchecked(i, image_pointer_size_);
2351      LoadMethod(self, dex_file, it, klass, method);
2352      LinkCode(method, oat_class, class_def_method_index);
2353      uint32_t it_method_index = it.GetMemberIndex();
2354      if (last_dex_method_index == it_method_index) {
2355        // duplicate case
2356        method->SetMethodIndex(last_class_def_method_index);
2357      } else {
2358        method->SetMethodIndex(class_def_method_index);
2359        last_dex_method_index = it_method_index;
2360        last_class_def_method_index = class_def_method_index;
2361      }
2362      class_def_method_index++;
2363    }
2364    for (size_t i = 0; it.HasNextVirtualMethod(); i++, it.Next()) {
2365      ArtMethod* method = klass->GetVirtualMethodUnchecked(i, image_pointer_size_);
2366      LoadMethod(self, dex_file, it, klass, method);
2367      DCHECK_EQ(class_def_method_index, it.NumDirectMethods() + i);
2368      LinkCode(method, oat_class, class_def_method_index);
2369      class_def_method_index++;
2370    }
2371    DCHECK(!it.HasNext());
2372  }
2373  self->AllowThreadSuspension();
2374}
2375
2376void ClassLinker::LoadField(const ClassDataItemIterator& it, Handle<mirror::Class> klass,
2377                            ArtField* dst) {
2378  const uint32_t field_idx = it.GetMemberIndex();
2379  dst->SetDexFieldIndex(field_idx);
2380  dst->SetDeclaringClass(klass.Get());
2381  dst->SetAccessFlags(it.GetFieldAccessFlags());
2382}
2383
2384void ClassLinker::LoadMethod(Thread* self, const DexFile& dex_file, const ClassDataItemIterator& it,
2385                             Handle<mirror::Class> klass, ArtMethod* dst) {
2386  uint32_t dex_method_idx = it.GetMemberIndex();
2387  const DexFile::MethodId& method_id = dex_file.GetMethodId(dex_method_idx);
2388  const char* method_name = dex_file.StringDataByIdx(method_id.name_idx_);
2389
2390  ScopedAssertNoThreadSuspension ants(self, "LoadMethod");
2391  dst->SetDexMethodIndex(dex_method_idx);
2392  dst->SetDeclaringClass(klass.Get());
2393  dst->SetCodeItemOffset(it.GetMethodCodeItemOffset());
2394
2395  dst->SetDexCacheResolvedMethods(klass->GetDexCache()->GetResolvedMethods());
2396  dst->SetDexCacheResolvedTypes(klass->GetDexCache()->GetResolvedTypes());
2397
2398  uint32_t access_flags = it.GetMethodAccessFlags();
2399
2400  if (UNLIKELY(strcmp("finalize", method_name) == 0)) {
2401    // Set finalizable flag on declaring class.
2402    if (strcmp("V", dex_file.GetShorty(method_id.proto_idx_)) == 0) {
2403      // Void return type.
2404      if (klass->GetClassLoader() != nullptr) {  // All non-boot finalizer methods are flagged.
2405        klass->SetFinalizable();
2406      } else {
2407        std::string temp;
2408        const char* klass_descriptor = klass->GetDescriptor(&temp);
2409        // The Enum class declares a "final" finalize() method to prevent subclasses from
2410        // introducing a finalizer. We don't want to set the finalizable flag for Enum or its
2411        // subclasses, so we exclude it here.
2412        // We also want to avoid setting the flag on Object, where we know that finalize() is
2413        // empty.
2414        if (strcmp(klass_descriptor, "Ljava/lang/Object;") != 0 &&
2415            strcmp(klass_descriptor, "Ljava/lang/Enum;") != 0) {
2416          klass->SetFinalizable();
2417        }
2418      }
2419    }
2420  } else if (method_name[0] == '<') {
2421    // Fix broken access flags for initializers. Bug 11157540.
2422    bool is_init = (strcmp("<init>", method_name) == 0);
2423    bool is_clinit = !is_init && (strcmp("<clinit>", method_name) == 0);
2424    if (UNLIKELY(!is_init && !is_clinit)) {
2425      LOG(WARNING) << "Unexpected '<' at start of method name " << method_name;
2426    } else {
2427      if (UNLIKELY((access_flags & kAccConstructor) == 0)) {
2428        LOG(WARNING) << method_name << " didn't have expected constructor access flag in class "
2429            << PrettyDescriptor(klass.Get()) << " in dex file " << dex_file.GetLocation();
2430        access_flags |= kAccConstructor;
2431      }
2432    }
2433  }
2434  dst->SetAccessFlags(access_flags);
2435}
2436
2437void ClassLinker::AppendToBootClassPath(Thread* self, const DexFile& dex_file) {
2438  StackHandleScope<1> hs(self);
2439  Handle<mirror::DexCache> dex_cache(hs.NewHandle(AllocDexCache(self, dex_file)));
2440  CHECK(dex_cache.Get() != nullptr) << "Failed to allocate dex cache for "
2441                                    << dex_file.GetLocation();
2442  AppendToBootClassPath(dex_file, dex_cache);
2443}
2444
2445void ClassLinker::AppendToBootClassPath(const DexFile& dex_file,
2446                                        Handle<mirror::DexCache> dex_cache) {
2447  CHECK(dex_cache.Get() != nullptr) << dex_file.GetLocation();
2448  boot_class_path_.push_back(&dex_file);
2449  RegisterDexFile(dex_file, dex_cache);
2450}
2451
2452bool ClassLinker::IsDexFileRegisteredLocked(const DexFile& dex_file) {
2453  dex_lock_.AssertSharedHeld(Thread::Current());
2454  for (size_t i = 0; i != dex_caches_.size(); ++i) {
2455    mirror::DexCache* dex_cache = GetDexCache(i);
2456    if (dex_cache->GetDexFile() == &dex_file) {
2457      return true;
2458    }
2459  }
2460  return false;
2461}
2462
2463bool ClassLinker::IsDexFileRegistered(const DexFile& dex_file) {
2464  ReaderMutexLock mu(Thread::Current(), dex_lock_);
2465  return IsDexFileRegisteredLocked(dex_file);
2466}
2467
2468void ClassLinker::RegisterDexFileLocked(const DexFile& dex_file,
2469                                        Handle<mirror::DexCache> dex_cache) {
2470  dex_lock_.AssertExclusiveHeld(Thread::Current());
2471  CHECK(dex_cache.Get() != nullptr) << dex_file.GetLocation();
2472  CHECK(dex_cache->GetLocation()->Equals(dex_file.GetLocation()))
2473      << dex_cache->GetLocation()->ToModifiedUtf8() << " " << dex_file.GetLocation();
2474  dex_caches_.push_back(GcRoot<mirror::DexCache>(dex_cache.Get()));
2475  dex_cache->SetDexFile(&dex_file);
2476  if (log_new_dex_caches_roots_) {
2477    // TODO: This is not safe if we can remove dex caches.
2478    new_dex_cache_roots_.push_back(dex_caches_.size() - 1);
2479  }
2480}
2481
2482void ClassLinker::RegisterDexFile(const DexFile& dex_file) {
2483  Thread* self = Thread::Current();
2484  {
2485    ReaderMutexLock mu(self, dex_lock_);
2486    if (IsDexFileRegisteredLocked(dex_file)) {
2487      return;
2488    }
2489  }
2490  // Don't alloc while holding the lock, since allocation may need to
2491  // suspend all threads and another thread may need the dex_lock_ to
2492  // get to a suspend point.
2493  StackHandleScope<1> hs(self);
2494  Handle<mirror::DexCache> dex_cache(hs.NewHandle(AllocDexCache(self, dex_file)));
2495  CHECK(dex_cache.Get() != nullptr) << "Failed to allocate dex cache for "
2496                                    << dex_file.GetLocation();
2497  {
2498    WriterMutexLock mu(self, dex_lock_);
2499    if (IsDexFileRegisteredLocked(dex_file)) {
2500      return;
2501    }
2502    RegisterDexFileLocked(dex_file, dex_cache);
2503  }
2504}
2505
2506void ClassLinker::RegisterDexFile(const DexFile& dex_file,
2507                                  Handle<mirror::DexCache> dex_cache) {
2508  WriterMutexLock mu(Thread::Current(), dex_lock_);
2509  RegisterDexFileLocked(dex_file, dex_cache);
2510}
2511
2512mirror::DexCache* ClassLinker::FindDexCache(const DexFile& dex_file) {
2513  ReaderMutexLock mu(Thread::Current(), dex_lock_);
2514  // Search assuming unique-ness of dex file.
2515  for (size_t i = 0; i != dex_caches_.size(); ++i) {
2516    mirror::DexCache* dex_cache = GetDexCache(i);
2517    if (dex_cache->GetDexFile() == &dex_file) {
2518      return dex_cache;
2519    }
2520  }
2521  // Search matching by location name.
2522  std::string location(dex_file.GetLocation());
2523  for (size_t i = 0; i != dex_caches_.size(); ++i) {
2524    mirror::DexCache* dex_cache = GetDexCache(i);
2525    if (dex_cache->GetDexFile()->GetLocation() == location) {
2526      return dex_cache;
2527    }
2528  }
2529  // Failure, dump diagnostic and abort.
2530  for (size_t i = 0; i != dex_caches_.size(); ++i) {
2531    mirror::DexCache* dex_cache = GetDexCache(i);
2532    LOG(ERROR) << "Registered dex file " << i << " = " << dex_cache->GetDexFile()->GetLocation();
2533  }
2534  LOG(FATAL) << "Failed to find DexCache for DexFile " << location;
2535  UNREACHABLE();
2536}
2537
2538void ClassLinker::FixupDexCaches(ArtMethod* resolution_method) {
2539  ReaderMutexLock mu(Thread::Current(), dex_lock_);
2540  for (auto& dex_cache : dex_caches_) {
2541    dex_cache.Read()->Fixup(resolution_method, image_pointer_size_);
2542  }
2543}
2544
2545mirror::Class* ClassLinker::CreatePrimitiveClass(Thread* self, Primitive::Type type) {
2546  mirror::Class* klass = AllocClass(self, mirror::Class::PrimitiveClassSize(image_pointer_size_));
2547  if (UNLIKELY(klass == nullptr)) {
2548    self->AssertPendingOOMException();
2549    return nullptr;
2550  }
2551  return InitializePrimitiveClass(klass, type);
2552}
2553
2554mirror::Class* ClassLinker::InitializePrimitiveClass(mirror::Class* primitive_class,
2555                                                     Primitive::Type type) {
2556  CHECK(primitive_class != nullptr);
2557  // Must hold lock on object when initializing.
2558  Thread* self = Thread::Current();
2559  StackHandleScope<1> hs(self);
2560  Handle<mirror::Class> h_class(hs.NewHandle(primitive_class));
2561  ObjectLock<mirror::Class> lock(self, h_class);
2562  h_class->SetAccessFlags(kAccPublic | kAccFinal | kAccAbstract);
2563  h_class->SetPrimitiveType(type);
2564  mirror::Class::SetStatus(h_class, mirror::Class::kStatusInitialized, self);
2565  const char* descriptor = Primitive::Descriptor(type);
2566  mirror::Class* existing = InsertClass(descriptor, h_class.Get(),
2567                                        ComputeModifiedUtf8Hash(descriptor));
2568  CHECK(existing == nullptr) << "InitPrimitiveClass(" << type << ") failed";
2569  return h_class.Get();
2570}
2571
2572// Create an array class (i.e. the class object for the array, not the
2573// array itself).  "descriptor" looks like "[C" or "[[[[B" or
2574// "[Ljava/lang/String;".
2575//
2576// If "descriptor" refers to an array of primitives, look up the
2577// primitive type's internally-generated class object.
2578//
2579// "class_loader" is the class loader of the class that's referring to
2580// us.  It's used to ensure that we're looking for the element type in
2581// the right context.  It does NOT become the class loader for the
2582// array class; that always comes from the base element class.
2583//
2584// Returns null with an exception raised on failure.
2585mirror::Class* ClassLinker::CreateArrayClass(Thread* self, const char* descriptor, size_t hash,
2586                                             Handle<mirror::ClassLoader> class_loader) {
2587  // Identify the underlying component type
2588  CHECK_EQ('[', descriptor[0]);
2589  StackHandleScope<2> hs(self);
2590  MutableHandle<mirror::Class> component_type(hs.NewHandle(FindClass(self, descriptor + 1,
2591                                                                     class_loader)));
2592  if (component_type.Get() == nullptr) {
2593    DCHECK(self->IsExceptionPending());
2594    // We need to accept erroneous classes as component types.
2595    const size_t component_hash = ComputeModifiedUtf8Hash(descriptor + 1);
2596    component_type.Assign(LookupClass(self, descriptor + 1, component_hash, class_loader.Get()));
2597    if (component_type.Get() == nullptr) {
2598      DCHECK(self->IsExceptionPending());
2599      return nullptr;
2600    } else {
2601      self->ClearException();
2602    }
2603  }
2604  if (UNLIKELY(component_type->IsPrimitiveVoid())) {
2605    ThrowNoClassDefFoundError("Attempt to create array of void primitive type");
2606    return nullptr;
2607  }
2608  // See if the component type is already loaded.  Array classes are
2609  // always associated with the class loader of their underlying
2610  // element type -- an array of Strings goes with the loader for
2611  // java/lang/String -- so we need to look for it there.  (The
2612  // caller should have checked for the existence of the class
2613  // before calling here, but they did so with *their* class loader,
2614  // not the component type's loader.)
2615  //
2616  // If we find it, the caller adds "loader" to the class' initiating
2617  // loader list, which should prevent us from going through this again.
2618  //
2619  // This call is unnecessary if "loader" and "component_type->GetClassLoader()"
2620  // are the same, because our caller (FindClass) just did the
2621  // lookup.  (Even if we get this wrong we still have correct behavior,
2622  // because we effectively do this lookup again when we add the new
2623  // class to the hash table --- necessary because of possible races with
2624  // other threads.)
2625  if (class_loader.Get() != component_type->GetClassLoader()) {
2626    mirror::Class* new_class = LookupClass(self, descriptor, hash, component_type->GetClassLoader());
2627    if (new_class != nullptr) {
2628      return new_class;
2629    }
2630  }
2631
2632  // Fill out the fields in the Class.
2633  //
2634  // It is possible to execute some methods against arrays, because
2635  // all arrays are subclasses of java_lang_Object_, so we need to set
2636  // up a vtable.  We can just point at the one in java_lang_Object_.
2637  //
2638  // Array classes are simple enough that we don't need to do a full
2639  // link step.
2640  auto new_class = hs.NewHandle<mirror::Class>(nullptr);
2641  if (UNLIKELY(!init_done_)) {
2642    // Classes that were hand created, ie not by FindSystemClass
2643    if (strcmp(descriptor, "[Ljava/lang/Class;") == 0) {
2644      new_class.Assign(GetClassRoot(kClassArrayClass));
2645    } else if (strcmp(descriptor, "[Ljava/lang/Object;") == 0) {
2646      new_class.Assign(GetClassRoot(kObjectArrayClass));
2647    } else if (strcmp(descriptor, GetClassRootDescriptor(kJavaLangStringArrayClass)) == 0) {
2648      new_class.Assign(GetClassRoot(kJavaLangStringArrayClass));
2649    } else if (strcmp(descriptor, "[C") == 0) {
2650      new_class.Assign(GetClassRoot(kCharArrayClass));
2651    } else if (strcmp(descriptor, "[I") == 0) {
2652      new_class.Assign(GetClassRoot(kIntArrayClass));
2653    } else if (strcmp(descriptor, "[J") == 0) {
2654      new_class.Assign(GetClassRoot(kLongArrayClass));
2655    }
2656  }
2657  if (new_class.Get() == nullptr) {
2658    new_class.Assign(AllocClass(self, mirror::Array::ClassSize(image_pointer_size_)));
2659    if (new_class.Get() == nullptr) {
2660      self->AssertPendingOOMException();
2661      return nullptr;
2662    }
2663    new_class->SetComponentType(component_type.Get());
2664  }
2665  ObjectLock<mirror::Class> lock(self, new_class);  // Must hold lock on object when initializing.
2666  DCHECK(new_class->GetComponentType() != nullptr);
2667  mirror::Class* java_lang_Object = GetClassRoot(kJavaLangObject);
2668  new_class->SetSuperClass(java_lang_Object);
2669  new_class->SetVTable(java_lang_Object->GetVTable());
2670  new_class->SetPrimitiveType(Primitive::kPrimNot);
2671  new_class->SetClassLoader(component_type->GetClassLoader());
2672  mirror::Class::SetStatus(new_class, mirror::Class::kStatusLoaded, self);
2673  {
2674    ArtMethod* imt[mirror::Class::kImtSize];
2675    std::fill_n(imt, arraysize(imt), Runtime::Current()->GetImtUnimplementedMethod());
2676    new_class->PopulateEmbeddedImtAndVTable(imt, image_pointer_size_);
2677  }
2678  mirror::Class::SetStatus(new_class, mirror::Class::kStatusInitialized, self);
2679  // don't need to set new_class->SetObjectSize(..)
2680  // because Object::SizeOf delegates to Array::SizeOf
2681
2682
2683  // All arrays have java/lang/Cloneable and java/io/Serializable as
2684  // interfaces.  We need to set that up here, so that stuff like
2685  // "instanceof" works right.
2686  //
2687  // Note: The GC could run during the call to FindSystemClass,
2688  // so we need to make sure the class object is GC-valid while we're in
2689  // there.  Do this by clearing the interface list so the GC will just
2690  // think that the entries are null.
2691
2692
2693  // Use the single, global copies of "interfaces" and "iftable"
2694  // (remember not to free them for arrays).
2695  {
2696    mirror::IfTable* array_iftable = array_iftable_.Read();
2697    CHECK(array_iftable != nullptr);
2698    new_class->SetIfTable(array_iftable);
2699  }
2700
2701  // Inherit access flags from the component type.
2702  int access_flags = new_class->GetComponentType()->GetAccessFlags();
2703  // Lose any implementation detail flags; in particular, arrays aren't finalizable.
2704  access_flags &= kAccJavaFlagsMask;
2705  // Arrays can't be used as a superclass or interface, so we want to add "abstract final"
2706  // and remove "interface".
2707  access_flags |= kAccAbstract | kAccFinal;
2708  access_flags &= ~kAccInterface;
2709
2710  new_class->SetAccessFlags(access_flags);
2711
2712  mirror::Class* existing = InsertClass(descriptor, new_class.Get(), hash);
2713  if (existing == nullptr) {
2714    return new_class.Get();
2715  }
2716  // Another thread must have loaded the class after we
2717  // started but before we finished.  Abandon what we've
2718  // done.
2719  //
2720  // (Yes, this happens.)
2721
2722  return existing;
2723}
2724
2725mirror::Class* ClassLinker::FindPrimitiveClass(char type) {
2726  switch (type) {
2727    case 'B':
2728      return GetClassRoot(kPrimitiveByte);
2729    case 'C':
2730      return GetClassRoot(kPrimitiveChar);
2731    case 'D':
2732      return GetClassRoot(kPrimitiveDouble);
2733    case 'F':
2734      return GetClassRoot(kPrimitiveFloat);
2735    case 'I':
2736      return GetClassRoot(kPrimitiveInt);
2737    case 'J':
2738      return GetClassRoot(kPrimitiveLong);
2739    case 'S':
2740      return GetClassRoot(kPrimitiveShort);
2741    case 'Z':
2742      return GetClassRoot(kPrimitiveBoolean);
2743    case 'V':
2744      return GetClassRoot(kPrimitiveVoid);
2745    default:
2746      break;
2747  }
2748  std::string printable_type(PrintableChar(type));
2749  ThrowNoClassDefFoundError("Not a primitive type: %s", printable_type.c_str());
2750  return nullptr;
2751}
2752
2753mirror::Class* ClassLinker::InsertClass(const char* descriptor, mirror::Class* klass,
2754                                        size_t hash) {
2755  if (VLOG_IS_ON(class_linker)) {
2756    mirror::DexCache* dex_cache = klass->GetDexCache();
2757    std::string source;
2758    if (dex_cache != nullptr) {
2759      source += " from ";
2760      source += dex_cache->GetLocation()->ToModifiedUtf8();
2761    }
2762    LOG(INFO) << "Loaded class " << descriptor << source;
2763  }
2764  WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
2765  mirror::Class* existing = LookupClassFromTableLocked(descriptor, klass->GetClassLoader(), hash);
2766  if (existing != nullptr) {
2767    return existing;
2768  }
2769  if (kIsDebugBuild && !klass->IsTemp() && klass->GetClassLoader() == nullptr &&
2770      dex_cache_image_class_lookup_required_) {
2771    // Check a class loaded with the system class loader matches one in the image if the class
2772    // is in the image.
2773    existing = LookupClassFromImage(descriptor);
2774    if (existing != nullptr) {
2775      CHECK_EQ(klass, existing);
2776    }
2777  }
2778  VerifyObject(klass);
2779  class_table_.InsertWithHash(GcRoot<mirror::Class>(klass), hash);
2780  if (log_new_class_table_roots_) {
2781    new_class_roots_.push_back(GcRoot<mirror::Class>(klass));
2782  }
2783  return nullptr;
2784}
2785
2786void ClassLinker::UpdateClassVirtualMethods(mirror::Class* klass, ArtMethod* new_methods,
2787                                            size_t new_num_methods) {
2788  // classlinker_classes_lock_ is used to guard against races between root marking and changing the
2789  // direct and virtual method pointers.
2790  WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
2791  klass->SetNumVirtualMethods(new_num_methods);
2792  klass->SetVirtualMethodsPtr(new_methods);
2793  if (log_new_class_table_roots_) {
2794    new_class_roots_.push_back(GcRoot<mirror::Class>(klass));
2795  }
2796}
2797
2798mirror::Class* ClassLinker::UpdateClass(const char* descriptor, mirror::Class* klass,
2799                                        size_t hash) {
2800  WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
2801  auto existing_it = class_table_.FindWithHash(std::make_pair(descriptor, klass->GetClassLoader()),
2802                                               hash);
2803  CHECK(existing_it != class_table_.end());
2804  mirror::Class* existing = existing_it->Read();
2805  CHECK_NE(existing, klass) << descriptor;
2806  CHECK(!existing->IsResolved()) << descriptor;
2807  CHECK_EQ(klass->GetStatus(), mirror::Class::kStatusResolving) << descriptor;
2808
2809  CHECK(!klass->IsTemp()) << descriptor;
2810  if (kIsDebugBuild && klass->GetClassLoader() == nullptr &&
2811      dex_cache_image_class_lookup_required_) {
2812    // Check a class loaded with the system class loader matches one in the image if the class
2813    // is in the image.
2814    existing = LookupClassFromImage(descriptor);
2815    if (existing != nullptr) {
2816      CHECK_EQ(klass, existing) << descriptor;
2817    }
2818  }
2819  VerifyObject(klass);
2820
2821  // Update the element in the hash set.
2822  *existing_it = GcRoot<mirror::Class>(klass);
2823  if (log_new_class_table_roots_) {
2824    new_class_roots_.push_back(GcRoot<mirror::Class>(klass));
2825  }
2826
2827  return existing;
2828}
2829
2830bool ClassLinker::RemoveClass(const char* descriptor, mirror::ClassLoader* class_loader) {
2831  WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
2832  auto pair = std::make_pair(descriptor, class_loader);
2833  auto it = class_table_.Find(pair);
2834  if (it != class_table_.end()) {
2835    class_table_.Erase(it);
2836    return true;
2837  }
2838  it = pre_zygote_class_table_.Find(pair);
2839  if (it != pre_zygote_class_table_.end()) {
2840    pre_zygote_class_table_.Erase(it);
2841    return true;
2842  }
2843  return false;
2844}
2845
2846mirror::Class* ClassLinker::LookupClass(Thread* self, const char* descriptor, size_t hash,
2847                                        mirror::ClassLoader* class_loader) {
2848  {
2849    ReaderMutexLock mu(self, *Locks::classlinker_classes_lock_);
2850    mirror::Class* result = LookupClassFromTableLocked(descriptor, class_loader, hash);
2851    if (result != nullptr) {
2852      return result;
2853    }
2854  }
2855  if (class_loader != nullptr || !dex_cache_image_class_lookup_required_) {
2856    return nullptr;
2857  } else {
2858    // Lookup failed but need to search dex_caches_.
2859    mirror::Class* result = LookupClassFromImage(descriptor);
2860    if (result != nullptr) {
2861      InsertClass(descriptor, result, hash);
2862    } else {
2863      // Searching the image dex files/caches failed, we don't want to get into this situation
2864      // often as map searches are faster, so after kMaxFailedDexCacheLookups move all image
2865      // classes into the class table.
2866      constexpr uint32_t kMaxFailedDexCacheLookups = 1000;
2867      if (++failed_dex_cache_class_lookups_ > kMaxFailedDexCacheLookups) {
2868        MoveImageClassesToClassTable();
2869      }
2870    }
2871    return result;
2872  }
2873}
2874
2875mirror::Class* ClassLinker::LookupClassFromTableLocked(const char* descriptor,
2876                                                       mirror::ClassLoader* class_loader,
2877                                                       size_t hash) {
2878  auto descriptor_pair = std::make_pair(descriptor, class_loader);
2879  auto it = pre_zygote_class_table_.FindWithHash(descriptor_pair, hash);
2880  if (it == pre_zygote_class_table_.end()) {
2881    it = class_table_.FindWithHash(descriptor_pair, hash);
2882    if (it == class_table_.end()) {
2883      return nullptr;
2884    }
2885  }
2886  return it->Read();
2887}
2888
2889static mirror::ObjectArray<mirror::DexCache>* GetImageDexCaches()
2890    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2891  gc::space::ImageSpace* image = Runtime::Current()->GetHeap()->GetImageSpace();
2892  CHECK(image != nullptr);
2893  mirror::Object* root = image->GetImageHeader().GetImageRoot(ImageHeader::kDexCaches);
2894  return root->AsObjectArray<mirror::DexCache>();
2895}
2896
2897void ClassLinker::MoveImageClassesToClassTable() {
2898  Thread* self = Thread::Current();
2899  WriterMutexLock mu(self, *Locks::classlinker_classes_lock_);
2900  if (!dex_cache_image_class_lookup_required_) {
2901    return;  // All dex cache classes are already in the class table.
2902  }
2903  ScopedAssertNoThreadSuspension ants(self, "Moving image classes to class table");
2904  mirror::ObjectArray<mirror::DexCache>* dex_caches = GetImageDexCaches();
2905  std::string temp;
2906  for (int32_t i = 0; i < dex_caches->GetLength(); i++) {
2907    mirror::DexCache* dex_cache = dex_caches->Get(i);
2908    mirror::ObjectArray<mirror::Class>* types = dex_cache->GetResolvedTypes();
2909    for (int32_t j = 0; j < types->GetLength(); j++) {
2910      mirror::Class* klass = types->Get(j);
2911      if (klass != nullptr) {
2912        DCHECK(klass->GetClassLoader() == nullptr);
2913        const char* descriptor = klass->GetDescriptor(&temp);
2914        size_t hash = ComputeModifiedUtf8Hash(descriptor);
2915        mirror::Class* existing = LookupClassFromTableLocked(descriptor, nullptr, hash);
2916        if (existing != nullptr) {
2917          CHECK_EQ(existing, klass) << PrettyClassAndClassLoader(existing) << " != "
2918              << PrettyClassAndClassLoader(klass);
2919        } else {
2920          class_table_.Insert(GcRoot<mirror::Class>(klass));
2921          if (log_new_class_table_roots_) {
2922            new_class_roots_.push_back(GcRoot<mirror::Class>(klass));
2923          }
2924        }
2925      }
2926    }
2927  }
2928  dex_cache_image_class_lookup_required_ = false;
2929}
2930
2931void ClassLinker::MoveClassTableToPreZygote() {
2932  WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
2933  DCHECK(pre_zygote_class_table_.Empty());
2934  pre_zygote_class_table_ = std::move(class_table_);
2935  class_table_.Clear();
2936}
2937
2938mirror::Class* ClassLinker::LookupClassFromImage(const char* descriptor) {
2939  ScopedAssertNoThreadSuspension ants(Thread::Current(), "Image class lookup");
2940  mirror::ObjectArray<mirror::DexCache>* dex_caches = GetImageDexCaches();
2941  for (int32_t i = 0; i < dex_caches->GetLength(); ++i) {
2942    mirror::DexCache* dex_cache = dex_caches->Get(i);
2943    const DexFile* dex_file = dex_cache->GetDexFile();
2944    // Try binary searching the string/type index.
2945    const DexFile::StringId* string_id = dex_file->FindStringId(descriptor);
2946    if (string_id != nullptr) {
2947      const DexFile::TypeId* type_id =
2948          dex_file->FindTypeId(dex_file->GetIndexForStringId(*string_id));
2949      if (type_id != nullptr) {
2950        uint16_t type_idx = dex_file->GetIndexForTypeId(*type_id);
2951        mirror::Class* klass = dex_cache->GetResolvedType(type_idx);
2952        if (klass != nullptr) {
2953          return klass;
2954        }
2955      }
2956    }
2957  }
2958  return nullptr;
2959}
2960
2961void ClassLinker::LookupClasses(const char* descriptor, std::vector<mirror::Class*>& result) {
2962  result.clear();
2963  if (dex_cache_image_class_lookup_required_) {
2964    MoveImageClassesToClassTable();
2965  }
2966  WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
2967  while (true) {
2968    auto it = class_table_.Find(descriptor);
2969    if (it == class_table_.end()) {
2970      break;
2971    }
2972    result.push_back(it->Read());
2973    class_table_.Erase(it);
2974  }
2975  for (mirror::Class* k : result) {
2976    class_table_.Insert(GcRoot<mirror::Class>(k));
2977  }
2978  size_t pre_zygote_start = result.size();
2979  // Now handle the pre zygote table.
2980  // Note: This dirties the pre-zygote table but shouldn't be an issue since LookupClasses is only
2981  // called from the debugger.
2982  while (true) {
2983    auto it = pre_zygote_class_table_.Find(descriptor);
2984    if (it == pre_zygote_class_table_.end()) {
2985      break;
2986    }
2987    result.push_back(it->Read());
2988    pre_zygote_class_table_.Erase(it);
2989  }
2990  for (size_t i = pre_zygote_start; i < result.size(); ++i) {
2991    pre_zygote_class_table_.Insert(GcRoot<mirror::Class>(result[i]));
2992  }
2993}
2994
2995void ClassLinker::VerifyClass(Thread* self, Handle<mirror::Class> klass) {
2996  // TODO: assert that the monitor on the Class is held
2997  ObjectLock<mirror::Class> lock(self, klass);
2998
2999  // Don't attempt to re-verify if already sufficiently verified.
3000  if (klass->IsVerified()) {
3001    EnsurePreverifiedMethods(klass);
3002    return;
3003  }
3004  if (klass->IsCompileTimeVerified() && Runtime::Current()->IsAotCompiler()) {
3005    return;
3006  }
3007
3008  // The class might already be erroneous, for example at compile time if we attempted to verify
3009  // this class as a parent to another.
3010  if (klass->IsErroneous()) {
3011    ThrowEarlierClassFailure(klass.Get());
3012    return;
3013  }
3014
3015  if (klass->GetStatus() == mirror::Class::kStatusResolved) {
3016    mirror::Class::SetStatus(klass, mirror::Class::kStatusVerifying, self);
3017  } else {
3018    CHECK_EQ(klass->GetStatus(), mirror::Class::kStatusRetryVerificationAtRuntime)
3019        << PrettyClass(klass.Get());
3020    CHECK(!Runtime::Current()->IsAotCompiler());
3021    mirror::Class::SetStatus(klass, mirror::Class::kStatusVerifyingAtRuntime, self);
3022  }
3023
3024  // Skip verification if disabled.
3025  if (!Runtime::Current()->IsVerificationEnabled()) {
3026    mirror::Class::SetStatus(klass, mirror::Class::kStatusVerified, self);
3027    EnsurePreverifiedMethods(klass);
3028    return;
3029  }
3030
3031  // Verify super class.
3032  StackHandleScope<2> hs(self);
3033  Handle<mirror::Class> super(hs.NewHandle(klass->GetSuperClass()));
3034  if (super.Get() != nullptr) {
3035    // Acquire lock to prevent races on verifying the super class.
3036    ObjectLock<mirror::Class> super_lock(self, super);
3037
3038    if (!super->IsVerified() && !super->IsErroneous()) {
3039      VerifyClass(self, super);
3040    }
3041    if (!super->IsCompileTimeVerified()) {
3042      std::string error_msg(
3043          StringPrintf("Rejecting class %s that attempts to sub-class erroneous class %s",
3044                       PrettyDescriptor(klass.Get()).c_str(),
3045                       PrettyDescriptor(super.Get()).c_str()));
3046      LOG(WARNING) << error_msg  << " in " << klass->GetDexCache()->GetLocation()->ToModifiedUtf8();
3047      Handle<mirror::Throwable> cause(hs.NewHandle(self->GetException()));
3048      if (cause.Get() != nullptr) {
3049        self->ClearException();
3050      }
3051      ThrowVerifyError(klass.Get(), "%s", error_msg.c_str());
3052      if (cause.Get() != nullptr) {
3053        self->GetException()->SetCause(cause.Get());
3054      }
3055      ClassReference ref(klass->GetDexCache()->GetDexFile(), klass->GetDexClassDefIndex());
3056      if (Runtime::Current()->IsAotCompiler()) {
3057        Runtime::Current()->GetCompilerCallbacks()->ClassRejected(ref);
3058      }
3059      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3060      return;
3061    }
3062  }
3063
3064  // Try to use verification information from the oat file, otherwise do runtime verification.
3065  const DexFile& dex_file = *klass->GetDexCache()->GetDexFile();
3066  mirror::Class::Status oat_file_class_status(mirror::Class::kStatusNotReady);
3067  bool preverified = VerifyClassUsingOatFile(dex_file, klass.Get(), oat_file_class_status);
3068  if (oat_file_class_status == mirror::Class::kStatusError) {
3069    VLOG(class_linker) << "Skipping runtime verification of erroneous class "
3070        << PrettyDescriptor(klass.Get()) << " in "
3071        << klass->GetDexCache()->GetLocation()->ToModifiedUtf8();
3072    ThrowVerifyError(klass.Get(), "Rejecting class %s because it failed compile-time verification",
3073                     PrettyDescriptor(klass.Get()).c_str());
3074    mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3075    return;
3076  }
3077  verifier::MethodVerifier::FailureKind verifier_failure = verifier::MethodVerifier::kNoFailure;
3078  std::string error_msg;
3079  if (!preverified) {
3080    verifier_failure = verifier::MethodVerifier::VerifyClass(self, klass.Get(),
3081                                                             Runtime::Current()->IsAotCompiler(),
3082                                                             &error_msg);
3083  }
3084  if (preverified || verifier_failure != verifier::MethodVerifier::kHardFailure) {
3085    if (!preverified && verifier_failure != verifier::MethodVerifier::kNoFailure) {
3086      VLOG(class_linker) << "Soft verification failure in class " << PrettyDescriptor(klass.Get())
3087          << " in " << klass->GetDexCache()->GetLocation()->ToModifiedUtf8()
3088          << " because: " << error_msg;
3089    }
3090    self->AssertNoPendingException();
3091    // Make sure all classes referenced by catch blocks are resolved.
3092    ResolveClassExceptionHandlerTypes(dex_file, klass);
3093    if (verifier_failure == verifier::MethodVerifier::kNoFailure) {
3094      // Even though there were no verifier failures we need to respect whether the super-class
3095      // was verified or requiring runtime reverification.
3096      if (super.Get() == nullptr || super->IsVerified()) {
3097        mirror::Class::SetStatus(klass, mirror::Class::kStatusVerified, self);
3098      } else {
3099        CHECK_EQ(super->GetStatus(), mirror::Class::kStatusRetryVerificationAtRuntime);
3100        mirror::Class::SetStatus(klass, mirror::Class::kStatusRetryVerificationAtRuntime, self);
3101        // Pretend a soft failure occured so that we don't consider the class verified below.
3102        verifier_failure = verifier::MethodVerifier::kSoftFailure;
3103      }
3104    } else {
3105      CHECK_EQ(verifier_failure, verifier::MethodVerifier::kSoftFailure);
3106      // Soft failures at compile time should be retried at runtime. Soft
3107      // failures at runtime will be handled by slow paths in the generated
3108      // code. Set status accordingly.
3109      if (Runtime::Current()->IsAotCompiler()) {
3110        mirror::Class::SetStatus(klass, mirror::Class::kStatusRetryVerificationAtRuntime, self);
3111      } else {
3112        mirror::Class::SetStatus(klass, mirror::Class::kStatusVerified, self);
3113        // As this is a fake verified status, make sure the methods are _not_ marked preverified
3114        // later.
3115        klass->SetPreverified();
3116      }
3117    }
3118  } else {
3119    LOG(WARNING) << "Verification failed on class " << PrettyDescriptor(klass.Get())
3120        << " in " << klass->GetDexCache()->GetLocation()->ToModifiedUtf8()
3121        << " because: " << error_msg;
3122    self->AssertNoPendingException();
3123    ThrowVerifyError(klass.Get(), "%s", error_msg.c_str());
3124    mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3125  }
3126  if (preverified || verifier_failure == verifier::MethodVerifier::kNoFailure) {
3127    // Class is verified so we don't need to do any access check on its methods.
3128    // Let the interpreter know it by setting the kAccPreverified flag onto each
3129    // method.
3130    // Note: we're going here during compilation and at runtime. When we set the
3131    // kAccPreverified flag when compiling image classes, the flag is recorded
3132    // in the image and is set when loading the image.
3133    EnsurePreverifiedMethods(klass);
3134  }
3135}
3136
3137void ClassLinker::EnsurePreverifiedMethods(Handle<mirror::Class> klass) {
3138  if (!klass->IsPreverified()) {
3139    klass->SetPreverifiedFlagOnAllMethods(image_pointer_size_);
3140    klass->SetPreverified();
3141  }
3142}
3143
3144bool ClassLinker::VerifyClassUsingOatFile(const DexFile& dex_file, mirror::Class* klass,
3145                                          mirror::Class::Status& oat_file_class_status) {
3146  // If we're compiling, we can only verify the class using the oat file if
3147  // we are not compiling the image or if the class we're verifying is not part of
3148  // the app.  In other words, we will only check for preverification of bootclasspath
3149  // classes.
3150  if (Runtime::Current()->IsAotCompiler()) {
3151    // Are we compiling the bootclasspath?
3152    if (Runtime::Current()->GetCompilerCallbacks()->IsBootImage()) {
3153      return false;
3154    }
3155    // We are compiling an app (not the image).
3156
3157    // Is this an app class? (I.e. not a bootclasspath class)
3158    if (klass->GetClassLoader() != nullptr) {
3159      return false;
3160    }
3161  }
3162
3163  const OatFile::OatDexFile* oat_dex_file = dex_file.GetOatDexFile();
3164  // In case we run without an image there won't be a backing oat file.
3165  if (oat_dex_file == nullptr) {
3166    return false;
3167  }
3168
3169  // We may be running with a preopted oat file but without image. In this case,
3170  // we don't skip verification of preverified classes to ensure we initialize
3171  // dex caches with all types resolved during verification.
3172  // We need to trust image classes, as these might be coming out of a pre-opted, quickened boot
3173  // image (that we just failed loading), and the verifier can't be run on quickened opcodes when
3174  // the runtime isn't started. On the other hand, app classes can be re-verified even if they are
3175  // already pre-opted, as then the runtime is started.
3176  if (!Runtime::Current()->IsAotCompiler() &&
3177      !Runtime::Current()->GetHeap()->HasImageSpace() &&
3178      klass->GetClassLoader() != nullptr) {
3179    return false;
3180  }
3181
3182  uint16_t class_def_index = klass->GetDexClassDefIndex();
3183  oat_file_class_status = oat_dex_file->GetOatClass(class_def_index).GetStatus();
3184  if (oat_file_class_status == mirror::Class::kStatusVerified ||
3185      oat_file_class_status == mirror::Class::kStatusInitialized) {
3186      return true;
3187  }
3188  if (oat_file_class_status == mirror::Class::kStatusRetryVerificationAtRuntime) {
3189    // Compile time verification failed with a soft error. Compile time verification can fail
3190    // because we have incomplete type information. Consider the following:
3191    // class ... {
3192    //   Foo x;
3193    //   .... () {
3194    //     if (...) {
3195    //       v1 gets assigned a type of resolved class Foo
3196    //     } else {
3197    //       v1 gets assigned a type of unresolved class Bar
3198    //     }
3199    //     iput x = v1
3200    // } }
3201    // when we merge v1 following the if-the-else it results in Conflict
3202    // (see verifier::RegType::Merge) as we can't know the type of Bar and we could possibly be
3203    // allowing an unsafe assignment to the field x in the iput (javac may have compiled this as
3204    // it knew Bar was a sub-class of Foo, but for us this may have been moved into a separate apk
3205    // at compile time).
3206    return false;
3207  }
3208  if (oat_file_class_status == mirror::Class::kStatusError) {
3209    // Compile time verification failed with a hard error. This is caused by invalid instructions
3210    // in the class. These errors are unrecoverable.
3211    return false;
3212  }
3213  if (oat_file_class_status == mirror::Class::kStatusNotReady) {
3214    // Status is uninitialized if we couldn't determine the status at compile time, for example,
3215    // not loading the class.
3216    // TODO: when the verifier doesn't rely on Class-es failing to resolve/load the type hierarchy
3217    // isn't a problem and this case shouldn't occur
3218    return false;
3219  }
3220  std::string temp;
3221  LOG(FATAL) << "Unexpected class status: " << oat_file_class_status
3222             << " " << dex_file.GetLocation() << " " << PrettyClass(klass) << " "
3223             << klass->GetDescriptor(&temp);
3224  UNREACHABLE();
3225}
3226
3227void ClassLinker::ResolveClassExceptionHandlerTypes(const DexFile& dex_file,
3228                                                    Handle<mirror::Class> klass) {
3229  for (size_t i = 0; i < klass->NumDirectMethods(); i++) {
3230    ResolveMethodExceptionHandlerTypes(dex_file, klass->GetDirectMethod(i, image_pointer_size_));
3231  }
3232  for (size_t i = 0; i < klass->NumVirtualMethods(); i++) {
3233    ResolveMethodExceptionHandlerTypes(dex_file, klass->GetVirtualMethod(i, image_pointer_size_));
3234  }
3235}
3236
3237void ClassLinker::ResolveMethodExceptionHandlerTypes(const DexFile& dex_file,
3238                                                     ArtMethod* method) {
3239  // similar to DexVerifier::ScanTryCatchBlocks and dex2oat's ResolveExceptionsForMethod.
3240  const DexFile::CodeItem* code_item = dex_file.GetCodeItem(method->GetCodeItemOffset());
3241  if (code_item == nullptr) {
3242    return;  // native or abstract method
3243  }
3244  if (code_item->tries_size_ == 0) {
3245    return;  // nothing to process
3246  }
3247  const uint8_t* handlers_ptr = DexFile::GetCatchHandlerData(*code_item, 0);
3248  uint32_t handlers_size = DecodeUnsignedLeb128(&handlers_ptr);
3249  ClassLinker* linker = Runtime::Current()->GetClassLinker();
3250  for (uint32_t idx = 0; idx < handlers_size; idx++) {
3251    CatchHandlerIterator iterator(handlers_ptr);
3252    for (; iterator.HasNext(); iterator.Next()) {
3253      // Ensure exception types are resolved so that they don't need resolution to be delivered,
3254      // unresolved exception types will be ignored by exception delivery
3255      if (iterator.GetHandlerTypeIndex() != DexFile::kDexNoIndex16) {
3256        mirror::Class* exception_type = linker->ResolveType(iterator.GetHandlerTypeIndex(), method);
3257        if (exception_type == nullptr) {
3258          DCHECK(Thread::Current()->IsExceptionPending());
3259          Thread::Current()->ClearException();
3260        }
3261      }
3262    }
3263    handlers_ptr = iterator.EndDataPointer();
3264  }
3265}
3266
3267mirror::Class* ClassLinker::CreateProxyClass(ScopedObjectAccessAlreadyRunnable& soa, jstring name,
3268                                             jobjectArray interfaces, jobject loader,
3269                                             jobjectArray methods, jobjectArray throws) {
3270  Thread* self = soa.Self();
3271  StackHandleScope<10> hs(self);
3272  MutableHandle<mirror::Class> klass(hs.NewHandle(
3273      AllocClass(self, GetClassRoot(kJavaLangClass), sizeof(mirror::Class))));
3274  if (klass.Get() == nullptr) {
3275    CHECK(self->IsExceptionPending());  // OOME.
3276    return nullptr;
3277  }
3278  DCHECK(klass->GetClass() != nullptr);
3279  klass->SetObjectSize(sizeof(mirror::Proxy));
3280  // Set the class access flags incl. preverified, so we do not try to set the flag on the methods.
3281  klass->SetAccessFlags(kAccClassIsProxy | kAccPublic | kAccFinal | kAccPreverified);
3282  klass->SetClassLoader(soa.Decode<mirror::ClassLoader*>(loader));
3283  DCHECK_EQ(klass->GetPrimitiveType(), Primitive::kPrimNot);
3284  klass->SetName(soa.Decode<mirror::String*>(name));
3285  klass->SetDexCache(GetClassRoot(kJavaLangReflectProxy)->GetDexCache());
3286  mirror::Class::SetStatus(klass, mirror::Class::kStatusIdx, self);
3287  std::string descriptor(GetDescriptorForProxy(klass.Get()));
3288  size_t hash = ComputeModifiedUtf8Hash(descriptor.c_str());
3289
3290  // Insert the class before loading the fields as the field roots
3291  // (ArtField::declaring_class_) are only visited from the class
3292  // table. There can't be any suspend points between inserting the
3293  // class and setting the field arrays below.
3294  mirror::Class* existing = InsertClass(descriptor.c_str(), klass.Get(), hash);
3295  CHECK(existing == nullptr);
3296
3297  // Instance fields are inherited, but we add a couple of static fields...
3298  const size_t num_fields = 2;
3299  ArtField* sfields = AllocArtFieldArray(self, num_fields);
3300  klass->SetSFields(sfields);
3301  klass->SetNumStaticFields(num_fields);
3302
3303  // 1. Create a static field 'interfaces' that holds the _declared_ interfaces implemented by
3304  // our proxy, so Class.getInterfaces doesn't return the flattened set.
3305  ArtField* interfaces_sfield = &sfields[0];
3306  interfaces_sfield->SetDexFieldIndex(0);
3307  interfaces_sfield->SetDeclaringClass(klass.Get());
3308  interfaces_sfield->SetAccessFlags(kAccStatic | kAccPublic | kAccFinal);
3309
3310  // 2. Create a static field 'throws' that holds exceptions thrown by our methods.
3311  ArtField* throws_sfield = &sfields[1];
3312  throws_sfield->SetDexFieldIndex(1);
3313  throws_sfield->SetDeclaringClass(klass.Get());
3314  throws_sfield->SetAccessFlags(kAccStatic | kAccPublic | kAccFinal);
3315
3316  // Proxies have 1 direct method, the constructor
3317  auto* directs = AllocArtMethodArray(self, 1);
3318  // Currently AllocArtMethodArray cannot return null, but the OOM logic is left there in case we
3319  // want to throw OOM in the future.
3320  if (UNLIKELY(directs == nullptr)) {
3321    self->AssertPendingOOMException();
3322    return nullptr;
3323  }
3324  klass->SetDirectMethodsPtr(directs);
3325  klass->SetNumDirectMethods(1u);
3326  CreateProxyConstructor(klass, klass->GetDirectMethodUnchecked(0, image_pointer_size_));
3327
3328  // Create virtual method using specified prototypes.
3329  auto h_methods = hs.NewHandle(soa.Decode<mirror::ObjectArray<mirror::Method>*>(methods));
3330  DCHECK_EQ(h_methods->GetClass(), mirror::Method::ArrayClass())
3331    << PrettyClass(h_methods->GetClass());
3332  const size_t num_virtual_methods = h_methods->GetLength();
3333  auto* virtuals = AllocArtMethodArray(self, num_virtual_methods);
3334  // Currently AllocArtMethodArray cannot return null, but the OOM logic is left there in case we
3335  // want to throw OOM in the future.
3336  if (UNLIKELY(virtuals == nullptr)) {
3337    self->AssertPendingOOMException();
3338    return nullptr;
3339  }
3340  klass->SetVirtualMethodsPtr(virtuals);
3341  klass->SetNumVirtualMethods(num_virtual_methods);
3342  for (size_t i = 0; i < num_virtual_methods; ++i) {
3343    auto* virtual_method = klass->GetVirtualMethodUnchecked(i, image_pointer_size_);
3344    auto* prototype = h_methods->Get(i)->GetArtMethod();
3345    CreateProxyMethod(klass, prototype, virtual_method);
3346    DCHECK(virtual_method->GetDeclaringClass() != nullptr);
3347    DCHECK(prototype->GetDeclaringClass() != nullptr);
3348  }
3349
3350  // The super class is java.lang.reflect.Proxy
3351  klass->SetSuperClass(GetClassRoot(kJavaLangReflectProxy));
3352  // Now effectively in the loaded state.
3353  mirror::Class::SetStatus(klass, mirror::Class::kStatusLoaded, self);
3354  self->AssertNoPendingException();
3355
3356  MutableHandle<mirror::Class> new_class = hs.NewHandle<mirror::Class>(nullptr);
3357  {
3358    // Must hold lock on object when resolved.
3359    ObjectLock<mirror::Class> resolution_lock(self, klass);
3360    // Link the fields and virtual methods, creating vtable and iftables.
3361    // The new class will replace the old one in the class table.
3362    Handle<mirror::ObjectArray<mirror::Class>> h_interfaces(
3363        hs.NewHandle(soa.Decode<mirror::ObjectArray<mirror::Class>*>(interfaces)));
3364    if (!LinkClass(self, descriptor.c_str(), klass, h_interfaces, &new_class)) {
3365      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3366      return nullptr;
3367    }
3368  }
3369  CHECK(klass->IsRetired());
3370  CHECK_NE(klass.Get(), new_class.Get());
3371  klass.Assign(new_class.Get());
3372
3373  CHECK_EQ(interfaces_sfield->GetDeclaringClass(), klass.Get());
3374  interfaces_sfield->SetObject<false>(klass.Get(),
3375                                      soa.Decode<mirror::ObjectArray<mirror::Class>*>(interfaces));
3376  CHECK_EQ(throws_sfield->GetDeclaringClass(), klass.Get());
3377  throws_sfield->SetObject<false>(klass.Get(),
3378      soa.Decode<mirror::ObjectArray<mirror::ObjectArray<mirror::Class> >*>(throws));
3379
3380  {
3381    // Lock on klass is released. Lock new class object.
3382    ObjectLock<mirror::Class> initialization_lock(self, klass);
3383    mirror::Class::SetStatus(klass, mirror::Class::kStatusInitialized, self);
3384  }
3385
3386  // sanity checks
3387  if (kIsDebugBuild) {
3388    CHECK(klass->GetIFields() == nullptr);
3389    CheckProxyConstructor(klass->GetDirectMethod(0, image_pointer_size_));
3390
3391    for (size_t i = 0; i < num_virtual_methods; ++i) {
3392      auto* virtual_method = klass->GetVirtualMethodUnchecked(i, image_pointer_size_);
3393      auto* prototype = h_methods->Get(i++)->GetArtMethod();
3394      CheckProxyMethod(virtual_method, prototype);
3395    }
3396
3397    StackHandleScope<1> hs2(self);
3398    Handle<mirror::String> decoded_name = hs2.NewHandle(soa.Decode<mirror::String*>(name));
3399    std::string interfaces_field_name(StringPrintf("java.lang.Class[] %s.interfaces",
3400                                                   decoded_name->ToModifiedUtf8().c_str()));
3401    CHECK_EQ(PrettyField(klass->GetStaticField(0)), interfaces_field_name);
3402
3403    std::string throws_field_name(StringPrintf("java.lang.Class[][] %s.throws",
3404                                               decoded_name->ToModifiedUtf8().c_str()));
3405    CHECK_EQ(PrettyField(klass->GetStaticField(1)), throws_field_name);
3406
3407    CHECK_EQ(klass.Get()->GetInterfaces(),
3408             soa.Decode<mirror::ObjectArray<mirror::Class>*>(interfaces));
3409    CHECK_EQ(klass.Get()->GetThrows(),
3410             soa.Decode<mirror::ObjectArray<mirror::ObjectArray<mirror::Class>>*>(throws));
3411  }
3412  return klass.Get();
3413}
3414
3415std::string ClassLinker::GetDescriptorForProxy(mirror::Class* proxy_class) {
3416  DCHECK(proxy_class->IsProxyClass());
3417  mirror::String* name = proxy_class->GetName();
3418  DCHECK(name != nullptr);
3419  return DotToDescriptor(name->ToModifiedUtf8().c_str());
3420}
3421
3422ArtMethod* ClassLinker::FindMethodForProxy(mirror::Class* proxy_class,
3423                                                   ArtMethod* proxy_method) {
3424  DCHECK(proxy_class->IsProxyClass());
3425  DCHECK(proxy_method->IsProxyMethod());
3426  {
3427    ReaderMutexLock mu(Thread::Current(), dex_lock_);
3428    // Locate the dex cache of the original interface/Object
3429    for (const GcRoot<mirror::DexCache>& root : dex_caches_) {
3430      auto* dex_cache = root.Read();
3431      if (proxy_method->HasSameDexCacheResolvedTypes(dex_cache->GetResolvedTypes())) {
3432        ArtMethod* resolved_method = dex_cache->GetResolvedMethod(
3433            proxy_method->GetDexMethodIndex(), image_pointer_size_);
3434        CHECK(resolved_method != nullptr);
3435        return resolved_method;
3436      }
3437    }
3438  }
3439  LOG(FATAL) << "Didn't find dex cache for " << PrettyClass(proxy_class) << " "
3440      << PrettyMethod(proxy_method);
3441  UNREACHABLE();
3442}
3443
3444void ClassLinker::CreateProxyConstructor(Handle<mirror::Class> klass, ArtMethod* out) {
3445  // Create constructor for Proxy that must initialize the method.
3446  CHECK_EQ(GetClassRoot(kJavaLangReflectProxy)->NumDirectMethods(), 16u);
3447  ArtMethod* proxy_constructor = GetClassRoot(kJavaLangReflectProxy)->GetDirectMethodUnchecked(
3448      2, image_pointer_size_);
3449  // Ensure constructor is in dex cache so that we can use the dex cache to look up the overridden
3450  // constructor method.
3451  GetClassRoot(kJavaLangReflectProxy)->GetDexCache()->SetResolvedMethod(
3452      proxy_constructor->GetDexMethodIndex(), proxy_constructor, image_pointer_size_);
3453  // Clone the existing constructor of Proxy (our constructor would just invoke it so steal its
3454  // code_ too)
3455  DCHECK(out != nullptr);
3456  out->CopyFrom(proxy_constructor, image_pointer_size_);
3457  // Make this constructor public and fix the class to be our Proxy version
3458  out->SetAccessFlags((out->GetAccessFlags() & ~kAccProtected) | kAccPublic);
3459  out->SetDeclaringClass(klass.Get());
3460}
3461
3462void ClassLinker::CheckProxyConstructor(ArtMethod* constructor) const {
3463  CHECK(constructor->IsConstructor());
3464  auto* np = constructor->GetInterfaceMethodIfProxy(image_pointer_size_);
3465  CHECK_STREQ(np->GetName(), "<init>");
3466  CHECK_STREQ(np->GetSignature().ToString().c_str(), "(Ljava/lang/reflect/InvocationHandler;)V");
3467  DCHECK(constructor->IsPublic());
3468}
3469
3470void ClassLinker::CreateProxyMethod(Handle<mirror::Class> klass, ArtMethod* prototype,
3471                                    ArtMethod* out) {
3472  // Ensure prototype is in dex cache so that we can use the dex cache to look up the overridden
3473  // prototype method
3474  auto* dex_cache = prototype->GetDeclaringClass()->GetDexCache();
3475  // Avoid dirtying the dex cache unless we need to.
3476  if (dex_cache->GetResolvedMethod(prototype->GetDexMethodIndex(), image_pointer_size_) !=
3477      prototype) {
3478    dex_cache->SetResolvedMethod(
3479        prototype->GetDexMethodIndex(), prototype, image_pointer_size_);
3480  }
3481  // We steal everything from the prototype (such as DexCache, invoke stub, etc.) then specialize
3482  // as necessary
3483  DCHECK(out != nullptr);
3484  out->CopyFrom(prototype, image_pointer_size_);
3485
3486  // Set class to be the concrete proxy class and clear the abstract flag, modify exceptions to
3487  // the intersection of throw exceptions as defined in Proxy
3488  out->SetDeclaringClass(klass.Get());
3489  out->SetAccessFlags((out->GetAccessFlags() & ~kAccAbstract) | kAccFinal);
3490
3491  // At runtime the method looks like a reference and argument saving method, clone the code
3492  // related parameters from this method.
3493  out->SetEntryPointFromQuickCompiledCode(GetQuickProxyInvokeHandler());
3494  out->SetEntryPointFromInterpreter(artInterpreterToCompiledCodeBridge);
3495}
3496
3497void ClassLinker::CheckProxyMethod(ArtMethod* method, ArtMethod* prototype) const {
3498  // Basic sanity
3499  CHECK(!prototype->IsFinal());
3500  CHECK(method->IsFinal());
3501  CHECK(!method->IsAbstract());
3502
3503  // The proxy method doesn't have its own dex cache or dex file and so it steals those of its
3504  // interface prototype. The exception to this are Constructors and the Class of the Proxy itself.
3505  CHECK(prototype->HasSameDexCacheResolvedMethods(method));
3506  CHECK(prototype->HasSameDexCacheResolvedTypes(method));
3507  auto* np = method->GetInterfaceMethodIfProxy(image_pointer_size_);
3508  CHECK_EQ(prototype->GetDeclaringClass()->GetDexCache(), np->GetDexCache());
3509  CHECK_EQ(prototype->GetDexMethodIndex(), method->GetDexMethodIndex());
3510
3511  CHECK_STREQ(np->GetName(), prototype->GetName());
3512  CHECK_STREQ(np->GetShorty(), prototype->GetShorty());
3513  // More complex sanity - via dex cache
3514  CHECK_EQ(np->GetReturnType(), prototype->GetReturnType());
3515}
3516
3517bool ClassLinker::CanWeInitializeClass(mirror::Class* klass, bool can_init_statics,
3518                                       bool can_init_parents) {
3519  if (can_init_statics && can_init_parents) {
3520    return true;
3521  }
3522  if (!can_init_statics) {
3523    // Check if there's a class initializer.
3524    ArtMethod* clinit = klass->FindClassInitializer(image_pointer_size_);
3525    if (clinit != nullptr) {
3526      return false;
3527    }
3528    // Check if there are encoded static values needing initialization.
3529    if (klass->NumStaticFields() != 0) {
3530      const DexFile::ClassDef* dex_class_def = klass->GetClassDef();
3531      DCHECK(dex_class_def != nullptr);
3532      if (dex_class_def->static_values_off_ != 0) {
3533        return false;
3534      }
3535    }
3536  }
3537  if (klass->IsInterface() || !klass->HasSuperClass()) {
3538    return true;
3539  }
3540  mirror::Class* super_class = klass->GetSuperClass();
3541  if (!can_init_parents && !super_class->IsInitialized()) {
3542    return false;
3543  }
3544  return CanWeInitializeClass(super_class, can_init_statics, can_init_parents);
3545}
3546
3547bool ClassLinker::InitializeClass(Thread* self, Handle<mirror::Class> klass,
3548                                  bool can_init_statics, bool can_init_parents) {
3549  // see JLS 3rd edition, 12.4.2 "Detailed Initialization Procedure" for the locking protocol
3550
3551  // Are we already initialized and therefore done?
3552  // Note: we differ from the JLS here as we don't do this under the lock, this is benign as
3553  // an initialized class will never change its state.
3554  if (klass->IsInitialized()) {
3555    return true;
3556  }
3557
3558  // Fast fail if initialization requires a full runtime. Not part of the JLS.
3559  if (!CanWeInitializeClass(klass.Get(), can_init_statics, can_init_parents)) {
3560    return false;
3561  }
3562
3563  self->AllowThreadSuspension();
3564  uint64_t t0;
3565  {
3566    ObjectLock<mirror::Class> lock(self, klass);
3567
3568    // Re-check under the lock in case another thread initialized ahead of us.
3569    if (klass->IsInitialized()) {
3570      return true;
3571    }
3572
3573    // Was the class already found to be erroneous? Done under the lock to match the JLS.
3574    if (klass->IsErroneous()) {
3575      ThrowEarlierClassFailure(klass.Get());
3576      VlogClassInitializationFailure(klass);
3577      return false;
3578    }
3579
3580    CHECK(klass->IsResolved()) << PrettyClass(klass.Get()) << ": state=" << klass->GetStatus();
3581
3582    if (!klass->IsVerified()) {
3583      VerifyClass(self, klass);
3584      if (!klass->IsVerified()) {
3585        // We failed to verify, expect either the klass to be erroneous or verification failed at
3586        // compile time.
3587        if (klass->IsErroneous()) {
3588          CHECK(self->IsExceptionPending());
3589          VlogClassInitializationFailure(klass);
3590        } else {
3591          CHECK(Runtime::Current()->IsAotCompiler());
3592          CHECK_EQ(klass->GetStatus(), mirror::Class::kStatusRetryVerificationAtRuntime);
3593        }
3594        return false;
3595      } else {
3596        self->AssertNoPendingException();
3597      }
3598    }
3599
3600    // If the class is kStatusInitializing, either this thread is
3601    // initializing higher up the stack or another thread has beat us
3602    // to initializing and we need to wait. Either way, this
3603    // invocation of InitializeClass will not be responsible for
3604    // running <clinit> and will return.
3605    if (klass->GetStatus() == mirror::Class::kStatusInitializing) {
3606      // Could have got an exception during verification.
3607      if (self->IsExceptionPending()) {
3608        VlogClassInitializationFailure(klass);
3609        return false;
3610      }
3611      // We caught somebody else in the act; was it us?
3612      if (klass->GetClinitThreadId() == self->GetTid()) {
3613        // Yes. That's fine. Return so we can continue initializing.
3614        return true;
3615      }
3616      // No. That's fine. Wait for another thread to finish initializing.
3617      return WaitForInitializeClass(klass, self, lock);
3618    }
3619
3620    if (!ValidateSuperClassDescriptors(klass)) {
3621      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3622      return false;
3623    }
3624    self->AllowThreadSuspension();
3625
3626    CHECK_EQ(klass->GetStatus(), mirror::Class::kStatusVerified) << PrettyClass(klass.Get());
3627
3628    // From here out other threads may observe that we're initializing and so changes of state
3629    // require the a notification.
3630    klass->SetClinitThreadId(self->GetTid());
3631    mirror::Class::SetStatus(klass, mirror::Class::kStatusInitializing, self);
3632
3633    t0 = NanoTime();
3634  }
3635
3636  // Initialize super classes, must be done while initializing for the JLS.
3637  if (!klass->IsInterface() && klass->HasSuperClass()) {
3638    mirror::Class* super_class = klass->GetSuperClass();
3639    if (!super_class->IsInitialized()) {
3640      CHECK(!super_class->IsInterface());
3641      CHECK(can_init_parents);
3642      StackHandleScope<1> hs(self);
3643      Handle<mirror::Class> handle_scope_super(hs.NewHandle(super_class));
3644      bool super_initialized = InitializeClass(self, handle_scope_super, can_init_statics, true);
3645      if (!super_initialized) {
3646        // The super class was verified ahead of entering initializing, we should only be here if
3647        // the super class became erroneous due to initialization.
3648        CHECK(handle_scope_super->IsErroneous() && self->IsExceptionPending())
3649            << "Super class initialization failed for "
3650            << PrettyDescriptor(handle_scope_super.Get())
3651            << " that has unexpected status " << handle_scope_super->GetStatus()
3652            << "\nPending exception:\n"
3653            << (self->GetException() != nullptr ? self->GetException()->Dump() : "");
3654        ObjectLock<mirror::Class> lock(self, klass);
3655        // Initialization failed because the super-class is erroneous.
3656        mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3657        return false;
3658      }
3659    }
3660  }
3661
3662  const size_t num_static_fields = klass->NumStaticFields();
3663  if (num_static_fields > 0) {
3664    const DexFile::ClassDef* dex_class_def = klass->GetClassDef();
3665    CHECK(dex_class_def != nullptr);
3666    const DexFile& dex_file = klass->GetDexFile();
3667    StackHandleScope<3> hs(self);
3668    Handle<mirror::ClassLoader> class_loader(hs.NewHandle(klass->GetClassLoader()));
3669    Handle<mirror::DexCache> dex_cache(hs.NewHandle(klass->GetDexCache()));
3670
3671    // Eagerly fill in static fields so that the we don't have to do as many expensive
3672    // Class::FindStaticField in ResolveField.
3673    for (size_t i = 0; i < num_static_fields; ++i) {
3674      ArtField* field = klass->GetStaticField(i);
3675      const uint32_t field_idx = field->GetDexFieldIndex();
3676      ArtField* resolved_field = dex_cache->GetResolvedField(field_idx, image_pointer_size_);
3677      if (resolved_field == nullptr) {
3678        dex_cache->SetResolvedField(field_idx, field, image_pointer_size_);
3679      } else {
3680        DCHECK_EQ(field, resolved_field);
3681      }
3682    }
3683
3684    EncodedStaticFieldValueIterator value_it(dex_file, &dex_cache, &class_loader,
3685                                             this, *dex_class_def);
3686    const uint8_t* class_data = dex_file.GetClassData(*dex_class_def);
3687    ClassDataItemIterator field_it(dex_file, class_data);
3688    if (value_it.HasNext()) {
3689      DCHECK(field_it.HasNextStaticField());
3690      CHECK(can_init_statics);
3691      for ( ; value_it.HasNext(); value_it.Next(), field_it.Next()) {
3692        ArtField* field = ResolveField(
3693            dex_file, field_it.GetMemberIndex(), dex_cache, class_loader, true);
3694        if (Runtime::Current()->IsActiveTransaction()) {
3695          value_it.ReadValueToField<true>(field);
3696        } else {
3697          value_it.ReadValueToField<false>(field);
3698        }
3699        DCHECK(!value_it.HasNext() || field_it.HasNextStaticField());
3700      }
3701    }
3702  }
3703
3704  ArtMethod* clinit = klass->FindClassInitializer(image_pointer_size_);
3705  if (clinit != nullptr) {
3706    CHECK(can_init_statics);
3707    JValue result;
3708    clinit->Invoke(self, nullptr, 0, &result, "V");
3709  }
3710
3711  self->AllowThreadSuspension();
3712  uint64_t t1 = NanoTime();
3713
3714  bool success = true;
3715  {
3716    ObjectLock<mirror::Class> lock(self, klass);
3717
3718    if (self->IsExceptionPending()) {
3719      WrapExceptionInInitializer(klass);
3720      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3721      success = false;
3722    } else if (Runtime::Current()->IsTransactionAborted()) {
3723      // The exception thrown when the transaction aborted has been caught and cleared
3724      // so we need to throw it again now.
3725      VLOG(compiler) << "Return from class initializer of " << PrettyDescriptor(klass.Get())
3726                     << " without exception while transaction was aborted: re-throw it now.";
3727      Runtime::Current()->ThrowTransactionAbortError(self);
3728      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3729      success = false;
3730    } else {
3731      RuntimeStats* global_stats = Runtime::Current()->GetStats();
3732      RuntimeStats* thread_stats = self->GetStats();
3733      ++global_stats->class_init_count;
3734      ++thread_stats->class_init_count;
3735      global_stats->class_init_time_ns += (t1 - t0);
3736      thread_stats->class_init_time_ns += (t1 - t0);
3737      // Set the class as initialized except if failed to initialize static fields.
3738      mirror::Class::SetStatus(klass, mirror::Class::kStatusInitialized, self);
3739      if (VLOG_IS_ON(class_linker)) {
3740        std::string temp;
3741        LOG(INFO) << "Initialized class " << klass->GetDescriptor(&temp) << " from " <<
3742            klass->GetLocation();
3743      }
3744      // Opportunistically set static method trampolines to their destination.
3745      FixupStaticTrampolines(klass.Get());
3746    }
3747  }
3748  return success;
3749}
3750
3751bool ClassLinker::WaitForInitializeClass(Handle<mirror::Class> klass, Thread* self,
3752                                         ObjectLock<mirror::Class>& lock)
3753    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3754  while (true) {
3755    self->AssertNoPendingException();
3756    CHECK(!klass->IsInitialized());
3757    lock.WaitIgnoringInterrupts();
3758
3759    // When we wake up, repeat the test for init-in-progress.  If
3760    // there's an exception pending (only possible if
3761    // we were not using WaitIgnoringInterrupts), bail out.
3762    if (self->IsExceptionPending()) {
3763      WrapExceptionInInitializer(klass);
3764      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
3765      return false;
3766    }
3767    // Spurious wakeup? Go back to waiting.
3768    if (klass->GetStatus() == mirror::Class::kStatusInitializing) {
3769      continue;
3770    }
3771    if (klass->GetStatus() == mirror::Class::kStatusVerified &&
3772        Runtime::Current()->IsAotCompiler()) {
3773      // Compile time initialization failed.
3774      return false;
3775    }
3776    if (klass->IsErroneous()) {
3777      // The caller wants an exception, but it was thrown in a
3778      // different thread.  Synthesize one here.
3779      ThrowNoClassDefFoundError("<clinit> failed for class %s; see exception in other thread",
3780                                PrettyDescriptor(klass.Get()).c_str());
3781      VlogClassInitializationFailure(klass);
3782      return false;
3783    }
3784    if (klass->IsInitialized()) {
3785      return true;
3786    }
3787    LOG(FATAL) << "Unexpected class status. " << PrettyClass(klass.Get()) << " is "
3788        << klass->GetStatus();
3789  }
3790  UNREACHABLE();
3791}
3792
3793static void ThrowSignatureCheckResolveReturnTypeException(Handle<mirror::Class> klass,
3794                                                          Handle<mirror::Class> super_klass,
3795                                                          ArtMethod* method,
3796                                                          ArtMethod* m)
3797    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3798  DCHECK(Thread::Current()->IsExceptionPending());
3799  DCHECK(!m->IsProxyMethod());
3800  const DexFile* dex_file = m->GetDexFile();
3801  const DexFile::MethodId& method_id = dex_file->GetMethodId(m->GetDexMethodIndex());
3802  const DexFile::ProtoId& proto_id = dex_file->GetMethodPrototype(method_id);
3803  uint16_t return_type_idx = proto_id.return_type_idx_;
3804  std::string return_type = PrettyType(return_type_idx, *dex_file);
3805  std::string class_loader = PrettyTypeOf(m->GetDeclaringClass()->GetClassLoader());
3806  ThrowWrappedLinkageError(klass.Get(),
3807                           "While checking class %s method %s signature against %s %s: "
3808                           "Failed to resolve return type %s with %s",
3809                           PrettyDescriptor(klass.Get()).c_str(),
3810                           PrettyMethod(method).c_str(),
3811                           super_klass->IsInterface() ? "interface" : "superclass",
3812                           PrettyDescriptor(super_klass.Get()).c_str(),
3813                           return_type.c_str(), class_loader.c_str());
3814}
3815
3816static void ThrowSignatureCheckResolveArgException(Handle<mirror::Class> klass,
3817                                                   Handle<mirror::Class> super_klass,
3818                                                   ArtMethod* method,
3819                                                   ArtMethod* m,
3820                                                   uint32_t index, uint32_t arg_type_idx)
3821    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3822  DCHECK(Thread::Current()->IsExceptionPending());
3823  DCHECK(!m->IsProxyMethod());
3824  const DexFile* dex_file = m->GetDexFile();
3825  std::string arg_type = PrettyType(arg_type_idx, *dex_file);
3826  std::string class_loader = PrettyTypeOf(m->GetDeclaringClass()->GetClassLoader());
3827  ThrowWrappedLinkageError(klass.Get(),
3828                           "While checking class %s method %s signature against %s %s: "
3829                           "Failed to resolve arg %u type %s with %s",
3830                           PrettyDescriptor(klass.Get()).c_str(),
3831                           PrettyMethod(method).c_str(),
3832                           super_klass->IsInterface() ? "interface" : "superclass",
3833                           PrettyDescriptor(super_klass.Get()).c_str(),
3834                           index, arg_type.c_str(), class_loader.c_str());
3835}
3836
3837static void ThrowSignatureMismatch(Handle<mirror::Class> klass,
3838                                   Handle<mirror::Class> super_klass,
3839                                   ArtMethod* method,
3840                                   const std::string& error_msg)
3841    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3842  ThrowLinkageError(klass.Get(),
3843                    "Class %s method %s resolves differently in %s %s: %s",
3844                    PrettyDescriptor(klass.Get()).c_str(),
3845                    PrettyMethod(method).c_str(),
3846                    super_klass->IsInterface() ? "interface" : "superclass",
3847                    PrettyDescriptor(super_klass.Get()).c_str(),
3848                    error_msg.c_str());
3849}
3850
3851static bool HasSameSignatureWithDifferentClassLoaders(Thread* self,
3852                                                      Handle<mirror::Class> klass,
3853                                                      Handle<mirror::Class> super_klass,
3854                                                      ArtMethod* method1,
3855                                                      ArtMethod* method2)
3856    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3857  {
3858    StackHandleScope<1> hs(self);
3859    Handle<mirror::Class> return_type(hs.NewHandle(method1->GetReturnType()));
3860    if (UNLIKELY(return_type.Get() == nullptr)) {
3861      ThrowSignatureCheckResolveReturnTypeException(klass, super_klass, method1, method1);
3862      return false;
3863    }
3864    mirror::Class* other_return_type = method2->GetReturnType();
3865    if (UNLIKELY(other_return_type == nullptr)) {
3866      ThrowSignatureCheckResolveReturnTypeException(klass, super_klass, method1, method2);
3867      return false;
3868    }
3869    if (UNLIKELY(other_return_type != return_type.Get())) {
3870      ThrowSignatureMismatch(klass, super_klass, method1,
3871                             StringPrintf("Return types mismatch: %s(%p) vs %s(%p)",
3872                                          PrettyClassAndClassLoader(return_type.Get()).c_str(),
3873                                          return_type.Get(),
3874                                          PrettyClassAndClassLoader(other_return_type).c_str(),
3875                                          other_return_type));
3876      return false;
3877    }
3878  }
3879  const DexFile::TypeList* types1 = method1->GetParameterTypeList();
3880  const DexFile::TypeList* types2 = method2->GetParameterTypeList();
3881  if (types1 == nullptr) {
3882    if (types2 != nullptr && types2->Size() != 0) {
3883      ThrowSignatureMismatch(klass, super_klass, method1,
3884                             StringPrintf("Type list mismatch with %s",
3885                                          PrettyMethod(method2, true).c_str()));
3886      return false;
3887    }
3888    return true;
3889  } else if (UNLIKELY(types2 == nullptr)) {
3890    if (types1->Size() != 0) {
3891      ThrowSignatureMismatch(klass, super_klass, method1,
3892                             StringPrintf("Type list mismatch with %s",
3893                                          PrettyMethod(method2, true).c_str()));
3894      return false;
3895    }
3896    return true;
3897  }
3898  uint32_t num_types = types1->Size();
3899  if (UNLIKELY(num_types != types2->Size())) {
3900    ThrowSignatureMismatch(klass, super_klass, method1,
3901                           StringPrintf("Type list mismatch with %s",
3902                                        PrettyMethod(method2, true).c_str()));
3903    return false;
3904  }
3905  for (uint32_t i = 0; i < num_types; ++i) {
3906    StackHandleScope<1> hs(self);
3907    uint32_t param_type_idx = types1->GetTypeItem(i).type_idx_;
3908    Handle<mirror::Class> param_type(hs.NewHandle(
3909        method1->GetClassFromTypeIndex(param_type_idx, true)));
3910    if (UNLIKELY(param_type.Get() == nullptr)) {
3911      ThrowSignatureCheckResolveArgException(klass, super_klass, method1,
3912                                             method1, i, param_type_idx);
3913      return false;
3914    }
3915    uint32_t other_param_type_idx = types2->GetTypeItem(i).type_idx_;
3916    mirror::Class* other_param_type =
3917        method2->GetClassFromTypeIndex(other_param_type_idx, true);
3918    if (UNLIKELY(other_param_type == nullptr)) {
3919      ThrowSignatureCheckResolveArgException(klass, super_klass, method1,
3920                                             method2, i, other_param_type_idx);
3921      return false;
3922    }
3923    if (UNLIKELY(param_type.Get() != other_param_type)) {
3924      ThrowSignatureMismatch(klass, super_klass, method1,
3925                             StringPrintf("Parameter %u type mismatch: %s(%p) vs %s(%p)",
3926                                          i,
3927                                          PrettyClassAndClassLoader(param_type.Get()).c_str(),
3928                                          param_type.Get(),
3929                                          PrettyClassAndClassLoader(other_param_type).c_str(),
3930                                          other_param_type));
3931      return false;
3932    }
3933  }
3934  return true;
3935}
3936
3937
3938bool ClassLinker::ValidateSuperClassDescriptors(Handle<mirror::Class> klass) {
3939  if (klass->IsInterface()) {
3940    return true;
3941  }
3942  // Begin with the methods local to the superclass.
3943  Thread* self = Thread::Current();
3944  StackHandleScope<1> hs(self);
3945  MutableHandle<mirror::Class> super_klass(hs.NewHandle<mirror::Class>(nullptr));
3946  if (klass->HasSuperClass() &&
3947      klass->GetClassLoader() != klass->GetSuperClass()->GetClassLoader()) {
3948    super_klass.Assign(klass->GetSuperClass());
3949    for (int i = klass->GetSuperClass()->GetVTableLength() - 1; i >= 0; --i) {
3950      auto* m = klass->GetVTableEntry(i, image_pointer_size_);
3951      auto* super_m = klass->GetSuperClass()->GetVTableEntry(i, image_pointer_size_);
3952      if (m != super_m) {
3953        if (UNLIKELY(!HasSameSignatureWithDifferentClassLoaders(self, klass, super_klass,
3954                                                                m, super_m))) {
3955          self->AssertPendingException();
3956          return false;
3957        }
3958      }
3959    }
3960  }
3961  for (int32_t i = 0; i < klass->GetIfTableCount(); ++i) {
3962    super_klass.Assign(klass->GetIfTable()->GetInterface(i));
3963    if (klass->GetClassLoader() != super_klass->GetClassLoader()) {
3964      uint32_t num_methods = super_klass->NumVirtualMethods();
3965      for (uint32_t j = 0; j < num_methods; ++j) {
3966        auto* m = klass->GetIfTable()->GetMethodArray(i)->GetElementPtrSize<ArtMethod*>(
3967            j, image_pointer_size_);
3968        auto* super_m = super_klass->GetVirtualMethod(j, image_pointer_size_);
3969        if (m != super_m) {
3970          if (UNLIKELY(!HasSameSignatureWithDifferentClassLoaders(self, klass, super_klass,
3971                                                                  m, super_m))) {
3972            self->AssertPendingException();
3973            return false;
3974          }
3975        }
3976      }
3977    }
3978  }
3979  return true;
3980}
3981
3982bool ClassLinker::EnsureInitialized(Thread* self, Handle<mirror::Class> c, bool can_init_fields,
3983                                    bool can_init_parents) {
3984  DCHECK(c.Get() != nullptr);
3985  if (c->IsInitialized()) {
3986    EnsurePreverifiedMethods(c);
3987    return true;
3988  }
3989  const bool success = InitializeClass(self, c, can_init_fields, can_init_parents);
3990  if (!success) {
3991    if (can_init_fields && can_init_parents) {
3992      CHECK(self->IsExceptionPending()) << PrettyClass(c.Get());
3993    }
3994  } else {
3995    self->AssertNoPendingException();
3996  }
3997  return success;
3998}
3999
4000void ClassLinker::FixupTemporaryDeclaringClass(mirror::Class* temp_class,
4001                                               mirror::Class* new_class) {
4002  ArtField* fields = new_class->GetIFields();
4003  DCHECK_EQ(temp_class->NumInstanceFields(), new_class->NumInstanceFields());
4004  for (size_t i = 0, count = new_class->NumInstanceFields(); i < count; i++) {
4005    if (fields[i].GetDeclaringClass() == temp_class) {
4006      fields[i].SetDeclaringClass(new_class);
4007    }
4008  }
4009
4010  fields = new_class->GetSFields();
4011  DCHECK_EQ(temp_class->NumStaticFields(), new_class->NumStaticFields());
4012  for (size_t i = 0, count = new_class->NumStaticFields(); i < count; i++) {
4013    if (fields[i].GetDeclaringClass() == temp_class) {
4014      fields[i].SetDeclaringClass(new_class);
4015    }
4016  }
4017
4018  DCHECK_EQ(temp_class->NumDirectMethods(), new_class->NumDirectMethods());
4019  for (auto& method : new_class->GetDirectMethods(image_pointer_size_)) {
4020    if (method.GetDeclaringClass() == temp_class) {
4021      method.SetDeclaringClass(new_class);
4022    }
4023  }
4024
4025  DCHECK_EQ(temp_class->NumVirtualMethods(), new_class->NumVirtualMethods());
4026  for (auto& method : new_class->GetVirtualMethods(image_pointer_size_)) {
4027    if (method.GetDeclaringClass() == temp_class) {
4028      method.SetDeclaringClass(new_class);
4029    }
4030  }
4031}
4032
4033bool ClassLinker::LinkClass(Thread* self, const char* descriptor, Handle<mirror::Class> klass,
4034                            Handle<mirror::ObjectArray<mirror::Class>> interfaces,
4035                            MutableHandle<mirror::Class>* h_new_class_out) {
4036  CHECK_EQ(mirror::Class::kStatusLoaded, klass->GetStatus());
4037
4038  if (!LinkSuperClass(klass)) {
4039    return false;
4040  }
4041  ArtMethod* imt[mirror::Class::kImtSize];
4042  std::fill_n(imt, arraysize(imt), Runtime::Current()->GetImtUnimplementedMethod());
4043  if (!LinkMethods(self, klass, interfaces, imt)) {
4044    return false;
4045  }
4046  if (!LinkInstanceFields(self, klass)) {
4047    return false;
4048  }
4049  size_t class_size;
4050  if (!LinkStaticFields(self, klass, &class_size)) {
4051    return false;
4052  }
4053  CreateReferenceInstanceOffsets(klass);
4054  CHECK_EQ(mirror::Class::kStatusLoaded, klass->GetStatus());
4055
4056  if (!klass->IsTemp() || (!init_done_ && klass->GetClassSize() == class_size)) {
4057    // We don't need to retire this class as it has no embedded tables or it was created the
4058    // correct size during class linker initialization.
4059    CHECK_EQ(klass->GetClassSize(), class_size) << PrettyDescriptor(klass.Get());
4060
4061    if (klass->ShouldHaveEmbeddedImtAndVTable()) {
4062      klass->PopulateEmbeddedImtAndVTable(imt, image_pointer_size_);
4063    }
4064
4065    // This will notify waiters on klass that saw the not yet resolved
4066    // class in the class_table_ during EnsureResolved.
4067    mirror::Class::SetStatus(klass, mirror::Class::kStatusResolved, self);
4068    h_new_class_out->Assign(klass.Get());
4069  } else {
4070    CHECK(!klass->IsResolved());
4071    // Retire the temporary class and create the correctly sized resolved class.
4072    StackHandleScope<1> hs(self);
4073    auto h_new_class = hs.NewHandle(klass->CopyOf(self, class_size, imt, image_pointer_size_));
4074    if (UNLIKELY(h_new_class.Get() == nullptr)) {
4075      self->AssertPendingOOMException();
4076      mirror::Class::SetStatus(klass, mirror::Class::kStatusError, self);
4077      return false;
4078    }
4079
4080    CHECK_EQ(h_new_class->GetClassSize(), class_size);
4081    ObjectLock<mirror::Class> lock(self, h_new_class);
4082    FixupTemporaryDeclaringClass(klass.Get(), h_new_class.Get());
4083    mirror::Class* existing = UpdateClass(descriptor, h_new_class.Get(),
4084                                          ComputeModifiedUtf8Hash(descriptor));
4085    CHECK(existing == nullptr || existing == klass.Get());
4086
4087    // This will notify waiters on temp class that saw the not yet resolved class in the
4088    // class_table_ during EnsureResolved.
4089    mirror::Class::SetStatus(klass, mirror::Class::kStatusRetired, self);
4090
4091    CHECK_EQ(h_new_class->GetStatus(), mirror::Class::kStatusResolving);
4092    // This will notify waiters on new_class that saw the not yet resolved
4093    // class in the class_table_ during EnsureResolved.
4094    mirror::Class::SetStatus(h_new_class, mirror::Class::kStatusResolved, self);
4095    // Return the new class.
4096    h_new_class_out->Assign(h_new_class.Get());
4097  }
4098  return true;
4099}
4100
4101static void CountMethodsAndFields(ClassDataItemIterator& dex_data,
4102                                  size_t* virtual_methods,
4103                                  size_t* direct_methods,
4104                                  size_t* static_fields,
4105                                  size_t* instance_fields) {
4106  *virtual_methods = *direct_methods = *static_fields = *instance_fields = 0;
4107
4108  while (dex_data.HasNextStaticField()) {
4109    dex_data.Next();
4110    (*static_fields)++;
4111  }
4112  while (dex_data.HasNextInstanceField()) {
4113    dex_data.Next();
4114    (*instance_fields)++;
4115  }
4116  while (dex_data.HasNextDirectMethod()) {
4117    (*direct_methods)++;
4118    dex_data.Next();
4119  }
4120  while (dex_data.HasNextVirtualMethod()) {
4121    (*virtual_methods)++;
4122    dex_data.Next();
4123  }
4124  DCHECK(!dex_data.HasNext());
4125}
4126
4127static void DumpClass(std::ostream& os,
4128                      const DexFile& dex_file, const DexFile::ClassDef& dex_class_def,
4129                      const char* suffix) {
4130  ClassDataItemIterator dex_data(dex_file, dex_file.GetClassData(dex_class_def));
4131  os << dex_file.GetClassDescriptor(dex_class_def) << suffix << ":\n";
4132  os << " Static fields:\n";
4133  while (dex_data.HasNextStaticField()) {
4134    const DexFile::FieldId& id = dex_file.GetFieldId(dex_data.GetMemberIndex());
4135    os << "  " << dex_file.GetFieldTypeDescriptor(id) << " " << dex_file.GetFieldName(id) << "\n";
4136    dex_data.Next();
4137  }
4138  os << " Instance fields:\n";
4139  while (dex_data.HasNextInstanceField()) {
4140    const DexFile::FieldId& id = dex_file.GetFieldId(dex_data.GetMemberIndex());
4141    os << "  " << dex_file.GetFieldTypeDescriptor(id) << " " << dex_file.GetFieldName(id) << "\n";
4142    dex_data.Next();
4143  }
4144  os << " Direct methods:\n";
4145  while (dex_data.HasNextDirectMethod()) {
4146    const DexFile::MethodId& id = dex_file.GetMethodId(dex_data.GetMemberIndex());
4147    os << "  " << dex_file.GetMethodName(id) << dex_file.GetMethodSignature(id).ToString() << "\n";
4148    dex_data.Next();
4149  }
4150  os << " Virtual methods:\n";
4151  while (dex_data.HasNextVirtualMethod()) {
4152    const DexFile::MethodId& id = dex_file.GetMethodId(dex_data.GetMemberIndex());
4153    os << "  " << dex_file.GetMethodName(id) << dex_file.GetMethodSignature(id).ToString() << "\n";
4154    dex_data.Next();
4155  }
4156}
4157
4158static std::string DumpClasses(const DexFile& dex_file1, const DexFile::ClassDef& dex_class_def1,
4159                               const DexFile& dex_file2, const DexFile::ClassDef& dex_class_def2) {
4160  std::ostringstream os;
4161  DumpClass(os, dex_file1, dex_class_def1, " (Compile time)");
4162  DumpClass(os, dex_file2, dex_class_def2, " (Runtime)");
4163  return os.str();
4164}
4165
4166
4167// Very simple structural check on whether the classes match. Only compares the number of
4168// methods and fields.
4169static bool SimpleStructuralCheck(const DexFile& dex_file1, const DexFile::ClassDef& dex_class_def1,
4170                                  const DexFile& dex_file2, const DexFile::ClassDef& dex_class_def2,
4171                                  std::string* error_msg) {
4172  ClassDataItemIterator dex_data1(dex_file1, dex_file1.GetClassData(dex_class_def1));
4173  ClassDataItemIterator dex_data2(dex_file2, dex_file2.GetClassData(dex_class_def2));
4174
4175  // Counters for current dex file.
4176  size_t dex_virtual_methods1, dex_direct_methods1, dex_static_fields1, dex_instance_fields1;
4177  CountMethodsAndFields(dex_data1, &dex_virtual_methods1, &dex_direct_methods1, &dex_static_fields1,
4178                        &dex_instance_fields1);
4179  // Counters for compile-time dex file.
4180  size_t dex_virtual_methods2, dex_direct_methods2, dex_static_fields2, dex_instance_fields2;
4181  CountMethodsAndFields(dex_data2, &dex_virtual_methods2, &dex_direct_methods2, &dex_static_fields2,
4182                        &dex_instance_fields2);
4183
4184  if (dex_virtual_methods1 != dex_virtual_methods2) {
4185    std::string class_dump = DumpClasses(dex_file1, dex_class_def1, dex_file2, dex_class_def2);
4186    *error_msg = StringPrintf("Virtual method count off: %zu vs %zu\n%s", dex_virtual_methods1,
4187                              dex_virtual_methods2, class_dump.c_str());
4188    return false;
4189  }
4190  if (dex_direct_methods1 != dex_direct_methods2) {
4191    std::string class_dump = DumpClasses(dex_file1, dex_class_def1, dex_file2, dex_class_def2);
4192    *error_msg = StringPrintf("Direct method count off: %zu vs %zu\n%s", dex_direct_methods1,
4193                              dex_direct_methods2, class_dump.c_str());
4194    return false;
4195  }
4196  if (dex_static_fields1 != dex_static_fields2) {
4197    std::string class_dump = DumpClasses(dex_file1, dex_class_def1, dex_file2, dex_class_def2);
4198    *error_msg = StringPrintf("Static field count off: %zu vs %zu\n%s", dex_static_fields1,
4199                              dex_static_fields2, class_dump.c_str());
4200    return false;
4201  }
4202  if (dex_instance_fields1 != dex_instance_fields2) {
4203    std::string class_dump = DumpClasses(dex_file1, dex_class_def1, dex_file2, dex_class_def2);
4204    *error_msg = StringPrintf("Instance field count off: %zu vs %zu\n%s", dex_instance_fields1,
4205                              dex_instance_fields2, class_dump.c_str());
4206    return false;
4207  }
4208
4209  return true;
4210}
4211
4212// Checks whether a the super-class changed from what we had at compile-time. This would
4213// invalidate quickening.
4214static bool CheckSuperClassChange(Handle<mirror::Class> klass,
4215                                  const DexFile& dex_file,
4216                                  const DexFile::ClassDef& class_def,
4217                                  mirror::Class* super_class)
4218    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4219  // Check for unexpected changes in the superclass.
4220  // Quick check 1) is the super_class class-loader the boot class loader? This always has
4221  // precedence.
4222  if (super_class->GetClassLoader() != nullptr &&
4223      // Quick check 2) different dex cache? Breaks can only occur for different dex files,
4224      // which is implied by different dex cache.
4225      klass->GetDexCache() != super_class->GetDexCache()) {
4226    // Now comes the expensive part: things can be broken if (a) the klass' dex file has a
4227    // definition for the super-class, and (b) the files are in separate oat files. The oat files
4228    // are referenced from the dex file, so do (b) first. Only relevant if we have oat files.
4229    const OatDexFile* class_oat_dex_file = dex_file.GetOatDexFile();
4230    const OatFile* class_oat_file = nullptr;
4231    if (class_oat_dex_file != nullptr) {
4232      class_oat_file = class_oat_dex_file->GetOatFile();
4233    }
4234
4235    if (class_oat_file != nullptr) {
4236      const OatDexFile* loaded_super_oat_dex_file = super_class->GetDexFile().GetOatDexFile();
4237      const OatFile* loaded_super_oat_file = nullptr;
4238      if (loaded_super_oat_dex_file != nullptr) {
4239        loaded_super_oat_file = loaded_super_oat_dex_file->GetOatFile();
4240      }
4241
4242      if (loaded_super_oat_file != nullptr && class_oat_file != loaded_super_oat_file) {
4243        // Now check (a).
4244        const DexFile::ClassDef* super_class_def = dex_file.FindClassDef(class_def.superclass_idx_);
4245        if (super_class_def != nullptr) {
4246          // Uh-oh, we found something. Do our check.
4247          std::string error_msg;
4248          if (!SimpleStructuralCheck(dex_file, *super_class_def,
4249                                     super_class->GetDexFile(), *super_class->GetClassDef(),
4250                                     &error_msg)) {
4251            // Print a warning to the log. This exception might be caught, e.g., as common in test
4252            // drivers. When the class is later tried to be used, we re-throw a new instance, as we
4253            // only save the type of the exception.
4254            LOG(WARNING) << "Incompatible structural change detected: " <<
4255                StringPrintf(
4256                    "Structural change of %s is hazardous (%s at compile time, %s at runtime): %s",
4257                    PrettyType(super_class_def->class_idx_, dex_file).c_str(),
4258                    class_oat_file->GetLocation().c_str(),
4259                    loaded_super_oat_file->GetLocation().c_str(),
4260                    error_msg.c_str());
4261            ThrowIncompatibleClassChangeError(klass.Get(),
4262                "Structural change of %s is hazardous (%s at compile time, %s at runtime): %s",
4263                PrettyType(super_class_def->class_idx_, dex_file).c_str(),
4264                class_oat_file->GetLocation().c_str(),
4265                loaded_super_oat_file->GetLocation().c_str(),
4266                error_msg.c_str());
4267            return false;
4268          }
4269        }
4270      }
4271    }
4272  }
4273  return true;
4274}
4275
4276bool ClassLinker::LoadSuperAndInterfaces(Handle<mirror::Class> klass, const DexFile& dex_file) {
4277  CHECK_EQ(mirror::Class::kStatusIdx, klass->GetStatus());
4278  const DexFile::ClassDef& class_def = dex_file.GetClassDef(klass->GetDexClassDefIndex());
4279  uint16_t super_class_idx = class_def.superclass_idx_;
4280  if (super_class_idx != DexFile::kDexNoIndex16) {
4281    mirror::Class* super_class = ResolveType(dex_file, super_class_idx, klass.Get());
4282    if (super_class == nullptr) {
4283      DCHECK(Thread::Current()->IsExceptionPending());
4284      return false;
4285    }
4286    // Verify
4287    if (!klass->CanAccess(super_class)) {
4288      ThrowIllegalAccessError(klass.Get(), "Class %s extended by class %s is inaccessible",
4289                              PrettyDescriptor(super_class).c_str(),
4290                              PrettyDescriptor(klass.Get()).c_str());
4291      return false;
4292    }
4293    CHECK(super_class->IsResolved());
4294    klass->SetSuperClass(super_class);
4295
4296    if (!CheckSuperClassChange(klass, dex_file, class_def, super_class)) {
4297      DCHECK(Thread::Current()->IsExceptionPending());
4298      return false;
4299    }
4300  }
4301  const DexFile::TypeList* interfaces = dex_file.GetInterfacesList(class_def);
4302  if (interfaces != nullptr) {
4303    for (size_t i = 0; i < interfaces->Size(); i++) {
4304      uint16_t idx = interfaces->GetTypeItem(i).type_idx_;
4305      mirror::Class* interface = ResolveType(dex_file, idx, klass.Get());
4306      if (interface == nullptr) {
4307        DCHECK(Thread::Current()->IsExceptionPending());
4308        return false;
4309      }
4310      // Verify
4311      if (!klass->CanAccess(interface)) {
4312        // TODO: the RI seemed to ignore this in my testing.
4313        ThrowIllegalAccessError(klass.Get(), "Interface %s implemented by class %s is inaccessible",
4314                                PrettyDescriptor(interface).c_str(),
4315                                PrettyDescriptor(klass.Get()).c_str());
4316        return false;
4317      }
4318    }
4319  }
4320  // Mark the class as loaded.
4321  mirror::Class::SetStatus(klass, mirror::Class::kStatusLoaded, nullptr);
4322  return true;
4323}
4324
4325bool ClassLinker::LinkSuperClass(Handle<mirror::Class> klass) {
4326  CHECK(!klass->IsPrimitive());
4327  mirror::Class* super = klass->GetSuperClass();
4328  if (klass.Get() == GetClassRoot(kJavaLangObject)) {
4329    if (super != nullptr) {
4330      ThrowClassFormatError(klass.Get(), "java.lang.Object must not have a superclass");
4331      return false;
4332    }
4333    return true;
4334  }
4335  if (super == nullptr) {
4336    ThrowLinkageError(klass.Get(), "No superclass defined for class %s",
4337                      PrettyDescriptor(klass.Get()).c_str());
4338    return false;
4339  }
4340  // Verify
4341  if (super->IsFinal() || super->IsInterface()) {
4342    ThrowIncompatibleClassChangeError(klass.Get(), "Superclass %s of %s is %s",
4343                                      PrettyDescriptor(super).c_str(),
4344                                      PrettyDescriptor(klass.Get()).c_str(),
4345                                      super->IsFinal() ? "declared final" : "an interface");
4346    return false;
4347  }
4348  if (!klass->CanAccess(super)) {
4349    ThrowIllegalAccessError(klass.Get(), "Superclass %s is inaccessible to class %s",
4350                            PrettyDescriptor(super).c_str(),
4351                            PrettyDescriptor(klass.Get()).c_str());
4352    return false;
4353  }
4354
4355  // Inherit kAccClassIsFinalizable from the superclass in case this
4356  // class doesn't override finalize.
4357  if (super->IsFinalizable()) {
4358    klass->SetFinalizable();
4359  }
4360
4361  // Inherit reference flags (if any) from the superclass.
4362  int reference_flags = (super->GetAccessFlags() & kAccReferenceFlagsMask);
4363  if (reference_flags != 0) {
4364    klass->SetAccessFlags(klass->GetAccessFlags() | reference_flags);
4365  }
4366  // Disallow custom direct subclasses of java.lang.ref.Reference.
4367  if (init_done_ && super == GetClassRoot(kJavaLangRefReference)) {
4368    ThrowLinkageError(klass.Get(),
4369                      "Class %s attempts to subclass java.lang.ref.Reference, which is not allowed",
4370                      PrettyDescriptor(klass.Get()).c_str());
4371    return false;
4372  }
4373
4374  if (kIsDebugBuild) {
4375    // Ensure super classes are fully resolved prior to resolving fields..
4376    while (super != nullptr) {
4377      CHECK(super->IsResolved());
4378      super = super->GetSuperClass();
4379    }
4380  }
4381  return true;
4382}
4383
4384// Populate the class vtable and itable. Compute return type indices.
4385bool ClassLinker::LinkMethods(Thread* self, Handle<mirror::Class> klass,
4386                              Handle<mirror::ObjectArray<mirror::Class>> interfaces,
4387                              ArtMethod** out_imt) {
4388  self->AllowThreadSuspension();
4389  if (klass->IsInterface()) {
4390    // No vtable.
4391    size_t count = klass->NumVirtualMethods();
4392    if (!IsUint<16>(count)) {
4393      ThrowClassFormatError(klass.Get(), "Too many methods on interface: %zd", count);
4394      return false;
4395    }
4396    for (size_t i = 0; i < count; ++i) {
4397      klass->GetVirtualMethodDuringLinking(i, image_pointer_size_)->SetMethodIndex(i);
4398    }
4399  } else if (!LinkVirtualMethods(self, klass)) {  // Link virtual methods first.
4400    return false;
4401  }
4402  return LinkInterfaceMethods(self, klass, interfaces, out_imt);  // Link interface method last.
4403}
4404
4405// Comparator for name and signature of a method, used in finding overriding methods. Implementation
4406// avoids the use of handles, if it didn't then rather than compare dex files we could compare dex
4407// caches in the implementation below.
4408class MethodNameAndSignatureComparator FINAL : public ValueObject {
4409 public:
4410  explicit MethodNameAndSignatureComparator(ArtMethod* method)
4411      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) :
4412      dex_file_(method->GetDexFile()), mid_(&dex_file_->GetMethodId(method->GetDexMethodIndex())),
4413      name_(nullptr), name_len_(0) {
4414    DCHECK(!method->IsProxyMethod()) << PrettyMethod(method);
4415  }
4416
4417  const char* GetName() {
4418    if (name_ == nullptr) {
4419      name_ = dex_file_->StringDataAndUtf16LengthByIdx(mid_->name_idx_, &name_len_);
4420    }
4421    return name_;
4422  }
4423
4424  bool HasSameNameAndSignature(ArtMethod* other)
4425      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4426    DCHECK(!other->IsProxyMethod()) << PrettyMethod(other);
4427    const DexFile* other_dex_file = other->GetDexFile();
4428    const DexFile::MethodId& other_mid = other_dex_file->GetMethodId(other->GetDexMethodIndex());
4429    if (dex_file_ == other_dex_file) {
4430      return mid_->name_idx_ == other_mid.name_idx_ && mid_->proto_idx_ == other_mid.proto_idx_;
4431    }
4432    GetName();  // Only used to make sure its calculated.
4433    uint32_t other_name_len;
4434    const char* other_name = other_dex_file->StringDataAndUtf16LengthByIdx(other_mid.name_idx_,
4435                                                                           &other_name_len);
4436    if (name_len_ != other_name_len || strcmp(name_, other_name) != 0) {
4437      return false;
4438    }
4439    return dex_file_->GetMethodSignature(*mid_) == other_dex_file->GetMethodSignature(other_mid);
4440  }
4441
4442 private:
4443  // Dex file for the method to compare against.
4444  const DexFile* const dex_file_;
4445  // MethodId for the method to compare against.
4446  const DexFile::MethodId* const mid_;
4447  // Lazily computed name from the dex file's strings.
4448  const char* name_;
4449  // Lazily computed name length.
4450  uint32_t name_len_;
4451};
4452
4453class LinkVirtualHashTable {
4454 public:
4455  LinkVirtualHashTable(Handle<mirror::Class> klass, size_t hash_size, uint32_t* hash_table,
4456                       size_t image_pointer_size)
4457     : klass_(klass), hash_size_(hash_size), hash_table_(hash_table),
4458       image_pointer_size_(image_pointer_size) {
4459    std::fill(hash_table_, hash_table_ + hash_size_, invalid_index_);
4460  }
4461  void Add(uint32_t virtual_method_index) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4462    ArtMethod* local_method = klass_->GetVirtualMethodDuringLinking(
4463        virtual_method_index, image_pointer_size_);
4464    const char* name = local_method->GetInterfaceMethodIfProxy(image_pointer_size_)->GetName();
4465    uint32_t hash = ComputeModifiedUtf8Hash(name);
4466    uint32_t index = hash % hash_size_;
4467    // Linear probe until we have an empty slot.
4468    while (hash_table_[index] != invalid_index_) {
4469      if (++index == hash_size_) {
4470        index = 0;
4471      }
4472    }
4473    hash_table_[index] = virtual_method_index;
4474  }
4475  uint32_t FindAndRemove(MethodNameAndSignatureComparator* comparator)
4476      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4477    const char* name = comparator->GetName();
4478    uint32_t hash = ComputeModifiedUtf8Hash(name);
4479    size_t index = hash % hash_size_;
4480    while (true) {
4481      const uint32_t value = hash_table_[index];
4482      // Since linear probe makes continuous blocks, hitting an invalid index means we are done
4483      // the block and can safely assume not found.
4484      if (value == invalid_index_) {
4485        break;
4486      }
4487      if (value != removed_index_) {  // This signifies not already overriden.
4488        ArtMethod* virtual_method =
4489            klass_->GetVirtualMethodDuringLinking(value, image_pointer_size_);
4490        if (comparator->HasSameNameAndSignature(
4491            virtual_method->GetInterfaceMethodIfProxy(image_pointer_size_))) {
4492          hash_table_[index] = removed_index_;
4493          return value;
4494        }
4495      }
4496      if (++index == hash_size_) {
4497        index = 0;
4498      }
4499    }
4500    return GetNotFoundIndex();
4501  }
4502  static uint32_t GetNotFoundIndex() {
4503    return invalid_index_;
4504  }
4505
4506 private:
4507  static const uint32_t invalid_index_;
4508  static const uint32_t removed_index_;
4509
4510  Handle<mirror::Class> klass_;
4511  const size_t hash_size_;
4512  uint32_t* const hash_table_;
4513  const size_t image_pointer_size_;
4514};
4515
4516const uint32_t LinkVirtualHashTable::invalid_index_ = std::numeric_limits<uint32_t>::max();
4517const uint32_t LinkVirtualHashTable::removed_index_ = std::numeric_limits<uint32_t>::max() - 1;
4518
4519bool ClassLinker::LinkVirtualMethods(Thread* self, Handle<mirror::Class> klass) {
4520  const size_t num_virtual_methods = klass->NumVirtualMethods();
4521  if (klass->HasSuperClass()) {
4522    const size_t super_vtable_length = klass->GetSuperClass()->GetVTableLength();
4523    const size_t max_count = num_virtual_methods + super_vtable_length;
4524    StackHandleScope<2> hs(self);
4525    Handle<mirror::Class> super_class(hs.NewHandle(klass->GetSuperClass()));
4526    MutableHandle<mirror::PointerArray> vtable;
4527    if (super_class->ShouldHaveEmbeddedImtAndVTable()) {
4528      vtable = hs.NewHandle(AllocPointerArray(self, max_count));
4529      if (UNLIKELY(vtable.Get() == nullptr)) {
4530        self->AssertPendingOOMException();
4531        return false;
4532      }
4533      for (size_t i = 0; i < super_vtable_length; i++) {
4534        vtable->SetElementPtrSize(
4535            i, super_class->GetEmbeddedVTableEntry(i, image_pointer_size_), image_pointer_size_);
4536      }
4537      if (num_virtual_methods == 0) {
4538        klass->SetVTable(vtable.Get());
4539        return true;
4540      }
4541    } else {
4542      auto* super_vtable = super_class->GetVTable();
4543      CHECK(super_vtable != nullptr) << PrettyClass(super_class.Get());
4544      if (num_virtual_methods == 0) {
4545        klass->SetVTable(super_vtable);
4546        return true;
4547      }
4548      vtable = hs.NewHandle(down_cast<mirror::PointerArray*>(
4549          super_vtable->CopyOf(self, max_count)));
4550      if (UNLIKELY(vtable.Get() == nullptr)) {
4551        self->AssertPendingOOMException();
4552        return false;
4553      }
4554    }
4555    // How the algorithm works:
4556    // 1. Populate hash table by adding num_virtual_methods from klass. The values in the hash
4557    // table are: invalid_index for unused slots, index super_vtable_length + i for a virtual
4558    // method which has not been matched to a vtable method, and j if the virtual method at the
4559    // index overrode the super virtual method at index j.
4560    // 2. Loop through super virtual methods, if they overwrite, update hash table to j
4561    // (j < super_vtable_length) to avoid redundant checks. (TODO maybe use this info for reducing
4562    // the need for the initial vtable which we later shrink back down).
4563    // 3. Add non overridden methods to the end of the vtable.
4564    static constexpr size_t kMaxStackHash = 250;
4565    const size_t hash_table_size = num_virtual_methods * 3;
4566    uint32_t* hash_table_ptr;
4567    std::unique_ptr<uint32_t[]> hash_heap_storage;
4568    if (hash_table_size <= kMaxStackHash) {
4569      hash_table_ptr = reinterpret_cast<uint32_t*>(
4570          alloca(hash_table_size * sizeof(*hash_table_ptr)));
4571    } else {
4572      hash_heap_storage.reset(new uint32_t[hash_table_size]);
4573      hash_table_ptr = hash_heap_storage.get();
4574    }
4575    LinkVirtualHashTable hash_table(klass, hash_table_size, hash_table_ptr, image_pointer_size_);
4576    // Add virtual methods to the hash table.
4577    for (size_t i = 0; i < num_virtual_methods; ++i) {
4578      DCHECK(klass->GetVirtualMethodDuringLinking(
4579          i, image_pointer_size_)->GetDeclaringClass() != nullptr);
4580      hash_table.Add(i);
4581    }
4582    // Loop through each super vtable method and see if they are overriden by a method we added to
4583    // the hash table.
4584    for (size_t j = 0; j < super_vtable_length; ++j) {
4585      // Search the hash table to see if we are overidden by any method.
4586      ArtMethod* super_method = vtable->GetElementPtrSize<ArtMethod*>(j, image_pointer_size_);
4587      MethodNameAndSignatureComparator super_method_name_comparator(
4588          super_method->GetInterfaceMethodIfProxy(image_pointer_size_));
4589      uint32_t hash_index = hash_table.FindAndRemove(&super_method_name_comparator);
4590      if (hash_index != hash_table.GetNotFoundIndex()) {
4591        ArtMethod* virtual_method = klass->GetVirtualMethodDuringLinking(
4592            hash_index, image_pointer_size_);
4593        if (klass->CanAccessMember(super_method->GetDeclaringClass(),
4594                                   super_method->GetAccessFlags())) {
4595          if (super_method->IsFinal()) {
4596            ThrowLinkageError(klass.Get(), "Method %s overrides final method in class %s",
4597                              PrettyMethod(virtual_method).c_str(),
4598                              super_method->GetDeclaringClassDescriptor());
4599            return false;
4600          }
4601          vtable->SetElementPtrSize(j, virtual_method, image_pointer_size_);
4602          virtual_method->SetMethodIndex(j);
4603        } else {
4604          LOG(WARNING) << "Before Android 4.1, method " << PrettyMethod(virtual_method)
4605                       << " would have incorrectly overridden the package-private method in "
4606                       << PrettyDescriptor(super_method->GetDeclaringClassDescriptor());
4607        }
4608      }
4609    }
4610    // Add the non overridden methods at the end.
4611    size_t actual_count = super_vtable_length;
4612    for (size_t i = 0; i < num_virtual_methods; ++i) {
4613      ArtMethod* local_method = klass->GetVirtualMethodDuringLinking(i, image_pointer_size_);
4614      size_t method_idx = local_method->GetMethodIndexDuringLinking();
4615      if (method_idx < super_vtable_length &&
4616          local_method == vtable->GetElementPtrSize<ArtMethod*>(method_idx, image_pointer_size_)) {
4617        continue;
4618      }
4619      vtable->SetElementPtrSize(actual_count, local_method, image_pointer_size_);
4620      local_method->SetMethodIndex(actual_count);
4621      ++actual_count;
4622    }
4623    if (!IsUint<16>(actual_count)) {
4624      ThrowClassFormatError(klass.Get(), "Too many methods defined on class: %zd", actual_count);
4625      return false;
4626    }
4627    // Shrink vtable if possible
4628    CHECK_LE(actual_count, max_count);
4629    if (actual_count < max_count) {
4630      vtable.Assign(down_cast<mirror::PointerArray*>(vtable->CopyOf(self, actual_count)));
4631      if (UNLIKELY(vtable.Get() == nullptr)) {
4632        self->AssertPendingOOMException();
4633        return false;
4634      }
4635    }
4636    klass->SetVTable(vtable.Get());
4637  } else {
4638    CHECK_EQ(klass.Get(), GetClassRoot(kJavaLangObject));
4639    if (!IsUint<16>(num_virtual_methods)) {
4640      ThrowClassFormatError(klass.Get(), "Too many methods: %d",
4641                            static_cast<int>(num_virtual_methods));
4642      return false;
4643    }
4644    auto* vtable = AllocPointerArray(self, num_virtual_methods);
4645    if (UNLIKELY(vtable == nullptr)) {
4646      self->AssertPendingOOMException();
4647      return false;
4648    }
4649    for (size_t i = 0; i < num_virtual_methods; ++i) {
4650      ArtMethod* virtual_method = klass->GetVirtualMethodDuringLinking(i, image_pointer_size_);
4651      vtable->SetElementPtrSize(i, virtual_method, image_pointer_size_);
4652      virtual_method->SetMethodIndex(i & 0xFFFF);
4653    }
4654    klass->SetVTable(vtable);
4655  }
4656  return true;
4657}
4658
4659bool ClassLinker::LinkInterfaceMethods(Thread* self, Handle<mirror::Class> klass,
4660                                       Handle<mirror::ObjectArray<mirror::Class>> interfaces,
4661                                       ArtMethod** out_imt) {
4662  StackHandleScope<3> hs(self);
4663  Runtime* const runtime = Runtime::Current();
4664  const bool has_superclass = klass->HasSuperClass();
4665  const size_t super_ifcount = has_superclass ? klass->GetSuperClass()->GetIfTableCount() : 0U;
4666  const bool have_interfaces = interfaces.Get() != nullptr;
4667  const size_t num_interfaces =
4668      have_interfaces ? interfaces->GetLength() : klass->NumDirectInterfaces();
4669  const size_t method_size = ArtMethod::ObjectSize(image_pointer_size_);
4670  if (num_interfaces == 0) {
4671    if (super_ifcount == 0) {
4672      // Class implements no interfaces.
4673      DCHECK_EQ(klass->GetIfTableCount(), 0);
4674      DCHECK(klass->GetIfTable() == nullptr);
4675      return true;
4676    }
4677    // Class implements same interfaces as parent, are any of these not marker interfaces?
4678    bool has_non_marker_interface = false;
4679    mirror::IfTable* super_iftable = klass->GetSuperClass()->GetIfTable();
4680    for (size_t i = 0; i < super_ifcount; ++i) {
4681      if (super_iftable->GetMethodArrayCount(i) > 0) {
4682        has_non_marker_interface = true;
4683        break;
4684      }
4685    }
4686    // Class just inherits marker interfaces from parent so recycle parent's iftable.
4687    if (!has_non_marker_interface) {
4688      klass->SetIfTable(super_iftable);
4689      return true;
4690    }
4691  }
4692  size_t ifcount = super_ifcount + num_interfaces;
4693  for (size_t i = 0; i < num_interfaces; i++) {
4694    mirror::Class* interface = have_interfaces ?
4695        interfaces->GetWithoutChecks(i) : mirror::Class::GetDirectInterface(self, klass, i);
4696    DCHECK(interface != nullptr);
4697    if (UNLIKELY(!interface->IsInterface())) {
4698      std::string temp;
4699      ThrowIncompatibleClassChangeError(klass.Get(), "Class %s implements non-interface class %s",
4700                                        PrettyDescriptor(klass.Get()).c_str(),
4701                                        PrettyDescriptor(interface->GetDescriptor(&temp)).c_str());
4702      return false;
4703    }
4704    ifcount += interface->GetIfTableCount();
4705  }
4706  MutableHandle<mirror::IfTable> iftable(hs.NewHandle(AllocIfTable(self, ifcount)));
4707  if (UNLIKELY(iftable.Get() == nullptr)) {
4708    self->AssertPendingOOMException();
4709    return false;
4710  }
4711  if (super_ifcount != 0) {
4712    mirror::IfTable* super_iftable = klass->GetSuperClass()->GetIfTable();
4713    for (size_t i = 0; i < super_ifcount; i++) {
4714      mirror::Class* super_interface = super_iftable->GetInterface(i);
4715      iftable->SetInterface(i, super_interface);
4716    }
4717  }
4718  self->AllowThreadSuspension();
4719  // Flatten the interface inheritance hierarchy.
4720  size_t idx = super_ifcount;
4721  for (size_t i = 0; i < num_interfaces; i++) {
4722    mirror::Class* interface = have_interfaces ? interfaces->Get(i) :
4723        mirror::Class::GetDirectInterface(self, klass, i);
4724    // Check if interface is already in iftable
4725    bool duplicate = false;
4726    for (size_t j = 0; j < idx; j++) {
4727      mirror::Class* existing_interface = iftable->GetInterface(j);
4728      if (existing_interface == interface) {
4729        duplicate = true;
4730        break;
4731      }
4732    }
4733    if (!duplicate) {
4734      // Add this non-duplicate interface.
4735      iftable->SetInterface(idx++, interface);
4736      // Add this interface's non-duplicate super-interfaces.
4737      for (int32_t j = 0; j < interface->GetIfTableCount(); j++) {
4738        mirror::Class* super_interface = interface->GetIfTable()->GetInterface(j);
4739        bool super_duplicate = false;
4740        for (size_t k = 0; k < idx; k++) {
4741          mirror::Class* existing_interface = iftable->GetInterface(k);
4742          if (existing_interface == super_interface) {
4743            super_duplicate = true;
4744            break;
4745          }
4746        }
4747        if (!super_duplicate) {
4748          iftable->SetInterface(idx++, super_interface);
4749        }
4750      }
4751    }
4752  }
4753  self->AllowThreadSuspension();
4754  // Shrink iftable in case duplicates were found
4755  if (idx < ifcount) {
4756    DCHECK_NE(num_interfaces, 0U);
4757    iftable.Assign(down_cast<mirror::IfTable*>(
4758        iftable->CopyOf(self, idx * mirror::IfTable::kMax)));
4759    if (UNLIKELY(iftable.Get() == nullptr)) {
4760      self->AssertPendingOOMException();
4761      return false;
4762    }
4763    ifcount = idx;
4764  } else {
4765    DCHECK_EQ(idx, ifcount);
4766  }
4767  klass->SetIfTable(iftable.Get());
4768  // If we're an interface, we don't need the vtable pointers, so we're done.
4769  if (klass->IsInterface()) {
4770    return true;
4771  }
4772  // These are allocated on the heap to begin, we then transfer to linear alloc when we re-create
4773  // the virtual methods array.
4774  // Need to use low 4GB arenas for compiler or else the pointers wont fit in 32 bit method array
4775  // during cross compilation.
4776  // Use the linear alloc pool since this one is in the low 4gb for the compiler.
4777  ArenaStack stack(runtime->GetLinearAlloc()->GetArenaPool());
4778  ScopedArenaAllocator allocator(&stack);
4779  ScopedArenaVector<ArtMethod*> miranda_methods(allocator.Adapter());
4780
4781  MutableHandle<mirror::PointerArray> vtable(hs.NewHandle(klass->GetVTableDuringLinking()));
4782  ArtMethod* const unimplemented_method = runtime->GetImtUnimplementedMethod();
4783  ArtMethod* const conflict_method = runtime->GetImtConflictMethod();
4784  // Copy the IMT from the super class if possible.
4785  bool extend_super_iftable = false;
4786  if (has_superclass) {
4787    mirror::Class* super_class = klass->GetSuperClass();
4788    extend_super_iftable = true;
4789    if (super_class->ShouldHaveEmbeddedImtAndVTable()) {
4790      for (size_t i = 0; i < mirror::Class::kImtSize; ++i) {
4791        out_imt[i] = super_class->GetEmbeddedImTableEntry(i, image_pointer_size_);
4792      }
4793    } else {
4794      // No imt in the super class, need to reconstruct from the iftable.
4795      mirror::IfTable* if_table = super_class->GetIfTable();
4796      const size_t length = super_class->GetIfTableCount();
4797      for (size_t i = 0; i < length; ++i) {
4798        mirror::Class* interface = iftable->GetInterface(i);
4799        const size_t num_virtuals = interface->NumVirtualMethods();
4800        const size_t method_array_count = if_table->GetMethodArrayCount(i);
4801        DCHECK_EQ(num_virtuals, method_array_count);
4802        if (method_array_count == 0) {
4803          continue;
4804        }
4805        auto* method_array = if_table->GetMethodArray(i);
4806        for (size_t j = 0; j < num_virtuals; ++j) {
4807          auto method = method_array->GetElementPtrSize<ArtMethod*>(j, image_pointer_size_);
4808          DCHECK(method != nullptr) << PrettyClass(super_class);
4809          if (method->IsMiranda()) {
4810            continue;
4811          }
4812          ArtMethod* interface_method = interface->GetVirtualMethod(j, image_pointer_size_);
4813          uint32_t imt_index = interface_method->GetDexMethodIndex() % mirror::Class::kImtSize;
4814          auto*& imt_ref = out_imt[imt_index];
4815          if (imt_ref == unimplemented_method) {
4816            imt_ref = method;
4817          } else if (imt_ref != conflict_method) {
4818            imt_ref = conflict_method;
4819          }
4820        }
4821      }
4822    }
4823  }
4824  // Allocate method arrays before since we don't want miss visiting miranda method roots due to
4825  // thread suspension.
4826  for (size_t i = 0; i < ifcount; ++i) {
4827    size_t num_methods = iftable->GetInterface(i)->NumVirtualMethods();
4828    if (num_methods > 0) {
4829      const bool is_super = i < super_ifcount;
4830      const bool super_interface = is_super && extend_super_iftable;
4831      mirror::PointerArray* method_array;
4832      if (super_interface) {
4833        mirror::IfTable* if_table = klass->GetSuperClass()->GetIfTable();
4834        DCHECK(if_table != nullptr);
4835        DCHECK(if_table->GetMethodArray(i) != nullptr);
4836        // If we are working on a super interface, try extending the existing method array.
4837        method_array = down_cast<mirror::PointerArray*>(if_table->GetMethodArray(i)->Clone(self));
4838      } else {
4839        method_array = AllocPointerArray(self, num_methods);
4840      }
4841      if (UNLIKELY(method_array == nullptr)) {
4842        self->AssertPendingOOMException();
4843        return false;
4844      }
4845      iftable->SetMethodArray(i, method_array);
4846    }
4847  }
4848
4849  auto* old_cause = self->StartAssertNoThreadSuspension(
4850      "Copying ArtMethods for LinkInterfaceMethods");
4851  for (size_t i = 0; i < ifcount; ++i) {
4852    size_t num_methods = iftable->GetInterface(i)->NumVirtualMethods();
4853    if (num_methods > 0) {
4854      StackHandleScope<2> hs2(self);
4855      const bool is_super = i < super_ifcount;
4856      const bool super_interface = is_super && extend_super_iftable;
4857      auto method_array(hs2.NewHandle(iftable->GetMethodArray(i)));
4858
4859      ArtMethod* input_virtual_methods = nullptr;
4860      Handle<mirror::PointerArray> input_vtable_array = NullHandle<mirror::PointerArray>();
4861      int32_t input_array_length = 0;
4862      if (super_interface) {
4863        // We are overwriting a super class interface, try to only virtual methods instead of the
4864        // whole vtable.
4865        input_virtual_methods = klass->GetVirtualMethodsPtr();
4866        input_array_length = klass->NumVirtualMethods();
4867      } else {
4868        // A new interface, we need the whole vtable in case a new interface method is implemented
4869        // in the whole superclass.
4870        input_vtable_array = vtable;
4871        input_array_length = input_vtable_array->GetLength();
4872      }
4873      if (input_array_length == 0) {
4874        // If the added virtual methods is empty, do nothing.
4875        DCHECK(super_interface);
4876        continue;
4877      }
4878      for (size_t j = 0; j < num_methods; ++j) {
4879        auto* interface_method = iftable->GetInterface(i)->GetVirtualMethod(
4880            j, image_pointer_size_);
4881        MethodNameAndSignatureComparator interface_name_comparator(
4882            interface_method->GetInterfaceMethodIfProxy(image_pointer_size_));
4883        int32_t k;
4884        // For each method listed in the interface's method list, find the
4885        // matching method in our class's method list.  We want to favor the
4886        // subclass over the superclass, which just requires walking
4887        // back from the end of the vtable.  (This only matters if the
4888        // superclass defines a private method and this class redefines
4889        // it -- otherwise it would use the same vtable slot.  In .dex files
4890        // those don't end up in the virtual method table, so it shouldn't
4891        // matter which direction we go.  We walk it backward anyway.)
4892        for (k = input_array_length - 1; k >= 0; --k) {
4893          ArtMethod* vtable_method = input_virtual_methods != nullptr ?
4894              reinterpret_cast<ArtMethod*>(
4895                  reinterpret_cast<uintptr_t>(input_virtual_methods) + method_size * k) :
4896              input_vtable_array->GetElementPtrSize<ArtMethod*>(k, image_pointer_size_);
4897          ArtMethod* vtable_method_for_name_comparison =
4898              vtable_method->GetInterfaceMethodIfProxy(image_pointer_size_);
4899          if (interface_name_comparator.HasSameNameAndSignature(
4900              vtable_method_for_name_comparison)) {
4901            if (!vtable_method->IsAbstract() && !vtable_method->IsPublic()) {
4902              // Must do EndAssertNoThreadSuspension before throw since the throw can cause
4903              // allocations.
4904              self->EndAssertNoThreadSuspension(old_cause);
4905              ThrowIllegalAccessError(klass.Get(),
4906                  "Method '%s' implementing interface method '%s' is not public",
4907                  PrettyMethod(vtable_method).c_str(), PrettyMethod(interface_method).c_str());
4908              return false;
4909            }
4910            method_array->SetElementPtrSize(j, vtable_method, image_pointer_size_);
4911            // Place method in imt if entry is empty, place conflict otherwise.
4912            uint32_t imt_index = interface_method->GetDexMethodIndex() % mirror::Class::kImtSize;
4913            auto** imt_ref = &out_imt[imt_index];
4914            if (*imt_ref == unimplemented_method) {
4915              *imt_ref = vtable_method;
4916            } else if (*imt_ref != conflict_method) {
4917              // If we are not a conflict and we have the same signature and name as the imt entry,
4918              // it must be that we overwrote a superclass vtable entry.
4919              MethodNameAndSignatureComparator imt_comparator(
4920                  (*imt_ref)->GetInterfaceMethodIfProxy(image_pointer_size_));
4921              *imt_ref = imt_comparator.HasSameNameAndSignature(vtable_method_for_name_comparison) ?
4922                  vtable_method : conflict_method;
4923            }
4924            break;
4925          }
4926        }
4927        if (k < 0 && !super_interface) {
4928          ArtMethod* miranda_method = nullptr;
4929          for (auto& mir_method : miranda_methods) {
4930            if (interface_name_comparator.HasSameNameAndSignature(mir_method)) {
4931              miranda_method = mir_method;
4932              break;
4933            }
4934          }
4935          if (miranda_method == nullptr) {
4936            miranda_method = reinterpret_cast<ArtMethod*>(allocator.Alloc(method_size));
4937            CHECK(miranda_method != nullptr);
4938            // Point the interface table at a phantom slot.
4939            new(miranda_method) ArtMethod(*interface_method, image_pointer_size_);
4940            miranda_methods.push_back(miranda_method);
4941          }
4942          method_array->SetElementPtrSize(j, miranda_method, image_pointer_size_);
4943        }
4944      }
4945    }
4946  }
4947  if (!miranda_methods.empty()) {
4948    const size_t old_method_count = klass->NumVirtualMethods();
4949    const size_t new_method_count = old_method_count + miranda_methods.size();
4950    // Attempt to realloc to save RAM if possible.
4951    ArtMethod* old_virtuals = klass->GetVirtualMethodsPtr();
4952    // The Realloced virtual methods aren't visiblef from the class roots, so there is no issue
4953    // where GCs could attempt to mark stale pointers due to memcpy. And since we overwrite the
4954    // realloced memory with out->CopyFrom, we are guaranteed to have objects in the to space since
4955    // CopyFrom has internal read barriers.
4956    auto* virtuals = reinterpret_cast<ArtMethod*>(runtime->GetLinearAlloc()->Realloc(
4957        self, old_virtuals, old_method_count * method_size, new_method_count * method_size));
4958    if (UNLIKELY(virtuals == nullptr)) {
4959      self->AssertPendingOOMException();
4960      return false;
4961    }
4962    ScopedArenaUnorderedMap<ArtMethod*, ArtMethod*> move_table(allocator.Adapter());
4963    if (virtuals != old_virtuals) {
4964      // Maps from heap allocated miranda method to linear alloc miranda method.
4965      StrideIterator<ArtMethod> out(reinterpret_cast<uintptr_t>(virtuals), method_size);
4966      // Copy over the old methods + miranda methods.
4967      for (auto& m : klass->GetVirtualMethods(image_pointer_size_)) {
4968        move_table.emplace(&m, &*out);
4969        // The CopyFrom is only necessary to not miss read barriers since Realloc won't do read
4970        // barriers when it copies.
4971        out->CopyFrom(&m, image_pointer_size_);
4972        ++out;
4973      }
4974    }
4975    StrideIterator<ArtMethod> out(
4976        reinterpret_cast<uintptr_t>(virtuals) + old_method_count * method_size, method_size);
4977    // Copy over miranda methods before copying vtable since CopyOf may cause thread suspension and
4978    // we want the roots of the miranda methods to get visited.
4979    for (ArtMethod* mir_method : miranda_methods) {
4980      out->CopyFrom(mir_method, image_pointer_size_);
4981      out->SetAccessFlags(out->GetAccessFlags() | kAccMiranda);
4982      move_table.emplace(mir_method, &*out);
4983      ++out;
4984    }
4985    UpdateClassVirtualMethods(klass.Get(), virtuals, new_method_count);
4986    // Done copying methods, they are all roots in the class now, so we can end the no thread
4987    // suspension assert.
4988    self->EndAssertNoThreadSuspension(old_cause);
4989
4990    const size_t old_vtable_count = vtable->GetLength();
4991    const size_t new_vtable_count = old_vtable_count + miranda_methods.size();
4992    miranda_methods.clear();
4993    vtable.Assign(down_cast<mirror::PointerArray*>(vtable->CopyOf(self, new_vtable_count)));
4994    if (UNLIKELY(vtable.Get() == nullptr)) {
4995      self->AssertPendingOOMException();
4996      return false;
4997    }
4998    out = StrideIterator<ArtMethod>(
4999        reinterpret_cast<uintptr_t>(virtuals) + old_method_count * method_size, method_size);
5000    size_t vtable_pos = old_vtable_count;
5001    for (size_t i = old_method_count; i < new_method_count; ++i) {
5002      // Leave the declaring class alone as type indices are relative to it
5003      out->SetMethodIndex(0xFFFF & vtable_pos);
5004      vtable->SetElementPtrSize(vtable_pos, &*out, image_pointer_size_);
5005      ++out;
5006      ++vtable_pos;
5007    }
5008    CHECK_EQ(vtable_pos, new_vtable_count);
5009    // Update old vtable methods.
5010    for (size_t i = 0; i < old_vtable_count; ++i) {
5011      auto* m = vtable->GetElementPtrSize<ArtMethod*>(i, image_pointer_size_);
5012      DCHECK(m != nullptr) << PrettyClass(klass.Get());
5013      auto it = move_table.find(m);
5014      if (it != move_table.end()) {
5015        auto* new_m = it->second;
5016        DCHECK(new_m != nullptr) << PrettyClass(klass.Get());
5017        vtable->SetElementPtrSize(i, new_m, image_pointer_size_);
5018      }
5019    }
5020    klass->SetVTable(vtable.Get());
5021    // Go fix up all the stale miranda pointers.
5022    for (size_t i = 0; i < ifcount; ++i) {
5023      for (size_t j = 0, count = iftable->GetMethodArrayCount(i); j < count; ++j) {
5024        auto* method_array = iftable->GetMethodArray(i);
5025        auto* m = method_array->GetElementPtrSize<ArtMethod*>(j, image_pointer_size_);
5026        DCHECK(m != nullptr) << PrettyClass(klass.Get());
5027        auto it = move_table.find(m);
5028        if (it != move_table.end()) {
5029          auto* new_m = it->second;
5030          DCHECK(new_m != nullptr) << PrettyClass(klass.Get());
5031          method_array->SetElementPtrSize(j, new_m, image_pointer_size_);
5032        }
5033      }
5034    }
5035    // Fix up IMT in case it has any miranda methods in it.
5036    for (size_t i = 0; i < mirror::Class::kImtSize; ++i) {
5037      auto it = move_table.find(out_imt[i]);
5038      if (it != move_table.end()) {
5039        out_imt[i] = it->second;
5040      }
5041    }
5042    // Check that there are no stale methods are in the dex cache array.
5043    if (kIsDebugBuild) {
5044      auto* resolved_methods = klass->GetDexCache()->GetResolvedMethods();
5045      for (size_t i = 0, count = resolved_methods->GetLength(); i < count; ++i) {
5046        auto* m = resolved_methods->GetElementPtrSize<ArtMethod*>(i, image_pointer_size_);
5047        CHECK(move_table.find(m) == move_table.end()) << PrettyMethod(m);
5048      }
5049    }
5050    // Put some random garbage in old virtuals to help find stale pointers.
5051    if (virtuals != old_virtuals) {
5052      memset(old_virtuals, 0xFEu, ArtMethod::ObjectSize(image_pointer_size_) * old_method_count);
5053    }
5054  } else {
5055    self->EndAssertNoThreadSuspension(old_cause);
5056  }
5057  if (kIsDebugBuild) {
5058    auto* check_vtable = klass->GetVTableDuringLinking();
5059    for (int i = 0; i < check_vtable->GetLength(); ++i) {
5060      CHECK(check_vtable->GetElementPtrSize<ArtMethod*>(i, image_pointer_size_) != nullptr);
5061    }
5062  }
5063  return true;
5064}
5065
5066bool ClassLinker::LinkInstanceFields(Thread* self, Handle<mirror::Class> klass) {
5067  CHECK(klass.Get() != nullptr);
5068  return LinkFields(self, klass, false, nullptr);
5069}
5070
5071bool ClassLinker::LinkStaticFields(Thread* self, Handle<mirror::Class> klass, size_t* class_size) {
5072  CHECK(klass.Get() != nullptr);
5073  return LinkFields(self, klass, true, class_size);
5074}
5075
5076struct LinkFieldsComparator {
5077  explicit LinkFieldsComparator() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
5078  }
5079  // No thread safety analysis as will be called from STL. Checked lock held in constructor.
5080  bool operator()(ArtField* field1, ArtField* field2)
5081      NO_THREAD_SAFETY_ANALYSIS {
5082    // First come reference fields, then 64-bit, then 32-bit, and then 16-bit, then finally 8-bit.
5083    Primitive::Type type1 = field1->GetTypeAsPrimitiveType();
5084    Primitive::Type type2 = field2->GetTypeAsPrimitiveType();
5085    if (type1 != type2) {
5086      if (type1 == Primitive::kPrimNot) {
5087        // Reference always goes first.
5088        return true;
5089      }
5090      if (type2 == Primitive::kPrimNot) {
5091        // Reference always goes first.
5092        return false;
5093      }
5094      size_t size1 = Primitive::ComponentSize(type1);
5095      size_t size2 = Primitive::ComponentSize(type2);
5096      if (size1 != size2) {
5097        // Larger primitive types go first.
5098        return size1 > size2;
5099      }
5100      // Primitive types differ but sizes match. Arbitrarily order by primitive type.
5101      return type1 < type2;
5102    }
5103    // Same basic group? Then sort by dex field index. This is guaranteed to be sorted
5104    // by name and for equal names by type id index.
5105    // NOTE: This works also for proxies. Their static fields are assigned appropriate indexes.
5106    return field1->GetDexFieldIndex() < field2->GetDexFieldIndex();
5107  }
5108};
5109
5110bool ClassLinker::LinkFields(Thread* self, Handle<mirror::Class> klass, bool is_static,
5111                             size_t* class_size) {
5112  self->AllowThreadSuspension();
5113  const size_t num_fields = is_static ? klass->NumStaticFields() : klass->NumInstanceFields();
5114  ArtField* const fields = is_static ? klass->GetSFields() : klass->GetIFields();
5115
5116  // Initialize field_offset
5117  MemberOffset field_offset(0);
5118  if (is_static) {
5119    field_offset = klass->GetFirstReferenceStaticFieldOffsetDuringLinking(image_pointer_size_);
5120  } else {
5121    mirror::Class* super_class = klass->GetSuperClass();
5122    if (super_class != nullptr) {
5123      CHECK(super_class->IsResolved())
5124          << PrettyClass(klass.Get()) << " " << PrettyClass(super_class);
5125      field_offset = MemberOffset(super_class->GetObjectSize());
5126    }
5127  }
5128
5129  CHECK_EQ(num_fields == 0, fields == nullptr) << PrettyClass(klass.Get());
5130
5131  // we want a relatively stable order so that adding new fields
5132  // minimizes disruption of C++ version such as Class and Method.
5133  std::deque<ArtField*> grouped_and_sorted_fields;
5134  const char* old_no_suspend_cause = self->StartAssertNoThreadSuspension(
5135      "Naked ArtField references in deque");
5136  for (size_t i = 0; i < num_fields; i++) {
5137    grouped_and_sorted_fields.push_back(&fields[i]);
5138  }
5139  std::sort(grouped_and_sorted_fields.begin(), grouped_and_sorted_fields.end(),
5140            LinkFieldsComparator());
5141
5142  // References should be at the front.
5143  size_t current_field = 0;
5144  size_t num_reference_fields = 0;
5145  FieldGaps gaps;
5146
5147  for (; current_field < num_fields; current_field++) {
5148    ArtField* field = grouped_and_sorted_fields.front();
5149    Primitive::Type type = field->GetTypeAsPrimitiveType();
5150    bool isPrimitive = type != Primitive::kPrimNot;
5151    if (isPrimitive) {
5152      break;  // past last reference, move on to the next phase
5153    }
5154    if (UNLIKELY(!IsAligned<sizeof(mirror::HeapReference<mirror::Object>)>(
5155        field_offset.Uint32Value()))) {
5156      MemberOffset old_offset = field_offset;
5157      field_offset = MemberOffset(RoundUp(field_offset.Uint32Value(), 4));
5158      AddFieldGap(old_offset.Uint32Value(), field_offset.Uint32Value(), &gaps);
5159    }
5160    DCHECK(IsAligned<sizeof(mirror::HeapReference<mirror::Object>)>(field_offset.Uint32Value()));
5161    grouped_and_sorted_fields.pop_front();
5162    num_reference_fields++;
5163    field->SetOffset(field_offset);
5164    field_offset = MemberOffset(field_offset.Uint32Value() +
5165                                sizeof(mirror::HeapReference<mirror::Object>));
5166  }
5167  // Gaps are stored as a max heap which means that we must shuffle from largest to smallest
5168  // otherwise we could end up with suboptimal gap fills.
5169  ShuffleForward<8>(&current_field, &field_offset, &grouped_and_sorted_fields, &gaps);
5170  ShuffleForward<4>(&current_field, &field_offset, &grouped_and_sorted_fields, &gaps);
5171  ShuffleForward<2>(&current_field, &field_offset, &grouped_and_sorted_fields, &gaps);
5172  ShuffleForward<1>(&current_field, &field_offset, &grouped_and_sorted_fields, &gaps);
5173  CHECK(grouped_and_sorted_fields.empty()) << "Missed " << grouped_and_sorted_fields.size() <<
5174      " fields.";
5175  self->EndAssertNoThreadSuspension(old_no_suspend_cause);
5176
5177  // We lie to the GC about the java.lang.ref.Reference.referent field, so it doesn't scan it.
5178  if (!is_static && klass->DescriptorEquals("Ljava/lang/ref/Reference;")) {
5179    // We know there are no non-reference fields in the Reference classes, and we know
5180    // that 'referent' is alphabetically last, so this is easy...
5181    CHECK_EQ(num_reference_fields, num_fields) << PrettyClass(klass.Get());
5182    CHECK_STREQ(fields[num_fields - 1].GetName(), "referent") << PrettyClass(klass.Get());
5183    --num_reference_fields;
5184  }
5185
5186  size_t size = field_offset.Uint32Value();
5187  // Update klass
5188  if (is_static) {
5189    klass->SetNumReferenceStaticFields(num_reference_fields);
5190    *class_size = size;
5191  } else {
5192    klass->SetNumReferenceInstanceFields(num_reference_fields);
5193    if (!klass->IsVariableSize()) {
5194      std::string temp;
5195      DCHECK_GE(size, sizeof(mirror::Object)) << klass->GetDescriptor(&temp);
5196      size_t previous_size = klass->GetObjectSize();
5197      if (previous_size != 0) {
5198        // Make sure that we didn't originally have an incorrect size.
5199        CHECK_EQ(previous_size, size) << klass->GetDescriptor(&temp);
5200      }
5201      klass->SetObjectSize(size);
5202    }
5203  }
5204
5205  if (kIsDebugBuild) {
5206    // Make sure that the fields array is ordered by name but all reference
5207    // offsets are at the beginning as far as alignment allows.
5208    MemberOffset start_ref_offset = is_static
5209        ? klass->GetFirstReferenceStaticFieldOffsetDuringLinking(image_pointer_size_)
5210        : klass->GetFirstReferenceInstanceFieldOffset();
5211    MemberOffset end_ref_offset(start_ref_offset.Uint32Value() +
5212                                num_reference_fields *
5213                                    sizeof(mirror::HeapReference<mirror::Object>));
5214    MemberOffset current_ref_offset = start_ref_offset;
5215    for (size_t i = 0; i < num_fields; i++) {
5216      ArtField* field = &fields[i];
5217      VLOG(class_linker) << "LinkFields: " << (is_static ? "static" : "instance")
5218          << " class=" << PrettyClass(klass.Get()) << " field=" << PrettyField(field) << " offset="
5219          << field->GetOffset();
5220      if (i != 0) {
5221        ArtField* const prev_field = &fields[i - 1];
5222        // NOTE: The field names can be the same. This is not possible in the Java language
5223        // but it's valid Java/dex bytecode and for example proguard can generate such bytecode.
5224        CHECK_LE(strcmp(prev_field->GetName(), field->GetName()), 0);
5225      }
5226      Primitive::Type type = field->GetTypeAsPrimitiveType();
5227      bool is_primitive = type != Primitive::kPrimNot;
5228      if (klass->DescriptorEquals("Ljava/lang/ref/Reference;") &&
5229          strcmp("referent", field->GetName()) == 0) {
5230        is_primitive = true;  // We lied above, so we have to expect a lie here.
5231      }
5232      MemberOffset offset = field->GetOffsetDuringLinking();
5233      if (is_primitive) {
5234        if (offset.Uint32Value() < end_ref_offset.Uint32Value()) {
5235          // Shuffled before references.
5236          size_t type_size = Primitive::ComponentSize(type);
5237          CHECK_LT(type_size, sizeof(mirror::HeapReference<mirror::Object>));
5238          CHECK_LT(offset.Uint32Value(), start_ref_offset.Uint32Value());
5239          CHECK_LE(offset.Uint32Value() + type_size, start_ref_offset.Uint32Value());
5240          CHECK(!IsAligned<sizeof(mirror::HeapReference<mirror::Object>)>(offset.Uint32Value()));
5241        }
5242      } else {
5243        CHECK_EQ(current_ref_offset.Uint32Value(), offset.Uint32Value());
5244        current_ref_offset = MemberOffset(current_ref_offset.Uint32Value() +
5245                                          sizeof(mirror::HeapReference<mirror::Object>));
5246      }
5247    }
5248    CHECK_EQ(current_ref_offset.Uint32Value(), end_ref_offset.Uint32Value());
5249  }
5250  return true;
5251}
5252
5253//  Set the bitmap of reference instance field offsets.
5254void ClassLinker::CreateReferenceInstanceOffsets(Handle<mirror::Class> klass) {
5255  uint32_t reference_offsets = 0;
5256  mirror::Class* super_class = klass->GetSuperClass();
5257  // Leave the reference offsets as 0 for mirror::Object (the class field is handled specially).
5258  if (super_class != nullptr) {
5259    reference_offsets = super_class->GetReferenceInstanceOffsets();
5260    // Compute reference offsets unless our superclass overflowed.
5261    if (reference_offsets != mirror::Class::kClassWalkSuper) {
5262      size_t num_reference_fields = klass->NumReferenceInstanceFieldsDuringLinking();
5263      if (num_reference_fields != 0u) {
5264        // All of the fields that contain object references are guaranteed be grouped in memory
5265        // starting at an appropriately aligned address after super class object data.
5266        uint32_t start_offset = RoundUp(super_class->GetObjectSize(),
5267                                        sizeof(mirror::HeapReference<mirror::Object>));
5268        uint32_t start_bit = (start_offset - mirror::kObjectHeaderSize) /
5269            sizeof(mirror::HeapReference<mirror::Object>);
5270        if (start_bit + num_reference_fields > 32) {
5271          reference_offsets = mirror::Class::kClassWalkSuper;
5272        } else {
5273          reference_offsets |= (0xffffffffu << start_bit) &
5274                               (0xffffffffu >> (32 - (start_bit + num_reference_fields)));
5275        }
5276      }
5277    }
5278  }
5279  klass->SetReferenceInstanceOffsets(reference_offsets);
5280}
5281
5282mirror::String* ClassLinker::ResolveString(const DexFile& dex_file, uint32_t string_idx,
5283                                           Handle<mirror::DexCache> dex_cache) {
5284  DCHECK(dex_cache.Get() != nullptr);
5285  mirror::String* resolved = dex_cache->GetResolvedString(string_idx);
5286  if (resolved != nullptr) {
5287    return resolved;
5288  }
5289  uint32_t utf16_length;
5290  const char* utf8_data = dex_file.StringDataAndUtf16LengthByIdx(string_idx, &utf16_length);
5291  mirror::String* string = intern_table_->InternStrong(utf16_length, utf8_data);
5292  dex_cache->SetResolvedString(string_idx, string);
5293  return string;
5294}
5295
5296mirror::Class* ClassLinker::ResolveType(const DexFile& dex_file, uint16_t type_idx,
5297                                        mirror::Class* referrer) {
5298  StackHandleScope<2> hs(Thread::Current());
5299  Handle<mirror::DexCache> dex_cache(hs.NewHandle(referrer->GetDexCache()));
5300  Handle<mirror::ClassLoader> class_loader(hs.NewHandle(referrer->GetClassLoader()));
5301  return ResolveType(dex_file, type_idx, dex_cache, class_loader);
5302}
5303
5304mirror::Class* ClassLinker::ResolveType(const DexFile& dex_file, uint16_t type_idx,
5305                                        Handle<mirror::DexCache> dex_cache,
5306                                        Handle<mirror::ClassLoader> class_loader) {
5307  DCHECK(dex_cache.Get() != nullptr);
5308  mirror::Class* resolved = dex_cache->GetResolvedType(type_idx);
5309  if (resolved == nullptr) {
5310    Thread* self = Thread::Current();
5311    const char* descriptor = dex_file.StringByTypeIdx(type_idx);
5312    resolved = FindClass(self, descriptor, class_loader);
5313    if (resolved != nullptr) {
5314      // TODO: we used to throw here if resolved's class loader was not the
5315      //       boot class loader. This was to permit different classes with the
5316      //       same name to be loaded simultaneously by different loaders
5317      dex_cache->SetResolvedType(type_idx, resolved);
5318    } else {
5319      CHECK(self->IsExceptionPending())
5320          << "Expected pending exception for failed resolution of: " << descriptor;
5321      // Convert a ClassNotFoundException to a NoClassDefFoundError.
5322      StackHandleScope<1> hs(self);
5323      Handle<mirror::Throwable> cause(hs.NewHandle(self->GetException()));
5324      if (cause->InstanceOf(GetClassRoot(kJavaLangClassNotFoundException))) {
5325        DCHECK(resolved == nullptr);  // No Handle needed to preserve resolved.
5326        self->ClearException();
5327        ThrowNoClassDefFoundError("Failed resolution of: %s", descriptor);
5328        self->GetException()->SetCause(cause.Get());
5329      }
5330    }
5331  }
5332  DCHECK((resolved == nullptr) || resolved->IsResolved() || resolved->IsErroneous())
5333      << PrettyDescriptor(resolved) << " " << resolved->GetStatus();
5334  return resolved;
5335}
5336
5337ArtMethod* ClassLinker::ResolveMethod(const DexFile& dex_file, uint32_t method_idx,
5338                                      Handle<mirror::DexCache> dex_cache,
5339                                      Handle<mirror::ClassLoader> class_loader,
5340                                      ArtMethod* referrer, InvokeType type) {
5341  DCHECK(dex_cache.Get() != nullptr);
5342  // Check for hit in the dex cache.
5343  ArtMethod* resolved = dex_cache->GetResolvedMethod(method_idx, image_pointer_size_);
5344  if (resolved != nullptr && !resolved->IsRuntimeMethod()) {
5345    DCHECK(resolved->GetDeclaringClassUnchecked() != nullptr) << resolved->GetDexMethodIndex();
5346    return resolved;
5347  }
5348  // Fail, get the declaring class.
5349  const DexFile::MethodId& method_id = dex_file.GetMethodId(method_idx);
5350  mirror::Class* klass = ResolveType(dex_file, method_id.class_idx_, dex_cache, class_loader);
5351  if (klass == nullptr) {
5352    DCHECK(Thread::Current()->IsExceptionPending());
5353    return nullptr;
5354  }
5355  // Scan using method_idx, this saves string compares but will only hit for matching dex
5356  // caches/files.
5357  switch (type) {
5358    case kDirect:  // Fall-through.
5359    case kStatic:
5360      resolved = klass->FindDirectMethod(dex_cache.Get(), method_idx, image_pointer_size_);
5361      DCHECK(resolved == nullptr || resolved->GetDeclaringClassUnchecked() != nullptr);
5362      break;
5363    case kInterface:
5364      resolved = klass->FindInterfaceMethod(dex_cache.Get(), method_idx, image_pointer_size_);
5365      DCHECK(resolved == nullptr || resolved->GetDeclaringClass()->IsInterface());
5366      break;
5367    case kSuper:  // Fall-through.
5368    case kVirtual:
5369      resolved = klass->FindVirtualMethod(dex_cache.Get(), method_idx, image_pointer_size_);
5370      break;
5371    default:
5372      LOG(FATAL) << "Unreachable - invocation type: " << type;
5373      UNREACHABLE();
5374  }
5375  if (resolved == nullptr) {
5376    // Search by name, which works across dex files.
5377    const char* name = dex_file.StringDataByIdx(method_id.name_idx_);
5378    const Signature signature = dex_file.GetMethodSignature(method_id);
5379    switch (type) {
5380      case kDirect:  // Fall-through.
5381      case kStatic:
5382        resolved = klass->FindDirectMethod(name, signature, image_pointer_size_);
5383        DCHECK(resolved == nullptr || resolved->GetDeclaringClassUnchecked() != nullptr);
5384        break;
5385      case kInterface:
5386        resolved = klass->FindInterfaceMethod(name, signature, image_pointer_size_);
5387        DCHECK(resolved == nullptr || resolved->GetDeclaringClass()->IsInterface());
5388        break;
5389      case kSuper:  // Fall-through.
5390      case kVirtual:
5391        resolved = klass->FindVirtualMethod(name, signature, image_pointer_size_);
5392        break;
5393    }
5394  }
5395  // If we found a method, check for incompatible class changes.
5396  if (LIKELY(resolved != nullptr && !resolved->CheckIncompatibleClassChange(type))) {
5397    // Be a good citizen and update the dex cache to speed subsequent calls.
5398    dex_cache->SetResolvedMethod(method_idx, resolved, image_pointer_size_);
5399    return resolved;
5400  } else {
5401    // If we had a method, it's an incompatible-class-change error.
5402    if (resolved != nullptr) {
5403      ThrowIncompatibleClassChangeError(type, resolved->GetInvokeType(), resolved, referrer);
5404    } else {
5405      // We failed to find the method which means either an access error, an incompatible class
5406      // change, or no such method. First try to find the method among direct and virtual methods.
5407      const char* name = dex_file.StringDataByIdx(method_id.name_idx_);
5408      const Signature signature = dex_file.GetMethodSignature(method_id);
5409      switch (type) {
5410        case kDirect:
5411        case kStatic:
5412          resolved = klass->FindVirtualMethod(name, signature, image_pointer_size_);
5413          // Note: kDirect and kStatic are also mutually exclusive, but in that case we would
5414          //       have had a resolved method before, which triggers the "true" branch above.
5415          break;
5416        case kInterface:
5417        case kVirtual:
5418        case kSuper:
5419          resolved = klass->FindDirectMethod(name, signature, image_pointer_size_);
5420          break;
5421      }
5422
5423      // If we found something, check that it can be accessed by the referrer.
5424      bool exception_generated = false;
5425      if (resolved != nullptr && referrer != nullptr) {
5426        mirror::Class* methods_class = resolved->GetDeclaringClass();
5427        mirror::Class* referring_class = referrer->GetDeclaringClass();
5428        if (!referring_class->CanAccess(methods_class)) {
5429          ThrowIllegalAccessErrorClassForMethodDispatch(referring_class, methods_class, resolved,
5430                                                        type);
5431          exception_generated = true;
5432        } else if (!referring_class->CanAccessMember(methods_class, resolved->GetAccessFlags())) {
5433          ThrowIllegalAccessErrorMethod(referring_class, resolved);
5434          exception_generated = true;
5435        }
5436      }
5437      if (!exception_generated) {
5438        // Otherwise, throw an IncompatibleClassChangeError if we found something, and check
5439        // interface methods and throw if we find the method there. If we find nothing, throw a
5440        // NoSuchMethodError.
5441        switch (type) {
5442          case kDirect:
5443          case kStatic:
5444            if (resolved != nullptr) {
5445              ThrowIncompatibleClassChangeError(type, kVirtual, resolved, referrer);
5446            } else {
5447              resolved = klass->FindInterfaceMethod(name, signature, image_pointer_size_);
5448              if (resolved != nullptr) {
5449                ThrowIncompatibleClassChangeError(type, kInterface, resolved, referrer);
5450              } else {
5451                ThrowNoSuchMethodError(type, klass, name, signature);
5452              }
5453            }
5454            break;
5455          case kInterface:
5456            if (resolved != nullptr) {
5457              ThrowIncompatibleClassChangeError(type, kDirect, resolved, referrer);
5458            } else {
5459              resolved = klass->FindVirtualMethod(name, signature, image_pointer_size_);
5460              if (resolved != nullptr) {
5461                ThrowIncompatibleClassChangeError(type, kVirtual, resolved, referrer);
5462              } else {
5463                ThrowNoSuchMethodError(type, klass, name, signature);
5464              }
5465            }
5466            break;
5467          case kSuper:
5468            if (resolved != nullptr) {
5469              ThrowIncompatibleClassChangeError(type, kDirect, resolved, referrer);
5470            } else {
5471              ThrowNoSuchMethodError(type, klass, name, signature);
5472            }
5473            break;
5474          case kVirtual:
5475            if (resolved != nullptr) {
5476              ThrowIncompatibleClassChangeError(type, kDirect, resolved, referrer);
5477            } else {
5478              resolved = klass->FindInterfaceMethod(name, signature, image_pointer_size_);
5479              if (resolved != nullptr) {
5480                ThrowIncompatibleClassChangeError(type, kInterface, resolved, referrer);
5481              } else {
5482                ThrowNoSuchMethodError(type, klass, name, signature);
5483              }
5484            }
5485            break;
5486        }
5487      }
5488    }
5489    Thread::Current()->AssertPendingException();
5490    return nullptr;
5491  }
5492}
5493
5494ArtField* ClassLinker::ResolveField(const DexFile& dex_file, uint32_t field_idx,
5495                                    Handle<mirror::DexCache> dex_cache,
5496                                    Handle<mirror::ClassLoader> class_loader, bool is_static) {
5497  DCHECK(dex_cache.Get() != nullptr);
5498  ArtField* resolved = dex_cache->GetResolvedField(field_idx, image_pointer_size_);
5499  if (resolved != nullptr) {
5500    return resolved;
5501  }
5502  const DexFile::FieldId& field_id = dex_file.GetFieldId(field_idx);
5503  Thread* const self = Thread::Current();
5504  StackHandleScope<1> hs(self);
5505  Handle<mirror::Class> klass(
5506      hs.NewHandle(ResolveType(dex_file, field_id.class_idx_, dex_cache, class_loader)));
5507  if (klass.Get() == nullptr) {
5508    DCHECK(Thread::Current()->IsExceptionPending());
5509    return nullptr;
5510  }
5511
5512  if (is_static) {
5513    resolved = mirror::Class::FindStaticField(self, klass, dex_cache.Get(), field_idx);
5514  } else {
5515    resolved = klass->FindInstanceField(dex_cache.Get(), field_idx);
5516  }
5517
5518  if (resolved == nullptr) {
5519    const char* name = dex_file.GetFieldName(field_id);
5520    const char* type = dex_file.GetFieldTypeDescriptor(field_id);
5521    if (is_static) {
5522      resolved = mirror::Class::FindStaticField(self, klass, name, type);
5523    } else {
5524      resolved = klass->FindInstanceField(name, type);
5525    }
5526    if (resolved == nullptr) {
5527      ThrowNoSuchFieldError(is_static ? "static " : "instance ", klass.Get(), type, name);
5528      return nullptr;
5529    }
5530  }
5531  dex_cache->SetResolvedField(field_idx, resolved, image_pointer_size_);
5532  return resolved;
5533}
5534
5535ArtField* ClassLinker::ResolveFieldJLS(const DexFile& dex_file, uint32_t field_idx,
5536                                       Handle<mirror::DexCache> dex_cache,
5537                                       Handle<mirror::ClassLoader> class_loader) {
5538  DCHECK(dex_cache.Get() != nullptr);
5539  ArtField* resolved = dex_cache->GetResolvedField(field_idx, image_pointer_size_);
5540  if (resolved != nullptr) {
5541    return resolved;
5542  }
5543  const DexFile::FieldId& field_id = dex_file.GetFieldId(field_idx);
5544  Thread* self = Thread::Current();
5545  StackHandleScope<1> hs(self);
5546  Handle<mirror::Class> klass(
5547      hs.NewHandle(ResolveType(dex_file, field_id.class_idx_, dex_cache, class_loader)));
5548  if (klass.Get() == nullptr) {
5549    DCHECK(Thread::Current()->IsExceptionPending());
5550    return nullptr;
5551  }
5552
5553  StringPiece name(dex_file.StringDataByIdx(field_id.name_idx_));
5554  StringPiece type(dex_file.StringDataByIdx(
5555      dex_file.GetTypeId(field_id.type_idx_).descriptor_idx_));
5556  resolved = mirror::Class::FindField(self, klass, name, type);
5557  if (resolved != nullptr) {
5558    dex_cache->SetResolvedField(field_idx, resolved, image_pointer_size_);
5559  } else {
5560    ThrowNoSuchFieldError("", klass.Get(), type, name);
5561  }
5562  return resolved;
5563}
5564
5565const char* ClassLinker::MethodShorty(uint32_t method_idx, ArtMethod* referrer,
5566                                      uint32_t* length) {
5567  mirror::Class* declaring_class = referrer->GetDeclaringClass();
5568  mirror::DexCache* dex_cache = declaring_class->GetDexCache();
5569  const DexFile& dex_file = *dex_cache->GetDexFile();
5570  const DexFile::MethodId& method_id = dex_file.GetMethodId(method_idx);
5571  return dex_file.GetMethodShorty(method_id, length);
5572}
5573
5574void ClassLinker::DumpAllClasses(int flags) {
5575  if (dex_cache_image_class_lookup_required_) {
5576    MoveImageClassesToClassTable();
5577  }
5578  // TODO: at the time this was written, it wasn't safe to call PrettyField with the ClassLinker
5579  // lock held, because it might need to resolve a field's type, which would try to take the lock.
5580  std::vector<mirror::Class*> all_classes;
5581  {
5582    ReaderMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
5583    for (GcRoot<mirror::Class>& it : class_table_) {
5584      all_classes.push_back(it.Read());
5585    }
5586  }
5587
5588  for (size_t i = 0; i < all_classes.size(); ++i) {
5589    all_classes[i]->DumpClass(std::cerr, flags);
5590  }
5591}
5592
5593static OatFile::OatMethod CreateOatMethod(const void* code) {
5594  CHECK(code != nullptr);
5595  const uint8_t* base = reinterpret_cast<const uint8_t*>(code);  // Base of data points at code.
5596  base -= sizeof(void*);  // Move backward so that code_offset != 0.
5597  const uint32_t code_offset = sizeof(void*);
5598  return OatFile::OatMethod(base, code_offset);
5599}
5600
5601bool ClassLinker::IsQuickResolutionStub(const void* entry_point) const {
5602  return (entry_point == GetQuickResolutionStub()) ||
5603      (quick_resolution_trampoline_ == entry_point);
5604}
5605
5606bool ClassLinker::IsQuickToInterpreterBridge(const void* entry_point) const {
5607  return (entry_point == GetQuickToInterpreterBridge()) ||
5608      (quick_to_interpreter_bridge_trampoline_ == entry_point);
5609}
5610
5611bool ClassLinker::IsQuickGenericJniStub(const void* entry_point) const {
5612  return (entry_point == GetQuickGenericJniStub()) ||
5613      (quick_generic_jni_trampoline_ == entry_point);
5614}
5615
5616const void* ClassLinker::GetRuntimeQuickGenericJniStub() const {
5617  return GetQuickGenericJniStub();
5618}
5619
5620void ClassLinker::SetEntryPointsToCompiledCode(ArtMethod* method,
5621                                               const void* method_code) const {
5622  OatFile::OatMethod oat_method = CreateOatMethod(method_code);
5623  oat_method.LinkMethod(method);
5624  method->SetEntryPointFromInterpreter(artInterpreterToCompiledCodeBridge);
5625}
5626
5627void ClassLinker::SetEntryPointsToInterpreter(ArtMethod* method) const {
5628  if (!method->IsNative()) {
5629    method->SetEntryPointFromInterpreter(artInterpreterToInterpreterBridge);
5630    method->SetEntryPointFromQuickCompiledCode(GetQuickToInterpreterBridge());
5631  } else {
5632    const void* quick_method_code = GetQuickGenericJniStub();
5633    OatFile::OatMethod oat_method = CreateOatMethod(quick_method_code);
5634    oat_method.LinkMethod(method);
5635    method->SetEntryPointFromInterpreter(artInterpreterToCompiledCodeBridge);
5636  }
5637}
5638
5639void ClassLinker::DumpForSigQuit(std::ostream& os) {
5640  Thread* self = Thread::Current();
5641  if (dex_cache_image_class_lookup_required_) {
5642    ScopedObjectAccess soa(self);
5643    MoveImageClassesToClassTable();
5644  }
5645  ReaderMutexLock mu(self, *Locks::classlinker_classes_lock_);
5646  os << "Zygote loaded classes=" << pre_zygote_class_table_.Size() << " post zygote classes="
5647     << class_table_.Size() << "\n";
5648}
5649
5650size_t ClassLinker::NumLoadedClasses() {
5651  if (dex_cache_image_class_lookup_required_) {
5652    MoveImageClassesToClassTable();
5653  }
5654  ReaderMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
5655  // Only return non zygote classes since these are the ones which apps which care about.
5656  return class_table_.Size();
5657}
5658
5659pid_t ClassLinker::GetClassesLockOwner() {
5660  return Locks::classlinker_classes_lock_->GetExclusiveOwnerTid();
5661}
5662
5663pid_t ClassLinker::GetDexLockOwner() {
5664  return dex_lock_.GetExclusiveOwnerTid();
5665}
5666
5667void ClassLinker::SetClassRoot(ClassRoot class_root, mirror::Class* klass) {
5668  DCHECK(!init_done_);
5669
5670  DCHECK(klass != nullptr);
5671  DCHECK(klass->GetClassLoader() == nullptr);
5672
5673  mirror::ObjectArray<mirror::Class>* class_roots = class_roots_.Read();
5674  DCHECK(class_roots != nullptr);
5675  DCHECK(class_roots->Get(class_root) == nullptr);
5676  class_roots->Set<false>(class_root, klass);
5677}
5678
5679const char* ClassLinker::GetClassRootDescriptor(ClassRoot class_root) {
5680  static const char* class_roots_descriptors[] = {
5681    "Ljava/lang/Class;",
5682    "Ljava/lang/Object;",
5683    "[Ljava/lang/Class;",
5684    "[Ljava/lang/Object;",
5685    "Ljava/lang/String;",
5686    "Ljava/lang/DexCache;",
5687    "Ljava/lang/ref/Reference;",
5688    "Ljava/lang/reflect/Constructor;",
5689    "Ljava/lang/reflect/Field;",
5690    "Ljava/lang/reflect/Method;",
5691    "Ljava/lang/reflect/Proxy;",
5692    "[Ljava/lang/String;",
5693    "[Ljava/lang/reflect/Constructor;",
5694    "[Ljava/lang/reflect/Field;",
5695    "[Ljava/lang/reflect/Method;",
5696    "Ljava/lang/ClassLoader;",
5697    "Ljava/lang/Throwable;",
5698    "Ljava/lang/ClassNotFoundException;",
5699    "Ljava/lang/StackTraceElement;",
5700    "Z",
5701    "B",
5702    "C",
5703    "D",
5704    "F",
5705    "I",
5706    "J",
5707    "S",
5708    "V",
5709    "[Z",
5710    "[B",
5711    "[C",
5712    "[D",
5713    "[F",
5714    "[I",
5715    "[J",
5716    "[S",
5717    "[Ljava/lang/StackTraceElement;",
5718  };
5719  static_assert(arraysize(class_roots_descriptors) == size_t(kClassRootsMax),
5720                "Mismatch between class descriptors and class-root enum");
5721
5722  const char* descriptor = class_roots_descriptors[class_root];
5723  CHECK(descriptor != nullptr);
5724  return descriptor;
5725}
5726
5727std::size_t ClassLinker::ClassDescriptorHashEquals::operator()(const GcRoot<mirror::Class>& root)
5728    const {
5729  std::string temp;
5730  return ComputeModifiedUtf8Hash(root.Read()->GetDescriptor(&temp));
5731}
5732
5733bool ClassLinker::ClassDescriptorHashEquals::operator()(const GcRoot<mirror::Class>& a,
5734                                                        const GcRoot<mirror::Class>& b) const {
5735  if (a.Read()->GetClassLoader() != b.Read()->GetClassLoader()) {
5736    return false;
5737  }
5738  std::string temp;
5739  return a.Read()->DescriptorEquals(b.Read()->GetDescriptor(&temp));
5740}
5741
5742std::size_t ClassLinker::ClassDescriptorHashEquals::operator()(
5743    const std::pair<const char*, mirror::ClassLoader*>& element) const {
5744  return ComputeModifiedUtf8Hash(element.first);
5745}
5746
5747bool ClassLinker::ClassDescriptorHashEquals::operator()(
5748    const GcRoot<mirror::Class>& a, const std::pair<const char*, mirror::ClassLoader*>& b) const {
5749  if (a.Read()->GetClassLoader() != b.second) {
5750    return false;
5751  }
5752  return a.Read()->DescriptorEquals(b.first);
5753}
5754
5755bool ClassLinker::ClassDescriptorHashEquals::operator()(const GcRoot<mirror::Class>& a,
5756                                                        const char* descriptor) const {
5757  return a.Read()->DescriptorEquals(descriptor);
5758}
5759
5760std::size_t ClassLinker::ClassDescriptorHashEquals::operator()(const char* descriptor) const {
5761  return ComputeModifiedUtf8Hash(descriptor);
5762}
5763
5764bool ClassLinker::MayBeCalledWithDirectCodePointer(ArtMethod* m) {
5765  if (Runtime::Current()->UseJit()) {
5766    // JIT can have direct code pointers from any method to any other method.
5767    return true;
5768  }
5769  // Non-image methods don't use direct code pointer.
5770  if (!m->GetDeclaringClass()->IsBootStrapClassLoaded()) {
5771    return false;
5772  }
5773  if (m->IsPrivate()) {
5774    // The method can only be called inside its own oat file. Therefore it won't be called using
5775    // its direct code if the oat file has been compiled in PIC mode.
5776    const DexFile& dex_file = m->GetDeclaringClass()->GetDexFile();
5777    const OatFile::OatDexFile* oat_dex_file = dex_file.GetOatDexFile();
5778    if (oat_dex_file == nullptr) {
5779      // No oat file: the method has not been compiled.
5780      return false;
5781    }
5782    const OatFile* oat_file = oat_dex_file->GetOatFile();
5783    return oat_file != nullptr && !oat_file->IsPic();
5784  } else {
5785    // The method can be called outside its own oat file. Therefore it won't be called using its
5786    // direct code pointer only if all loaded oat files have been compiled in PIC mode.
5787    ReaderMutexLock mu(Thread::Current(), dex_lock_);
5788    for (const OatFile* oat_file : oat_files_) {
5789      if (!oat_file->IsPic()) {
5790        return true;
5791      }
5792    }
5793    return false;
5794  }
5795}
5796
5797jobject ClassLinker::CreatePathClassLoader(Thread* self, std::vector<const DexFile*>& dex_files) {
5798  // SOAAlreadyRunnable is protected, and we need something to add a global reference.
5799  // We could move the jobject to the callers, but all call-sites do this...
5800  ScopedObjectAccessUnchecked soa(self);
5801
5802  // Register the dex files.
5803  for (const DexFile* dex_file : dex_files) {
5804    RegisterDexFile(*dex_file);
5805  }
5806
5807  // For now, create a libcore-level DexFile for each ART DexFile. This "explodes" multidex.
5808  StackHandleScope<10> hs(self);
5809
5810  ArtField* dex_elements_field =
5811      soa.DecodeField(WellKnownClasses::dalvik_system_DexPathList_dexElements);
5812
5813  mirror::Class* dex_elements_class = dex_elements_field->GetType<true>();
5814  DCHECK(dex_elements_class != nullptr);
5815  DCHECK(dex_elements_class->IsArrayClass());
5816  Handle<mirror::ObjectArray<mirror::Object>> h_dex_elements(hs.NewHandle(
5817      mirror::ObjectArray<mirror::Object>::Alloc(self, dex_elements_class, dex_files.size())));
5818  Handle<mirror::Class> h_dex_element_class =
5819      hs.NewHandle(dex_elements_class->GetComponentType());
5820
5821  ArtField* element_file_field =
5822      soa.DecodeField(WellKnownClasses::dalvik_system_DexPathList__Element_dexFile);
5823  DCHECK_EQ(h_dex_element_class.Get(), element_file_field->GetDeclaringClass());
5824
5825  ArtField* cookie_field = soa.DecodeField(WellKnownClasses::dalvik_system_DexFile_cookie);
5826  DCHECK_EQ(cookie_field->GetDeclaringClass(), element_file_field->GetType<false>());
5827
5828  // Fill the elements array.
5829  int32_t index = 0;
5830  for (const DexFile* dex_file : dex_files) {
5831    StackHandleScope<3> hs2(self);
5832
5833    Handle<mirror::LongArray> h_long_array = hs2.NewHandle(mirror::LongArray::Alloc(self, 1));
5834    DCHECK(h_long_array.Get() != nullptr);
5835    h_long_array->Set(0, reinterpret_cast<intptr_t>(dex_file));
5836
5837    Handle<mirror::Object> h_dex_file = hs2.NewHandle(
5838        cookie_field->GetDeclaringClass()->AllocObject(self));
5839    DCHECK(h_dex_file.Get() != nullptr);
5840    cookie_field->SetObject<false>(h_dex_file.Get(), h_long_array.Get());
5841
5842    Handle<mirror::Object> h_element = hs2.NewHandle(h_dex_element_class->AllocObject(self));
5843    DCHECK(h_element.Get() != nullptr);
5844    element_file_field->SetObject<false>(h_element.Get(), h_dex_file.Get());
5845
5846    h_dex_elements->Set(index, h_element.Get());
5847    index++;
5848  }
5849  DCHECK_EQ(index, h_dex_elements->GetLength());
5850
5851  // Create DexPathList.
5852  Handle<mirror::Object> h_dex_path_list = hs.NewHandle(
5853      dex_elements_field->GetDeclaringClass()->AllocObject(self));
5854  DCHECK(h_dex_path_list.Get() != nullptr);
5855  // Set elements.
5856  dex_elements_field->SetObject<false>(h_dex_path_list.Get(), h_dex_elements.Get());
5857
5858  // Create PathClassLoader.
5859  Handle<mirror::Class> h_path_class_class = hs.NewHandle(
5860      soa.Decode<mirror::Class*>(WellKnownClasses::dalvik_system_PathClassLoader));
5861  Handle<mirror::Object> h_path_class_loader = hs.NewHandle(
5862      h_path_class_class->AllocObject(self));
5863  DCHECK(h_path_class_loader.Get() != nullptr);
5864  // Set DexPathList.
5865  ArtField* path_list_field =
5866      soa.DecodeField(WellKnownClasses::dalvik_system_PathClassLoader_pathList);
5867  DCHECK(path_list_field != nullptr);
5868  path_list_field->SetObject<false>(h_path_class_loader.Get(), h_dex_path_list.Get());
5869
5870  // Make a pretend boot-classpath.
5871  // TODO: Should we scan the image?
5872  ArtField* const parent_field =
5873      mirror::Class::FindField(self, hs.NewHandle(h_path_class_loader->GetClass()), "parent",
5874                               "Ljava/lang/ClassLoader;");
5875  DCHECK(parent_field!= nullptr);
5876  mirror::Object* boot_cl =
5877      soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_BootClassLoader)->AllocObject(self);
5878  parent_field->SetObject<false>(h_path_class_loader.Get(), boot_cl);
5879
5880  // Make it a global ref and return.
5881  ScopedLocalRef<jobject> local_ref(
5882      soa.Env(), soa.Env()->AddLocalReference<jobject>(h_path_class_loader.Get()));
5883  return soa.Env()->NewGlobalRef(local_ref.get());
5884}
5885
5886ArtMethod* ClassLinker::CreateRuntimeMethod() {
5887  ArtMethod* method = AllocArtMethodArray(Thread::Current(), 1);
5888  CHECK(method != nullptr);
5889  method->SetDexMethodIndex(DexFile::kDexNoIndex);
5890  CHECK(method->IsRuntimeMethod());
5891  return method;
5892}
5893
5894void ClassLinker::DropFindArrayClassCache() {
5895  std::fill_n(find_array_class_cache_, kFindArrayCacheSize, GcRoot<mirror::Class>(nullptr));
5896  find_array_class_cache_next_victim_ = 0;
5897}
5898
5899}  // namespace art
5900