blob: cd3c5cbb7f4736936bde821d1f610d5401943b22 [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -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 */
Ian Rogersdf20fe02011-07-20 20:34:16 -070016
Brian Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_RUNTIME_JNI_INTERNAL_H_
18#define ART_RUNTIME_JNI_INTERNAL_H_
Ian Rogersdf20fe02011-07-20 20:34:16 -070019
20#include "jni.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070021
Elliott Hughes76160052012-12-12 16:31:20 -080022#include "base/macros.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080023#include "base/mutex.h"
Elliott Hughes6c1a3942011-08-17 15:00:06 -070024#include "indirect_reference_table.h"
Elliott Hughesbbd76712011-08-17 10:25:24 -070025#include "reference_table.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080026#include "root_visitor.h"
Elliott Hughesa0957642011-09-02 14:27:33 -070027#include "runtime.h"
Mathieu Chartier055d46c2014-02-06 11:22:17 -080028#include "sirt_ref.h"
Ian Rogersdf20fe02011-07-20 20:34:16 -070029
Elliott Hughesae80b492012-04-24 10:43:17 -070030#include <iosfwd>
Elliott Hughes0af55432011-08-17 18:37:28 -070031#include <string>
32
Elliott Hugheseac76672012-05-24 21:56:51 -070033#ifndef NATIVE_METHOD
34#define NATIVE_METHOD(className, functionName, signature) \
35 { #functionName, signature, reinterpret_cast<void*>(className ## _ ## functionName) }
36#endif
37#define REGISTER_NATIVE_METHODS(jni_class_name) \
38 RegisterNativeMethods(env, jni_class_name, gMethods, arraysize(gMethods))
39
Ian Rogersdf20fe02011-07-20 20:34:16 -070040namespace art {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080041namespace mirror {
Brian Carlstromea46f952013-07-30 01:26:50 -070042 class ArtField;
43 class ArtMethod;
44 class ClassLoader;
45} // namespace mirror
Jeff Hao5d917302013-02-27 17:57:33 -080046class ArgArray;
Elliott Hughes418d20f2011-09-22 14:00:39 -070047union JValue;
Elliott Hughes79082e32011-08-25 12:07:32 -070048class Libraries;
Ian Rogers00f7d0e2012-07-19 15:28:27 -070049class ScopedObjectAccess;
Elliott Hughes18c07532011-08-18 15:50:51 -070050class Thread;
Ian Rogersdf20fe02011-07-20 20:34:16 -070051
Ian Rogers62d6c772013-02-27 08:32:07 -080052void JniAbortF(const char* jni_function_name, const char* fmt, ...)
53 __attribute__((__format__(__printf__, 2, 3)));
Ian Rogers00f7d0e2012-07-19 15:28:27 -070054void RegisterNativeMethods(JNIEnv* env, const char* jni_class_name, const JNINativeMethod* methods,
Ian Rogersabd7be92013-08-15 10:26:54 -070055 jint method_count);
Elliott Hughesa2501992011-08-26 19:39:54 -070056
Ian Rogers00f7d0e2012-07-19 15:28:27 -070057JValue InvokeWithJValues(const ScopedObjectAccess&, jobject obj, jmethodID mid, jvalue* args)
Ian Rogersb726dcb2012-09-05 08:57:23 -070058 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Brian Carlstromea46f952013-07-30 01:26:50 -070059void InvokeWithArgArray(const ScopedObjectAccess& soa, mirror::ArtMethod* method,
Jeff Hao6474d192013-03-26 14:08:09 -070060 ArgArray *arg_array, JValue* result, char result_type)
Ian Rogersb726dcb2012-09-05 08:57:23 -070061 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes418d20f2011-09-22 14:00:39 -070062
Elliott Hughesa4f94742012-05-29 16:28:38 -070063int ThrowNewException(JNIEnv* env, jclass exception_class, const char* msg, jobject cause);
64
Mathieu Chartierc11d9b82013-09-19 10:01:59 -070065class JavaVMExt : public JavaVM {
66 public:
Elliott Hughesa0957642011-09-02 14:27:33 -070067 JavaVMExt(Runtime* runtime, Runtime::ParsedOptions* options);
Elliott Hughesde69d7f2011-08-18 16:49:37 -070068 ~JavaVMExt();
Elliott Hughes0af55432011-08-17 18:37:28 -070069
Elliott Hughes75770752011-08-24 17:52:38 -070070 /**
71 * Loads the given shared library. 'path' is an absolute pathname.
Elliott Hughes0af55432011-08-17 18:37:28 -070072 *
Elliott Hughes75770752011-08-24 17:52:38 -070073 * Returns 'true' on success. On failure, sets 'detail' to a
74 * human-readable description of the error.
Elliott Hughes0af55432011-08-17 18:37:28 -070075 */
Mathieu Chartier055d46c2014-02-06 11:22:17 -080076 bool LoadNativeLibrary(const std::string& path, const SirtRef<mirror::ClassLoader>& class_loader,
Ian Rogers1eb512d2013-10-18 15:42:20 -070077 std::string* detail)
Ian Rogersb726dcb2012-09-05 08:57:23 -070078 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughesbbd76712011-08-17 10:25:24 -070079
Elliott Hughes79082e32011-08-25 12:07:32 -070080 /**
81 * Returns a pointer to the code for the native method 'm', found
82 * using dlsym(3) on every native library that's been loaded so far.
83 */
Brian Carlstromea46f952013-07-30 01:26:50 -070084 void* FindCodeForNativeMethod(mirror::ArtMethod* m)
Ian Rogersb726dcb2012-09-05 08:57:23 -070085 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes79082e32011-08-25 12:07:32 -070086
Elliott Hughesae80b492012-04-24 10:43:17 -070087 void DumpForSigQuit(std::ostream& os);
88
Ian Rogers00f7d0e2012-07-19 15:28:27 -070089 void DumpReferenceTables(std::ostream& os)
Ian Rogersb726dcb2012-09-05 08:57:23 -070090 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes9d5ccec2011-09-19 13:19:50 -070091
Elliott Hughes88c5c352012-03-15 18:49:48 -070092 void SetCheckJniEnabled(bool enabled);
Elliott Hughes4ffd3132011-10-24 12:06:42 -070093
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080094 void VisitRoots(RootVisitor*, void*);
Elliott Hughes410c0c82011-09-01 17:58:25 -070095
Mathieu Chartierc11d9b82013-09-19 10:01:59 -070096 void DisallowNewWeakGlobals() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_);
97 void AllowNewWeakGlobals() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
98 jweak AddWeakGlobalReference(Thread* self, mirror::Object* obj)
99 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
100 void DeleteWeakGlobalRef(Thread* self, jweak obj)
101 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mathieu Chartier810b1d72013-09-20 14:02:02 -0700102 void SweepJniWeakGlobals(RootVisitor visitor, void* arg);
Mathieu Chartierc11d9b82013-09-19 10:01:59 -0700103 mirror::Object* DecodeWeakGlobal(Thread* self, IndirectRef ref);
104
Elliott Hughesf2682d52011-08-15 16:37:04 -0700105 Runtime* runtime;
Elliott Hughesbbd76712011-08-17 10:25:24 -0700106
Elliott Hughesa2501992011-08-26 19:39:54 -0700107 // Used for testing. By default, we'll LOG(FATAL) the reason.
Elliott Hughesb264f082012-04-06 17:10:10 -0700108 void (*check_jni_abort_hook)(void* data, const std::string& reason);
109 void* check_jni_abort_hook_data;
Elliott Hughesa2501992011-08-26 19:39:54 -0700110
Elliott Hughesa0957642011-09-02 14:27:33 -0700111 // Extra checking.
Elliott Hughes515a5bc2011-08-17 11:08:34 -0700112 bool check_jni;
Elliott Hughesa2501992011-08-26 19:39:54 -0700113 bool force_copy;
Elliott Hughes515a5bc2011-08-17 11:08:34 -0700114
Elliott Hughesa0957642011-09-02 14:27:33 -0700115 // Extra diagnostics.
Elliott Hughesa0957642011-09-02 14:27:33 -0700116 std::string trace;
117
Elliott Hughesc5bfa8f2011-08-30 14:32:49 -0700118 // Used to provide compatibility for apps that assumed direct references.
119 bool work_around_app_jni_bugs;
120
Elliott Hughesbbd76712011-08-17 10:25:24 -0700121 // Used to hold references to pinned primitive arrays.
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700122 Mutex pins_lock DEFAULT_MUTEX_ACQUIRED_AFTER;
Elliott Hughesf8349362012-06-18 15:00:06 -0700123 ReferenceTable pin_table GUARDED_BY(pins_lock);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700124
125 // JNI global references.
Ian Rogersb8a0b942013-08-20 18:09:52 -0700126 ReaderWriterMutex globals_lock DEFAULT_MUTEX_ACQUIRED_AFTER;
Elliott Hughesf8349362012-06-18 15:00:06 -0700127 IndirectReferenceTable globals GUARDED_BY(globals_lock);
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700128
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700129 Mutex libraries_lock DEFAULT_MUTEX_ACQUIRED_AFTER;
Elliott Hughesf8349362012-06-18 15:00:06 -0700130 Libraries* libraries GUARDED_BY(libraries_lock);
Elliott Hughesa2501992011-08-26 19:39:54 -0700131
132 // Used by -Xcheck:jni.
133 const JNIInvokeInterface* unchecked_functions;
Mathieu Chartierc11d9b82013-09-19 10:01:59 -0700134
135 private:
136 // TODO: Make the other members of this class also private.
137 // JNI weak global references.
138 Mutex weak_globals_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
139 IndirectReferenceTable weak_globals_ GUARDED_BY(weak_globals_lock_);
140 bool allow_new_weak_globals_ GUARDED_BY(weak_globals_lock_);
141 ConditionVariable weak_globals_add_condition_ GUARDED_BY(weak_globals_lock_);
Elliott Hughesf2682d52011-08-15 16:37:04 -0700142};
143
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700144struct JNIEnvExt : public JNIEnv {
Elliott Hughes75770752011-08-24 17:52:38 -0700145 JNIEnvExt(Thread* self, JavaVMExt* vm);
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700146 ~JNIEnvExt();
Elliott Hughesbbd76712011-08-17 10:25:24 -0700147
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700148 void DumpReferenceTables(std::ostream& os)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700149 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700150
Elliott Hughes88c5c352012-03-15 18:49:48 -0700151 void SetCheckJniEnabled(bool enabled);
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700152
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700153 void PushFrame(int capacity);
154 void PopFrame();
155
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800156 static Offset SegmentStateOffset();
Ian Rogersdc51b792011-09-22 20:41:37 -0700157
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700158 static Offset LocalRefCookieOffset() {
159 return Offset(OFFSETOF_MEMBER(JNIEnvExt, local_ref_cookie));
160 }
161
Ian Rogers848871b2013-08-05 10:56:33 -0700162 static Offset SelfOffset() {
163 return Offset(OFFSETOF_MEMBER(JNIEnvExt, self));
164 }
165
Mathieu Chartier590fee92013-09-13 13:46:47 -0700166 jobject NewLocalRef(mirror::Object* obj) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
167 void DeleteLocalRef(jobject obj) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
168
Elliott Hughes85d15452011-09-16 17:33:01 -0700169 Thread* const self;
Elliott Hughes75770752011-08-24 17:52:38 -0700170 JavaVMExt* vm;
Carl Shapiroea4dca82011-08-01 13:45:38 -0700171
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700172 // Cookie used when using the local indirect reference table.
Ian Rogers5a7a74a2011-09-26 16:32:29 -0700173 uint32_t local_ref_cookie;
174
175 // JNI local references.
176 IndirectReferenceTable locals;
177
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700178 // Stack of cookies corresponding to PushLocalFrame/PopLocalFrame calls.
179 // TODO: to avoid leaks (and bugs), we need to clear this vector on entry (or return)
180 // to a native method.
181 std::vector<uint32_t> stacked_local_ref_cookies;
182
Elliott Hughesc5bfa8f2011-08-30 14:32:49 -0700183 // Frequently-accessed fields cached from JavaVM.
Elliott Hughes515a5bc2011-08-17 11:08:34 -0700184 bool check_jni;
185
Elliott Hughesa2501992011-08-26 19:39:54 -0700186 // How many nested "critical" JNI calls are we in?
187 int critical;
Carl Shapiro2ed144c2011-07-26 16:52:08 -0700188
Elliott Hughesbbd76712011-08-17 10:25:24 -0700189 // Entered JNI monitors, for bulk exit on thread detach.
Elliott Hughes02b48d12011-09-07 17:15:51 -0700190 ReferenceTable monitors;
Elliott Hughes6c1a3942011-08-17 15:00:06 -0700191
Elliott Hughesa2501992011-08-26 19:39:54 -0700192 // Used by -Xcheck:jni.
193 const JNINativeInterface* unchecked_functions;
Carl Shapiroea4dca82011-08-01 13:45:38 -0700194};
195
Elliott Hughesa2501992011-08-26 19:39:54 -0700196const JNINativeInterface* GetCheckJniNativeInterface();
197const JNIInvokeInterface* GetCheckJniInvokeInterface();
198
Ian Rogersdfcdf1a2011-10-10 17:50:35 -0700199// Used to save and restore the JNIEnvExt state when not going through code created by the JNI
200// compiler
201class ScopedJniEnvLocalRefState {
202 public:
Elliott Hughesa51a3dd2011-10-17 15:19:26 -0700203 explicit ScopedJniEnvLocalRefState(JNIEnvExt* env) : env_(env) {
Ian Rogersdfcdf1a2011-10-10 17:50:35 -0700204 saved_local_ref_cookie_ = env->local_ref_cookie;
205 env->local_ref_cookie = env->locals.GetSegmentState();
206 }
207
208 ~ScopedJniEnvLocalRefState() {
209 env_->locals.SetSegmentState(env_->local_ref_cookie);
210 env_->local_ref_cookie = saved_local_ref_cookie_;
211 }
212
213 private:
214 JNIEnvExt* env_;
215 uint32_t saved_local_ref_cookie_;
216 DISALLOW_COPY_AND_ASSIGN(ScopedJniEnvLocalRefState);
217};
218
Ian Rogersdf20fe02011-07-20 20:34:16 -0700219} // namespace art
Carl Shapiroea4dca82011-08-01 13:45:38 -0700220
Elliott Hughesb465ab02011-08-24 11:21:21 -0700221std::ostream& operator<<(std::ostream& os, const jobjectRefType& rhs);
222
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700223#endif // ART_RUNTIME_JNI_INTERNAL_H_