1 /* 2 * Copyright (C) 2016 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_DEX_DEX_FILE_ANNOTATIONS_H_ 18 #define ART_RUNTIME_DEX_DEX_FILE_ANNOTATIONS_H_ 19 20 #include "dex/dex_file.h" 21 #include "handle.h" 22 #include "mirror/dex_cache.h" 23 #include "mirror/object_array.h" 24 #include "obj_ptr.h" 25 26 namespace art { 27 28 namespace mirror { 29 class ClassLoader; 30 } // namespace mirror 31 class ArtField; 32 class ArtMethod; 33 class ClassLinker; 34 35 namespace annotations { 36 37 // Field annotations. 38 ObjPtr<mirror::Object> GetAnnotationForField(ArtField* field, 39 Handle<mirror::Class> annotation_class) 40 REQUIRES_SHARED(Locks::mutator_lock_); 41 ObjPtr<mirror::ObjectArray<mirror::Object>> GetAnnotationsForField(ArtField* field) 42 REQUIRES_SHARED(Locks::mutator_lock_); 43 ObjPtr<mirror::ObjectArray<mirror::String>> GetSignatureAnnotationForField(ArtField* field) 44 REQUIRES_SHARED(Locks::mutator_lock_); 45 bool IsFieldAnnotationPresent(ArtField* field, Handle<mirror::Class> annotation_class) 46 REQUIRES_SHARED(Locks::mutator_lock_); 47 48 // Method annotations. 49 ObjPtr<mirror::Object> GetAnnotationDefaultValue(ArtMethod* method) 50 REQUIRES_SHARED(Locks::mutator_lock_); 51 ObjPtr<mirror::Object> GetAnnotationForMethod(ArtMethod* method, 52 Handle<mirror::Class> annotation_class) 53 REQUIRES_SHARED(Locks::mutator_lock_); 54 ObjPtr<mirror::ObjectArray<mirror::Object>> GetAnnotationsForMethod(ArtMethod* method) 55 REQUIRES_SHARED(Locks::mutator_lock_); 56 ObjPtr<mirror::ObjectArray<mirror::Class>> GetExceptionTypesForMethod(ArtMethod* method) 57 REQUIRES_SHARED(Locks::mutator_lock_); 58 ObjPtr<mirror::ObjectArray<mirror::Object>> GetParameterAnnotations(ArtMethod* method) 59 REQUIRES_SHARED(Locks::mutator_lock_); 60 uint32_t GetNumberOfAnnotatedMethodParameters(ArtMethod* method) 61 REQUIRES_SHARED(Locks::mutator_lock_); 62 ObjPtr<mirror::Object> GetAnnotationForMethodParameter(ArtMethod* method, 63 uint32_t parameter_idx, 64 Handle<mirror::Class> annotation_class) 65 REQUIRES_SHARED(Locks::mutator_lock_); 66 bool GetParametersMetadataForMethod( 67 ArtMethod* method, 68 /*out*/ MutableHandle<mirror::ObjectArray<mirror::String>>* names, 69 /*out*/ MutableHandle<mirror::IntArray>* access_flags) REQUIRES_SHARED(Locks::mutator_lock_); 70 ObjPtr<mirror::ObjectArray<mirror::String>> GetSignatureAnnotationForMethod(ArtMethod* method) 71 REQUIRES_SHARED(Locks::mutator_lock_); 72 // Check whether `method` is annotated with `annotation_class`. 73 // If `lookup_in_resolved_boot_classes` is true, look up any of the 74 // method's annotations' classes in the bootstrap class loader's 75 // resolved types; if it is false (default value), resolve them as a 76 // side effect. 77 bool IsMethodAnnotationPresent(ArtMethod* method, 78 Handle<mirror::Class> annotation_class, 79 uint32_t visibility = DexFile::kDexVisibilityRuntime) 80 REQUIRES_SHARED(Locks::mutator_lock_); 81 82 // Check whether a method from the `dex_file` with the given `method_index` 83 // is annotated with @dalvik.annotation.optimization.FastNative or 84 // @dalvik.annotation.optimization.CriticalNative with build visibility. 85 // If yes, return the associated access flags, i.e. kAccFastNative or kAccCriticalNative. 86 uint32_t GetNativeMethodAnnotationAccessFlags(const DexFile& dex_file, 87 const dex::ClassDef& class_def, 88 uint32_t method_index); 89 // Is the field from the `dex_file` with the given `field_index` 90 // annotated with @dalvik.annotation.optimization.ReachabilitySensitive? 91 bool FieldIsReachabilitySensitive(const DexFile& dex_file, 92 const dex::ClassDef& class_def, 93 uint32_t field_index); 94 // Is the method from the `dex_file` with the given `method_index` 95 // annotated with @dalvik.annotation.optimization.ReachabilitySensitive? 96 bool MethodIsReachabilitySensitive(const DexFile& dex_file, 97 const dex::ClassDef& class_def, 98 uint32_t method_index); 99 // Does the method from the `dex_file` with the given `method_index` contain an access to a field 100 // annotated with @dalvik.annotation.optimization.ReachabilitySensitive, or a call to a method 101 // with that annotation? 102 // Class_def is the class defining the method. We consider only accessses to classes or methods 103 // declared in the static type of the corresponding object. We may overlook accesses to annotated 104 // fields or methods that are in neither class_def nor a containing (outer) class. 105 bool MethodContainsRSensitiveAccess(const DexFile& dex_file, 106 const dex::ClassDef& class_def, 107 uint32_t method_index); 108 // Is the given class annotated with @dalvik.annotation.optimization.DeadReferenceSafe? 109 bool HasDeadReferenceSafeAnnotation(const DexFile& dex_file, 110 const dex::ClassDef& class_def); 111 112 // Class annotations. 113 ObjPtr<mirror::Object> GetAnnotationForClass(Handle<mirror::Class> klass, 114 Handle<mirror::Class> annotation_class) 115 REQUIRES_SHARED(Locks::mutator_lock_); 116 ObjPtr<mirror::ObjectArray<mirror::Object>> GetAnnotationsForClass(Handle<mirror::Class> klass) 117 REQUIRES_SHARED(Locks::mutator_lock_); 118 ObjPtr<mirror::ObjectArray<mirror::Class>> GetDeclaredClasses(Handle<mirror::Class> klass) 119 REQUIRES_SHARED(Locks::mutator_lock_); 120 ObjPtr<mirror::Class> GetDeclaringClass(Handle<mirror::Class> klass) 121 REQUIRES_SHARED(Locks::mutator_lock_); 122 ObjPtr<mirror::Class> GetEnclosingClass(Handle<mirror::Class> klass) 123 REQUIRES_SHARED(Locks::mutator_lock_); 124 ObjPtr<mirror::Object> GetEnclosingMethod(Handle<mirror::Class> klass) 125 REQUIRES_SHARED(Locks::mutator_lock_); 126 bool GetInnerClass(Handle<mirror::Class> klass, /*out*/ ObjPtr<mirror::String>* name) 127 REQUIRES_SHARED(Locks::mutator_lock_); 128 bool GetInnerClassFlags(Handle<mirror::Class> klass, uint32_t* flags) 129 REQUIRES_SHARED(Locks::mutator_lock_); 130 ObjPtr<mirror::ObjectArray<mirror::String>> GetSignatureAnnotationForClass( 131 Handle<mirror::Class> klass) REQUIRES_SHARED(Locks::mutator_lock_); 132 const char* GetSourceDebugExtension(Handle<mirror::Class> klass) 133 REQUIRES_SHARED(Locks::mutator_lock_); 134 bool IsClassAnnotationPresent(Handle<mirror::Class> klass, 135 Handle<mirror::Class> annotation_class) 136 REQUIRES_SHARED(Locks::mutator_lock_); 137 138 // Map back from a PC to the line number in a method. 139 int32_t GetLineNumFromPC(const DexFile* dex_file, ArtMethod* method, uint32_t rel_pc) 140 REQUIRES_SHARED(Locks::mutator_lock_); 141 142 // Annotations iterator. 143 class RuntimeEncodedStaticFieldValueIterator : public EncodedStaticFieldValueIterator { 144 public: 145 // A constructor meant to be called from runtime code. 146 RuntimeEncodedStaticFieldValueIterator(Handle<mirror::DexCache> dex_cache, 147 Handle<mirror::ClassLoader> class_loader, 148 ClassLinker* linker, 149 const dex::ClassDef& class_def) 150 REQUIRES_SHARED(Locks::mutator_lock_) 151 : EncodedStaticFieldValueIterator(*dex_cache->GetDexFile(), class_def), 152 dex_cache_(dex_cache), 153 class_loader_(class_loader), 154 linker_(linker) { 155 } 156 157 template<bool kTransactionActive> 158 void ReadValueToField(ArtField* field) const REQUIRES_SHARED(Locks::mutator_lock_); 159 160 private: 161 const Handle<mirror::DexCache> dex_cache_; // Dex cache to resolve literal objects. 162 const Handle<mirror::ClassLoader> class_loader_; // ClassLoader to resolve types. 163 ClassLinker* const linker_; // Linker to resolve literal objects. 164 DISALLOW_IMPLICIT_CONSTRUCTORS(RuntimeEncodedStaticFieldValueIterator); 165 }; 166 167 } // namespace annotations 168 169 } // namespace art 170 171 #endif // ART_RUNTIME_DEX_DEX_FILE_ANNOTATIONS_H_ 172
