Merge pull request #120 from mkitti/independent_JNI

To summarize the net changes:

1. Library loading and core JVM initialization, and destroy are moved into the JNI module. This means __init__() no longer loads the dynamic library. This is entirely done on init()
2. penv is no longer a global in JavaCall and passed by default to ccall. All JNI calls from JavaCall do not require a JNIEnv pointer to be passed since that is handled entirely within JNI module now. penv can still be passed in as a named argument.
3. JavaCall.findjvm() just returns a tuple of Strings describing the library or libraries to load rather than setting a global.
4. Tests no longer use ccall directly but now refer to the wrapped versions in the JNI module.
As a side effect and for unknown reasons, JavaCall.init() and some functions now work on x86 Windows. This is somehow related to storing jnienv as a global.

Author: mkitti

appveyor.yml

@@ -1,13 +1,14 @@
 environment:
   matrix:
+  - julia_version: 1.0
+    platform: x64 # 64-bit
   - julia_version: 1
-  - julia_version: 1.3
-  - julia_version: 1.4
+    platform: x64 # 64-bit
+  - julia_version: 1
+    JAVA_HOME: C:\Program Files (x86)\Java\jdk1.8.0
+    platform: x86 # 32-bit
   - julia_version: nightly
-
-platform:
-  - x86 # 32-bit
-  - x64 # 64-bit
+    platform: x64 # 64-bit
 
 # # Uncomment the following lines to allow failures on nightly julia
 # # (tests will run but not make your overall status red)

src/JNI.jl

@@ -11,7 +11,6 @@ export JavaObject, JavaMetaClass,
 # using Sys: iswindows, islinux, isunix, isapple
 
 import DataStructures: OrderedSet
-import Libdl
 using Dates
 
 @static if Sys.iswindows()
@@ -30,6 +29,8 @@ include("core.jl")
 include("convert.jl")
 include("reflect.jl")
 
+Base.@deprecate_binding jnifunc JavaCall.JNI.jniref[]
+
 function __init__()
     global JULIA_COPY_STACKS = get(ENV, "JULIA_COPY_STACKS", "") ∈ ("1", "yes")
     if ! Sys.iswindows()
@@ -44,8 +45,6 @@ function __init__()
                   "Calling the JVM may result in undefined behavior.")
         end
     end
-    findjvm()
-    global create = Libdl.dlsym(libjvm, :JNI_CreateJavaVM)
 end
 
 

src/JavaCall.jl

@@ -4,23 +4,23 @@ convert(::Type{JObject}, str::AbstractString) = convert(JObject, JString(str))
 #Cast java object from S to T . Needed for polymorphic calls
 function convert(::Type{JavaObject{T}}, obj::JavaObject{S}) where {T,S}
     if isConvertible(T, S)   #Safe static cast
-        ptr = JNI.NewLocalRef(penv, obj.ptr)
+        ptr = JNI.NewLocalRef(obj.ptr)
         ptr === C_NULL && geterror()
         return JavaObject{T}(ptr)
     end
     isnull(obj) && throw(ArgumentError("Cannot convert NULL"))
-    realClass = JNI.GetObjectClass(penv, obj.ptr)
+    realClass = JNI.GetObjectClass(obj.ptr)
     if isConvertible(T, realClass)  #dynamic cast
-        ptr = JNI.NewLocalRef(penv, obj.ptr)
+        ptr = JNI.NewLocalRef(obj.ptr)
         ptr === C_NULL && geterror()
         return JavaObject{T}(ptr)
     end
     throw(JavaCallError("Cannot cast java object from $S to $T"))
 end
 
 #Is java type convertible from S to T.
-isConvertible(T, S) = JNI.IsAssignableFrom(penv, metaclass(S).ptr, metaclass(T).ptr) == JNI_TRUE
-isConvertible(T, S::Ptr{Nothing} ) = JNI.IsAssignableFrom(penv, S, metaclass(T).ptr) == JNI_TRUE
+isConvertible(T, S) = JNI.IsAssignableFrom(metaclass(S).ptr, metaclass(T).ptr) == JNI_TRUE
+isConvertible(T, S::Ptr{Nothing} ) = JNI.IsAssignableFrom(S, metaclass(T).ptr) == JNI_TRUE
 
 unsafe_convert(::Type{Ptr{Nothing}}, cls::JavaMetaClass) = cls.ptr
 
