blob: a55c48b87fee9913d14ea3c6b0e0d9c68bcb573e [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
20#include "class.h"
Jeff Hao790ad902013-05-22 15:02:08 -070021#include "dex_file.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"
Hiroshi Yamauchi4f1ebc22014-06-25 14:30:41 -070027#include "read_barrier.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;
34struct MethodClassOffsets;
Jeff Hao790ad902013-05-22 15:02:08 -070035class MethodHelper;
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070036class ScopedObjectAccessAlreadyRunnable;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080037class StringPiece;
Jeff Hao16743632013-05-08 10:59:04 -070038class ShadowFrame;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080039
40namespace mirror {
41
42class StaticStorageBase;
43
Jeff Hao790ad902013-05-22 15:02:08 -070044typedef void (EntryPointFromInterpreter)(Thread* self, MethodHelper& mh,
45 const DexFile::CodeItem* code_item, ShadowFrame* shadow_frame, JValue* result);
Jeff Hao16743632013-05-08 10:59:04 -070046
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080047// C++ mirror of java.lang.reflect.Method and java.lang.reflect.Constructor
Brian Carlstromea46f952013-07-30 01:26:50 -070048class MANAGED ArtMethod : public Object {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080049 public:
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070050 static ArtMethod* FromReflectedMethod(const ScopedObjectAccessAlreadyRunnable& soa,
51 jobject jlr_method)
Ian Rogers62f05122014-03-21 11:21:29 -070052 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
53
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070054 Class* GetDeclaringClass() ALWAYS_INLINE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080055
56 void SetDeclaringClass(Class *new_declaring_class) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
57
58 static MemberOffset DeclaringClassOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -070059 return MemberOffset(OFFSETOF_MEMBER(ArtMethod, declaring_class_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080060 }
61
Ian Rogersef7d42f2014-01-06 12:55:46 -080062 uint32_t GetAccessFlags() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Jeff Hao5d917302013-02-27 17:57:33 -080063
Ian Rogersef7d42f2014-01-06 12:55:46 -080064 void SetAccessFlags(uint32_t new_access_flags) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +010065 // Not called within a transaction.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070066 SetField32<false>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, access_flags_), new_access_flags);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080067 }
68
69 // Approximate what kind of method call would be used for this method.
Ian Rogersef7d42f2014-01-06 12:55:46 -080070 InvokeType GetInvokeType() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080071
72 // Returns true if the method is declared public.
Ian Rogersef7d42f2014-01-06 12:55:46 -080073 bool IsPublic() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080074 return (GetAccessFlags() & kAccPublic) != 0;
75 }
76
77 // Returns true if the method is declared private.
Ian Rogersef7d42f2014-01-06 12:55:46 -080078 bool IsPrivate() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080079 return (GetAccessFlags() & kAccPrivate) != 0;
80 }
81
82 // Returns true if the method is declared static.
Ian Rogersef7d42f2014-01-06 12:55:46 -080083 bool IsStatic() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080084 return (GetAccessFlags() & kAccStatic) != 0;
85 }
86
87 // Returns true if the method is a constructor.
Ian Rogersef7d42f2014-01-06 12:55:46 -080088 bool IsConstructor() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080089 return (GetAccessFlags() & kAccConstructor) != 0;
90 }
91
Mathieu Chartierbfd9a432014-05-21 17:43:44 -070092 // Returns true if the method is a class initializer.
93 bool IsClassInitializer() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
94 return IsConstructor() && IsStatic();
95 }
96
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080097 // Returns true if the method is static, private, or a constructor.
Ian Rogersef7d42f2014-01-06 12:55:46 -080098 bool IsDirect() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080099 return IsDirect(GetAccessFlags());
100 }
101
102 static bool IsDirect(uint32_t access_flags) {
103 return (access_flags & (kAccStatic | kAccPrivate | kAccConstructor)) != 0;
104 }
105
106 // Returns true if the method is declared synchronized.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800107 bool IsSynchronized() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800108 uint32_t synchonized = kAccSynchronized | kAccDeclaredSynchronized;
109 return (GetAccessFlags() & synchonized) != 0;
110 }
111
Ian Rogersef7d42f2014-01-06 12:55:46 -0800112 bool IsFinal() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800113 return (GetAccessFlags() & kAccFinal) != 0;
114 }
115
Ian Rogersef7d42f2014-01-06 12:55:46 -0800116 bool IsMiranda() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800117 return (GetAccessFlags() & kAccMiranda) != 0;
118 }
119
Ian Rogersef7d42f2014-01-06 12:55:46 -0800120 bool IsNative() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800121 return (GetAccessFlags() & kAccNative) != 0;
122 }
123
Ian Rogersef7d42f2014-01-06 12:55:46 -0800124 bool IsFastNative() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers16ce0922014-01-10 14:59:36 -0800125 uint32_t mask = kAccFastNative | kAccNative;
126 return (GetAccessFlags() & mask) == mask;
Ian Rogers1eb512d2013-10-18 15:42:20 -0700127 }
128
Ian Rogersef7d42f2014-01-06 12:55:46 -0800129 bool IsAbstract() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800130 return (GetAccessFlags() & kAccAbstract) != 0;
131 }
132
Ian Rogersef7d42f2014-01-06 12:55:46 -0800133 bool IsSynthetic() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800134 return (GetAccessFlags() & kAccSynthetic) != 0;
135 }
136
Ian Rogersef7d42f2014-01-06 12:55:46 -0800137 bool IsProxyMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800138
Ian Rogersef7d42f2014-01-06 12:55:46 -0800139 bool IsPreverified() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertz233ea8e2013-06-06 11:57:09 +0200140 return (GetAccessFlags() & kAccPreverified) != 0;
141 }
142
Ian Rogersef7d42f2014-01-06 12:55:46 -0800143 void SetPreverified() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
144 DCHECK(!IsPreverified());
Sebastien Hertz233ea8e2013-06-06 11:57:09 +0200145 SetAccessFlags(GetAccessFlags() | kAccPreverified);
146 }
147
Ian Rogersef7d42f2014-01-06 12:55:46 -0800148 bool IsPortableCompiled() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
149 return (GetAccessFlags() & kAccPortableCompiled) != 0;
150 }
151
152 void SetIsPortableCompiled() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
153 DCHECK(!IsPortableCompiled());
154 SetAccessFlags(GetAccessFlags() | kAccPortableCompiled);
155 }
156
157 void ClearIsPortableCompiled() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
158 DCHECK(IsPortableCompiled());
159 SetAccessFlags(GetAccessFlags() & ~kAccPortableCompiled);
160 }
161
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800162 bool CheckIncompatibleClassChange(InvokeType type) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
163
Ian Rogersef7d42f2014-01-06 12:55:46 -0800164 uint16_t GetMethodIndex() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800165
Ian Rogersef7d42f2014-01-06 12:55:46 -0800166 size_t GetVtableIndex() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800167 return GetMethodIndex();
168 }
169
Ian Rogersef7d42f2014-01-06 12:55:46 -0800170 void SetMethodIndex(uint16_t new_method_index) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100171 // Not called within a transaction.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700172 SetField32<false>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, method_index_), new_method_index);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800173 }
174
175 static MemberOffset MethodIndexOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700176 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, method_index_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800177 }
178
Ian Rogersef7d42f2014-01-06 12:55:46 -0800179 uint32_t GetCodeItemOffset() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700180 return GetField32(OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_code_item_offset_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800181 }
182
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700183 void SetCodeItemOffset(uint32_t new_code_off) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100184 // Not called within a transaction.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700185 SetField32<false>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_code_item_offset_), new_code_off);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800186 }
187
188 // Number of 32bit registers that would be required to hold all the arguments
189 static size_t NumArgRegisters(const StringPiece& shorty);
190
Ian Rogersef7d42f2014-01-06 12:55:46 -0800191 uint32_t GetDexMethodIndex() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800192
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700193 void SetDexMethodIndex(uint32_t new_idx) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100194 // Not called within a transaction.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700195 SetField32<false>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_method_index_), new_idx);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800196 }
197
Ian Rogersef7d42f2014-01-06 12:55:46 -0800198 ObjectArray<String>* GetDexCacheStrings() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800199 void SetDexCacheStrings(ObjectArray<String>* new_dex_cache_strings)
200 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
201
202 static MemberOffset DexCacheStringsOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700203 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_cache_strings_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800204 }
205
206 static MemberOffset DexCacheResolvedMethodsOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700207 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_cache_resolved_methods_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800208 }
209
210 static MemberOffset DexCacheResolvedTypesOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700211 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_cache_resolved_types_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800212 }
213
Ian Rogersef7d42f2014-01-06 12:55:46 -0800214 ObjectArray<ArtMethod>* GetDexCacheResolvedMethods() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Brian Carlstromea46f952013-07-30 01:26:50 -0700215 void SetDexCacheResolvedMethods(ObjectArray<ArtMethod>* new_dex_cache_methods)
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800216 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
217
Ian Rogersef7d42f2014-01-06 12:55:46 -0800218 ObjectArray<Class>* GetDexCacheResolvedTypes() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800219 void SetDexCacheResolvedTypes(ObjectArray<Class>* new_dex_cache_types)
220 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
221
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800222 // Find the method that this method overrides
Ian Rogersef7d42f2014-01-06 12:55:46 -0800223 ArtMethod* FindOverriddenMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800224
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700225 void Invoke(Thread* self, uint32_t* args, uint32_t args_size, JValue* result, const char* shorty)
226 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800227
Mathieu Chartier4e305412014-02-19 10:54:44 -0800228 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700229 EntryPointFromInterpreter* GetEntryPointFromInterpreter()
230 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800231 return GetFieldPtr<EntryPointFromInterpreter*, kVerifyFlags>(
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700232 OFFSET_OF_OBJECT_MEMBER(ArtMethod, entry_point_from_interpreter_));
Jeff Hao16743632013-05-08 10:59:04 -0700233 }
234
Mathieu Chartier4e305412014-02-19 10:54:44 -0800235 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700236 void SetEntryPointFromInterpreter(EntryPointFromInterpreter* entry_point_from_interpreter)
237 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800238 SetFieldPtr<false, true, kVerifyFlags>(
239 OFFSET_OF_OBJECT_MEMBER(ArtMethod, entry_point_from_interpreter_),
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700240 entry_point_from_interpreter);
Jeff Hao16743632013-05-08 10:59:04 -0700241 }
242
Ian Rogersef7d42f2014-01-06 12:55:46 -0800243 static MemberOffset EntryPointFromPortableCompiledCodeOffset() {
244 return MemberOffset(OFFSETOF_MEMBER(ArtMethod, entry_point_from_portable_compiled_code_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800245 }
246
Mathieu Chartier4e305412014-02-19 10:54:44 -0800247 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700248 const void* GetEntryPointFromPortableCompiledCode() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800249 return GetFieldPtr<const void*, kVerifyFlags>(
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700250 EntryPointFromPortableCompiledCodeOffset());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800251 }
252
Mathieu Chartier4e305412014-02-19 10:54:44 -0800253 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700254 void SetEntryPointFromPortableCompiledCode(const void* entry_point_from_portable_compiled_code)
255 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800256 SetFieldPtr<false, true, kVerifyFlags>(
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700257 EntryPointFromPortableCompiledCodeOffset(), entry_point_from_portable_compiled_code);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800258 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800259
Ian Rogersef7d42f2014-01-06 12:55:46 -0800260 static MemberOffset EntryPointFromQuickCompiledCodeOffset() {
261 return MemberOffset(OFFSETOF_MEMBER(ArtMethod, entry_point_from_quick_compiled_code_));
262 }
263
Mathieu Chartier4e305412014-02-19 10:54:44 -0800264 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700265 const void* GetEntryPointFromQuickCompiledCode() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
266 return GetFieldPtr<const void*, kVerifyFlags>(EntryPointFromQuickCompiledCodeOffset());
Ian Rogersef7d42f2014-01-06 12:55:46 -0800267 }
268
Mathieu Chartier4e305412014-02-19 10:54:44 -0800269 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700270 void SetEntryPointFromQuickCompiledCode(const void* entry_point_from_quick_compiled_code)
271 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartier4e305412014-02-19 10:54:44 -0800272 SetFieldPtr<false, true, kVerifyFlags>(
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700273 EntryPointFromQuickCompiledCodeOffset(), entry_point_from_quick_compiled_code);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800274 }
275
Ian Rogersef7d42f2014-01-06 12:55:46 -0800276 uint32_t GetCodeSize() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
277
278 bool IsWithinQuickCode(uintptr_t pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
279 uintptr_t code = reinterpret_cast<uintptr_t>(GetEntryPointFromQuickCompiledCode());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800280 if (code == 0) {
281 return pc == 0;
282 }
283 /*
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100284 * During a stack walk, a return PC may point past-the-end of the code
285 * in the case that the last instruction is a call that isn't expected to
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800286 * return. Thus, we check <= code + GetCodeSize().
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100287 *
288 * NOTE: For Thumb both pc and code are offset by 1 indicating the Thumb state.
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800289 */
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700290 return code <= pc && pc <= code + GetCodeSize();
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800291 }
292
Ian Rogersef7d42f2014-01-06 12:55:46 -0800293 void AssertPcIsWithinQuickCode(uintptr_t pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800294
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700295 uint32_t GetQuickOatCodeOffset() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
296 uint32_t GetPortableOatCodeOffset() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
297 void SetQuickOatCodeOffset(uint32_t code_offset) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
298 void SetPortableOatCodeOffset(uint32_t code_offset) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800299
Vladimir Marko8a630572014-04-09 18:45:35 +0100300 static const void* EntryPointToCodePointer(const void* entry_point) ALWAYS_INLINE {
301 uintptr_t code = reinterpret_cast<uintptr_t>(entry_point);
302 code &= ~0x1; // TODO: Make this Thumb2 specific.
303 return reinterpret_cast<const void*>(code);
304 }
305
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100306 // Actual entry point pointer to compiled oat code or nullptr.
307 const void* GetQuickOatEntryPoint() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko8a630572014-04-09 18:45:35 +0100308 // Actual pointer to compiled oat code or nullptr.
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100309 const void* GetQuickOatCodePointer() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko8a630572014-04-09 18:45:35 +0100310
Ian Rogers1809a722013-08-09 22:05:32 -0700311 // Callers should wrap the uint8_t* in a MappingTable instance for convenient access.
Vladimir Marko8a630572014-04-09 18:45:35 +0100312 const uint8_t* GetMappingTable() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100313 const uint8_t* GetMappingTable(const void* code_pointer)
314 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800315
Ian Rogers1809a722013-08-09 22:05:32 -0700316 // Callers should wrap the uint8_t* in a VmapTable instance for convenient access.
Vladimir Marko8a630572014-04-09 18:45:35 +0100317 const uint8_t* GetVmapTable() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100318 const uint8_t* GetVmapTable(const void* code_pointer)
319 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800320
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700321 const uint8_t* GetNativeGcMap() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
322 return GetFieldPtr<uint8_t*>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, gc_map_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800323 }
Mathieu Chartier4e305412014-02-19 10:54:44 -0800324 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700325 void SetNativeGcMap(const uint8_t* data) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
326 SetFieldPtr<false, true, kVerifyFlags>(OFFSET_OF_OBJECT_MEMBER(ArtMethod, gc_map_), data);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800327 }
328
329 // When building the oat need a convenient place to stuff the offset of the native GC map.
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700330 void SetOatNativeGcMapOffset(uint32_t gc_map_offset) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
331 uint32_t GetOatNativeGcMapOffset() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800332
Andreas Gampe90546832014-03-12 18:07:19 -0700333 template <bool kCheckFrameSize = true>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700334 uint32_t GetFrameSizeInBytes() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Vladimir Marko7624d252014-05-02 14:40:15 +0100335 uint32_t result = GetQuickFrameInfo().FrameSizeInBytes();
Andreas Gampe90546832014-03-12 18:07:19 -0700336 if (kCheckFrameSize) {
337 DCHECK_LE(static_cast<size_t>(kStackAlignment), result);
338 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800339 return result;
340 }
341
Vladimir Marko7624d252014-05-02 14:40:15 +0100342 QuickMethodFrameInfo GetQuickFrameInfo() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100343 QuickMethodFrameInfo GetQuickFrameInfo(const void* code_pointer)
344 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800345
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700346 size_t GetReturnPcOffsetInBytes() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100347 return GetReturnPcOffsetInBytes(GetFrameSizeInBytes());
348 }
349
350 size_t GetReturnPcOffsetInBytes(uint32_t frame_size_in_bytes)
351 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
352 DCHECK_EQ(frame_size_in_bytes, GetFrameSizeInBytes());
353 return frame_size_in_bytes - kPointerSize;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800354 }
355
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700356 size_t GetHandleScopeOffsetInBytes() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800357 return kPointerSize;
358 }
359
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700360 bool IsRegistered() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800361
Ian Rogers1eb512d2013-10-18 15:42:20 -0700362 void RegisterNative(Thread* self, const void* native_method, bool is_fast)
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800363 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
364
365 void UnregisterNative(Thread* self) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
366
367 static MemberOffset NativeMethodOffset() {
Ian Rogersef7d42f2014-01-06 12:55:46 -0800368 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, entry_point_from_jni_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800369 }
370
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700371 const void* GetNativeMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
372 return GetFieldPtr<const void*>(NativeMethodOffset());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800373 }
374
Mathieu Chartier4e305412014-02-19 10:54:44 -0800375 template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags>
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700376 void SetNativeMethod(const void*) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800377
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800378 static MemberOffset GetMethodIndexOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700379 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, method_index_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800380 }
381
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800382 // Is this a CalleSaveMethod or ResolutionMethod and therefore doesn't adhere to normal
383 // conventions for a method of managed code. Returns false for Proxy methods.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800384 bool IsRuntimeMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800385
386 // Is this a hand crafted method used for something like describing callee saves?
Ian Rogersef7d42f2014-01-06 12:55:46 -0800387 bool IsCalleeSaveMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800388
Ian Rogersef7d42f2014-01-06 12:55:46 -0800389 bool IsResolutionMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800390
Ian Rogersef7d42f2014-01-06 12:55:46 -0800391 bool IsImtConflictMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Jeff Hao88474b42013-10-23 16:24:40 -0700392
Ian Rogersef7d42f2014-01-06 12:55:46 -0800393 uintptr_t NativePcOffset(const uintptr_t pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Vladimir Marko4c1c5102014-05-14 16:51:16 +0100394 uintptr_t NativePcOffset(const uintptr_t pc, const void* quick_entry_point)
395 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800396
397 // Converts a native PC to a dex PC.
Dave Allisonb373e092014-02-20 16:06:36 -0800398 uint32_t ToDexPc(const uintptr_t pc, bool abort_on_failure = true)
399 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800400
401 // Converts a dex PC to a native PC.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800402 uintptr_t ToNativePc(const uint32_t dex_pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800403
Ian Rogersc449aa82013-07-29 14:35:46 -0700404 // Find the catch block for the given exception type and dex_pc. When a catch block is found,
405 // indicates whether the found catch block is responsible for clearing the exception or whether
406 // a move-exception instruction is present.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700407 static uint32_t FindCatchBlock(Handle<ArtMethod> h_this, Handle<Class> exception_type,
408 uint32_t dex_pc, bool* has_no_move_exception)
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800409 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
410
Brian Carlstromea46f952013-07-30 01:26:50 -0700411 static void SetClass(Class* java_lang_reflect_ArtMethod);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800412
Hiroshi Yamauchi4f1ebc22014-06-25 14:30:41 -0700413 template<ReadBarrierOption kReadBarrierOption = kWithReadBarrier>
414 static Class* GetJavaLangReflectArtMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Hiroshi Yamauchibd0fb612014-05-20 13:46:00 -0700415 DCHECK(java_lang_reflect_ArtMethod_ != nullptr);
Hiroshi Yamauchi4f1ebc22014-06-25 14:30:41 -0700416 return ReadBarrier::BarrierForRoot<mirror::Class, kReadBarrierOption>(
417 &java_lang_reflect_ArtMethod_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800418 }
419
Brian Carlstromea46f952013-07-30 01:26:50 -0700420 static void ResetClass();
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800421
Mathieu Chartier83c8ee02014-01-28 14:50:23 -0800422 static void VisitRoots(RootCallback* callback, void* arg)
Mathieu Chartierc528dba2013-11-26 12:00:11 -0800423 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
424
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700425 const DexFile* GetDexFile() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
426 const char* GetDeclaringClassDescriptor() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
427 const char* GetShorty() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
428 uint32_t unused_length;
429 return GetShorty(&unused_length);
430 }
431 const char* GetShorty(uint32_t* out_length) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
432 const Signature GetSignature() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
433 const char* GetName() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
434 const DexFile::CodeItem* GetCodeItem() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
435 bool IsResolvedTypeIdx(uint16_t type_idx) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
436 int32_t GetLineNumFromDexPC(uint32_t dex_pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
437 const DexFile::ProtoId& GetPrototype() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
438 const DexFile::TypeList* GetParameterTypeList() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
439 const char* GetDeclaringClassSourceFile() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
440 uint16_t GetClassDefIndex() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
441 const DexFile::ClassDef& GetClassDef() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
442 const char* GetReturnTypeDescriptor() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
443 const char* GetTypeDescriptorFromTypeIdx(uint16_t type_idx)
444 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
445 mirror::ClassLoader* GetClassLoader() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
446 mirror::DexCache* GetDexCache() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
447 ArtMethod* GetInterfaceMethodIfProxy() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
448
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800449 protected:
450 // Field order required by test "ValidateFieldOrderOfJavaCppUnionClasses".
Ian Rogersef7d42f2014-01-06 12:55:46 -0800451 // The class we are a part of.
452 HeapReference<Class> declaring_class_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800453
Ian Rogersef7d42f2014-01-06 12:55:46 -0800454 // Short cuts to declaring_class_->dex_cache_ member for fast compiled code access.
Ian Rogers700a4022014-05-19 16:49:03 -0700455 HeapReference<ObjectArray<ArtMethod>> dex_cache_resolved_methods_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800456
Ian Rogersef7d42f2014-01-06 12:55:46 -0800457 // Short cuts to declaring_class_->dex_cache_ member for fast compiled code access.
Ian Rogers700a4022014-05-19 16:49:03 -0700458 HeapReference<ObjectArray<Class>> dex_cache_resolved_types_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800459
Ian Rogersef7d42f2014-01-06 12:55:46 -0800460 // Short cuts to declaring_class_->dex_cache_ member for fast compiled code access.
Ian Rogers700a4022014-05-19 16:49:03 -0700461 HeapReference<ObjectArray<String>> dex_cache_strings_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800462
Ian Rogersef7d42f2014-01-06 12:55:46 -0800463 // Method dispatch from the interpreter invokes this pointer which may cause a bridge into
464 // compiled code.
465 uint64_t entry_point_from_interpreter_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800466
Ian Rogersef7d42f2014-01-06 12:55:46 -0800467 // Pointer to JNI function registered to this method, or a function to resolve the JNI function.
468 uint64_t entry_point_from_jni_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800469
Ian Rogersef7d42f2014-01-06 12:55:46 -0800470 // Method dispatch from portable compiled code invokes this pointer which may cause bridging into
471 // quick compiled code or the interpreter.
472 uint64_t entry_point_from_portable_compiled_code_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800473
Ian Rogersef7d42f2014-01-06 12:55:46 -0800474 // Method dispatch from quick compiled code invokes this pointer which may cause bridging into
475 // portable compiled code or the interpreter.
476 uint64_t entry_point_from_quick_compiled_code_;
Jeff Haoaa4a7932013-05-13 11:28:27 -0700477
Ian Rogersef7d42f2014-01-06 12:55:46 -0800478 // Pointer to a data structure created by the compiler and used by the garbage collector to
479 // determine which registers hold live references to objects within the heap. Keyed by native PC
480 // offsets for the quick compiler and dex PCs for the portable.
481 uint64_t gc_map_;
Jeff Hao16743632013-05-08 10:59:04 -0700482
Ian Rogersef7d42f2014-01-06 12:55:46 -0800483 // Access flags; low 16 bits are defined by spec.
484 uint32_t access_flags_;
485
486 /* Dex file fields. The defining dex file is available via declaring_class_->dex_cache_ */
487
488 // Offset to the CodeItem.
489 uint32_t dex_code_item_offset_;
490
491 // Index into method_ids of the dex file associated with this method.
492 uint32_t dex_method_index_;
493
494 /* End of dex file fields. */
495
496 // Entry within a dispatch table for this method. For static/direct methods the index is into
497 // the declaringClass.directMethods, for virtual methods the vtable and for interface methods the
498 // ifTable.
499 uint32_t method_index_;
500
Brian Carlstromea46f952013-07-30 01:26:50 -0700501 static Class* java_lang_reflect_ArtMethod_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800502
Mathieu Chartier02e25112013-08-14 16:14:24 -0700503 private:
Brian Carlstromea46f952013-07-30 01:26:50 -0700504 friend struct art::ArtMethodOffsets; // for verifying offset information
505 DISALLOW_IMPLICIT_CONSTRUCTORS(ArtMethod);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800506};
507
Brian Carlstromea46f952013-07-30 01:26:50 -0700508class MANAGED ArtMethodClass : public Class {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800509 private:
Brian Carlstromea46f952013-07-30 01:26:50 -0700510 DISALLOW_IMPLICIT_CONSTRUCTORS(ArtMethodClass);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800511};
512
513} // namespace mirror
514} // namespace art
515
Brian Carlstromea46f952013-07-30 01:26:50 -0700516#endif // ART_RUNTIME_MIRROR_ART_METHOD_H_