class_linker.h revision 5369c40f75fdcb1be7a7c06db212ce965c83a164
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#ifndef ART_RUNTIME_CLASS_LINKER_H_ 18#define ART_RUNTIME_CLASS_LINKER_H_ 19 20#include <string> 21#include <utility> 22#include <vector> 23 24#include "base/allocator.h" 25#include "base/macros.h" 26#include "base/mutex.h" 27#include "dex_file.h" 28#include "gc_root.h" 29#include "gtest/gtest.h" 30#include "jni.h" 31#include "oat_file.h" 32#include "object_callbacks.h" 33 34namespace art { 35 36namespace gc { 37namespace space { 38 class ImageSpace; 39} // namespace space 40} // namespace gc 41namespace mirror { 42 class ClassLoader; 43 class DexCache; 44 class DexCacheTest_Open_Test; 45 class IfTable; 46 template<class T> class ObjectArray; 47 class StackTraceElement; 48} // namespace mirror 49 50class InternTable; 51template<class T> class ObjectLock; 52class ScopedObjectAccessAlreadyRunnable; 53template<class T> class Handle; 54 55typedef bool (ClassVisitor)(mirror::Class* c, void* arg); 56 57enum VisitRootFlags : uint8_t; 58 59class ClassLinker { 60 public: 61 explicit ClassLinker(InternTable* intern_table); 62 ~ClassLinker(); 63 64 // Initialize class linker by bootstraping from dex files. 65 void InitWithoutImage(const std::vector<const DexFile*>& boot_class_path) 66 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 67 68 // Initialize class linker from one or more images. 69 void InitFromImage() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 70 71 bool IsInBootClassPath(const char* descriptor); 72 73 // Finds a class by its descriptor, loading it if necessary. 74 // If class_loader is null, searches boot_class_path_. 75 mirror::Class* FindClass(Thread* self, const char* descriptor, 76 Handle<mirror::ClassLoader> class_loader) 77 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 78 79 // Finds a class by its descriptor using the "system" class loader, ie by searching the 80 // boot_class_path_. 81 mirror::Class* FindSystemClass(Thread* self, const char* descriptor) 82 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 83 84 // Finds the array class given for the element class. 85 mirror::Class* FindArrayClass(Thread* self, mirror::Class** element_class) 86 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 87 88 // Reutrns true if the class linker is initialized. 89 bool IsInitialized() const; 90 91 // Define a new a class based on a ClassDef from a DexFile 92 mirror::Class* DefineClass(const char* descriptor, 93 Handle<mirror::ClassLoader> class_loader, 94 const DexFile& dex_file, const DexFile::ClassDef& dex_class_def) 95 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 96 97 // Finds a class by its descriptor, returning NULL if it isn't wasn't loaded 98 // by the given 'class_loader'. 99 mirror::Class* LookupClass(const char* descriptor, const mirror::ClassLoader* class_loader) 100 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 101 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 102 103 // Finds all the classes with the given descriptor, regardless of ClassLoader. 104 void LookupClasses(const char* descriptor, std::vector<mirror::Class*>& classes) 105 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 106 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 107 108 mirror::Class* FindPrimitiveClass(char type) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 109 110 // General class unloading is not supported, this is used to prune 111 // unwanted classes during image writing. 112 bool RemoveClass(const char* descriptor, const mirror::ClassLoader* class_loader) 113 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 114 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 115 116 void DumpAllClasses(int flags) 117 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 118 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 119 120 void DumpForSigQuit(std::ostream& os) 121 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 122 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 123 124 size_t NumLoadedClasses() 125 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 126 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 127 128 // Resolve a String with the given index from the DexFile, storing the 129 // result in the DexCache. The referrer is used to identify the 130 // target DexCache and ClassLoader to use for resolution. 131 mirror::String* ResolveString(uint32_t string_idx, mirror::ArtMethod* referrer) 132 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 133 134 // Resolve a String with the given index from the DexFile, storing the 135 // result in the DexCache. 136 mirror::String* ResolveString(const DexFile& dex_file, uint32_t string_idx, 137 Handle<mirror::DexCache> dex_cache) 138 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 139 140 // Resolve a Type with the given index from the DexFile, storing the 141 // result in the DexCache. The referrer is used to identity the 142 // target DexCache and ClassLoader to use for resolution. 143 mirror::Class* ResolveType(const DexFile& dex_file, uint16_t type_idx, mirror::Class* referrer) 144 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 145 146 // Resolve a Type with the given index from the DexFile, storing the 147 // result in the DexCache. The referrer is used to identify the 148 // target DexCache and ClassLoader to use for resolution. 149 mirror::Class* ResolveType(uint16_t type_idx, mirror::ArtMethod* referrer) 150 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 151 152 mirror::Class* ResolveType(uint16_t type_idx, mirror::ArtField* referrer) 153 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 154 155 // Resolve a type with the given ID from the DexFile, storing the 156 // result in DexCache. The ClassLoader is used to search for the 157 // type, since it may be referenced from but not contained within 158 // the given DexFile. 159 mirror::Class* ResolveType(const DexFile& dex_file, uint16_t type_idx, 160 Handle<mirror::DexCache> dex_cache, 161 Handle<mirror::ClassLoader> class_loader) 162 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 163 164 // Resolve a method with a given ID from the DexFile, storing the 165 // result in DexCache. The ClassLinker and ClassLoader are used as 166 // in ResolveType. What is unique is the method type argument which 167 // is used to determine if this method is a direct, static, or 168 // virtual method. 169 mirror::ArtMethod* ResolveMethod(const DexFile& dex_file, 170 uint32_t method_idx, 171 Handle<mirror::DexCache> dex_cache, 172 Handle<mirror::ClassLoader> class_loader, 173 Handle<mirror::ArtMethod> referrer, 174 InvokeType type) 175 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 176 177 mirror::ArtMethod* GetResolvedMethod(uint32_t method_idx, mirror::ArtMethod* referrer, 178 InvokeType type) 179 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 180 mirror::ArtMethod* ResolveMethod(Thread* self, uint32_t method_idx, mirror::ArtMethod** referrer, 181 InvokeType type) 182 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 183 184 mirror::ArtField* GetResolvedField(uint32_t field_idx, mirror::Class* field_declaring_class) 185 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 186 mirror::ArtField* ResolveField(uint32_t field_idx, mirror::ArtMethod* referrer, 187 bool is_static) 188 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 189 190 // Resolve a field with a given ID from the DexFile, storing the 191 // result in DexCache. The ClassLinker and ClassLoader are used as 192 // in ResolveType. What is unique is the is_static argument which is 193 // used to determine if we are resolving a static or non-static 194 // field. 195 mirror::ArtField* ResolveField(const DexFile& dex_file, 196 uint32_t field_idx, 197 Handle<mirror::DexCache> dex_cache, 198 Handle<mirror::ClassLoader> class_loader, 199 bool is_static) 200 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 201 202 // Resolve a field with a given ID from the DexFile, storing the 203 // result in DexCache. The ClassLinker and ClassLoader are used as 204 // in ResolveType. No is_static argument is provided so that Java 205 // field resolution semantics are followed. 206 mirror::ArtField* ResolveFieldJLS(const DexFile& dex_file, uint32_t field_idx, 207 Handle<mirror::DexCache> dex_cache, 208 Handle<mirror::ClassLoader> class_loader) 209 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 210 211 // Get shorty from method index without resolution. Used to do handlerization. 212 const char* MethodShorty(uint32_t method_idx, mirror::ArtMethod* referrer, uint32_t* length) 213 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 214 215 // Returns true on success, false if there's an exception pending. 216 // can_run_clinit=false allows the compiler to attempt to init a class, 217 // given the restriction that no <clinit> execution is possible. 218 bool EnsureInitialized(Handle<mirror::Class> c, bool can_init_fields, bool can_init_parents) 219 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 220 221 // Initializes classes that have instances in the image but that have 222 // <clinit> methods so they could not be initialized by the compiler. 223 void RunRootClinits() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 224 225 void RegisterDexFile(const DexFile& dex_file) 226 LOCKS_EXCLUDED(dex_lock_) 227 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 228 void RegisterDexFile(const DexFile& dex_file, Handle<mirror::DexCache> dex_cache) 229 LOCKS_EXCLUDED(dex_lock_) 230 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 231 232 const OatFile* RegisterOatFile(const OatFile* oat_file) 233 LOCKS_EXCLUDED(dex_lock_); 234 235 const std::vector<const DexFile*>& GetBootClassPath() { 236 return boot_class_path_; 237 } 238 239 void VisitClasses(ClassVisitor* visitor, void* arg) 240 LOCKS_EXCLUDED(dex_lock_) 241 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 242 // Less efficient variant of VisitClasses that doesn't hold the classlinker_classes_lock_ 243 // when calling the visitor. 244 void VisitClassesWithoutClassesLock(ClassVisitor* visitor, void* arg) 245 LOCKS_EXCLUDED(dex_lock_) 246 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 247 248 void VisitClassRoots(RootCallback* callback, void* arg, VisitRootFlags flags) 249 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 250 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 251 void VisitRoots(RootCallback* callback, void* arg, VisitRootFlags flags) 252 LOCKS_EXCLUDED(dex_lock_) 253 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 254 255 mirror::DexCache* FindDexCache(const DexFile& dex_file) 256 LOCKS_EXCLUDED(dex_lock_) 257 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 258 bool IsDexFileRegistered(const DexFile& dex_file) 259 LOCKS_EXCLUDED(dex_lock_) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 260 void FixupDexCaches(mirror::ArtMethod* resolution_method) 261 LOCKS_EXCLUDED(dex_lock_) 262 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 263 264 // Generate an oat file from a dex file 265 bool GenerateOatFile(const char* dex_filename, 266 int oat_fd, 267 const char* oat_cache_filename, 268 std::string* error_msg) 269 LOCKS_EXCLUDED(Locks::mutator_lock_); 270 271 // Find or create the oat file holding dex_location. Then load all corresponding dex files 272 // (if multidex) into the given vector. 273 bool OpenDexFilesFromOat(const char* dex_location, const char* oat_location, 274 std::vector<std::string>* error_msgs, 275 std::vector<const DexFile*>* dex_files) 276 LOCKS_EXCLUDED(dex_lock_, Locks::mutator_lock_); 277 278 // Returns true if the given oat file has the same image checksum as the image it is paired with. 279 static bool VerifyOatImageChecksum(const OatFile* oat_file, const InstructionSet instruction_set); 280 // Returns true if the oat file checksums match with the image and the offsets are such that it 281 // could be loaded with it. 282 static bool VerifyOatChecksums(const OatFile* oat_file, const InstructionSet instruction_set, 283 std::string* error_msg); 284 // Returns true if oat file contains the dex file with the given location and checksum. 285 static bool VerifyOatAndDexFileChecksums(const OatFile* oat_file, 286 const char* dex_location, 287 uint32_t dex_location_checksum, 288 InstructionSet instruction_set, 289 std::string* error_msg); 290 291 // TODO: replace this with multiple methods that allocate the correct managed type. 292 template <class T> 293 mirror::ObjectArray<T>* AllocObjectArray(Thread* self, size_t length) 294 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 295 296 mirror::ObjectArray<mirror::Class>* AllocClassArray(Thread* self, size_t length) 297 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 298 299 mirror::ObjectArray<mirror::String>* AllocStringArray(Thread* self, size_t length) 300 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 301 302 mirror::ObjectArray<mirror::ArtMethod>* AllocArtMethodArray(Thread* self, size_t length) 303 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 304 305 mirror::IfTable* AllocIfTable(Thread* self, size_t ifcount) 306 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 307 308 mirror::ObjectArray<mirror::ArtField>* AllocArtFieldArray(Thread* self, size_t length) 309 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 310 311 mirror::ObjectArray<mirror::StackTraceElement>* AllocStackTraceElementArray(Thread* self, 312 size_t length) 313 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 314 315 void VerifyClass(Handle<mirror::Class> klass) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 316 bool VerifyClassUsingOatFile(const DexFile& dex_file, mirror::Class* klass, 317 mirror::Class::Status& oat_file_class_status) 318 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 319 void ResolveClassExceptionHandlerTypes(const DexFile& dex_file, 320 Handle<mirror::Class> klass) 321 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 322 void ResolveMethodExceptionHandlerTypes(const DexFile& dex_file, mirror::ArtMethod* klass) 323 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 324 325 mirror::Class* CreateProxyClass(ScopedObjectAccessAlreadyRunnable& soa, jstring name, 326 jobjectArray interfaces, jobject loader, jobjectArray methods, 327 jobjectArray throws) 328 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 329 std::string GetDescriptorForProxy(mirror::Class* proxy_class) 330 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 331 mirror::ArtMethod* FindMethodForProxy(mirror::Class* proxy_class, 332 mirror::ArtMethod* proxy_method) 333 LOCKS_EXCLUDED(dex_lock_) 334 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 335 336 // Get the oat code for a method when its class isn't yet initialized 337 const void* GetQuickOatCodeFor(mirror::ArtMethod* method) 338 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 339 const void* GetPortableOatCodeFor(mirror::ArtMethod* method, bool* have_portable_code) 340 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 341 342 // Get the oat code for a method from a method index. 343 const void* GetQuickOatCodeFor(const DexFile& dex_file, uint16_t class_def_idx, uint32_t method_idx) 344 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 345 const void* GetPortableOatCodeFor(const DexFile& dex_file, uint16_t class_def_idx, uint32_t method_idx) 346 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 347 348 pid_t GetClassesLockOwner(); // For SignalCatcher. 349 pid_t GetDexLockOwner(); // For SignalCatcher. 350 351 const void* GetPortableResolutionTrampoline() const { 352 return portable_resolution_trampoline_; 353 } 354 355 const void* GetQuickGenericJniTrampoline() const { 356 return quick_generic_jni_trampoline_; 357 } 358 359 const void* GetQuickResolutionTrampoline() const { 360 return quick_resolution_trampoline_; 361 } 362 363 const void* GetPortableImtConflictTrampoline() const { 364 return portable_imt_conflict_trampoline_; 365 } 366 367 const void* GetQuickImtConflictTrampoline() const { 368 return quick_imt_conflict_trampoline_; 369 } 370 371 const void* GetQuickToInterpreterBridgeTrampoline() const { 372 return quick_to_interpreter_bridge_trampoline_; 373 } 374 375 InternTable* GetInternTable() const { 376 return intern_table_; 377 } 378 379 // Attempts to insert a class into a class table. Returns NULL if 380 // the class was inserted, otherwise returns an existing class with 381 // the same descriptor and ClassLoader. 382 mirror::Class* InsertClass(const char* descriptor, mirror::Class* klass, size_t hash) 383 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 384 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 385 386 // Special code to allocate an art method, use this instead of class->AllocObject. 387 mirror::ArtMethod* AllocArtMethod(Thread* self) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 388 389 mirror::ObjectArray<mirror::Class>* GetClassRoots() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 390 mirror::ObjectArray<mirror::Class>* class_roots = class_roots_.Read(); 391 DCHECK(class_roots != NULL); 392 return class_roots; 393 } 394 395 private: 396 bool FindOatMethodFor(mirror::ArtMethod* method, OatFile::OatMethod* oat_method) 397 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 398 399 OatFile& GetImageOatFile(gc::space::ImageSpace* space) 400 LOCKS_EXCLUDED(dex_lock_) 401 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 402 403 void FinishInit(Thread* self) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 404 405 // For early bootstrapping by Init 406 mirror::Class* AllocClass(Thread* self, mirror::Class* java_lang_Class, uint32_t class_size) 407 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 408 409 // Alloc* convenience functions to avoid needing to pass in mirror::Class* 410 // values that are known to the ClassLinker such as 411 // kObjectArrayClass and kJavaLangString etc. 412 mirror::Class* AllocClass(Thread* self, uint32_t class_size) 413 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 414 mirror::DexCache* AllocDexCache(Thread* self, const DexFile& dex_file) 415 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 416 mirror::ArtField* AllocArtField(Thread* self) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 417 418 mirror::Class* CreatePrimitiveClass(Thread* self, Primitive::Type type) 419 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 420 mirror::Class* InitializePrimitiveClass(mirror::Class* primitive_class, Primitive::Type type) 421 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 422 423 424 mirror::Class* CreateArrayClass(Thread* self, const char* descriptor, 425 Handle<mirror::ClassLoader> class_loader) 426 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 427 428 void AppendToBootClassPath(const DexFile& dex_file) 429 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 430 void AppendToBootClassPath(const DexFile& dex_file, Handle<mirror::DexCache> dex_cache) 431 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 432 433 void ConstructFieldMap(const DexFile& dex_file, const DexFile::ClassDef& dex_class_def, 434 mirror::Class* c, SafeMap<uint32_t, mirror::ArtField*>& field_map) 435 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 436 437 // Precomputes size needed for Class, in the case of a non-temporary class this size must be 438 // sufficient to hold all static fields. 439 uint32_t SizeOfClassWithoutEmbeddedTables(const DexFile& dex_file, 440 const DexFile::ClassDef& dex_class_def); 441 442 void LoadClass(const DexFile& dex_file, 443 const DexFile::ClassDef& dex_class_def, 444 Handle<mirror::Class> klass, 445 mirror::ClassLoader* class_loader) 446 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 447 void LoadClassMembers(const DexFile& dex_file, 448 const byte* class_data, 449 Handle<mirror::Class> klass, 450 mirror::ClassLoader* class_loader, 451 const OatFile::OatClass* oat_class) 452 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 453 454 void LoadField(const DexFile& dex_file, const ClassDataItemIterator& it, 455 Handle<mirror::Class> klass, Handle<mirror::ArtField> dst) 456 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 457 458 mirror::ArtMethod* LoadMethod(Thread* self, const DexFile& dex_file, 459 const ClassDataItemIterator& dex_method, 460 Handle<mirror::Class> klass) 461 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 462 463 void FixupStaticTrampolines(mirror::Class* klass) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 464 465 // Finds the associated oat class for a dex_file and descriptor. Returns whether the class 466 // was found, and sets the data in oat_class. 467 bool FindOatClass(const DexFile& dex_file, uint16_t class_def_idx, OatFile::OatClass* oat_class) 468 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 469 470 void RegisterDexFileLocked(const DexFile& dex_file, Handle<mirror::DexCache> dex_cache) 471 EXCLUSIVE_LOCKS_REQUIRED(dex_lock_) 472 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 473 bool IsDexFileRegisteredLocked(const DexFile& dex_file) 474 SHARED_LOCKS_REQUIRED(dex_lock_, Locks::mutator_lock_); 475 476 bool InitializeClass(Handle<mirror::Class> klass, bool can_run_clinit, 477 bool can_init_parents) 478 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 479 bool WaitForInitializeClass(Handle<mirror::Class> klass, Thread* self, 480 ObjectLock<mirror::Class>& lock); 481 bool ValidateSuperClassDescriptors(Handle<mirror::Class> klass) 482 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 483 484 bool IsSameDescriptorInDifferentClassContexts(Thread* self, const char* descriptor, 485 Handle<mirror::ClassLoader> class_loader1, 486 Handle<mirror::ClassLoader> class_loader2) 487 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 488 489 bool IsSameMethodSignatureInDifferentClassContexts(Thread* self, mirror::ArtMethod* method, 490 mirror::Class* klass1, 491 mirror::Class* klass2) 492 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 493 494 bool LinkClass(Thread* self, const char* descriptor, Handle<mirror::Class> klass, 495 Handle<mirror::ObjectArray<mirror::Class>> interfaces, 496 mirror::Class** new_class) 497 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 498 499 bool LinkSuperClass(Handle<mirror::Class> klass) 500 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 501 502 bool LoadSuperAndInterfaces(Handle<mirror::Class> klass, const DexFile& dex_file) 503 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 504 505 bool LinkMethods(Thread* self, Handle<mirror::Class> klass, 506 Handle<mirror::ObjectArray<mirror::Class>> interfaces) 507 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 508 509 bool LinkVirtualMethods(Thread* self, Handle<mirror::Class> klass) 510 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 511 512 bool LinkInterfaceMethods(Handle<mirror::Class> klass, 513 Handle<mirror::ObjectArray<mirror::Class>> interfaces) 514 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 515 516 bool LinkStaticFields(Handle<mirror::Class> klass, size_t* class_size) 517 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 518 bool LinkInstanceFields(Handle<mirror::Class> klass) 519 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 520 bool LinkFields(Handle<mirror::Class> klass, bool is_static, size_t* class_size) 521 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 522 void LinkCode(Handle<mirror::ArtMethod> method, const OatFile::OatClass* oat_class, 523 const DexFile& dex_file, uint32_t dex_method_index, uint32_t method_index) 524 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 525 526 void CreateReferenceInstanceOffsets(Handle<mirror::Class> klass) 527 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 528 void CreateReferenceStaticOffsets(Handle<mirror::Class> klass) 529 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 530 void CreateReferenceOffsets(Handle<mirror::Class> klass, bool is_static, 531 uint32_t reference_offsets) 532 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 533 534 // For use by ImageWriter to find DexCaches for its roots 535 ReaderWriterMutex* DexLock() 536 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) LOCK_RETURNED(dex_lock_) { 537 return &dex_lock_; 538 } 539 size_t GetDexCacheCount() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, dex_lock_) { 540 return dex_caches_.size(); 541 } 542 mirror::DexCache* GetDexCache(size_t idx) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, dex_lock_); 543 544 const OatFile* FindOpenedOatFileForDexFile(const DexFile& dex_file) 545 LOCKS_EXCLUDED(dex_lock_) 546 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 547 548 // Find an opened oat file that contains dex_location. If oat_location is not nullptr, the file 549 // must have that location, else any oat location is accepted. 550 const OatFile* FindOpenedOatFile(const char* oat_location, const char* dex_location, 551 const uint32_t* const dex_location_checksum) 552 LOCKS_EXCLUDED(dex_lock_); 553 554 // Will open the oat file directly without relocating, even if we could/should do relocation. 555 const OatFile* FindOatFileFromOatLocation(const std::string& oat_location, 556 std::string* error_msg) 557 LOCKS_EXCLUDED(dex_lock_); 558 559 const OatFile* FindOpenedOatFileFromOatLocation(const std::string& oat_location) 560 LOCKS_EXCLUDED(dex_lock_); 561 562 const OatFile* OpenOatFileFromDexLocation(const std::string& dex_location, 563 InstructionSet isa, 564 bool* already_opened, 565 bool* obsolete_file_cleanup_failed, 566 std::vector<std::string>* error_msg) 567 LOCKS_EXCLUDED(dex_lock_, Locks::mutator_lock_); 568 569 const OatFile* GetInterpretedOnlyOat(const std::string& oat_path, 570 InstructionSet isa, 571 std::string* error_msg); 572 573 const OatFile* PatchAndRetrieveOat(const std::string& input, const std::string& output, 574 const std::string& image_location, InstructionSet isa, 575 std::string* error_msg) 576 LOCKS_EXCLUDED(Locks::mutator_lock_); 577 578 bool CheckOatFile(const OatFile* oat_file, InstructionSet isa, 579 bool* checksum_verified, std::string* error_msg); 580 int32_t GetRequiredDelta(const OatFile* oat_file, InstructionSet isa); 581 582 // Note: will not register the oat file. 583 const OatFile* FindOatFileInOatLocationForDexFile(const char* dex_location, 584 uint32_t dex_location_checksum, 585 const char* oat_location, 586 std::string* error_msg) 587 LOCKS_EXCLUDED(dex_lock_); 588 589 // Creates the oat file from the dex_location to the oat_location. Needs a file descriptor for 590 // the file to be written, which is assumed to be under a lock. 591 const OatFile* CreateOatFileForDexLocation(const char* dex_location, 592 int fd, const char* oat_location, 593 std::vector<std::string>* error_msgs) 594 LOCKS_EXCLUDED(dex_lock_, Locks::mutator_lock_); 595 596 // Finds an OatFile that contains a DexFile for the given a DexFile location. 597 // 598 // Note 1: this will not check open oat files, which are assumed to be stale when this is run. 599 // Note 2: Does not register the oat file. It is the caller's job to register if the file is to 600 // be kept. 601 const OatFile* FindOatFileContainingDexFileFromDexLocation(const char* location, 602 const uint32_t* const location_checksum, 603 InstructionSet isa, 604 std::vector<std::string>* error_msgs, 605 bool* obsolete_file_cleanup_failed) 606 LOCKS_EXCLUDED(dex_lock_, Locks::mutator_lock_); 607 608 // verify an oat file with the given dex file. Will return false when the dex file could not be 609 // verified. Will return true otherwise. 610 bool VerifyOatWithDexFile(const OatFile* oat_file, const char* dex_location, 611 std::string* error_msg); 612 613 mirror::ArtMethod* CreateProxyConstructor(Thread* self, Handle<mirror::Class> klass, 614 mirror::Class* proxy_class) 615 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 616 mirror::ArtMethod* CreateProxyMethod(Thread* self, Handle<mirror::Class> klass, 617 Handle<mirror::ArtMethod> prototype) 618 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 619 620 std::vector<const DexFile*> boot_class_path_; 621 622 mutable ReaderWriterMutex dex_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 623 std::vector<size_t> new_dex_cache_roots_ GUARDED_BY(dex_lock_);; 624 std::vector<GcRoot<mirror::DexCache>> dex_caches_ GUARDED_BY(dex_lock_); 625 std::vector<const OatFile*> oat_files_ GUARDED_BY(dex_lock_); 626 627 628 // multimap from a string hash code of a class descriptor to 629 // mirror::Class* instances. Results should be compared for a matching 630 // Class::descriptor_ and Class::class_loader_. 631 typedef AllocationTrackingMultiMap<size_t, GcRoot<mirror::Class>, kAllocatorTagClassTable> Table; 632 // This contains strong roots. To enable concurrent root scanning of 633 // the class table, be careful to use a read barrier when accessing this. 634 Table class_table_ GUARDED_BY(Locks::classlinker_classes_lock_); 635 std::vector<std::pair<size_t, GcRoot<mirror::Class>>> new_class_roots_; 636 637 // Do we need to search dex caches to find image classes? 638 bool dex_cache_image_class_lookup_required_; 639 // Number of times we've searched dex caches for a class. After a certain number of misses we move 640 // the classes into the class_table_ to avoid dex cache based searches. 641 AtomicInteger failed_dex_cache_class_lookups_; 642 643 mirror::Class* LookupClassFromTableLocked(const char* descriptor, 644 const mirror::ClassLoader* class_loader, 645 size_t hash) 646 SHARED_LOCKS_REQUIRED(Locks::classlinker_classes_lock_, Locks::mutator_lock_); 647 648 mirror::Class* UpdateClass(const char* descriptor, mirror::Class* klass, size_t hash) 649 LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 650 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 651 652 void MoveImageClassesToClassTable() LOCKS_EXCLUDED(Locks::classlinker_classes_lock_) 653 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 654 mirror::Class* LookupClassFromImage(const char* descriptor) 655 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 656 657 // EnsureResolved is called to make sure that a class in the class_table_ has been resolved 658 // before returning it to the caller. Its the responsibility of the thread that placed the class 659 // in the table to make it resolved. The thread doing resolution must notify on the class' lock 660 // when resolution has occurred. This happens in mirror::Class::SetStatus. As resolution may 661 // retire a class, the version of the class in the table is returned and this may differ from 662 // the class passed in. 663 mirror::Class* EnsureResolved(Thread* self, const char* descriptor, mirror::Class* klass) 664 WARN_UNUSED SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 665 666 void FixupTemporaryDeclaringClass(mirror::Class* temp_class, mirror::Class* new_class) 667 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 668 669 // indexes into class_roots_. 670 // needs to be kept in sync with class_roots_descriptors_. 671 enum ClassRoot { 672 kJavaLangClass, 673 kJavaLangObject, 674 kClassArrayClass, 675 kObjectArrayClass, 676 kJavaLangString, 677 kJavaLangDexCache, 678 kJavaLangRefReference, 679 kJavaLangReflectArtField, 680 kJavaLangReflectArtMethod, 681 kJavaLangReflectProxy, 682 kJavaLangStringArrayClass, 683 kJavaLangReflectArtFieldArrayClass, 684 kJavaLangReflectArtMethodArrayClass, 685 kJavaLangClassLoader, 686 kJavaLangThrowable, 687 kJavaLangClassNotFoundException, 688 kJavaLangStackTraceElement, 689 kPrimitiveBoolean, 690 kPrimitiveByte, 691 kPrimitiveChar, 692 kPrimitiveDouble, 693 kPrimitiveFloat, 694 kPrimitiveInt, 695 kPrimitiveLong, 696 kPrimitiveShort, 697 kPrimitiveVoid, 698 kBooleanArrayClass, 699 kByteArrayClass, 700 kCharArrayClass, 701 kDoubleArrayClass, 702 kFloatArrayClass, 703 kIntArrayClass, 704 kLongArrayClass, 705 kShortArrayClass, 706 kJavaLangStackTraceElementArrayClass, 707 kClassRootsMax, 708 }; 709 GcRoot<mirror::ObjectArray<mirror::Class>> class_roots_; 710 711 mirror::Class* GetClassRoot(ClassRoot class_root) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 712 713 void SetClassRoot(ClassRoot class_root, mirror::Class* klass) 714 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 715 716 static const char* class_roots_descriptors_[]; 717 718 const char* GetClassRootDescriptor(ClassRoot class_root) { 719 const char* descriptor = class_roots_descriptors_[class_root]; 720 CHECK(descriptor != NULL); 721 return descriptor; 722 } 723 724 // The interface table used by all arrays. 725 GcRoot<mirror::IfTable> array_iftable_; 726 727 // A cache of the last FindArrayClass results. The cache serves to avoid creating array class 728 // descriptors for the sake of performing FindClass. 729 static constexpr size_t kFindArrayCacheSize = 16; 730 GcRoot<mirror::Class> find_array_class_cache_[kFindArrayCacheSize]; 731 size_t find_array_class_cache_next_victim_; 732 733 bool init_done_; 734 bool log_new_dex_caches_roots_ GUARDED_BY(dex_lock_); 735 bool log_new_class_table_roots_ GUARDED_BY(Locks::classlinker_classes_lock_); 736 737 InternTable* intern_table_; 738 739 // Trampolines within the image the bounce to runtime entrypoints. Done so that there is a single 740 // patch point within the image. TODO: make these proper relocations. 741 const void* portable_resolution_trampoline_; 742 const void* quick_resolution_trampoline_; 743 const void* portable_imt_conflict_trampoline_; 744 const void* quick_imt_conflict_trampoline_; 745 const void* quick_generic_jni_trampoline_; 746 const void* quick_to_interpreter_bridge_trampoline_; 747 748 friend class ImageWriter; // for GetClassRoots 749 friend class ImageDumper; // for FindOpenedOatFileFromOatLocation 750 friend class ElfPatcher; // for FindOpenedOatFileForDexFile & FindOpenedOatFileFromOatLocation 751 friend class NoDex2OatTest; // for FindOpenedOatFileForDexFile 752 friend class NoPatchoatTest; // for FindOpenedOatFileForDexFile 753 FRIEND_TEST(ClassLinkerTest, ClassRootDescriptors); 754 FRIEND_TEST(mirror::DexCacheTest, Open); 755 FRIEND_TEST(ExceptionTest, FindExceptionHandler); 756 FRIEND_TEST(ObjectTest, AllocObjectArray); 757 DISALLOW_COPY_AND_ASSIGN(ClassLinker); 758}; 759 760} // namespace art 761 762#endif // ART_RUNTIME_CLASS_LINKER_H_ 763