@@ -71,8 +71,8 @@ for (x, y, z) in [(:jboolean, :(JNI.NewBooleanArray), :(JNI.SetBooleanArrayRegio
         function convert_arg(argtype::Type{Array{$x,1}}, arg)
             carg = convert(argtype, arg)
             sz=length(carg)
-            arrayptr = $y(penv, sz)
-            $z(penv, arrayptr, 0, sz, carg)
+            arrayptr = $y(sz)
+            $z(arrayptr, 0, sz, carg)
             return carg, arrayptr
         end
     end
@@ -83,9 +83,9 @@ function convert_arg(argtype::Type{Array{T,1}}, arg) where T<:JavaObject
     carg = convert(argtype, arg)
     sz = length(carg)
     init = carg[1]
-    arrayptr = JNI.NewObjectArray(penv, sz, metaclass(T).ptr, init.ptr)
+    arrayptr = JNI.NewObjectArray(sz, metaclass(T).ptr, init.ptr)
     for i=2:sz
-        JNI.SetObjectArrayElement(penv, arrayptr, i-1, carg[i].ptr)
+        JNI.SetObjectArrayElement(arrayptr, i-1, carg[i].ptr)
     end
     return carg, arrayptr
 end
@@ -104,24 +104,24 @@ for (x, y, z) in [(:jboolean, :(JNI.GetBooleanArrayElements), :(JNI.ReleaseBoole
                   (:jdouble,  :(JNI.GetDoubleArrayElements),  :(JNI.ReleaseDoubleArrayElements)) ]
     m = quote
         function convert_result(rettype::Type{Array{$(x),1}}, result)
-            sz = JNI.GetArrayLength(penv, result)
-            arr = $y(penv, result, Ptr{jboolean}(C_NULL))
+            sz = JNI.GetArrayLength(result)
+            arr = $y(result, Ptr{jboolean}(C_NULL))
             jl_arr::Array = unsafe_wrap(Array, arr, Int(sz))
             jl_arr = deepcopy(jl_arr)
-            $z(penv, result, arr, Int32(0))
+            $z(result, arr, Int32(0))
             return jl_arr
         end
     end
     eval(m)
 end
 
 function convert_result(rettype::Type{Array{JavaObject{T},1}}, result) where T
-    sz = JNI.GetArrayLength(penv, result)
+    sz = JNI.GetArrayLength(result)
 
     ret = Array{JavaObject{T}}(undef, sz)
 
     for i=1:sz
-        a=JNI.GetObjectArrayElement(penv, result, i-1)
+        a=JNI.GetObjectArrayElement(result, i-1)
         ret[i] = JavaObject{T}(a)
     end
     return ret
@@ -130,33 +130,33 @@ end
 
 # covers return types like Vector{Vector{T}}
 function convert_result(rettype::Type{Array{T,1}}, result) where T
-    sz = JNI.GetArrayLength(penv, result)
+    sz = JNI.GetArrayLength(result)
 
     ret = Array{T}(undef, sz)
 
     for i=1:sz
-        a=JNI.GetObjectArrayElement(penv, result, i-1)
+        a=JNI.GetObjectArrayElement(result, i-1)
         ret[i] = convert_result(T, a)
     end
     return ret
 end
 
 
 function convert_result(rettype::Type{Array{JavaObject{T},2}}, result) where T
-    sz = JNI.GetArrayLength(penv, result)
+    sz = JNI.GetArrayLength(result)
     if sz == 0
         return Array{T}(undef, 0,0)
     end
-    a_1 = JNI.GetObjectArrayElement(penv, result, 0)
-    sz_1 = JNI.GetArrayLength(penv, a_1)
+    a_1 = JNI.GetObjectArrayElement(result, 0)
+    sz_1 = JNI.GetArrayLength(a_1)
     ret = Array{JavaObject{T}}(undef, sz, sz_1)
     for i=1:sz
-        a = JNI.GetObjectArrayElement(penv, result, i-1)
+        a = JNI.GetObjectArrayElement(result, i-1)
         # check that size of the current subarray is the same as for the first one
-        sz_a = JNI.GetArrayLength(penv, a)
+        sz_a = JNI.GetArrayLength(a)
         @assert(sz_a == sz_1, "Size of $(i)th subrarray is $sz_a, but size of the 1st subarray was $sz_1")
         for j=1:sz_1
-            x = JNI.GetObjectArrayElement(penv, a, j-1)
+            x = JNI.GetObjectArrayElement(a, j-1)
             ret[i, j] = JavaObject{T}(x)
         end
     end
@@ -166,17 +166,17 @@ end
 
 # matrices of primitive types and other arrays
 function convert_result(rettype::Type{Array{T,2}}, result) where T
-    sz = JNI.GetArrayLength(penv, result)
+    sz = JNI.GetArrayLength(result)
     if sz == 0
         return Array{T}(undef, 0,0)
     end
-    a_1 = JNI.GetObjectArrayElement(penv, result, 0)
-    sz_1 = JNI.GetArrayLength(penv, a_1)
+    a_1 = JNI.GetObjectArrayElement(result, 0)
+    sz_1 = JNI.GetArrayLength(a_1)
     ret = Array{T}(undef, sz, sz_1)
     for i=1:sz
-        a = JNI.GetObjectArrayElement(penv, result, i-1)
+        a = JNI.GetObjectArrayElement(result, i-1)
         # check that size of the current subarray is the same as for the first one
-        sz_a = JNI.GetArrayLength(penv, a)
+        sz_a = JNI.GetArrayLength(a)
         @assert(sz_a == sz_1, "Size of $(i)th subrarray is $sz_a, but size of the 1st subarray was $sz_1")
         ret[i, :] = convert_result(Vector{T}, a)
     end
@@ -252,10 +252,10 @@ end
 function unsafe_string(jstr::JString)  #jstr must be a jstring obtained via a JNI call
     if isnull(jstr); return ""; end #Return empty string to keep type stability. But this is questionable
     pIsCopy = Array{jboolean}(undef, 1)
-    #buf::Ptr{UInt8} = JNI.GetStringUTFChars(penv, jstr.ptr, pIsCopy)
-    buf = JNI.GetStringUTFChars(penv, jstr.ptr, pIsCopy)
+    #buf::Ptr{UInt8} = JNI.GetStringUTFChars(jstr.ptr, pIsCopy)
+    buf = JNI.GetStringUTFChars(jstr.ptr, pIsCopy)
     s = unsafe_string(buf)
-    JNI.ReleaseStringUTFChars(penv, jstr.ptr, buf)
+    JNI.ReleaseStringUTFChars(jstr.ptr, buf)
     return s
 end
 
@@ -269,11 +269,11 @@ for (x, y, z) in [(:jboolean, :(JNI.GetBooleanArrayElements), :(JNI.ReleaseBoole
                   (:jdouble,  :(JNI.GetDoubleArrayElements),  :(JNI.ReleaseDoubleArrayElements)) ]
     m = quote
         function convert(::Type{Array{$(x),1}}, obj::JObject)
-            sz = JNI.GetArrayLength(penv, obj.ptr)
-            arr = $y(penv, obj.ptr, Ptr{jboolean}(C_NULL))
+            sz = JNI.GetArrayLength(obj.ptr)
+            arr = $y(obj.ptr, Ptr{jboolean}(C_NULL))
             jl_arr::Array = unsafe_wrap(Array, arr, Int(sz))
             jl_arr = deepcopy(jl_arr)
-            $z(penv, obj.ptr, arr, Int32(0))
+            $z(obj.ptr, arr, Int32(0))
             return jl_arr
         end
     end
@@ -282,10 +282,10 @@ end
 
 
 function convert(::Type{Array{T, 1}}, obj::JObject) where T
-    sz = JNI.GetArrayLength(penv, obj.ptr)
+    sz = JNI.GetArrayLength(obj.ptr)
     ret = Array{T}(undef, sz)
     for i=1:sz
-        ptr = JNI.GetObjectArrayElement(penv, obj.ptr, i-1)
+        ptr = JNI.GetObjectArrayElement(obj.ptr, i-1)
         ret[i] = convert(T, JObject(ptr))
     end
     return ret

src/convert.jl

@@ -25,8 +25,8 @@ JavaObject{T}() where {T} = JavaObject{T}((),)
 
 function deleteref(x::JavaObject)
     if x.ptr == C_NULL; return; end
-    if (penv==C_NULL); return; end
-    JNI.DeleteLocalRef(penv, x.ptr)
+    if !JNI.is_env_loaded(); return; end;
+    JNI.DeleteLocalRef(x.ptr)
     x.ptr=C_NULL #Safety in case this function is called direcly, rather than at finalize
     return
 end
@@ -69,7 +69,7 @@ const JClassLoader = JavaObject{Symbol("java.lang.ClassLoader")}
 const JString = JavaObject{Symbol("java.lang.String")}
 
 function JString(str::AbstractString)
-    jstring = JNI.NewStringUTF(penv, String(str))
+    jstring = JNI.NewStringUTF(String(str))
     if jstring == C_NULL
         geterror()
     else
@@ -107,7 +107,7 @@ end
 function jnew(T::Symbol, argtypes::Tuple, args...)
     assertroottask_or_goodenv()
     sig = method_signature(Nothing, argtypes...)
-    jmethodId = JNI.GetMethodID(penv, metaclass(T).ptr, String("<init>"), sig)
+    jmethodId = JNI.GetMethodID(metaclass(T).ptr, String("<init>"), sig)
     if jmethodId == C_NULL
         throw(JavaCallError("No constructor for $T with signature $sig"))
     end
@@ -119,7 +119,7 @@ function jcall(typ::Type{JavaObject{T}}, method::AbstractString, rettype::Type,
                args... ) where T
     assertroottask_or_goodenv()
     sig = method_signature(rettype, argtypes...)
-    jmethodId = JNI.GetStaticMethodID(penv, metaclass(T).ptr, String(method), sig)
+    jmethodId = JNI.GetStaticMethodID(metaclass(T).ptr, String(method), sig)
     jmethodId==C_NULL && geterror(true)
     _jcall(metaclass(T), jmethodId, C_NULL, rettype, argtypes, args...)
 end
@@ -128,21 +128,21 @@ end
 function jcall(obj::JavaObject, method::AbstractString, rettype::Type, argtypes::Tuple, args... )
     assertroottask_or_goodenv()
     sig = method_signature(rettype, argtypes...)
-    jmethodId = JNI.GetMethodID(penv, metaclass(obj).ptr, String(method), sig)
+    jmethodId = JNI.GetMethodID(metaclass(obj).ptr, String(method), sig)
     jmethodId==C_NULL && geterror(true)
     _jcall(obj, jmethodId, C_NULL, rettype,  argtypes, args...)
 end
 
 function jfield(typ::Type{JavaObject{T}}, field::AbstractString, fieldType::Type) where T
     assertroottask_or_goodenv()
-    jfieldID  = JNI.GetStaticFieldID(penv, metaclass(T).ptr, String(field), signature(fieldType))
+    jfieldID  = JNI.GetStaticFieldID(metaclass(T).ptr, String(field), signature(fieldType))
     jfieldID==C_NULL && geterror(true)
     _jfield(metaclass(T), jfieldID, fieldType)
 end
 
 function jfield(obj::JavaObject, field::AbstractString, fieldType::Type)
     assertroottask_or_goodenv()
-    jfieldID  = JNI.GetFieldID(penv, metaclass(obj).ptr, String(field), signature(fieldType))
+    jfieldID  = JNI.GetFieldID(metaclass(obj).ptr, String(field), signature(fieldType))
     jfieldID==C_NULL && geterror(true)
     _jfield(obj, jfieldID, fieldType)
 end
@@ -159,7 +159,7 @@ for (x, y, z) in [(:jboolean, :(JNI.GetBooleanField), :(JNI.GetStaticBooleanFiel
     m = quote
         function _jfield(obj, jfieldID::Ptr{Nothing}, fieldType::Type{$(x)})
             callmethod = ifelse( typeof(obj)<:JavaObject, $y , $z )
-            result = callmethod(penv, obj.ptr, jfieldID)
+            result = callmethod(obj.ptr, jfieldID)
             result==C_NULL && geterror()
             return convert_result(fieldType, result)
         end
@@ -169,7 +169,7 @@ end
 
 function _jfield(obj, jfieldID::Ptr{Nothing}, fieldType::Type)
     callmethod = ifelse( typeof(obj)<:JavaObject, JNI.GetObjectField , JNI.GetStaticObjectField )
-    result = callmethod(penv, obj.ptr, jfieldID)
+    result = callmethod(obj.ptr, jfieldID)
     result==C_NULL && geterror()
     return convert_result(fieldType, result)
 end
@@ -195,7 +195,7 @@ for (x, y, z) in [(:jboolean, :(JNI.CallBooleanMethodA), :(JNI.CallStaticBoolean
             @assert jmethodId != C_NULL
             isnull(obj) && throw(JavaCallError("Attempt to call method on Java NULL"))
             savedArgs, convertedArgs = convert_args(argtypes, args...)
-            result = callmethod(penv, obj.ptr, jmethodId, convertedArgs)
+            result = callmethod(obj.ptr, jmethodId, convertedArgs)
             result==C_NULL && geterror()
             result == nothing && (return)
             return convert_result(rettype, result)
@@ -219,7 +219,7 @@ function _jcall(obj, jmethodId::Ptr{Nothing}, callmethod::Union{Function,Ptr{Not
     @assert jmethodId != C_NULL
     isnull(obj) && error("Attempt to call method on Java NULL")
     savedArgs, convertedArgs = convert_args(argtypes, args...)
-    result = callmethod(penv, obj.ptr, jmethodId, convertedArgs)
+    result = callmethod(obj.ptr, jmethodId, convertedArgs)
     result==C_NULL && geterror()
     return convert_result(rettype, result)
 end
@@ -229,7 +229,7 @@ global const _jmc_cache = Dict{Symbol, JavaMetaClass}()
 
 function _metaclass(class::Symbol)
     jclass=javaclassname(class)
-    jclassptr = JNI.FindClass(penv, jclass)
+    jclassptr = JNI.FindClass(jclass)
     jclassptr == C_NULL && throw(JavaCallError("Class Not Found $jclass"))
     return JavaMetaClass(class, jclassptr)
 end
@@ -247,21 +247,21 @@ metaclass(::JavaObject{T}) where {T} = metaclass(T)
 javaclassname(class::Symbol) = replace(string(class), "."=>"/")
 
 function geterror(allow=false)
-    isexception = JNI.ExceptionCheck(penv)
+    isexception = JNI.ExceptionCheck()
 
     if isexception == JNI_TRUE
-        jthrow = JNI.ExceptionOccurred(penv)
+        jthrow = JNI.ExceptionOccurred()
         jthrow==C_NULL && throw(JavaCallError("Java Exception thrown, but no details could be retrieved from the JVM"))
-        JNI.ExceptionDescribe(penv ) #Print java stackstrace to stdout
-        JNI.ExceptionClear(penv )
-        jclass = JNI.FindClass(penv, "java/lang/Throwable")
+        JNI.ExceptionDescribe() #Print java stackstrace to stdout
+        JNI.ExceptionClear()
+        jclass = JNI.FindClass("java/lang/Throwable")
         jclass==C_NULL && throw(JavaCallError("Java Exception thrown, but no details could be retrieved from the JVM"))
-        jmethodId=JNI.GetMethodID(penv, jclass, "toString", "()Ljava/lang/String;")
+        jmethodId=JNI.GetMethodID(jclass, "toString", "()Ljava/lang/String;")
         jmethodId==C_NULL && throw(JavaCallError("Java Exception thrown, but no details could be retrieved from the JVM"))
-        res = JNI.CallObjectMethodA(penv, jthrow, jmethodId, Int[])
+        res = JNI.CallObjectMethodA(jthrow, jmethodId, Int[])
         res==C_NULL && throw(JavaCallError("Java Exception thrown, but no details could be retrieved from the JVM"))
         msg = unsafe_string(JString(res))
-        JNI.DeleteLocalRef(penv, jthrow)
+        JNI.DeleteLocalRef(jthrow)
         throw(JavaCallError(string("Error calling Java: ",msg)))
     else
         if allow==false

src/core.jl

@@ -309,6 +309,7 @@ JNINativeInterface() = JNINativeInterface(repeat([C_NULL],233)...)
 struct JNIEnv
     JNINativeInterface_::Ptr{JNINativeInterface}
 end
+JNIEnv() = JNIEnv(C_NULL)
 
 struct JNIInvokeInterface #struct JNIInvokeInterface_ {
     reserved0::Ptr{Nothing} #void *reserved0;
@@ -325,6 +326,7 @@ struct JNIInvokeInterface #struct JNIInvokeInterface_ {
 
     AttachCurrentThreadAsDaemon::Ptr{Nothing} #jint (JNICALL *AttachCurrentThreadAsDaemon)(JavaVM *vm, void **penv, void *args);
 end
+JNIInvokeInterface() = JNIInvokeInterface(repeat([C_NULL],8)...)
 
 struct JavaVM
     JNIInvokeInterface_::Ptr{JNIInvokeInterface}