jdk-24/test/hotspot/jtreg/vmTestbase/nsk/share/jni/ExceptionCheckingJniEnv.cpp

/*
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2018, Google and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

#include <stdlib.h>
#include <string.h>

#include "ExceptionCheckingJniEnv.hpp"

namespace {

template<class T = void*>
class JNIVerifier {
 public:
  JNIVerifier(ExceptionCheckingJniEnv *env, const char* base_msg)
      : _env(env), _base_msg(base_msg), _return_error(NULL) {
  }

  ~JNIVerifier() {
    JNIEnv* jni_env = _env->GetJNIEnv();
    if (jni_env->ExceptionCheck()) {
      _env->HandleError(_base_msg);
      return;
    }

    if (_return_error != NULL) {
      ProcessReturnError();
    }
  }

  void ProcessReturnError() {
    // This is error prone, but:
    //   - Seems like we cannot use std::string (due to windows/solaris not
    //   building when used, seemingly due to exception libraries not linking).
    //   - Seems like we cannot use sprintf due to VS2013 (JDK-8213622).
    //
    //   We are aiming to do:
    //     snprintf(full_message, len, "%s : %s", _base_msg, _return_error);
    //   but will use strlen + memcpy instead.
    size_t base_len = strlen(_base_msg);
    const char* between_msg = " : ";
    size_t between_len = strlen(between_msg);
    size_t return_len = strlen(_return_error);

    // +1 for the '\0'
    size_t len = base_len + between_len + return_len + 1;

    char* full_message = (char*) malloc(len);
    if (full_message == NULL) {
      _env->HandleError(_return_error);
      return;
    }

    // Now we construct the string using memcpy to not use sprintf/std::string
    // instead of:
    //     snprintf(full_message, len, "%s : %s", _base_msg, _return_error);
    memcpy(full_message, _base_msg, base_len);
    memcpy(full_message + base_len, between_msg, between_len);
    memcpy(full_message + base_len + between_len, _return_error, return_len);
    full_message[len - 1] = '\0';

    // -1 due to the '\0' not counted by strlen but is counted for the allocation.
    if (strlen(full_message) != len - 1) {
      _env->GetJNIEnv()->FatalError("Length of message is not what was expected");
    }

    _env->HandleError(full_message);
    free(full_message);
  }

  T ResultNotNull(T ptr) {
    if (ptr == NULL) {
      _return_error = "Return is NULL";
    }
    return ptr;
  }

 private:
  ExceptionCheckingJniEnv* _env;
  const char* const _base_msg;
  const char* _return_error;
};

}

jclass ExceptionCheckingJniEnv::GetObjectClass(jobject obj) {
  JNIVerifier<jclass> marker(this, "GetObjectClass");
  return marker.ResultNotNull(_jni_env->GetObjectClass(obj));
}

jfieldID ExceptionCheckingJniEnv::GetFieldID(jclass klass, const char *name, const char* type) {
  JNIVerifier<jfieldID> marker(this, "GetFieldID");
  return marker.ResultNotNull(_jni_env->GetFieldID(klass, name, type));
}

jobject ExceptionCheckingJniEnv::GetObjectField(jobject obj, jfieldID field) {
  JNIVerifier<jobject> marker(this, "GetObjectField");
  return marker.ResultNotNull(_jni_env->GetObjectField(obj, field));
}

void ExceptionCheckingJniEnv::SetObjectField(jobject obj, jfieldID field, jobject value) {
  JNIVerifier<> marker(this, "SetObjectField");
  _jni_env->SetObjectField(obj, field, value);
}

jobject ExceptionCheckingJniEnv::NewGlobalRef(jobject obj) {
  JNIVerifier<jobject> marker(this, "NewGlobalRef");
  return marker.ResultNotNull(_jni_env->NewGlobalRef(obj));
}

void ExceptionCheckingJniEnv::DeleteGlobalRef(jobject obj) {
  JNIVerifier<> marker(this, "DeleteGlobalRef");
  _jni_env->DeleteGlobalRef(obj);
}

jobject ExceptionCheckingJniEnv::NewLocalRef(jobject obj) {
  JNIVerifier<jobject> marker(this, "NewLocalRef");
  return marker.ResultNotNull(_jni_env->NewLocalRef(obj));
}

void ExceptionCheckingJniEnv::DeleteLocalRef(jobject obj) {
  JNIVerifier<> marker(this, "DeleteLocalRef");
  _jni_env->DeleteLocalRef(obj);
}

jweak ExceptionCheckingJniEnv::NewWeakGlobalRef(jobject obj) {
  JNIVerifier<jweak> marker(this, "NewWeakGlobalRef");
  return marker.ResultNotNull(_jni_env->NewWeakGlobalRef(obj));
}

void ExceptionCheckingJniEnv::DeleteWeakGlobalRef(jweak weak_ref) {
  JNIVerifier<> marker(this, "DeleteWeakGlobalRef");
  _jni_env->DeleteWeakGlobalRef(weak_ref);
}

jsize ExceptionCheckingJniEnv::GetArrayLength(jarray array) {
  JNIVerifier<> marker(this, "GetArrayLength");
  return _jni_env->GetArrayLength(array);
}

jsize ExceptionCheckingJniEnv::GetStringLength(jstring str) {
  JNIVerifier<> marker(this, "GetStringLength");
  return _jni_env->GetStringLength(str);
}

void* ExceptionCheckingJniEnv::GetPrimitiveArrayCritical(jarray array, jboolean* isCopy) {
  JNIVerifier<> marker(this, "GetPrimitiveArrayCritical");
  return marker.ResultNotNull(_jni_env->GetPrimitiveArrayCritical(array, isCopy));
}

void ExceptionCheckingJniEnv::ReleasePrimitiveArrayCritical(jarray array, void* carray, jint mode) {
  JNIVerifier<> marker(this, "ReleasePrimitiveArrayCritical");
  _jni_env->ReleasePrimitiveArrayCritical(array, carray, mode);
}

const jchar* ExceptionCheckingJniEnv::GetStringCritical(jstring str, jboolean* isCopy) {
  JNIVerifier<const jchar*> marker(this, "GetPrimitiveArrayCritical");
  return marker.ResultNotNull(_jni_env->GetStringCritical(str, isCopy));
}

void ExceptionCheckingJniEnv::ReleaseStringCritical(jstring str, const jchar* carray) {
  JNIVerifier<> marker(this, "ReleaseStringCritical");
  _jni_env->ReleaseStringCritical(str, carray);
}