blob: 01e6149e2328512325c915be30babb0d35fae111 [file] [log] [blame]
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001/*
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
Brian Carlstromea46f952013-07-30 01:26:50 -070017#ifndef ART_RUNTIME_MIRROR_ART_METHOD_H_
18#define ART_RUNTIME_MIRROR_ART_METHOD_H_
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080019
Jeff Hao790ad902013-05-22 15:02:08 -070020#include "dex_file.h"
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -070021#include "gc_root.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080022#include "invoke_type.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080023#include "modifiers.h"
24#include "object.h"
Mathieu Chartier83c8ee02014-01-28 14:50:23 -080025#include "object_callbacks.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010026#include "quick/quick_method_frame_info.h"
Mingyao Yang98d1cc82014-05-15 17:02:16 -070027#include "read_barrier_option.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080028
29namespace art {
30
Brian Carlstromea46f952013-07-30 01:26:50 -070031struct ArtMethodOffsets;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080032struct ConstructorMethodOffsets;
33union JValue;
Jeff Hao790ad902013-05-22 15:02:08 -070034class MethodHelper;
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070035class ScopedObjectAccessAlreadyRunnable;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080036class StringPiece;
Jeff Hao16743632013-05-08 10:59:04 -070037class ShadowFrame;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080038
39namespace mirror {
40
Jeff Hao790ad902013-05-22 15:02:08 -070041typedef void (EntryPointFromInterpreter)(Thread* self, MethodHelper& mh,
42 const DexFile::CodeItem* code_item, ShadowFrame* shadow_frame, JValue* result);
Jeff Hao16743632013-05-08 10:59:04 -070043
Mingyao Yang98d1cc82014-05-15 17:02:16 -070044// C++ mirror of java.lang.reflect.ArtMethod.
45class MANAGED ArtMethod FINAL : public Object {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080046 public:
Mingyao Yang98d1cc82014-05-15 17:02:16 -070047 // Size of java.lang.reflect.ArtMethod.class.
48 static uint32_t ClassSize();
49
50 // Size of an instance of java.lang.reflect.ArtMethod not including its value array.
51 static constexpr uint32_t InstanceSize() {
52 return sizeof(ArtMethod);
53 }
54
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070055 static ArtMethod* FromReflectedMethod(const ScopedObjectAccessAlreadyRunnable& soa,
56 jobject jlr_method)
Ian Rogers62f05122014-03-21 11:21:29 -070057 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
58
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070059 Class* GetDeclaringClass() ALWAYS_INLINE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080060
61 void SetDeclaringClass(Class *new_declaring_class) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
62
63 static MemberOffset DeclaringClassOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -070064 return MemberOffset(OFFSETOF_MEMBER(ArtMethod, declaring_class_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080065 }
66
Ian Rogersef7d42f2014-01-06 12:55:46 -080067 uint32_t GetAccessFlags() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Jeff Hao5d917302013-02-27 17:57:33 -080068
Ian Rogersef7d42f2014-01-06 12:55:46 -080069 void SetAccessFlags(uint32_t new_access_flags) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +010070 // Not called within a transaction.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070071 SetField32<false>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, access_flags_), new_access_flags);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080072 }
73
74 // Approximate what kind of method call would be used for this method.
Ian Rogersef7d42f2014-01-06 12:55:46 -080075 InvokeType GetInvokeType() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080076
77 // Returns true if the method is declared public.
Ian Rogersef7d42f2014-01-06 12:55:46 -080078 bool IsPublic() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080079 return (GetAccessFlags() & kAccPublic) != 0;
80 }
81
82 // Returns true if the method is declared private.
Ian Rogersef7d42f2014-01-06 12:55:46 -080083 bool IsPrivate() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080084 return (GetAccessFlags() & kAccPrivate) != 0;
85 }
86
87 // Returns true if the method is declared static.
Ian Rogersef7d42f2014-01-06 12:55:46 -080088 bool IsStatic() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080089 return (GetAccessFlags() & kAccStatic) != 0;
90 }
91
92 // Returns true if the method is a constructor.
Ian Rogersef7d42f2014-01-06 12:55:46 -080093 bool IsConstructor() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080094 return (GetAccessFlags() & kAccConstructor) != 0;
95 }
96
Mathieu Chartierbfd9a432014-05-21 17:43:44 -070097 // Returns true if the method is a class initializer.
98 bool IsClassInitializer() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
99 return IsConstructor() && IsStatic();
100 }
101
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800102 // Returns true if the method is static, private, or a constructor.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800103 bool IsDirect() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800104 return IsDirect(GetAccessFlags());
105 }
106
107 static bool IsDirect(uint32_t access_flags) {
108 return (access_flags & (kAccStatic | kAccPrivate | kAccConstructor)) != 0;
109 }
110
111 // Returns true if the method is declared synchronized.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800112 bool IsSynchronized() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800113 uint32_t synchonized = kAccSynchronized | kAccDeclaredSynchronized;
114 return (GetAccessFlags() & synchonized) != 0;
115 }
116
Ian Rogersef7d42f2014-01-06 12:55:46 -0800117 bool IsFinal() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800118 return (GetAccessFlags() & kAccFinal) != 0;
119 }
120
Ian Rogersef7d42f2014-01-06 12:55:46 -0800121 bool IsMiranda() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800122 return (GetAccessFlags() & kAccMiranda) != 0;
123 }
124
Ian Rogersef7d42f2014-01-06 12:55:46 -0800125 bool IsNative() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800126 return (GetAccessFlags() & kAccNative) != 0;
127 }
128
Ian Rogersef7d42f2014-01-06 12:55:46 -0800129 bool IsFastNative() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers16ce0922014-01-10 14:59:36 -0800130 uint32_t mask = kAccFastNative | kAccNative;
131 return (GetAccessFlags() & mask) == mask;
Ian Rogers1eb512d2013-10-18 15:42:20 -0700132 }
133
Ian Rogersef7d42f2014-01-06 12:55:46 -0800134 bool IsAbstract() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800135 return (GetAccessFlags() & kAccAbstract) != 0;
136 }
137
Ian Rogersef7d42f2014-01-06 12:55:46 -0800138 bool IsSynthetic() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800139 return (GetAccessFlags() & kAccSynthetic) != 0;
140 }
141
Ian Rogersef7d42f2014-01-06 12:55:46 -0800142 bool IsProxyMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800143
Ian Rogersef7d42f2014-01-06 12:55:46 -0800144 bool IsPreverified() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertz233ea8e2013-06-06 11:57:09 +0200145 return (GetAccessFlags() & kAccPreverified) != 0;
146 }
147
Ian Rogersef7d42f2014-01-06 12:55:46 -0800148 void SetPreverified() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
149 DCHECK(!IsPreverified());
Sebastien Hertz233ea8e2013-06-06 11:57:09 +0200150 SetAccessFlags(GetAccessFlags() | kAccPreverified);
151 }
152
Ian Rogersef7d42f2014-01-06 12:55:46 -0800153 bool IsPortableCompiled() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
154 return (GetAccessFlags() & kAccPortableCompiled) != 0;
155 }
156
157 void SetIsPortableCompiled() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
158 DCHECK(!IsPortableCompiled());
159 SetAccessFlags(GetAccessFlags() | kAccPortableCompiled);
160 }
161
162 void ClearIsPortableCompiled() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
163 DCHECK(IsPortableCompiled());
164 SetAccessFlags(GetAccessFlags() & ~kAccPortableCompiled);
165 }
166
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800167 bool CheckIncompatibleClassChange(InvokeType type) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
168
Ian Rogersef7d42f2014-01-06 12:55:46 -0800169 uint16_t GetMethodIndex() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800170
Ian Rogersef7d42f2014-01-06 12:55:46 -0800171 size_t GetVtableIndex() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800172 return GetMethodIndex();
173 }
174
Ian Rogersef7d42f2014-01-06 12:55:46 -0800175 void SetMethodIndex(uint16_t new_method_index) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100176 // Not called within a transaction.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700177 SetField32<false>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, method_index_), new_method_index);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800178 }
179
180 static MemberOffset MethodIndexOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700181 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, method_index_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800182 }
183
Ian Rogersef7d42f2014-01-06 12:55:46 -0800184 uint32_t GetCodeItemOffset() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700185 return GetField32(OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_code_item_offset_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800186 }
187
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700188 void SetCodeItemOffset(uint32_t new_code_off) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100189 // Not called within a transaction.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700190 SetField32<false>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_code_item_offset_), new_code_off);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800191 }
192
193 // Number of 32bit registers that would be required to hold all the arguments
194 static size_t NumArgRegisters(const StringPiece& shorty);
195
Ian Rogersef7d42f2014-01-06 12:55:46 -0800196 uint32_t GetDexMethodIndex() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800197
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700198 void SetDexMethodIndex(uint32_t new_idx) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100199 // Not called within a transaction.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700200 SetField32<false>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_method_index_), new_idx);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800201 }
202
Ian Rogersef7d42f2014-01-06 12:55:46 -0800203 ObjectArray<String>* GetDexCacheStrings() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800204 void SetDexCacheStrings(ObjectArray<String>* new_dex_cache_strings)
205 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
206
207 static MemberOffset DexCacheStringsOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700208 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_cache_strings_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800209 }
210
211 static MemberOffset DexCacheResolvedMethodsOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700212 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_cache_resolved_methods_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800213 }
214
215 static MemberOffset DexCacheResolvedTypesOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700216 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_cache_resolved_types_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800217 }
218
Ian Rogersef7d42f2014-01-06 12:55:46 -0800219 ObjectArray<ArtMethod>* GetDexCacheResolvedMethods() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Brian Carlstromea46f952013-07-30 01:26:50 -0700220 void SetDexCacheResolvedMethods(ObjectArray<ArtMethod>* new_dex_cache_methods)
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800221 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
222
Ian Rogersef7d42f2014-01-06 12:55:46 -0800223 ObjectArray<Class>* GetDexCacheResolvedTypes() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800224 void SetDexCacheResolvedTypes(ObjectArray<Class>* new_dex_cache_types)
225 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
226
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800227 // Find the method that this method overrides
Ian Rogersef7d42f2014-01-06 12:55:46 -0800228 ArtMethod* FindOverriddenMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800229
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700230 void Invoke(Thread* self, uint32_t* args, uint32_t args_size, JValue* result, const char* shorty)
231 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800232
Mathieu Chartier4e305412014-02-19 10:54:44 -0800233 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700234 EntryPointFromInterpreter* GetEntryPointFromInterpreter()
235 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800236 return GetFieldPtr<EntryPointFromInterpreter*, kVerifyFlags>(
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700237 OFFSET_OF_OBJECT_MEMBER(ArtMethod, entry_point_from_interpreter_));
Jeff Hao16743632013-05-08 10:59:04 -0700238 }
239
Mathieu Chartier4e305412014-02-19 10:54:44 -0800240 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700241 void SetEntryPointFromInterpreter(EntryPointFromInterpreter* entry_point_from_interpreter)
242 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800243 SetFieldPtr<false, true, kVerifyFlags>(
244 OFFSET_OF_OBJECT_MEMBER(ArtMethod, entry_point_from_interpreter_),
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700245 entry_point_from_interpreter);
Jeff Hao16743632013-05-08 10:59:04 -0700246 }
247
Ian Rogersef7d42f2014-01-06 12:55:46 -0800248 static MemberOffset EntryPointFromPortableCompiledCodeOffset() {
249 return MemberOffset(OFFSETOF_MEMBER(ArtMethod, entry_point_from_portable_compiled_code_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800250 }
251
Mathieu Chartier4e305412014-02-19 10:54:44 -0800252 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700253 const void* GetEntryPointFromPortableCompiledCode() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800254 return GetFieldPtr<const void*, kVerifyFlags>(
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700255 EntryPointFromPortableCompiledCodeOffset());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800256 }
257
Mathieu Chartier4e305412014-02-19 10:54:44 -0800258 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700259 void SetEntryPointFromPortableCompiledCode(const void* entry_point_from_portable_compiled_code)
260 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800261 SetFieldPtr<false, true, kVerifyFlags>(
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700262 EntryPointFromPortableCompiledCodeOffset(), entry_point_from_portable_compiled_code);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800263 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800264
Ian Rogersef7d42f2014-01-06 12:55:46 -0800265 static MemberOffset EntryPointFromQuickCompiledCodeOffset() {
266 return MemberOffset(OFFSETOF_MEMBER(ArtMethod, entry_point_from_quick_compiled_code_));
267 }
268
Mathieu Chartier4e305412014-02-19 10:54:44 -0800269 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700270 const void* GetEntryPointFromQuickCompiledCode() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
271 return GetFieldPtr<const void*, kVerifyFlags>(EntryPointFromQuickCompiledCodeOffset());
Ian Rogersef7d42f2014-01-06 12:55:46 -0800272 }
273
Mathieu Chartier4e305412014-02-19 10:54:44 -0800274 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700275 void SetEntryPointFromQuickCompiledCode(const void* entry_point_from_quick_compiled_code)
276 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800277 SetFieldPtr<false, true, kVerifyFlags>(
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700278 EntryPointFromQuickCompiledCodeOffset(), entry_point_from_quick_compiled_code);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800279 }
280
Ian Rogersef7d42f2014-01-06 12:55:46 -0800281 uint32_t GetCodeSize() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
282
283 bool IsWithinQuickCode(uintptr_t pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
284 uintptr_t code = reinterpret_cast<uintptr_t>(GetEntryPointFromQuickCompiledCode());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800285 if (code == 0) {
286 return pc == 0;
287 }
288 /*
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100289 * During a stack walk, a return PC may point past-the-end of the code
290 * in the case that the last instruction is a call that isn't expected to
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800291 * return. Thus, we check <= code + GetCodeSize().
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100292 *
293 * NOTE: For Thumb both pc and code are offset by 1 indicating the Thumb state.
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800294 */
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700295 return code <= pc && pc <= code + GetCodeSize();
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800296 }
297
Ian Rogersef7d42f2014-01-06 12:55:46 -0800298 void AssertPcIsWithinQuickCode(uintptr_t pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800299
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700300 uint32_t GetQuickOatCodeOffset() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
301 uint32_t GetPortableOatCodeOffset() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
302 void SetQuickOatCodeOffset(uint32_t code_offset) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
303 void SetPortableOatCodeOffset(uint32_t code_offset) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800304
Vladimir Marko8a630572014-04-09 18:45:35 +0100305 static const void* EntryPointToCodePointer(const void* entry_point) ALWAYS_INLINE {
306 uintptr_t code = reinterpret_cast<uintptr_t>(entry_point);
307 code &= ~0x1; // TODO: Make this Thumb2 specific.
308 return reinterpret_cast<const void*>(code);
309 }
310
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100311 // Actual entry point pointer to compiled oat code or nullptr.
312 const void* GetQuickOatEntryPoint() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko8a630572014-04-09 18:45:35 +0100313 // Actual pointer to compiled oat code or nullptr.
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100314 const void* GetQuickOatCodePointer() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko8a630572014-04-09 18:45:35 +0100315
Ian Rogers1809a722013-08-09 22:05:32 -0700316 // Callers should wrap the uint8_t* in a MappingTable instance for convenient access.
Vladimir Marko8a630572014-04-09 18:45:35 +0100317 const uint8_t* GetMappingTable() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100318 const uint8_t* GetMappingTable(const void* code_pointer)
319 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800320
Ian Rogers1809a722013-08-09 22:05:32 -0700321 // Callers should wrap the uint8_t* in a VmapTable instance for convenient access.
Vladimir Marko8a630572014-04-09 18:45:35 +0100322 const uint8_t* GetVmapTable() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100323 const uint8_t* GetVmapTable(const void* code_pointer)
324 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800325
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700326 const uint8_t* GetNativeGcMap() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
327 return GetFieldPtr<uint8_t*>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, gc_map_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800328 }
Mathieu Chartier4e305412014-02-19 10:54:44 -0800329 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700330 void SetNativeGcMap(const uint8_t* data) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
331 SetFieldPtr<false, true, kVerifyFlags>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, gc_map_), data);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800332 }
333
334 // When building the oat need a convenient place to stuff the offset of the native GC map.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700335 void SetOatNativeGcMapOffset(uint32_t gc_map_offset) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
336 uint32_t GetOatNativeGcMapOffset() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800337
Andreas Gampe90546832014-03-12 18:07:19 -0700338 template <bool kCheckFrameSize = true>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700339 uint32_t GetFrameSizeInBytes() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Vladimir Marko7624d252014-05-02 14:40:15 +0100340 uint32_t result = GetQuickFrameInfo().FrameSizeInBytes();
Andreas Gampe90546832014-03-12 18:07:19 -0700341 if (kCheckFrameSize) {
342 DCHECK_LE(static_cast<size_t>(kStackAlignment), result);
343 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800344 return result;
345 }
346
Vladimir Marko7624d252014-05-02 14:40:15 +0100347 QuickMethodFrameInfo GetQuickFrameInfo() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100348 QuickMethodFrameInfo GetQuickFrameInfo(const void* code_pointer)
349 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800350
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700351 size_t GetReturnPcOffsetInBytes() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100352 return GetReturnPcOffsetInBytes(GetFrameSizeInBytes());
353 }
354
355 size_t GetReturnPcOffsetInBytes(uint32_t frame_size_in_bytes)
356 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
357 DCHECK_EQ(frame_size_in_bytes, GetFrameSizeInBytes());
358 return frame_size_in_bytes - kPointerSize;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800359 }
360
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700361 size_t GetHandleScopeOffsetInBytes() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800362 return kPointerSize;
363 }
364
Ian Rogers1eb512d2013-10-18 15:42:20 -0700365 void RegisterNative(Thread* self, const void* native_method, bool is_fast)
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800366 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
367
368 void UnregisterNative(Thread* self) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
369
370 static MemberOffset NativeMethodOffset() {
Ian Rogersef7d42f2014-01-06 12:55:46 -0800371 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, entry_point_from_jni_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800372 }
373
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700374 const void* GetNativeMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
375 return GetFieldPtr<const void*>(NativeMethodOffset());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800376 }
377
Mathieu Chartier4e305412014-02-19 10:54:44 -0800378 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700379 void SetNativeMethod(const void*) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800380
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800381 static MemberOffset GetMethodIndexOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700382 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, method_index_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800383 }
384
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800385 // Is this a CalleSaveMethod or ResolutionMethod and therefore doesn't adhere to normal
386 // conventions for a method of managed code. Returns false for Proxy methods.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800387 bool IsRuntimeMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800388
389 // Is this a hand crafted method used for something like describing callee saves?
Ian Rogersef7d42f2014-01-06 12:55:46 -0800390 bool IsCalleeSaveMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800391
Ian Rogersef7d42f2014-01-06 12:55:46 -0800392 bool IsResolutionMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800393
Ian Rogersef7d42f2014-01-06 12:55:46 -0800394 bool IsImtConflictMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Jeff Hao88474b42013-10-23 16:24:40 -0700395
Ian Rogersef7d42f2014-01-06 12:55:46 -0800396 uintptr_t NativePcOffset(const uintptr_t pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100397 uintptr_t NativePcOffset(const uintptr_t pc, const void* quick_entry_point)
398 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800399
400 // Converts a native PC to a dex PC.
Dave Allisonb373e092014-02-20 16:06:36 -0800401 uint32_t ToDexPc(const uintptr_t pc, bool abort_on_failure = true)
402 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800403
404 // Converts a dex PC to a native PC.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800405 uintptr_t ToNativePc(const uint32_t dex_pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800406
Ian Rogersc449aa82013-07-29 14:35:46 -0700407 // Find the catch block for the given exception type and dex_pc. When a catch block is found,
408 // indicates whether the found catch block is responsible for clearing the exception or whether
409 // a move-exception instruction is present.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700410 static uint32_t FindCatchBlock(Handle<ArtMethod> h_this, Handle<Class> exception_type,
411 uint32_t dex_pc, bool* has_no_move_exception)
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800412 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
413
Brian Carlstromea46f952013-07-30 01:26:50 -0700414 static void SetClass(Class* java_lang_reflect_ArtMethod);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800415
Hiroshi Yamauchi4f1ebc22014-06-25 14:30:41 -0700416 template<ReadBarrierOption kReadBarrierOption = kWithReadBarrier>
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700417 static Class* GetJavaLangReflectArtMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800418
Brian Carlstromea46f952013-07-30 01:26:50 -0700419 static void ResetClass();
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800420
Mathieu Chartier83c8ee02014-01-28 14:50:23 -0800421 static void VisitRoots(RootCallback* callback, void* arg)
Mathieu Chartierc528dba2013-11-26 12:00:11 -0800422 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
423
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700424 const DexFile* GetDexFile() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700425
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700426 const char* GetDeclaringClassDescriptor() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700427
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700428 const char* GetShorty() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
429 uint32_t unused_length;
430 return GetShorty(&unused_length);
431 }
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700432
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700433 const char* GetShorty(uint32_t* out_length) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700434
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700435 const Signature GetSignature() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700436
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700437 const char* GetName() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700438
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700439 const DexFile::CodeItem* GetCodeItem() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700440
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700441 bool IsResolvedTypeIdx(uint16_t type_idx) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700442
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700443 int32_t GetLineNumFromDexPC(uint32_t dex_pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700444
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700445 const DexFile::ProtoId& GetPrototype() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700446
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700447 const DexFile::TypeList* GetParameterTypeList() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700448
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700449 const char* GetDeclaringClassSourceFile() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700450
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700451 uint16_t GetClassDefIndex() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700452
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700453 const DexFile::ClassDef& GetClassDef() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700454
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700455 const char* GetReturnTypeDescriptor() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700456
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700457 const char* GetTypeDescriptorFromTypeIdx(uint16_t type_idx)
458 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700459
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700460 mirror::ClassLoader* GetClassLoader() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700461
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700462 mirror::DexCache* GetDexCache() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700463
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700464 ArtMethod* GetInterfaceMethodIfProxy() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
465
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800466 protected:
467 // Field order required by test "ValidateFieldOrderOfJavaCppUnionClasses".
Ian Rogersef7d42f2014-01-06 12:55:46 -0800468 // The class we are a part of.
469 HeapReference<Class> declaring_class_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800470
Ian Rogersef7d42f2014-01-06 12:55:46 -0800471 // Short cuts to declaring_class_->dex_cache_ member for fast compiled code access.
Ian Rogers700a4022014-05-19 16:49:03 -0700472 HeapReference<ObjectArray<ArtMethod>> dex_cache_resolved_methods_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800473
Ian Rogersef7d42f2014-01-06 12:55:46 -0800474 // Short cuts to declaring_class_->dex_cache_ member for fast compiled code access.
Ian Rogers700a4022014-05-19 16:49:03 -0700475 HeapReference<ObjectArray<Class>> dex_cache_resolved_types_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800476
Ian Rogersef7d42f2014-01-06 12:55:46 -0800477 // Short cuts to declaring_class_->dex_cache_ member for fast compiled code access.
Ian Rogers700a4022014-05-19 16:49:03 -0700478 HeapReference<ObjectArray<String>> dex_cache_strings_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800479
Ian Rogersef7d42f2014-01-06 12:55:46 -0800480 // Method dispatch from the interpreter invokes this pointer which may cause a bridge into
481 // compiled code.
482 uint64_t entry_point_from_interpreter_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800483
Ian Rogersef7d42f2014-01-06 12:55:46 -0800484 // Pointer to JNI function registered to this method, or a function to resolve the JNI function.
485 uint64_t entry_point_from_jni_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800486
Ian Rogersef7d42f2014-01-06 12:55:46 -0800487 // Method dispatch from portable compiled code invokes this pointer which may cause bridging into
488 // quick compiled code or the interpreter.
489 uint64_t entry_point_from_portable_compiled_code_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800490
Ian Rogersef7d42f2014-01-06 12:55:46 -0800491 // Method dispatch from quick compiled code invokes this pointer which may cause bridging into
492 // portable compiled code or the interpreter.
493 uint64_t entry_point_from_quick_compiled_code_;
Jeff Haoaa4a7932013-05-13 11:28:27 -0700494
Ian Rogersef7d42f2014-01-06 12:55:46 -0800495 // Pointer to a data structure created by the compiler and used by the garbage collector to
496 // determine which registers hold live references to objects within the heap. Keyed by native PC
497 // offsets for the quick compiler and dex PCs for the portable.
498 uint64_t gc_map_;
Jeff Hao16743632013-05-08 10:59:04 -0700499
Ian Rogersef7d42f2014-01-06 12:55:46 -0800500 // Access flags; low 16 bits are defined by spec.
501 uint32_t access_flags_;
502
503 /* Dex file fields. The defining dex file is available via declaring_class_->dex_cache_ */
504
505 // Offset to the CodeItem.
506 uint32_t dex_code_item_offset_;
507
508 // Index into method_ids of the dex file associated with this method.
509 uint32_t dex_method_index_;
510
511 /* End of dex file fields. */
512
513 // Entry within a dispatch table for this method. For static/direct methods the index is into
514 // the declaringClass.directMethods, for virtual methods the vtable and for interface methods the
515 // ifTable.
516 uint32_t method_index_;
517
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700518 static GcRoot<Class> java_lang_reflect_ArtMethod_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800519
Mathieu Chartier02e25112013-08-14 16:14:24 -0700520 private:
Brian Carlstromea46f952013-07-30 01:26:50 -0700521 friend struct art::ArtMethodOffsets; // for verifying offset information
522 DISALLOW_IMPLICIT_CONSTRUCTORS(ArtMethod);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800523};
524
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800525} // namespace mirror
526} // namespace art
527
Brian Carlstromea46f952013-07-30 01:26:50 -0700528#endif // ART_RUNTIME_MIRROR_ART_METHOD_H_