blob: 552762bfb0b83dd2dabdad3d650d7a17cd4532de [file] [log] [blame]
Elliott Hughes418d20f2011-09-22 14:00:39 -07001/*
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 Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_RUNTIME_REFLECTION_H_
18#define ART_RUNTIME_REFLECTION_H_
Elliott Hughes418d20f2011-09-22 14:00:39 -070019
liulvpingfff1d8f2020-12-21 09:43:37 +080020#include "base/enums.h"
Andreas Gampe7fbc4a52018-11-28 08:26:47 -080021#include "base/locks.h"
Dmitrii Ishcheikin8cd02092024-01-30 15:22:45 +000022#include "base/macros.h"
David Sehr67bf42e2018-02-26 16:43:04 -080023#include "dex/primitive.h"
Elliott Hughes418d20f2011-09-22 14:00:39 -070024#include "jni.h"
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070025#include "obj_ptr.h"
Elliott Hughes418d20f2011-09-22 14:00:39 -070026
Dmitrii Ishcheikin8cd02092024-01-30 15:22:45 +000027namespace art HIDDEN {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080028namespace mirror {
Igor Murashkin2ffb7032017-11-08 13:35:21 -080029class Class;
30class Object;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080031} // namespace mirror
Mathieu Chartierc7853442015-03-27 14:35:38 -070032class ArtField;
Mathieu Chartiere401d142015-04-22 13:56:20 -070033class ArtMethod;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080034union JValue;
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070035class ScopedObjectAccessAlreadyRunnable;
Ian Rogers53b8b092014-03-13 23:45:53 -070036class ShadowFrame;
Elliott Hughes418d20f2011-09-22 14:00:39 -070037
Dmitrii Ishcheikin8cd02092024-01-30 15:22:45 +000038EXPORT ObjPtr<mirror::Object> BoxPrimitive(Primitive::Type src_class, const JValue& value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070039 REQUIRES_SHARED(Locks::mutator_lock_);
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070040
Dmitrii Ishcheikin8cd02092024-01-30 15:22:45 +000041EXPORT bool UnboxPrimitiveForField(ObjPtr<mirror::Object> o,
42 ObjPtr<mirror::Class> dst_class,
43 ArtField* f,
44 JValue* unboxed_value) REQUIRES_SHARED(Locks::mutator_lock_);
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070045
Dmitrii Ishcheikin8cd02092024-01-30 15:22:45 +000046EXPORT bool UnboxPrimitiveForResult(ObjPtr<mirror::Object> o,
47 ObjPtr<mirror::Class> dst_class,
48 JValue* unboxed_value) REQUIRES_SHARED(Locks::mutator_lock_);
Elliott Hughes418d20f2011-09-22 14:00:39 -070049
Orion Hodsonba28f9f2016-10-26 10:56:25 +010050ALWAYS_INLINE bool ConvertPrimitiveValueNoThrow(Primitive::Type src_class,
51 Primitive::Type dst_class,
52 const JValue& src,
53 JValue* dst)
54 REQUIRES_SHARED(Locks::mutator_lock_);
55
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +000056ALWAYS_INLINE bool ConvertPrimitiveValue(bool unbox_for_result,
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070057 Primitive::Type src_class,
58 Primitive::Type dst_class,
59 const JValue& src,
60 JValue* dst)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070061 REQUIRES_SHARED(Locks::mutator_lock_);
Elliott Hughes418d20f2011-09-22 14:00:39 -070062
Alex Light01fbfbe2019-06-27 10:47:04 -070063// Invokes the given method (either an ArtMethod or a jmethodID) with direct/static semantics.
64template<typename MethodType>
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070065JValue InvokeWithVarArgs(const ScopedObjectAccessAlreadyRunnable& soa,
66 jobject obj,
Alex Light01fbfbe2019-06-27 10:47:04 -070067 MethodType mid,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070068 va_list args)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070069 REQUIRES_SHARED(Locks::mutator_lock_);
Elliott Hughes2a20cfd2011-09-23 19:30:41 -070070
Alex Light01fbfbe2019-06-27 10:47:04 -070071// Invokes the given method (either an ArtMethod or a jmethodID) with reflection semantics.
72template<typename MethodType>
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070073JValue InvokeWithJValues(const ScopedObjectAccessAlreadyRunnable& soa,
74 jobject obj,
Alex Light01fbfbe2019-06-27 10:47:04 -070075 MethodType mid,
Elliott Hughes22352f32018-06-15 17:33:58 -070076 const jvalue* args)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070077 REQUIRES_SHARED(Locks::mutator_lock_);
Ian Rogers53b8b092014-03-13 23:45:53 -070078
Alex Light01fbfbe2019-06-27 10:47:04 -070079// Invokes the given method (either an ArtMethod or a jmethodID) with virtual/interface semantics.
80// Note this will perform lookup based on the 'obj' to determine which implementation of the given
81// method should be invoked.
82template<typename MethodType>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070083JValue InvokeVirtualOrInterfaceWithJValues(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070084 jobject obj,
Alex Light01fbfbe2019-06-27 10:47:04 -070085 MethodType mid,
Elliott Hughes22352f32018-06-15 17:33:58 -070086 const jvalue* args)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070087 REQUIRES_SHARED(Locks::mutator_lock_);
Ian Rogers53b8b092014-03-13 23:45:53 -070088
Alex Light01fbfbe2019-06-27 10:47:04 -070089// Invokes the given method (either an ArtMethod or a jmethodID) with virtual/interface semantics.
90// Note this will perform lookup based on the 'obj' to determine which implementation of the given
91// method should be invoked.
92template<typename MethodType>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -070093JValue InvokeVirtualOrInterfaceWithVarArgs(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070094 jobject obj,
Alex Light01fbfbe2019-06-27 10:47:04 -070095 MethodType mid,
Mathieu Chartiera59d9b22016-09-26 18:13:17 -070096 va_list args)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070097 REQUIRES_SHARED(Locks::mutator_lock_);
Ian Rogers53b8b092014-03-13 23:45:53 -070098
Mathieu Chartierfc58af42015-04-16 18:00:39 -070099// num_frames is number of frames we look up for access check.
liulvpingfff1d8f2020-12-21 09:43:37 +0800100template<PointerSize pointer_size>
Chris Wailes9f61e0a2021-05-12 17:16:50 -0700101NO_STACK_PROTECTOR
Mathieu Chartiera59d9b22016-09-26 18:13:17 -0700102jobject InvokeMethod(const ScopedObjectAccessAlreadyRunnable& soa,
103 jobject method,
104 jobject receiver,
105 jobject args,
106 size_t num_frames = 1)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700107 REQUIRES_SHARED(Locks::mutator_lock_);
Ian Rogers53b8b092014-03-13 23:45:53 -0700108
Andreas Gampe8ad7a3b2017-05-22 16:08:52 -0700109// Special-casing of the above. Assumes that the method is the correct constructor, the class is
110// initialized, and that the receiver is an instance of the class.
111void InvokeConstructor(const ScopedObjectAccessAlreadyRunnable& soa,
112 ArtMethod* constructor,
113 ObjPtr<mirror::Object> receiver,
114 jobject args)
115 REQUIRES_SHARED(Locks::mutator_lock_);
116
Mathieu Chartiera59d9b22016-09-26 18:13:17 -0700117ALWAYS_INLINE bool VerifyObjectIsClass(ObjPtr<mirror::Object> o, ObjPtr<mirror::Class> c)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700118 REQUIRES_SHARED(Locks::mutator_lock_);
Elliott Hughes418d20f2011-09-22 14:00:39 -0700119
Mathieu Chartiera59d9b22016-09-26 18:13:17 -0700120bool VerifyAccess(Thread* self,
121 ObjPtr<mirror::Object> obj,
122 ObjPtr<mirror::Class> declaring_class,
123 uint32_t access_flags,
124 ObjPtr<mirror::Class>* calling_class,
125 size_t num_frames)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700126 REQUIRES_SHARED(Locks::mutator_lock_);
Jeff Hao11d5d8f2014-03-26 15:08:20 -0700127
Mathieu Chartierf36cb5f2015-04-24 16:55:16 -0700128// This version takes a known calling class.
Mathieu Chartiera59d9b22016-09-26 18:13:17 -0700129bool VerifyAccess(ObjPtr<mirror::Object> obj,
130 ObjPtr<mirror::Class> declaring_class,
Mathieu Chartier268764d2016-09-13 12:09:38 -0700131 uint32_t access_flags,
Mathieu Chartiera59d9b22016-09-26 18:13:17 -0700132 ObjPtr<mirror::Class> calling_class)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700133 REQUIRES_SHARED(Locks::mutator_lock_);
Mathieu Chartierf36cb5f2015-04-24 16:55:16 -0700134
135// Get the calling class by using a stack visitor, may return null for unattached native threads.
Mathieu Chartiera59d9b22016-09-26 18:13:17 -0700136ObjPtr<mirror::Class> GetCallingClass(Thread* self, size_t num_frames)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700137 REQUIRES_SHARED(Locks::mutator_lock_);
Mathieu Chartierf36cb5f2015-04-24 16:55:16 -0700138
Mathieu Chartiera59d9b22016-09-26 18:13:17 -0700139void InvalidReceiverError(ObjPtr<mirror::Object> o, ObjPtr<mirror::Class> c)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700140 REQUIRES_SHARED(Locks::mutator_lock_);
Mathieu Chartierdaaf3262015-03-24 13:30:28 -0700141
Mathieu Chartiera59d9b22016-09-26 18:13:17 -0700142void UpdateReference(Thread* self, jobject obj, ObjPtr<mirror::Object> result)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700143 REQUIRES_SHARED(Locks::mutator_lock_);
Jeff Hao83c81952015-05-27 19:29:29 -0700144
Elliott Hughes418d20f2011-09-22 14:00:39 -0700145} // namespace art
146
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700147#endif // ART_RUNTIME_REFLECTION_H_