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