duke@435: /*
mikael@6198:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #include "precompiled.hpp"
stefank@2314: #include "classfile/javaClasses.hpp"
stefank@2314: #include "classfile/systemDictionary.hpp"
stefank@2314: #include "classfile/vmSymbols.hpp"
stefank@2314: #include "memory/oopFactory.hpp"
stefank@2314: #include "memory/resourceArea.hpp"
stefank@2314: #include "memory/universe.inline.hpp"
stefank@2314: #include "oops/instanceKlass.hpp"
coleenp@4037: #include "oops/method.hpp"
stefank@2314: #include "oops/oop.inline.hpp"
coleenp@2497: #include "oops/symbol.hpp"
stefank@2314: #include "prims/jvm_misc.hpp"
stefank@2314: #include "prims/nativeLookup.hpp"
stefank@2314: #include "runtime/arguments.hpp"
stefank@2314: #include "runtime/handles.inline.hpp"
stefank@2314: #include "runtime/javaCalls.hpp"
stefank@2314: #include "runtime/sharedRuntime.hpp"
stefank@2314: #include "runtime/signature.hpp"
jprovino@4542: #include "utilities/macros.hpp"
stefank@2314: #ifdef TARGET_OS_FAMILY_linux
stefank@2314: # include "os_linux.inline.hpp"
stefank@2314: #endif
stefank@2314: #ifdef TARGET_OS_FAMILY_solaris
stefank@2314: # include "os_solaris.inline.hpp"
stefank@2314: #endif
stefank@2314: #ifdef TARGET_OS_FAMILY_windows
stefank@2314: # include "os_windows.inline.hpp"
stefank@2314: #endif
goetz@6461: #ifdef TARGET_OS_FAMILY_aix
goetz@6461: # include "os_aix.inline.hpp"
goetz@6461: #endif
never@3156: #ifdef TARGET_OS_FAMILY_bsd
never@3156: # include "os_bsd.inline.hpp"
never@3156: #endif
duke@435: 
duke@435: 
coleenp@2497: static void mangle_name_on(outputStream* st, Symbol* name, int begin, int end) {
duke@435:   char* bytes = (char*)name->bytes() + begin;
duke@435:   char* end_bytes = (char*)name->bytes() + end;
duke@435:   while (bytes < end_bytes) {
duke@435:     jchar c;
duke@435:     bytes = UTF8::next(bytes, &c);
duke@435:     if (c <= 0x7f && isalnum(c)) {
duke@435:       st->put((char) c);
duke@435:     } else {
duke@435:            if (c == '_') st->print("_1");
duke@435:       else if (c == '/') st->print("_");
duke@435:       else if (c == ';') st->print("_2");
duke@435:       else if (c == '[') st->print("_3");
duke@435:       else               st->print("_%.5x", c);
duke@435:     }
duke@435:   }
duke@435: }
duke@435: 
duke@435: 
coleenp@2497: static void mangle_name_on(outputStream* st, Symbol* name) {
duke@435:   mangle_name_on(st, name, 0, name->utf8_length());
duke@435: }
duke@435: 
duke@435: 
duke@435: char* NativeLookup::pure_jni_name(methodHandle method) {
duke@435:   stringStream st;
duke@435:   // Prefix
duke@435:   st.print("Java_");
duke@435:   // Klass name
duke@435:   mangle_name_on(&st, method->klass_name());
duke@435:   st.print("_");
duke@435:   // Method name
duke@435:   mangle_name_on(&st, method->name());
duke@435:   return st.as_string();
duke@435: }
duke@435: 
duke@435: 
never@3500: char* NativeLookup::critical_jni_name(methodHandle method) {
never@3500:   stringStream st;
never@3500:   // Prefix
never@3500:   st.print("JavaCritical_");
never@3500:   // Klass name
never@3500:   mangle_name_on(&st, method->klass_name());
never@3500:   st.print("_");
never@3500:   // Method name
never@3500:   mangle_name_on(&st, method->name());
never@3500:   return st.as_string();
never@3500: }
never@3500: 
never@3500: 
duke@435: char* NativeLookup::long_jni_name(methodHandle method) {
duke@435:   // Signature ignore the wrapping parenteses and the trailing return type
duke@435:   stringStream st;
coleenp@2497:   Symbol* signature = method->signature();
duke@435:   st.print("__");
duke@435:   // find ')'
duke@435:   int end;
duke@435:   for (end = 0; end < signature->utf8_length() && signature->byte_at(end) != ')'; end++);
duke@435:   // skip first '('
duke@435:   mangle_name_on(&st, signature, 1, end);
duke@435:   return st.as_string();
duke@435: }
duke@435: 
duke@435: extern "C" {
duke@435:   void JNICALL JVM_RegisterUnsafeMethods(JNIEnv *env, jclass unsafecls);
jrose@1145:   void JNICALL JVM_RegisterMethodHandleMethods(JNIEnv *env, jclass unsafecls);
duke@435:   void JNICALL JVM_RegisterPerfMethods(JNIEnv *env, jclass perfclass);
mgerdin@3619:   void JNICALL JVM_RegisterWhiteBoxMethods(JNIEnv *env, jclass wbclass);
duke@435: }
duke@435: 
jrose@2638: #define CC (char*)  /* cast a literal from (const char*) */
jrose@2638: #define FN_PTR(f) CAST_FROM_FN_PTR(void*, &f)
jrose@2638: 
jrose@2638: static JNINativeMethod lookup_special_native_methods[] = {
jrose@2638:   { CC"Java_sun_misc_Unsafe_registerNatives",                      NULL, FN_PTR(JVM_RegisterUnsafeMethods)       },
jrose@2639:   { CC"Java_java_lang_invoke_MethodHandleNatives_registerNatives", NULL, FN_PTR(JVM_RegisterMethodHandleMethods) },
mgerdin@3619:   { CC"Java_sun_misc_Perf_registerNatives",                        NULL, FN_PTR(JVM_RegisterPerfMethods)         },
mgerdin@3619:   { CC"Java_sun_hotspot_WhiteBox_registerNatives",                 NULL, FN_PTR(JVM_RegisterWhiteBoxMethods)     },
jrose@2638: };
jrose@2638: 
duke@435: static address lookup_special_native(char* jni_name) {
jrose@2638:   int count = sizeof(lookup_special_native_methods) / sizeof(JNINativeMethod);
mikael@5838:   for (int i = 0; i < count; i++) {
jrose@2638:     // NB: To ignore the jni prefix and jni postfix strstr is used matching.
jrose@2638:     if (strstr(jni_name, lookup_special_native_methods[i].name) != NULL) {
jrose@2638:       return CAST_FROM_FN_PTR(address, lookup_special_native_methods[i].fnPtr);
duke@435:     }
duke@435:   }
duke@435:   return NULL;
duke@435: }
duke@435: 
duke@435: address NativeLookup::lookup_style(methodHandle method, char* pure_name, const char* long_name, int args_size, bool os_style, bool& in_base_library, TRAPS) {
duke@435:   address entry;
duke@435:   // Compute complete JNI name for style
duke@435:   stringStream st;
duke@435:   if (os_style) os::print_jni_name_prefix_on(&st, args_size);
duke@435:   st.print_raw(pure_name);
duke@435:   st.print_raw(long_name);
duke@435:   if (os_style) os::print_jni_name_suffix_on(&st, args_size);
duke@435:   char* jni_name = st.as_string();
duke@435: 
duke@435:   // If the loader is null we have a system class, so we attempt a lookup in
duke@435:   // the native Java library. This takes care of any bootstrapping problems.
duke@435:   // Note: It is critical for bootstrapping that Java_java_lang_ClassLoader_00024NativeLibrary_find
duke@435:   // gets found the first time around - otherwise an infinite loop can occure. This is
duke@435:   // another VM/library dependency
coleenp@4251:   Handle loader(THREAD, method->method_holder()->class_loader());
duke@435:   if (loader.is_null()) {
duke@435:     entry = lookup_special_native(jni_name);
duke@435:     if (entry == NULL) {
ikrylov@2322:        entry = (address) os::dll_lookup(os::native_java_library(), jni_name);
duke@435:     }
duke@435:     if (entry != NULL) {
duke@435:       in_base_library = true;
duke@435:       return entry;
duke@435:     }
duke@435:   }
duke@435: 
duke@435:   // Otherwise call static method findNative in ClassLoader
never@1577:   KlassHandle   klass (THREAD, SystemDictionary::ClassLoader_klass());
duke@435:   Handle name_arg = java_lang_String::create_from_str(jni_name, CHECK_NULL);
duke@435: 
duke@435:   JavaValue result(T_LONG);
duke@435:   JavaCalls::call_static(&result,
duke@435:                          klass,
coleenp@2497:                          vmSymbols::findNative_name(),
coleenp@2497:                          vmSymbols::classloader_string_long_signature(),
duke@435:                          // Arguments
duke@435:                          loader,
duke@435:                          name_arg,
duke@435:                          CHECK_NULL);
duke@435:   entry = (address) (intptr_t) result.get_jlong();
duke@435: 
duke@435:   if (entry == NULL) {
duke@435:     // findNative didn't find it, if there are any agent libraries look in them
duke@435:     AgentLibrary* agent;
duke@435:     for (agent = Arguments::agents(); agent != NULL; agent = agent->next()) {
ikrylov@2322:       entry = (address) os::dll_lookup(agent->os_lib(), jni_name);
duke@435:       if (entry != NULL) {
duke@435:         return entry;
duke@435:       }
duke@435:     }
duke@435:   }
duke@435: 
duke@435:   return entry;
duke@435: }
duke@435: 
duke@435: 
never@3500: address NativeLookup::lookup_critical_style(methodHandle method, char* pure_name, const char* long_name, int args_size, bool os_style) {
never@3500:   if (!method->has_native_function()) {
never@3500:     return NULL;
never@3500:   }
never@3500: 
never@3500:   address current_entry = method->native_function();
never@3500: 
never@3500:   char dll_name[JVM_MAXPATHLEN];
never@3500:   int offset;
never@3500:   if (os::dll_address_to_library_name(current_entry, dll_name, sizeof(dll_name), &offset)) {
never@3500:     char ebuf[32];
never@3500:     void* dll = os::dll_load(dll_name, ebuf, sizeof(ebuf));
never@3500:     if (dll != NULL) {
never@3500:       // Compute complete JNI name for style
never@3500:       stringStream st;
never@3500:       if (os_style) os::print_jni_name_prefix_on(&st, args_size);
never@3500:       st.print_raw(pure_name);
never@3500:       st.print_raw(long_name);
never@3500:       if (os_style) os::print_jni_name_suffix_on(&st, args_size);
never@3500:       char* jni_name = st.as_string();
never@3500:       return (address)os::dll_lookup(dll, jni_name);
never@3500:     }
never@3500:   }
never@3500: 
never@3500:   return NULL;
never@3500: }
never@3500: 
never@3500: 
duke@435: // Check all the formats of native implementation name to see if there is one
duke@435: // for the specified method.
duke@435: address NativeLookup::lookup_entry(methodHandle method, bool& in_base_library, TRAPS) {
duke@435:   address entry = NULL;
duke@435:   in_base_library = false;
duke@435:   // Compute pure name
duke@435:   char* pure_name = pure_jni_name(method);
duke@435: 
duke@435:   // Compute argument size
duke@435:   int args_size = 1                             // JNIEnv
duke@435:                 + (method->is_static() ? 1 : 0) // class for static methods
duke@435:                 + method->size_of_parameters(); // actual parameters
duke@435: 
duke@435: 
duke@435:   // 1) Try JNI short style
duke@435:   entry = lookup_style(method, pure_name, "",        args_size, true,  in_base_library, CHECK_NULL);
duke@435:   if (entry != NULL) return entry;
duke@435: 
duke@435:   // Compute long name
duke@435:   char* long_name = long_jni_name(method);
duke@435: 
duke@435:   // 2) Try JNI long style
duke@435:   entry = lookup_style(method, pure_name, long_name, args_size, true,  in_base_library, CHECK_NULL);
duke@435:   if (entry != NULL) return entry;
duke@435: 
duke@435:   // 3) Try JNI short style without os prefix/suffix
duke@435:   entry = lookup_style(method, pure_name, "",        args_size, false, in_base_library, CHECK_NULL);
duke@435:   if (entry != NULL) return entry;
duke@435: 
duke@435:   // 4) Try JNI long style without os prefix/suffix
duke@435:   entry = lookup_style(method, pure_name, long_name, args_size, false, in_base_library, CHECK_NULL);
duke@435: 
duke@435:   return entry; // NULL indicates not found
duke@435: }
duke@435: 
never@3500: // Check all the formats of native implementation name to see if there is one
never@3500: // for the specified method.
never@3500: address NativeLookup::lookup_critical_entry(methodHandle method) {
never@3500:   if (!CriticalJNINatives) return NULL;
never@3500: 
never@3500:   if (method->is_synchronized() ||
never@3500:       !method->is_static()) {
never@3500:     // Only static non-synchronized methods are allowed
never@3500:     return NULL;
never@3500:   }
never@3500: 
never@3500:   ResourceMark rm;
never@3500:   address entry = NULL;
never@3500: 
never@3500:   Symbol* signature = method->signature();
never@3500:   for (int end = 0; end < signature->utf8_length(); end++) {
never@3500:     if (signature->byte_at(end) == 'L') {
never@3500:       // Don't allow object types
never@3500:       return NULL;
never@3500:     }
never@3500:   }
never@3500: 
never@3500:   // Compute critical name
never@3500:   char* critical_name = critical_jni_name(method);
never@3500: 
never@3500:   // Compute argument size
never@3500:   int args_size = 1                             // JNIEnv
never@3500:                 + (method->is_static() ? 1 : 0) // class for static methods
never@3500:                 + method->size_of_parameters(); // actual parameters
never@3500: 
never@3500: 
never@3500:   // 1) Try JNI short style
never@3500:   entry = lookup_critical_style(method, critical_name, "",        args_size, true);
never@3500:   if (entry != NULL) return entry;
never@3500: 
never@3500:   // Compute long name
never@3500:   char* long_name = long_jni_name(method);
never@3500: 
never@3500:   // 2) Try JNI long style
never@3500:   entry = lookup_critical_style(method, critical_name, long_name, args_size, true);
never@3500:   if (entry != NULL) return entry;
never@3500: 
never@3500:   // 3) Try JNI short style without os prefix/suffix
never@3500:   entry = lookup_critical_style(method, critical_name, "",        args_size, false);
never@3500:   if (entry != NULL) return entry;
never@3500: 
never@3500:   // 4) Try JNI long style without os prefix/suffix
never@3500:   entry = lookup_critical_style(method, critical_name, long_name, args_size, false);
never@3500: 
never@3500:   return entry; // NULL indicates not found
never@3500: }
never@3500: 
duke@435: // Check if there are any JVM TI prefixes which have been applied to the native method name.
duke@435: // If any are found, remove them before attemping the look up of the
duke@435: // native implementation again.
duke@435: // See SetNativeMethodPrefix in the JVM TI Spec for more details.
duke@435: address NativeLookup::lookup_entry_prefixed(methodHandle method, bool& in_base_library, TRAPS) {
jprovino@4165: #if INCLUDE_JVMTI
duke@435:   ResourceMark rm(THREAD);
duke@435: 
duke@435:   int prefix_count;
duke@435:   char** prefixes = JvmtiExport::get_all_native_method_prefixes(&prefix_count);
duke@435:   char* in_name = method->name()->as_C_string();
duke@435:   char* wrapper_name = in_name;
duke@435:   // last applied prefix will be first -- go backwards
duke@435:   for (int i = prefix_count-1; i >= 0; i--) {
duke@435:     char* prefix = prefixes[i];
duke@435:     size_t prefix_len = strlen(prefix);
duke@435:     if (strncmp(prefix, wrapper_name, prefix_len) == 0) {
duke@435:       // has this prefix remove it
duke@435:       wrapper_name += prefix_len;
duke@435:     }
duke@435:   }
duke@435:   if (wrapper_name != in_name) {
duke@435:     // we have a name for a wrapping method
duke@435:     int wrapper_name_len = (int)strlen(wrapper_name);
coleenp@2497:     TempNewSymbol wrapper_symbol = SymbolTable::probe(wrapper_name, wrapper_name_len);
coleenp@2497:     if (wrapper_symbol != NULL) {
duke@435:       KlassHandle kh(method->method_holder());
hseigel@4278:       Method* wrapper_method = kh()->lookup_method(wrapper_symbol,
duke@435:                                                                   method->signature());
duke@435:       if (wrapper_method != NULL && !wrapper_method->is_native()) {
duke@435:         // we found a wrapper method, use its native entry
duke@435:         method->set_is_prefixed_native();
duke@435:         return lookup_entry(wrapper_method, in_base_library, THREAD);
duke@435:       }
duke@435:     }
duke@435:   }
jprovino@4165: #endif // INCLUDE_JVMTI
duke@435:   return NULL;
duke@435: }
duke@435: 
duke@435: address NativeLookup::lookup_base(methodHandle method, bool& in_base_library, TRAPS) {
duke@435:   address entry = NULL;
duke@435:   ResourceMark rm(THREAD);
duke@435: 
duke@435:   entry = lookup_entry(method, in_base_library, THREAD);
duke@435:   if (entry != NULL) return entry;
duke@435: 
duke@435:   // standard native method resolution has failed.  Check if there are any
duke@435:   // JVM TI prefixes which have been applied to the native method name.
duke@435:   entry = lookup_entry_prefixed(method, in_base_library, THREAD);
duke@435:   if (entry != NULL) return entry;
duke@435: 
duke@435:   // Native function not found, throw UnsatisfiedLinkError
duke@435:   THROW_MSG_0(vmSymbols::java_lang_UnsatisfiedLinkError(),
duke@435:               method->name_and_sig_as_C_string());
duke@435: }
duke@435: 
duke@435: 
duke@435: address NativeLookup::lookup(methodHandle method, bool& in_base_library, TRAPS) {
duke@435:   if (!method->has_native_function()) {
twisti@5108:     address entry = lookup_base(method, in_base_library, CHECK_NULL);
duke@435:     method->set_native_function(entry,
coleenp@4037:       Method::native_bind_event_is_interesting);
duke@435:     // -verbose:jni printing
duke@435:     if (PrintJNIResolving) {
duke@435:       ResourceMark rm(THREAD);
duke@435:       tty->print_cr("[Dynamic-linking native method %s.%s ... JNI]",
coleenp@4251:         method->method_holder()->external_name(),
duke@435:         method->name()->as_C_string());
duke@435:     }
duke@435:   }
duke@435:   return method->native_function();
duke@435: }
duke@435: 
duke@435: address NativeLookup::base_library_lookup(const char* class_name, const char* method_name, const char* signature) {
duke@435:   EXCEPTION_MARK;
duke@435:   bool in_base_library = true;  // SharedRuntime inits some math methods.
coleenp@2497:   TempNewSymbol c_name = SymbolTable::new_symbol(class_name,  CATCH);
coleenp@2497:   TempNewSymbol m_name = SymbolTable::new_symbol(method_name, CATCH);
coleenp@2497:   TempNewSymbol s_name = SymbolTable::new_symbol(signature,   CATCH);
duke@435: 
duke@435:   // Find the class
coleenp@4037:   Klass* k = SystemDictionary::resolve_or_fail(c_name, true, CATCH);
duke@435:   instanceKlassHandle klass (THREAD, k);
duke@435: 
duke@435:   // Find method and invoke standard lookup
duke@435:   methodHandle method (THREAD,
coleenp@2497:                        klass->uncached_lookup_method(m_name, s_name));
duke@435:   address result = lookup(method, in_base_library, CATCH);
duke@435:   assert(in_base_library, "must be in basic library");
duke@435:   guarantee(result != NULL, "must be non NULL");
duke@435:   return result;
duke@435: }