java_vm_ext.h revision 91c2f0cde2a009bd52aa1c3d1dee705cc02c932f
168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers/* 268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * Copyright (C) 2011 The Android Open Source Project 368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * 468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * Licensed under the Apache License, Version 2.0 (the "License"); 568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * you may not use this file except in compliance with the License. 668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * You may obtain a copy of the License at 768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * 868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * http://www.apache.org/licenses/LICENSE-2.0 968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * 1068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * Unless required by applicable law or agreed to in writing, software 1168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * distributed under the License is distributed on an "AS IS" BASIS, 1268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * See the License for the specific language governing permissions and 1468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * limitations under the License. 1568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers */ 1668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 1768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers#ifndef ART_RUNTIME_JAVA_VM_EXT_H_ 1868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers#define ART_RUNTIME_JAVA_VM_EXT_H_ 1968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 2068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers#include "jni.h" 2168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 2268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers#include "base/macros.h" 2368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers#include "base/mutex.h" 2468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers#include "indirect_reference_table.h" 2568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers#include "reference_table.h" 2668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 2768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogersnamespace art { 2868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 2968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogersnamespace mirror { 3068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers class ArtMethod; 3168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers class Array; 3268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers} // namespace mirror 3368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 3468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogersclass Libraries; 3568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogersclass ParsedOptions; 3668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogersclass Runtime; 3768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 3868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogersclass JavaVMExt : public JavaVM { 3968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers public: 4068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers JavaVMExt(Runtime* runtime, ParsedOptions* options); 4168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers ~JavaVMExt(); 4268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 4368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool ForceCopy() const { 4468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers return force_copy_; 4568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers } 4668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 4768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool IsCheckJniEnabled() const { 4868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers return check_jni_; 4968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers } 5068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 5168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool IsTracingEnabled() const { 5268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers return tracing_enabled_; 5368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers } 5468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 5568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers Runtime* GetRuntime() const { 5668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers return runtime_; 5768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers } 5868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 5968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void SetCheckJniAbortHook(void (*hook)(void*, const std::string&), void* data) { 6068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers check_jni_abort_hook_ = hook; 6168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers check_jni_abort_hook_data_ = data; 6268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers } 6368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 6468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Aborts execution unless there is an abort handler installed in which case it will return. Its 6568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // therefore important that callers return after aborting as otherwise code following the abort 6668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // will be executed in the abort handler case. 6768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void JniAbort(const char* jni_function_name, const char* msg); 6868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 6968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void JniAbortV(const char* jni_function_name, const char* fmt, va_list ap); 7068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 7168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void JniAbortF(const char* jni_function_name, const char* fmt, ...) 7268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers __attribute__((__format__(__printf__, 3, 4))); 7368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 7468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // If both "-Xcheck:jni" and "-Xjnitrace:" are enabled, we print trace messages 7568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // when a native method that matches the -Xjnitrace argument calls a JNI function 7668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // such as NewByteArray. 7768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // If -verbose:third-party-jni is on, we want to log any JNI function calls 7868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // made by a third-party native method. 7968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool ShouldTrace(mirror::ArtMethod* method) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 8068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 8168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers /** 8268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * Loads the given shared library. 'path' is an absolute pathname. 8368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * 8468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * Returns 'true' on success. On failure, sets 'detail' to a 8568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * human-readable description of the error. 8668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers */ 8768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool LoadNativeLibrary(JNIEnv* env, const std::string& path, jobject javaLoader, 8868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers std::string* error_msg); 8968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 9068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers /** 9168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * Returns a pointer to the code for the native method 'm', found 9268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers * using dlsym(3) on every native library that's been loaded so far. 9368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers */ 9468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void* FindCodeForNativeMethod(mirror::ArtMethod* m) 9568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 9668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 9768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void DumpForSigQuit(std::ostream& os) 982e158932354e5950eb59c79498ab46b0586885fdMathieu Chartier LOCKS_EXCLUDED(Locks::jni_libraries_lock_, globals_lock_, weak_globals_lock_); 9968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 10068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void DumpReferenceTables(std::ostream& os) 10168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 10268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 10368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool SetCheckJniEnabled(bool enabled); 10468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 10568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void VisitRoots(RootCallback* callback, void* arg) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 10668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 10768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void DisallowNewWeakGlobals() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); 10868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 10968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void AllowNewWeakGlobals() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 11068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 11168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers jobject AddGlobalRef(Thread* self, mirror::Object* obj) 11268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 11368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 11468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers jweak AddWeakGlobalRef(Thread* self, mirror::Object* obj) 11568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 11668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 11768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void DeleteGlobalRef(Thread* self, jobject obj); 11868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 11968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void DeleteWeakGlobalRef(Thread* self, jweak obj); 12068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 12168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void SweepJniWeakGlobals(IsMarkedCallback* callback, void* arg) 12268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 12368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 12468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers mirror::Object* DecodeGlobal(Thread* self, IndirectRef ref) 12568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 12668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 12768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers mirror::Object* DecodeWeakGlobal(Thread* self, IndirectRef ref) 12868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 12968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 13068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers const JNIInvokeInterface* GetUncheckedFunctions() const { 13168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers return unchecked_functions_; 13268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers } 13368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 13491c2f0cde2a009bd52aa1c3d1dee705cc02c932fMathieu Chartier void TrimGlobals() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) 13591c2f0cde2a009bd52aa1c3d1dee705cc02c932fMathieu Chartier LOCKS_EXCLUDED(globals_lock_); 13691c2f0cde2a009bd52aa1c3d1dee705cc02c932fMathieu Chartier 13768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers private: 13868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers Runtime* const runtime_; 13968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 14068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Used for testing. By default, we'll LOG(FATAL) the reason. 14168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void (*check_jni_abort_hook_)(void* data, const std::string& reason); 14268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers void* check_jni_abort_hook_data_; 14368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 14468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Extra checking. 14568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool check_jni_; 14668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool force_copy_; 14768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers const bool tracing_enabled_; 14868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 14968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Extra diagnostics. 15068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers const std::string trace_; 15168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 15268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // JNI global references. 15368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers ReaderWriterMutex globals_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 15468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Not guarded by globals_lock since we sometimes use SynchronizedGet in Thread::DecodeJObject. 15568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers IndirectReferenceTable globals_; 15668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 15768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers std::unique_ptr<Libraries> libraries_ GUARDED_BY(Locks::jni_libraries_lock_); 15868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 15968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Used by -Xcheck:jni. 16068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers const JNIInvokeInterface* const unchecked_functions_; 16168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 16268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // JNI weak global references. 16368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers Mutex weak_globals_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 16468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Since weak_globals_ contain weak roots, be careful not to 16568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // directly access the object references in it. Use Get() with the 16668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // read barrier enabled. 16768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers IndirectReferenceTable weak_globals_ GUARDED_BY(weak_globals_lock_); 16868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers bool allow_new_weak_globals_ GUARDED_BY(weak_globals_lock_); 16968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers ConditionVariable weak_globals_add_condition_ GUARDED_BY(weak_globals_lock_); 17068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 17168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers DISALLOW_COPY_AND_ASSIGN(JavaVMExt); 17268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers}; 17368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 17468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers} // namespace art 17568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 17668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers#endif // ART_RUNTIME_JAVA_VM_EXT_H_ 177