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