mpv/misc/jni.c

384 lines
11 KiB
C

/*
* JNI utility functions
*
* Copyright (c) 2015-2016 Matthieu Bouron <matthieu.bouron stupeflix.com>
*
* This file is part of mpv.
*
* mpv is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* mpv is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with mpv. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libavcodec/jni.h>
#include <stdlib.h>
#include "jni.h"
#include "mpv_talloc.h"
#include "osdep/threads.h"
static JavaVM *java_vm;
static pthread_key_t current_env;
static mp_once once = MP_STATIC_ONCE_INITIALIZER;
static mp_static_mutex lock = MP_STATIC_MUTEX_INITIALIZER;
static void jni_detach_env(void *data)
{
if (java_vm) {
(*java_vm)->DetachCurrentThread(java_vm);
}
}
static void jni_create_pthread_key(void)
{
pthread_key_create(&current_env, jni_detach_env);
}
JNIEnv *mp_jni_get_env(struct mp_log *log)
{
JNIEnv *env = NULL;
mp_mutex_lock(&lock);
if (!java_vm)
java_vm = av_jni_get_java_vm(NULL);
if (!java_vm) {
mp_err(log, "No Java virtual machine has been registered\n");
goto done;
}
mp_exec_once(&once, jni_create_pthread_key);
if ((env = pthread_getspecific(current_env)) != NULL)
goto done;
int ret = (*java_vm)->GetEnv(java_vm, (void **)&env, JNI_VERSION_1_6);
switch(ret) {
case JNI_EDETACHED:
if ((*java_vm)->AttachCurrentThread(java_vm, &env, NULL) != 0) {
mp_err(log, "Failed to attach the JNI environment to the current thread\n");
env = NULL;
} else {
pthread_setspecific(current_env, env);
}
break;
case JNI_OK:
break;
case JNI_EVERSION:
mp_err(log, "The specified JNI version is not supported\n");
break;
default:
mp_err(log, "Failed to get the JNI environment attached to this thread\n");
break;
}
done:
mp_mutex_unlock(&lock);
return env;
}
char *mp_jni_jstring_to_utf_chars(JNIEnv *env, jstring string, struct mp_log *log)
{
if (!string)
return NULL;
const char *utf_chars = (*env)->GetStringUTFChars(env, string, NULL);
if ((*env)->ExceptionCheck(env)) {
(*env)->ExceptionClear(env);
mp_err(log, "getStringUTFChars() threw an exception\n");
return NULL;
}
char *ret = talloc_strdup(NULL, utf_chars);
(*env)->ReleaseStringUTFChars(env, string, utf_chars);
return ret;
}
jstring mp_jni_utf_chars_to_jstring(JNIEnv *env, const char *utf_chars,
struct mp_log *log)
{
jstring ret = (*env)->NewStringUTF(env, utf_chars);
if ((*env)->ExceptionCheck(env)) {
(*env)->ExceptionClear(env);
mp_err(log, "NewStringUTF() threw an exception\n");
return NULL;
}
return ret;
}
int mp_jni_exception_get_summary(JNIEnv *env, jthrowable exception,
char **error, struct mp_log *log)
{
int ret = 0;
char *name = NULL;
char *message = NULL;
jclass class_class = NULL;
jclass exception_class = NULL;
jstring string = NULL;
*error = NULL;
exception_class = (*env)->GetObjectClass(env, exception);
if ((*env)->ExceptionCheck(env)) {
(*env)->ExceptionClear(env);
mp_err(log, "Could not find Throwable class\n");
ret = -1;
goto done;
}
class_class = (*env)->GetObjectClass(env, exception_class);
if ((*env)->ExceptionCheck(env)) {
(*env)->ExceptionClear(env);
mp_err(log, "Could not find Throwable class's class\n");
ret = -1;
goto done;
}
jmethodID get_name_id = (*env)->GetMethodID(env, class_class, "getName", "()Ljava/lang/String;");
if ((*env)->ExceptionCheck(env)) {
(*env)->ExceptionClear(env);
mp_err(log, "Could not find method Class.getName()\n");
ret = -1;
goto done;
}
string = (*env)->CallObjectMethod(env, exception_class, get_name_id);
if ((*env)->ExceptionCheck(env)) {
(*env)->ExceptionClear(env);
mp_err(log, "Class.getName() threw an exception\n");
ret = -1;
goto done;
}
if (string) {
name = mp_jni_jstring_to_utf_chars(env, string, log);
MP_JNI_LOCAL_FREEP(&string);
}
jmethodID get_message_id = (*env)->GetMethodID(env, exception_class, "getMessage", "()Ljava/lang/String;");
if ((*env)->ExceptionCheck(env)) {
(*env)->ExceptionClear(env);
mp_err(log, "Could not find method Throwable.getMessage()\n");
ret = -1;
goto done;
}
string = (*env)->CallObjectMethod(env, exception, get_message_id);
if ((*env)->ExceptionCheck(env)) {
(*env)->ExceptionClear(env);
mp_err(log, "Throwable.getMessage() threw an exception\n");
ret = -1;
goto done;
}
if (string) {
message = mp_jni_jstring_to_utf_chars(env, string, log);
MP_JNI_LOCAL_FREEP(&string);
}
if (name && message) {
*error = talloc_asprintf(NULL, "%s: %s", name, message);
} else if (name && !message) {
*error = talloc_asprintf(NULL, "%s occurred", name);
} else if (!name && message) {
*error = talloc_asprintf(NULL, "Exception: %s", message);
} else {
mp_warn(log, "Could not retrieve exception name and message\n");
*error = talloc_strdup(NULL, "Exception occurred");
}
done:
talloc_free(name);
talloc_free(message);
MP_JNI_LOCAL_FREEP(&class_class);
MP_JNI_LOCAL_FREEP(&exception_class);
MP_JNI_LOCAL_FREEP(&string);
return ret;
}
int mp_jni_exception_check(JNIEnv *env, int logging, struct mp_log *log)
{
if (!(*env)->ExceptionCheck(env))
return 0;
if (!logging) {
(*env)->ExceptionClear(env);
return -1;
}
jthrowable exception = (*env)->ExceptionOccurred(env);
(*env)->ExceptionClear(env);
char *message = NULL;
int ret = mp_jni_exception_get_summary(env, exception, &message, log);
MP_JNI_LOCAL_FREEP(&exception);
if (ret < 0)
return ret;
mp_err(log, "%s\n", message);
talloc_free(message);
return -1;
}
#define CHECK_EXC_MANDATORY() do { \
if ((ret = mp_jni_exception_check(env, mandatory, log)) < 0 && \
mandatory) { \
goto done; \
} \
} while (0)
int mp_jni_init_jfields(JNIEnv *env, void *jfields,
const struct MPJniField *jfields_mapping,
int global, struct mp_log *log)
{
int ret = 0;
jclass last_clazz = NULL;
for (int i = 0; jfields_mapping[i].name; i++) {
bool mandatory = !!jfields_mapping[i].mandatory;
enum MPJniFieldType type = jfields_mapping[i].type;
void *jfield = (uint8_t*)jfields + jfields_mapping[i].offset;
if (type == MP_JNI_CLASS) {
last_clazz = NULL;
jclass clazz = (*env)->FindClass(env, jfields_mapping[i].name);
CHECK_EXC_MANDATORY();
last_clazz = *(jclass*)jfield =
global ? (*env)->NewGlobalRef(env, clazz) : clazz;
if (global)
MP_JNI_LOCAL_FREEP(&clazz);
continue;
}
if (!last_clazz) {
ret = -1;
break;
}
switch (type) {
case MP_JNI_FIELD: {
jfieldID field_id = (*env)->GetFieldID(env, last_clazz,
jfields_mapping[i].name, jfields_mapping[i].signature);
CHECK_EXC_MANDATORY();
*(jfieldID*)jfield = field_id;
break;
}
case MP_JNI_STATIC_FIELD_AS_INT:
case MP_JNI_STATIC_FIELD: {
jfieldID field_id = (*env)->GetStaticFieldID(env, last_clazz,
jfields_mapping[i].name, jfields_mapping[i].signature);
CHECK_EXC_MANDATORY();
if (type == MP_JNI_STATIC_FIELD_AS_INT) {
if (field_id) {
jint value = (*env)->GetStaticIntField(env, last_clazz, field_id);
CHECK_EXC_MANDATORY();
*(jint*)jfield = value;
}
} else {
*(jfieldID*)jfield = field_id;
}
break;
}
case MP_JNI_METHOD: {
jmethodID method_id = (*env)->GetMethodID(env, last_clazz,
jfields_mapping[i].name, jfields_mapping[i].signature);
CHECK_EXC_MANDATORY();
*(jmethodID*)jfield = method_id;
break;
}
case MP_JNI_STATIC_METHOD: {
jmethodID method_id = (*env)->GetStaticMethodID(env, last_clazz,
jfields_mapping[i].name, jfields_mapping[i].signature);
CHECK_EXC_MANDATORY();
*(jmethodID*)jfield = method_id;
break;
}
default:
mp_err(log, "Unknown JNI field type\n");
ret = -1;
goto done;
}
ret = 0;
}
done:
if (ret < 0) {
/* reset jfields in case of failure so it does not leak references */
mp_jni_reset_jfields(env, jfields, jfields_mapping, global, log);
}
return ret;
}
#undef CHECK_EXC_MANDATORY
int mp_jni_reset_jfields(JNIEnv *env, void *jfields,
const struct MPJniField *jfields_mapping,
int global, struct mp_log *log)
{
for (int i = 0; jfields_mapping[i].name; i++) {
enum MPJniFieldType type = jfields_mapping[i].type;
void *jfield = (uint8_t*)jfields + jfields_mapping[i].offset;
switch (type) {
case MP_JNI_CLASS: {
jclass clazz = *(jclass*)jfield;
if (!clazz)
continue;
if (global) {
MP_JNI_GLOBAL_FREEP(&clazz);
} else {
MP_JNI_LOCAL_FREEP(&clazz);
}
*(jclass*)jfield = NULL;
break;
}
case MP_JNI_FIELD:
case MP_JNI_STATIC_FIELD:
*(jfieldID*)jfield = NULL;
break;
case MP_JNI_STATIC_FIELD_AS_INT:
*(jint*)jfield = 0;
break;
case MP_JNI_METHOD:
case MP_JNI_STATIC_METHOD:
*(jmethodID*)jfield = NULL;
break;
default:
mp_err(log, "Unknown JNI field type\n");
}
}
return 0;
}