]> sigrok.org Git - libsigrok.git/blobdiff - bindings/java/org/sigrok/core/classes/classes.i
Java: Fix leaking global refs
[libsigrok.git] / bindings / java / org / sigrok / core / classes / classes.i
index 7a61bfd55d2610b7bfa5b0da333b7868fbfaaeaa..dda333df09dc7762a6057779f93abede14995e91 100644 (file)
@@ -72,10 +72,10 @@ namespace Glib {
   jclass Value = jenv->FindClass("org/sigrok/core/classes/" #JValue);
   jmethodID Value_init = jenv->GetMethodID(Value, "<init>", "(JZ)V");
   $result = jenv->NewObject(Vector, Vector_init);
-  jlong value;
+  jlong value = 0;
   for (auto entry : $1)
   {
-    value = reinterpret_cast<intptr_t>(new CValue(entry));
+    *(CValue **) &value = new CValue(entry);
     jenv->CallObjectMethod($result, Vector_add,
       jenv->NewObject(Value, Value_init, value, true));
   }
@@ -146,10 +146,11 @@ MAP_COMMON(std::string, std::shared_ptr<sigrok::ClassName>, String, ClassName)
   jclass Value = jenv->FindClass("org/sigrok/core/classes/" #ClassName);
   jmethodID Value_init = jenv->GetMethodID(Value, "<init>", "(JZ)V");
   $result = jenv->NewObject(HashMap, HashMap_init);
-  jlong value;
+  jlong value = 0;
   for (auto entry : $1)
   {
-    value = reinterpret_cast<intptr_t>(new std::shared_ptr< sigrok::ClassName>(entry.second));
+    *(std::shared_ptr< sigrok::ClassName > **)&value =
+      new std::shared_ptr< sigrok::ClassName>(entry.second);
     jenv->CallObjectMethod($result, HashMap_put,
       jenv->NewStringUTF(entry.first.c_str()),
       jenv->NewObject(Value, Value_init, value, true));
@@ -180,12 +181,12 @@ MAP_COMMON(const sigrok::ConfigKey *, Glib::VariantBase, ConfigKey, Variant)
   jclass Variant = jenv->FindClass("org/sigrok/core/classes/Variant");
   jmethodID Variant_init = jenv->GetMethodID(Variant, "<init>", "(JZ)V");
   $result = jenv->NewObject(HashMap, HashMap_init);
-  jlong key;
-  jlong value;
+  jlong key = 0;
+  jlong value = 0;
   for (auto entry : $1)
   {
-    key = reinterpret_cast<intptr_t>(entry.first);
-    value = reinterpret_cast<intptr_t>(new Glib::VariantBase(entry.second));
+    *(const sigrok::ConfigKey **) &key = entry.first;
+    *(Glib::VariantBase **) &value = new Glib::VariantBase(entry.second);
     jenv->CallObjectMethod($result, HashMap_put,
       jenv->NewObject(ConfigKey, ConfigKey_init, key, false));
       jenv->NewObject(Variant, Variant_init, value, true));
@@ -216,10 +217,10 @@ MAP_COMMON(const sigrok::ConfigKey *, std::set<enum sigrok::Capability>,
   jmethodID Capability_swigToEnum = jenv->GetStaticMethodID(Capability,
     "swigToEnum", "(I)Lorg/sigrok/core/classes/Capability;");
   $result = jenv->NewObject(HashMap, HashMap_init);
-  jlong key;
+  jlong key = 0;
   for (auto map_entry : $1)
   {
-    key = reinterpret_cast<intptr_t>(map_entry.first);
+    *(const sigrok::ConfigKey **) &key = map_entry.first;
     jobject value = jenv->NewObject(HashSet, HashSet_init);
     for (auto &set_entry : map_entry.second)
       jenv->CallObjectMethod(value, HashSet_add,
@@ -236,6 +237,74 @@ MAP_COMMON(const sigrok::ConfigKey *, std::set<enum sigrok::Capability>,
    $1 = jenv;
 %} 
 
+/* Thread safe JNIEnv handling */
+
+%inline {
+namespace {
+  class ScopedEnv {
+    public:
+      ScopedEnv(JavaVM *jvm);
+      ScopedEnv(const ScopedEnv &ref) = delete;
+      ~ScopedEnv();
+      JNIEnv* operator-> () { return env; }
+      operator bool () const { return (bool)env; }
+    private:
+      JavaVM *jvm;
+      JNIEnv *env;
+      int env_status;
+  };
+  ScopedEnv::ScopedEnv(JavaVM *jvm) : jvm(jvm), env(NULL) {
+    env_status = jvm->GetEnv((void **)&env, JNI_VERSION_1_2);
+    if (env_status == JNI_EDETACHED) {
+%#if defined(__ANDROID__)
+      jvm->AttachCurrentThread(&env, NULL);
+%#else
+      jvm->AttachCurrentThread((void **)&env, NULL);
+%#endif
+    }
+  }
+  ScopedEnv::~ScopedEnv() {
+    if (env_status == JNI_EDETACHED) {
+      jvm->DetachCurrentThread();
+    }
+  }
+}
+}
+
+/* "Smartpointer" for Java references. */
+
+%inline {
+namespace {
+  class GlobalRefBase
+  {
+    protected:
+      GlobalRefBase (JavaVM *jvm, jobject ref);
+      GlobalRefBase (const GlobalRefBase &ref) = delete;
+      ~GlobalRefBase ();
+      JavaVM *jvm;
+      jobject jref;
+  };
+  GlobalRefBase::GlobalRefBase (JavaVM *jvm, jobject ref) : jvm(jvm), jref(0) {
+    ScopedEnv env(jvm);
+    if (env && ref)
+      jref = env->NewGlobalRef(ref);
+  }
+  GlobalRefBase::~GlobalRefBase () {
+    ScopedEnv env(jvm);
+    if(env && jref)
+      env->DeleteGlobalRef(jref);
+  }
+  template <class Jtype>
+  class GlobalRef : private GlobalRefBase
+  {
+    public:
+      GlobalRef (JavaVM *jvm, Jtype ref) : GlobalRefBase(jvm, ref) {}
+      GlobalRef (const GlobalRef &ref) : GlobalRefBase(ref.jvm, ref.jref) {}
+      operator Jtype () const { return static_cast<Jtype>(jref); }
+  };
+}
+}
+
 /* Support Java log callbacks. */
 
 %typemap(javaimports) sigrok::Context
@@ -254,20 +323,24 @@ typedef jobject jlogcallback;
 {
   void add_log_callback(JNIEnv *env, jlogcallback obj)
   {
+    JavaVM *jvm = NULL;
+    env->GetJavaVM(&jvm);
     jclass obj_class = env->GetObjectClass(obj);
     jmethodID method = env->GetMethodID(obj_class, "run",
       "(Lorg/sigrok/core/classes/LogLevel;Ljava/lang/String;)V");
-    jclass LogLevel = (jclass) env->NewGlobalRef(
-        env->FindClass("org/sigrok/core/classes/LogLevel"));
+    GlobalRef<jclass> LogLevel(jvm, env->FindClass("org/sigrok/core/classes/LogLevel"));
     jmethodID LogLevel_init = env->GetMethodID(LogLevel, "<init>", "(JZ)V");
-    jobject obj_ref = env->NewGlobalRef(obj);
+    GlobalRef<jobject> obj_ref(jvm, obj);
 
     $self->set_log_callback([=] (
       const sigrok::LogLevel *loglevel,
       std::string message)
     {
-      jlong loglevel_addr;
-      loglevel_addr = reinterpret_cast<intptr_t>(loglevel);
+      ScopedEnv env(jvm);
+      if (!env)
+        throw sigrok::Error(SR_ERR);
+      jlong loglevel_addr = 0;
+      *(const sigrok::LogLevel **) &loglevel_addr = loglevel;
       jobject loglevel_obj = env->NewObject(
         LogLevel, LogLevel_init, loglevel_addr, false);
       jobject message_obj = env->NewStringUTF(message.c_str());
@@ -296,25 +369,30 @@ typedef jobject jdatafeedcallback;
 {
   void add_datafeed_callback(JNIEnv *env, jdatafeedcallback obj)
   {
+    JavaVM *jvm = NULL;
+    env->GetJavaVM(&jvm);
     jclass obj_class = env->GetObjectClass(obj);
     jmethodID method = env->GetMethodID(obj_class, "run",
       "(Lorg/sigrok/core/classes/Device;Lorg/sigrok/core/classes/Packet;)V");
-    jclass Device = (jclass) env->NewGlobalRef(
-        env->FindClass("org/sigrok/core/classes/Device"));
+    GlobalRef<jclass> Device(jvm, env->FindClass("org/sigrok/core/classes/Device"));
     jmethodID Device_init = env->GetMethodID(Device, "<init>", "(JZ)V");
-    jclass Packet = (jclass) env->NewGlobalRef(
-       env->FindClass("org/sigrok/core/classes/Packet"));
+    GlobalRef<jclass> Packet(jvm, env->FindClass("org/sigrok/core/classes/Packet"));
     jmethodID Packet_init = env->GetMethodID(Packet, "<init>", "(JZ)V");
-    jobject obj_ref = env->NewGlobalRef(obj);
+    GlobalRef<jobject> obj_ref(jvm, obj);
 
     $self->add_datafeed_callback([=] (
       std::shared_ptr<sigrok::Device> device,
       std::shared_ptr<sigrok::Packet> packet)
     {
-      jlong device_addr;
-      jlong packet_addr;
-      device_addr = reinterpret_cast<intptr_t>(new std::shared_ptr<sigrok::Device>(device));
-      packet_addr = reinterpret_cast<intptr_t>(new std::shared_ptr<sigrok::Packet>(packet));
+      ScopedEnv env(jvm);
+      if (!env)
+        throw sigrok::Error(SR_ERR);
+      jlong device_addr = 0;
+      jlong packet_addr = 0;
+      *(std::shared_ptr<sigrok::Device> **) &device_addr =
+        new std::shared_ptr<sigrok::Device>(device);
+      *(std::shared_ptr<sigrok::Packet> **) &packet_addr =
+        new std::shared_ptr<sigrok::Packet>(packet);
       jobject device_obj = env->NewObject(
         Device, Device_init, device_addr, true);
       jobject packet_obj = env->NewObject(