blob: a020e9d17e99a72da183b03746d7f4fefdf41a0b [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
Mathieu Chartiere401d142015-04-22 13:56:20 -070017#ifndef ART_RUNTIME_ART_METHOD_H_
18#define ART_RUNTIME_ART_METHOD_H_
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080019
Nicolas Geoffray6bc43742015-10-12 18:11:10 +010020#include "base/bit_utils.h"
Vladimir Marko05792b92015-08-03 11:56:49 +010021#include "base/casts.h"
Jeff Hao790ad902013-05-22 15:02:08 -070022#include "dex_file.h"
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -070023#include "gc_root.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080024#include "invoke_type.h"
Mathieu Chartier36b58f52014-12-10 12:06:45 -080025#include "method_reference.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080026#include "modifiers.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070027#include "mirror/object.h"
Mingyao Yang98d1cc82014-05-15 17:02:16 -070028#include "read_barrier_option.h"
Sebastien Hertze4b7c892014-12-17 20:02:50 +010029#include "stack.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070030#include "utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080031
32namespace art {
33
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080034union JValue;
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010035class OatQuickMethodHeader;
Nicolas Geoffray5550ca82015-08-21 18:38:30 +010036class ProfilingInfo;
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070037class ScopedObjectAccessAlreadyRunnable;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080038class StringPiece;
Jeff Hao16743632013-05-08 10:59:04 -070039class ShadowFrame;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080040
41namespace mirror {
Mathieu Chartiere401d142015-04-22 13:56:20 -070042class Array;
43class Class;
44class PointerArray;
45} // namespace mirror
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080046
Mathieu Chartiere401d142015-04-22 13:56:20 -070047class ArtMethod FINAL {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080048 public:
Mathieu Chartiere401d142015-04-22 13:56:20 -070049 ArtMethod() : access_flags_(0), dex_code_item_offset_(0), dex_method_index_(0),
50 method_index_(0) { }
51
Nicolas Geoffray22cf3d32015-11-02 11:57:11 +000052 ArtMethod(ArtMethod* src, size_t image_pointer_size) {
53 CopyFrom(src, image_pointer_size);
Mathieu Chartiere401d142015-04-22 13:56:20 -070054 }
Mingyao Yang98d1cc82014-05-15 17:02:16 -070055
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070056 static ArtMethod* FromReflectedMethod(const ScopedObjectAccessAlreadyRunnable& soa,
57 jobject jlr_method)
Mathieu Chartier90443472015-07-16 20:32:27 -070058 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers62f05122014-03-21 11:21:29 -070059
Mathieu Chartier90443472015-07-16 20:32:27 -070060 ALWAYS_INLINE mirror::Class* GetDeclaringClass() SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080061
Mathieu Chartiere401d142015-04-22 13:56:20 -070062 ALWAYS_INLINE mirror::Class* GetDeclaringClassNoBarrier()
Mathieu Chartier90443472015-07-16 20:32:27 -070063 SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -070064
65 ALWAYS_INLINE mirror::Class* GetDeclaringClassUnchecked()
Mathieu Chartier90443472015-07-16 20:32:27 -070066 SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -070067
68 void SetDeclaringClass(mirror::Class *new_declaring_class)
Mathieu Chartier90443472015-07-16 20:32:27 -070069 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080070
Mathieu Chartier10e5ea92015-08-13 12:56:31 -070071 bool CASDeclaringClass(mirror::Class* expected_class, mirror::Class* desired_class)
72 SHARED_REQUIRES(Locks::mutator_lock_);
73
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080074 static MemberOffset DeclaringClassOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -070075 return MemberOffset(OFFSETOF_MEMBER(ArtMethod, declaring_class_));
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080076 }
77
Andreas Gampecbc96b82015-09-30 20:05:24 +000078 // Note: GetAccessFlags acquires the mutator lock in debug mode to check that it is not called for
79 // a proxy method.
80 ALWAYS_INLINE uint32_t GetAccessFlags();
Jeff Hao5d917302013-02-27 17:57:33 -080081
Mathieu Chartiere401d142015-04-22 13:56:20 -070082 void SetAccessFlags(uint32_t new_access_flags) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +010083 // Not called within a transaction.
Mathieu Chartiere401d142015-04-22 13:56:20 -070084 access_flags_ = new_access_flags;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080085 }
86
87 // Approximate what kind of method call would be used for this method.
Mathieu Chartier90443472015-07-16 20:32:27 -070088 InvokeType GetInvokeType() SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080089
90 // Returns true if the method is declared public.
Andreas Gampecbc96b82015-09-30 20:05:24 +000091 bool IsPublic() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080092 return (GetAccessFlags() & kAccPublic) != 0;
93 }
94
95 // Returns true if the method is declared private.
Andreas Gampecbc96b82015-09-30 20:05:24 +000096 bool IsPrivate() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080097 return (GetAccessFlags() & kAccPrivate) != 0;
98 }
99
100 // Returns true if the method is declared static.
Andreas Gampecbc96b82015-09-30 20:05:24 +0000101 bool IsStatic() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800102 return (GetAccessFlags() & kAccStatic) != 0;
103 }
104
105 // Returns true if the method is a constructor.
Andreas Gampecbc96b82015-09-30 20:05:24 +0000106 bool IsConstructor() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800107 return (GetAccessFlags() & kAccConstructor) != 0;
108 }
109
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700110 // Returns true if the method is a class initializer.
Andreas Gampecbc96b82015-09-30 20:05:24 +0000111 bool IsClassInitializer() {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700112 return IsConstructor() && IsStatic();
113 }
114
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800115 // Returns true if the method is static, private, or a constructor.
Andreas Gampecbc96b82015-09-30 20:05:24 +0000116 bool IsDirect() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800117 return IsDirect(GetAccessFlags());
118 }
119
120 static bool IsDirect(uint32_t access_flags) {
Andreas Gampecbc96b82015-09-30 20:05:24 +0000121 constexpr uint32_t direct = kAccStatic | kAccPrivate | kAccConstructor;
122 return (access_flags & direct) != 0;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800123 }
124
125 // Returns true if the method is declared synchronized.
Andreas Gampecbc96b82015-09-30 20:05:24 +0000126 bool IsSynchronized() {
127 constexpr uint32_t synchonized = kAccSynchronized | kAccDeclaredSynchronized;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800128 return (GetAccessFlags() & synchonized) != 0;
129 }
130
Andreas Gampecbc96b82015-09-30 20:05:24 +0000131 bool IsFinal() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800132 return (GetAccessFlags() & kAccFinal) != 0;
133 }
134
Andreas Gampecbc96b82015-09-30 20:05:24 +0000135 bool IsMiranda() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800136 return (GetAccessFlags() & kAccMiranda) != 0;
137 }
138
Alex Light9139e002015-10-09 15:59:48 -0700139 // Returns true if invoking this method will not throw an AbstractMethodError or
140 // IncompatibleClassChangeError.
141 bool IsInvokable() {
142 return !IsAbstract() && !IsDefaultConflicting();
143 }
144
145 // A default conflict method is a special sentinel method that stands for a conflict between
146 // multiple default methods. It cannot be invoked, throwing an IncompatibleClassChangeError if one
147 // attempts to do so.
148 bool IsDefaultConflicting() {
149 return (GetAccessFlags() & kAccDefaultConflict) != 0u;
150 }
151
Alex Lighteb7c1442015-08-31 13:17:42 -0700152 // This is set by the class linker.
153 bool IsDefault() {
154 return (GetAccessFlags() & kAccDefault) != 0;
155 }
156
Andreas Gampecbc96b82015-09-30 20:05:24 +0000157 bool IsNative() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800158 return (GetAccessFlags() & kAccNative) != 0;
159 }
160
Andreas Gampecbc96b82015-09-30 20:05:24 +0000161 bool IsFastNative() {
162 constexpr uint32_t mask = kAccFastNative | kAccNative;
Ian Rogers16ce0922014-01-10 14:59:36 -0800163 return (GetAccessFlags() & mask) == mask;
Ian Rogers1eb512d2013-10-18 15:42:20 -0700164 }
165
Andreas Gampecbc96b82015-09-30 20:05:24 +0000166 bool IsAbstract() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800167 return (GetAccessFlags() & kAccAbstract) != 0;
168 }
169
Andreas Gampecbc96b82015-09-30 20:05:24 +0000170 bool IsSynthetic() {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800171 return (GetAccessFlags() & kAccSynthetic) != 0;
172 }
173
Mathieu Chartier90443472015-07-16 20:32:27 -0700174 bool IsProxyMethod() SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800175
Igor Murashkindf707e42016-02-02 16:56:50 -0800176 bool SkipAccessChecks() {
177 return (GetAccessFlags() & kAccSkipAccessChecks) != 0;
Sebastien Hertz233ea8e2013-06-06 11:57:09 +0200178 }
179
Igor Murashkindf707e42016-02-02 16:56:50 -0800180 void SetSkipAccessChecks() {
181 DCHECK(!SkipAccessChecks());
182 SetAccessFlags(GetAccessFlags() | kAccSkipAccessChecks);
Sebastien Hertz233ea8e2013-06-06 11:57:09 +0200183 }
184
Alex Lighteb7c1442015-08-31 13:17:42 -0700185 // Returns true if this method could be overridden by a default method.
Alex Light9139e002015-10-09 15:59:48 -0700186 bool IsOverridableByDefaultMethod() SHARED_REQUIRES(Locks::mutator_lock_);
Alex Lighteb7c1442015-08-31 13:17:42 -0700187
Mathieu Chartier90443472015-07-16 20:32:27 -0700188 bool CheckIncompatibleClassChange(InvokeType type) SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800189
Alex Light9139e002015-10-09 15:59:48 -0700190 // Throws the error that would result from trying to invoke this method (i.e.
191 // IncompatibleClassChangeError or AbstractMethodError). Only call if !IsInvokable();
192 void ThrowInvocationTimeError() SHARED_REQUIRES(Locks::mutator_lock_);
193
Mathieu Chartier90443472015-07-16 20:32:27 -0700194 uint16_t GetMethodIndex() SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800195
Mathieu Chartier9f3629d2014-10-28 18:23:02 -0700196 // Doesn't do erroneous / unresolved class checks.
Mathieu Chartier90443472015-07-16 20:32:27 -0700197 uint16_t GetMethodIndexDuringLinking() SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartier9f3629d2014-10-28 18:23:02 -0700198
Mathieu Chartier90443472015-07-16 20:32:27 -0700199 size_t GetVtableIndex() SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800200 return GetMethodIndex();
201 }
202
Mathieu Chartier90443472015-07-16 20:32:27 -0700203 void SetMethodIndex(uint16_t new_method_index) SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100204 // Not called within a transaction.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700205 method_index_ = new_method_index;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800206 }
207
Vladimir Markoc1363122015-04-09 14:13:13 +0100208 static MemberOffset DexMethodIndexOffset() {
209 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, dex_method_index_);
210 }
211
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800212 static MemberOffset MethodIndexOffset() {
Brian Carlstromea46f952013-07-30 01:26:50 -0700213 return OFFSET_OF_OBJECT_MEMBER(ArtMethod, method_index_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800214 }
215
Mathieu Chartiere401d142015-04-22 13:56:20 -0700216 uint32_t GetCodeItemOffset() {
217 return dex_code_item_offset_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800218 }
219
Mathieu Chartiere401d142015-04-22 13:56:20 -0700220 void SetCodeItemOffset(uint32_t new_code_off) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100221 // Not called within a transaction.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700222 dex_code_item_offset_ = new_code_off;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800223 }
224
225 // Number of 32bit registers that would be required to hold all the arguments
226 static size_t NumArgRegisters(const StringPiece& shorty);
227
Mathieu Chartier90443472015-07-16 20:32:27 -0700228 ALWAYS_INLINE uint32_t GetDexMethodIndex() SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800229
Mathieu Chartiere401d142015-04-22 13:56:20 -0700230 void SetDexMethodIndex(uint32_t new_idx) {
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100231 // Not called within a transaction.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700232 dex_method_index_ = new_idx;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800233 }
234
Vladimir Marko05792b92015-08-03 11:56:49 +0100235 ALWAYS_INLINE ArtMethod** GetDexCacheResolvedMethods(size_t pointer_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700236 SHARED_REQUIRES(Locks::mutator_lock_);
Vladimir Marko05792b92015-08-03 11:56:49 +0100237 ALWAYS_INLINE ArtMethod* GetDexCacheResolvedMethod(uint16_t method_index, size_t ptr_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700238 SHARED_REQUIRES(Locks::mutator_lock_);
Vladimir Marko05792b92015-08-03 11:56:49 +0100239 ALWAYS_INLINE void SetDexCacheResolvedMethod(uint16_t method_index,
240 ArtMethod* new_method,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700241 size_t ptr_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700242 SHARED_REQUIRES(Locks::mutator_lock_);
Vladimir Marko05792b92015-08-03 11:56:49 +0100243 ALWAYS_INLINE void SetDexCacheResolvedMethods(ArtMethod** new_dex_cache_methods, size_t ptr_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700244 SHARED_REQUIRES(Locks::mutator_lock_);
Vladimir Marko05792b92015-08-03 11:56:49 +0100245 bool HasDexCacheResolvedMethods(size_t pointer_size) SHARED_REQUIRES(Locks::mutator_lock_);
246 bool HasSameDexCacheResolvedMethods(ArtMethod* other, size_t pointer_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700247 SHARED_REQUIRES(Locks::mutator_lock_);
Vladimir Marko05792b92015-08-03 11:56:49 +0100248 bool HasSameDexCacheResolvedMethods(ArtMethod** other_cache, size_t pointer_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700249 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800250
Andreas Gampe58a5af82014-07-31 16:23:49 -0700251 template <bool kWithCheck = true>
Vladimir Marko05792b92015-08-03 11:56:49 +0100252 mirror::Class* GetDexCacheResolvedType(uint32_t type_idx, size_t ptr_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700253 SHARED_REQUIRES(Locks::mutator_lock_);
Vladimir Marko05792b92015-08-03 11:56:49 +0100254 void SetDexCacheResolvedTypes(GcRoot<mirror::Class>* new_dex_cache_types, size_t ptr_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700255 SHARED_REQUIRES(Locks::mutator_lock_);
Vladimir Marko05792b92015-08-03 11:56:49 +0100256 bool HasDexCacheResolvedTypes(size_t pointer_size) SHARED_REQUIRES(Locks::mutator_lock_);
257 bool HasSameDexCacheResolvedTypes(ArtMethod* other, size_t pointer_size)
258 SHARED_REQUIRES(Locks::mutator_lock_);
259 bool HasSameDexCacheResolvedTypes(GcRoot<mirror::Class>* other_cache, size_t pointer_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700260 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800261
Ian Rogersa0485602014-12-02 15:48:04 -0800262 // Get the Class* from the type index into this method's dex cache.
Vladimir Marko05792b92015-08-03 11:56:49 +0100263 mirror::Class* GetClassFromTypeIndex(uint16_t type_idx, bool resolve, size_t ptr_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700264 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogersa0485602014-12-02 15:48:04 -0800265
Alex Light6c8467f2015-11-20 15:03:26 -0800266 // Returns true if this method has the same name and signature of the other method.
267 bool HasSameNameAndSignature(ArtMethod* other) SHARED_REQUIRES(Locks::mutator_lock_);
268
Ian Rogerse0a02da2014-12-02 14:10:53 -0800269 // Find the method that this method overrides.
Alex Light705ad492015-09-21 11:36:30 -0700270 ArtMethod* FindOverriddenMethod(size_t pointer_size)
271 REQUIRES(Roles::uninterruptible_)
272 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800273
Ian Rogerse0a02da2014-12-02 14:10:53 -0800274 // Find the method index for this method within other_dexfile. If this method isn't present then
275 // return DexFile::kDexNoIndex. The name_and_signature_idx MUST refer to a MethodId with the same
276 // name and signature in the other_dexfile, such as the method index used to resolve this method
277 // in the other_dexfile.
278 uint32_t FindDexMethodIndexInOtherDexFile(const DexFile& other_dexfile,
279 uint32_t name_and_signature_idx)
Mathieu Chartier90443472015-07-16 20:32:27 -0700280 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogerse0a02da2014-12-02 14:10:53 -0800281
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700282 void Invoke(Thread* self, uint32_t* args, uint32_t args_size, JValue* result, const char* shorty)
Mathieu Chartier90443472015-07-16 20:32:27 -0700283 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800284
Mathieu Chartiere401d142015-04-22 13:56:20 -0700285 const void* GetEntryPointFromQuickCompiledCode() {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800286 return GetEntryPointFromQuickCompiledCodePtrSize(sizeof(void*));
287 }
Mathieu Chartiere401d142015-04-22 13:56:20 -0700288 ALWAYS_INLINE const void* GetEntryPointFromQuickCompiledCodePtrSize(size_t pointer_size) {
Vladimir Marko05792b92015-08-03 11:56:49 +0100289 return GetNativePointer<const void*>(
Mathieu Chartier2d721012014-11-10 11:08:06 -0800290 EntryPointFromQuickCompiledCodeOffset(pointer_size), pointer_size);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800291 }
292
Mathieu Chartiere401d142015-04-22 13:56:20 -0700293 void SetEntryPointFromQuickCompiledCode(const void* entry_point_from_quick_compiled_code) {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800294 SetEntryPointFromQuickCompiledCodePtrSize(entry_point_from_quick_compiled_code,
295 sizeof(void*));
296 }
Mathieu Chartier2d721012014-11-10 11:08:06 -0800297 ALWAYS_INLINE void SetEntryPointFromQuickCompiledCodePtrSize(
Mathieu Chartiere401d142015-04-22 13:56:20 -0700298 const void* entry_point_from_quick_compiled_code, size_t pointer_size) {
Vladimir Marko05792b92015-08-03 11:56:49 +0100299 SetNativePointer(EntryPointFromQuickCompiledCodeOffset(pointer_size),
300 entry_point_from_quick_compiled_code, pointer_size);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800301 }
302
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700303 void RegisterNative(const void* native_method, bool is_fast)
Mathieu Chartier90443472015-07-16 20:32:27 -0700304 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800305
Mathieu Chartier90443472015-07-16 20:32:27 -0700306 void UnregisterNative() SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800307
Vladimir Marko05792b92015-08-03 11:56:49 +0100308 static MemberOffset DexCacheResolvedMethodsOffset(size_t pointer_size) {
309 return MemberOffset(PtrSizedFieldsOffset(pointer_size) + OFFSETOF_MEMBER(
310 PtrSizedFields, dex_cache_resolved_methods_) / sizeof(void*) * pointer_size);
311 }
312
313 static MemberOffset DexCacheResolvedTypesOffset(size_t pointer_size) {
314 return MemberOffset(PtrSizedFieldsOffset(pointer_size) + OFFSETOF_MEMBER(
315 PtrSizedFields, dex_cache_resolved_types_) / sizeof(void*) * pointer_size);
316 }
317
Mathieu Chartier2d721012014-11-10 11:08:06 -0800318 static MemberOffset EntryPointFromJniOffset(size_t pointer_size) {
Mathieu Chartiereace4582014-11-24 18:29:54 -0800319 return MemberOffset(PtrSizedFieldsOffset(pointer_size) + OFFSETOF_MEMBER(
Mathieu Chartier2d721012014-11-10 11:08:06 -0800320 PtrSizedFields, entry_point_from_jni_) / sizeof(void*) * pointer_size);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800321 }
322
Mathieu Chartier2d721012014-11-10 11:08:06 -0800323 static MemberOffset EntryPointFromQuickCompiledCodeOffset(size_t pointer_size) {
Mathieu Chartiereace4582014-11-24 18:29:54 -0800324 return MemberOffset(PtrSizedFieldsOffset(pointer_size) + OFFSETOF_MEMBER(
Mathieu Chartier2d721012014-11-10 11:08:06 -0800325 PtrSizedFields, entry_point_from_quick_compiled_code_) / sizeof(void*) * pointer_size);
326 }
327
Mathieu Chartier1147b9b2015-09-14 18:50:08 -0700328 ProfilingInfo* GetProfilingInfo(size_t pointer_size) {
329 return reinterpret_cast<ProfilingInfo*>(GetEntryPointFromJniPtrSize(pointer_size));
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100330 }
331
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000332 ALWAYS_INLINE void SetProfilingInfo(ProfilingInfo* info) {
333 SetEntryPointFromJniPtrSize(info, sizeof(void*));
334 }
335
Nicolas Geoffray22cf3d32015-11-02 11:57:11 +0000336 ALWAYS_INLINE void SetProfilingInfoPtrSize(ProfilingInfo* info, size_t pointer_size) {
337 SetEntryPointFromJniPtrSize(info, pointer_size);
338 }
339
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000340 static MemberOffset ProfilingInfoOffset() {
341 return EntryPointFromJniOffset(sizeof(void*));
342 }
343
Mathieu Chartiere401d142015-04-22 13:56:20 -0700344 void* GetEntryPointFromJni() {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800345 return GetEntryPointFromJniPtrSize(sizeof(void*));
346 }
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100347
Mathieu Chartiere401d142015-04-22 13:56:20 -0700348 ALWAYS_INLINE void* GetEntryPointFromJniPtrSize(size_t pointer_size) {
Vladimir Marko05792b92015-08-03 11:56:49 +0100349 return GetNativePointer<void*>(EntryPointFromJniOffset(pointer_size), pointer_size);
Mathieu Chartier2d721012014-11-10 11:08:06 -0800350 }
351
Andreas Gampecbc96b82015-09-30 20:05:24 +0000352 void SetEntryPointFromJni(const void* entrypoint) {
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100353 DCHECK(IsNative());
Mathieu Chartiere401d142015-04-22 13:56:20 -0700354 SetEntryPointFromJniPtrSize(entrypoint, sizeof(void*));
Mathieu Chartier2d721012014-11-10 11:08:06 -0800355 }
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100356
Mathieu Chartiere401d142015-04-22 13:56:20 -0700357 ALWAYS_INLINE void SetEntryPointFromJniPtrSize(const void* entrypoint, size_t pointer_size) {
Vladimir Marko05792b92015-08-03 11:56:49 +0100358 SetNativePointer(EntryPointFromJniOffset(pointer_size), entrypoint, pointer_size);
Mathieu Chartier2d721012014-11-10 11:08:06 -0800359 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800360
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800361 // Is this a CalleSaveMethod or ResolutionMethod and therefore doesn't adhere to normal
362 // conventions for a method of managed code. Returns false for Proxy methods.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700363 ALWAYS_INLINE bool IsRuntimeMethod();
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800364
365 // Is this a hand crafted method used for something like describing callee saves?
Mathieu Chartier90443472015-07-16 20:32:27 -0700366 bool IsCalleeSaveMethod() SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800367
Mathieu Chartier90443472015-07-16 20:32:27 -0700368 bool IsResolutionMethod() SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800369
Mathieu Chartier90443472015-07-16 20:32:27 -0700370 bool IsImtConflictMethod() SHARED_REQUIRES(Locks::mutator_lock_);
Jeff Hao88474b42013-10-23 16:24:40 -0700371
Mathieu Chartier90443472015-07-16 20:32:27 -0700372 bool IsImtUnimplementedMethod() SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartier2d2621a2014-10-23 16:48:06 -0700373
Mathieu Chartier90443472015-07-16 20:32:27 -0700374 MethodReference ToMethodReference() SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartier36b58f52014-12-10 12:06:45 -0800375 return MethodReference(GetDexFile(), GetDexMethodIndex());
376 }
377
Ian Rogersc449aa82013-07-29 14:35:46 -0700378 // Find the catch block for the given exception type and dex_pc. When a catch block is found,
379 // indicates whether the found catch block is responsible for clearing the exception or whether
380 // a move-exception instruction is present.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700381 uint32_t FindCatchBlock(Handle<mirror::Class> exception_type, uint32_t dex_pc,
382 bool* has_no_move_exception)
Mathieu Chartier90443472015-07-16 20:32:27 -0700383 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800384
Mathieu Chartierda7c6502015-07-23 16:01:26 -0700385 // NO_THREAD_SAFETY_ANALYSIS since we don't know what the callback requires.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700386 template<typename RootVisitorType>
Mathieu Chartier1147b9b2015-09-14 18:50:08 -0700387 void VisitRoots(RootVisitorType& visitor, size_t pointer_size) NO_THREAD_SAFETY_ANALYSIS;
Mathieu Chartierc528dba2013-11-26 12:00:11 -0800388
Mathieu Chartier90443472015-07-16 20:32:27 -0700389 const DexFile* GetDexFile() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700390
Mathieu Chartier90443472015-07-16 20:32:27 -0700391 const char* GetDeclaringClassDescriptor() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700392
Mathieu Chartier90443472015-07-16 20:32:27 -0700393 const char* GetShorty() SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700394 uint32_t unused_length;
395 return GetShorty(&unused_length);
396 }
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700397
Mathieu Chartier90443472015-07-16 20:32:27 -0700398 const char* GetShorty(uint32_t* out_length) SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700399
Mathieu Chartier90443472015-07-16 20:32:27 -0700400 const Signature GetSignature() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700401
Mathieu Chartier90443472015-07-16 20:32:27 -0700402 ALWAYS_INLINE const char* GetName() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700403
Mathieu Chartier90443472015-07-16 20:32:27 -0700404 mirror::String* GetNameAsString(Thread* self) SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogers6b14d552014-10-28 21:50:58 -0700405
Mathieu Chartier90443472015-07-16 20:32:27 -0700406 const DexFile::CodeItem* GetCodeItem() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700407
Vladimir Marko05792b92015-08-03 11:56:49 +0100408 bool IsResolvedTypeIdx(uint16_t type_idx, size_t ptr_size) SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700409
Mathieu Chartier90443472015-07-16 20:32:27 -0700410 int32_t GetLineNumFromDexPC(uint32_t dex_pc) SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700411
Mathieu Chartier90443472015-07-16 20:32:27 -0700412 const DexFile::ProtoId& GetPrototype() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700413
Mathieu Chartier90443472015-07-16 20:32:27 -0700414 const DexFile::TypeList* GetParameterTypeList() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700415
Mathieu Chartier90443472015-07-16 20:32:27 -0700416 const char* GetDeclaringClassSourceFile() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700417
Mathieu Chartier90443472015-07-16 20:32:27 -0700418 uint16_t GetClassDefIndex() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700419
Mathieu Chartier90443472015-07-16 20:32:27 -0700420 const DexFile::ClassDef& GetClassDef() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700421
Mathieu Chartier90443472015-07-16 20:32:27 -0700422 const char* GetReturnTypeDescriptor() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700423
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700424 const char* GetTypeDescriptorFromTypeIdx(uint16_t type_idx)
Mathieu Chartier90443472015-07-16 20:32:27 -0700425 SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700426
Ian Rogersded66a02014-10-28 18:12:55 -0700427 // May cause thread suspension due to GetClassFromTypeIdx calling ResolveType this caused a large
428 // number of bugs at call sites.
Vladimir Marko05792b92015-08-03 11:56:49 +0100429 mirror::Class* GetReturnType(bool resolve, size_t ptr_size)
430 SHARED_REQUIRES(Locks::mutator_lock_);
Ian Rogersded66a02014-10-28 18:12:55 -0700431
Mathieu Chartier90443472015-07-16 20:32:27 -0700432 mirror::ClassLoader* GetClassLoader() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700433
Mathieu Chartier90443472015-07-16 20:32:27 -0700434 mirror::DexCache* GetDexCache() SHARED_REQUIRES(Locks::mutator_lock_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700435
Mathieu Chartiere401d142015-04-22 13:56:20 -0700436 ALWAYS_INLINE ArtMethod* GetInterfaceMethodIfProxy(size_t pointer_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700437 SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -0700438
Mathieu Chartierfc58af42015-04-16 18:00:39 -0700439 // May cause thread suspension due to class resolution.
440 bool EqualParameters(Handle<mirror::ObjectArray<mirror::Class>> params)
Mathieu Chartier90443472015-07-16 20:32:27 -0700441 SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartierfc58af42015-04-16 18:00:39 -0700442
Vladimir Marko14632852015-08-17 12:07:23 +0100443 // Size of an instance of this native class.
444 static size_t Size(size_t pointer_size) {
Mathieu Chartiere401d142015-04-22 13:56:20 -0700445 return RoundUp(OFFSETOF_MEMBER(ArtMethod, ptr_sized_fields_), pointer_size) +
Mathieu Chartiereace4582014-11-24 18:29:54 -0800446 (sizeof(PtrSizedFields) / sizeof(void*)) * pointer_size;
Mathieu Chartier2d721012014-11-10 11:08:06 -0800447 }
448
Vladimir Marko14632852015-08-17 12:07:23 +0100449 // Alignment of an instance of this native class.
450 static size_t Alignment(size_t pointer_size) {
Vladimir Markocf36d492015-08-12 19:27:26 +0100451 // The ArtMethod alignment is the same as image pointer size. This differs from
Vladimir Marko14632852015-08-17 12:07:23 +0100452 // alignof(ArtMethod) if cross-compiling with pointer_size != sizeof(void*).
Vladimir Markocf36d492015-08-12 19:27:26 +0100453 return pointer_size;
454 }
455
Nicolas Geoffray22cf3d32015-11-02 11:57:11 +0000456 void CopyFrom(ArtMethod* src, size_t image_pointer_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700457 SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700458
Vladimir Marko05792b92015-08-03 11:56:49 +0100459 ALWAYS_INLINE GcRoot<mirror::Class>* GetDexCacheResolvedTypes(size_t pointer_size)
Mathieu Chartier90443472015-07-16 20:32:27 -0700460 SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700461
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100462 uint16_t IncrementCounter() {
463 return ++hotness_count_;
464 }
465
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100466 void ClearCounter() {
467 hotness_count_ = 0;
468 }
469
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100470 const uint8_t* GetQuickenedInfo() SHARED_REQUIRES(Locks::mutator_lock_);
471
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +0100472 // Returns the method header for the compiled code containing 'pc'. Note that runtime
473 // methods will return null for this method, as they are not oat based.
474 const OatQuickMethodHeader* GetOatQuickMethodHeader(uintptr_t pc)
475 SHARED_REQUIRES(Locks::mutator_lock_);
476
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000477 // Returns whether the method has any compiled code, JIT or AOT.
478 bool HasAnyCompiledCode() SHARED_REQUIRES(Locks::mutator_lock_);
479
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800480
481 // Update heap objects and non-entrypoint pointers by the passed in visitor for image relocation.
482 // Does not use read barrier.
483 template <typename Visitor>
484 ALWAYS_INLINE void UpdateObjectsForImageRelocation(const Visitor& visitor)
485 SHARED_REQUIRES(Locks::mutator_lock_);
486
487 // Update entry points by passing them through the visitor.
488 template <typename Visitor>
489 ALWAYS_INLINE void UpdateEntrypoints(const Visitor& visitor);
490
Mathieu Chartier2d721012014-11-10 11:08:06 -0800491 protected:
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800492 // Field order required by test "ValidateFieldOrderOfJavaCppUnionClasses".
Ian Rogersef7d42f2014-01-06 12:55:46 -0800493 // The class we are a part of.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700494 GcRoot<mirror::Class> declaring_class_;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800495
Ian Rogersef7d42f2014-01-06 12:55:46 -0800496 // Access flags; low 16 bits are defined by spec.
497 uint32_t access_flags_;
498
499 /* Dex file fields. The defining dex file is available via declaring_class_->dex_cache_ */
500
501 // Offset to the CodeItem.
502 uint32_t dex_code_item_offset_;
503
504 // Index into method_ids of the dex file associated with this method.
505 uint32_t dex_method_index_;
506
507 /* End of dex file fields. */
508
509 // Entry within a dispatch table for this method. For static/direct methods the index is into
510 // the declaringClass.directMethods, for virtual methods the vtable and for interface methods the
511 // ifTable.
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100512 uint16_t method_index_;
513
514 // The hotness we measure for this method. Incremented by the interpreter. Not atomic, as we allow
515 // missing increments: if the method is hot, we will see it eventually.
516 uint16_t hotness_count_;
Ian Rogersef7d42f2014-01-06 12:55:46 -0800517
Mathieu Chartiereace4582014-11-24 18:29:54 -0800518 // Fake padding field gets inserted here.
Mathieu Chartier2d721012014-11-10 11:08:06 -0800519
520 // Must be the last fields in the method.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700521 // PACKED(4) is necessary for the correctness of
522 // RoundUp(OFFSETOF_MEMBER(ArtMethod, ptr_sized_fields_), pointer_size).
Mathieu Chartier2d721012014-11-10 11:08:06 -0800523 struct PACKED(4) PtrSizedFields {
Vladimir Marko05792b92015-08-03 11:56:49 +0100524 // Short cuts to declaring_class_->dex_cache_ member for fast compiled code access.
525 ArtMethod** dex_cache_resolved_methods_;
526
527 // Short cuts to declaring_class_->dex_cache_ member for fast compiled code access.
528 GcRoot<mirror::Class>* dex_cache_resolved_types_;
529
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100530 // Pointer to JNI function registered to this method, or a function to resolve the JNI function,
531 // or the profiling data for non-native methods.
Mathieu Chartier2d721012014-11-10 11:08:06 -0800532 void* entry_point_from_jni_;
533
534 // Method dispatch from quick compiled code invokes this pointer which may cause bridging into
Elliott Hughes956af0f2014-12-11 14:34:28 -0800535 // the interpreter.
Mathieu Chartier2d721012014-11-10 11:08:06 -0800536 void* entry_point_from_quick_compiled_code_;
Mathieu Chartier2d721012014-11-10 11:08:06 -0800537 } ptr_sized_fields_;
538
Mathieu Chartier02e25112013-08-14 16:14:24 -0700539 private:
Mathieu Chartiereace4582014-11-24 18:29:54 -0800540 static size_t PtrSizedFieldsOffset(size_t pointer_size) {
Mathieu Chartiere401d142015-04-22 13:56:20 -0700541 // Round up to pointer size for padding field.
542 return RoundUp(OFFSETOF_MEMBER(ArtMethod, ptr_sized_fields_), pointer_size);
543 }
544
545 template<typename T>
Vladimir Marko05792b92015-08-03 11:56:49 +0100546 ALWAYS_INLINE T GetNativePointer(MemberOffset offset, size_t pointer_size) const {
547 static_assert(std::is_pointer<T>::value, "T must be a pointer type");
Mathieu Chartiere401d142015-04-22 13:56:20 -0700548 DCHECK(ValidPointerSize(pointer_size)) << pointer_size;
549 const auto addr = reinterpret_cast<uintptr_t>(this) + offset.Uint32Value();
550 if (pointer_size == sizeof(uint32_t)) {
551 return reinterpret_cast<T>(*reinterpret_cast<const uint32_t*>(addr));
552 } else {
553 auto v = *reinterpret_cast<const uint64_t*>(addr);
Vladimir Marko05792b92015-08-03 11:56:49 +0100554 return reinterpret_cast<T>(dchecked_integral_cast<uintptr_t>(v));
Mathieu Chartiere401d142015-04-22 13:56:20 -0700555 }
556 }
557
558 template<typename T>
Vladimir Marko05792b92015-08-03 11:56:49 +0100559 ALWAYS_INLINE void SetNativePointer(MemberOffset offset, T new_value, size_t pointer_size) {
560 static_assert(std::is_pointer<T>::value, "T must be a pointer type");
Mathieu Chartiere401d142015-04-22 13:56:20 -0700561 DCHECK(ValidPointerSize(pointer_size)) << pointer_size;
562 const auto addr = reinterpret_cast<uintptr_t>(this) + offset.Uint32Value();
563 if (pointer_size == sizeof(uint32_t)) {
564 uintptr_t ptr = reinterpret_cast<uintptr_t>(new_value);
Vladimir Marko05792b92015-08-03 11:56:49 +0100565 *reinterpret_cast<uint32_t*>(addr) = dchecked_integral_cast<uint32_t>(ptr);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700566 } else {
567 *reinterpret_cast<uint64_t*>(addr) = reinterpret_cast<uintptr_t>(new_value);
568 }
Mathieu Chartier2d721012014-11-10 11:08:06 -0800569 }
570
Mathieu Chartiere401d142015-04-22 13:56:20 -0700571 DISALLOW_COPY_AND_ASSIGN(ArtMethod); // Need to use CopyFrom to deal with 32 vs 64 bits.
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800572};
573
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800574} // namespace art
575
Mathieu Chartiere401d142015-04-22 13:56:20 -0700576#endif // ART_RUNTIME_ART_METHOD_H_