blob: b5d63944b0b94e48d1abaa3e35bbd5d8990e4f4d [file] [log] [blame]
/*
* Copyright (c) 2004, 2022, Oracle 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 <string.h>
#include "jvmti.h"
#include "agent_common.h"
#include "jni_tools.h"
#include "jvmti_tools.h"
extern "C" {
/* ============================================================================= */
/* scaffold objects */
static JNIEnv* jni = NULL;
static jvmtiEnv *jvmti = NULL;
static jlong timeout = 0;
/* constant names */
#define EXPECTED_CLASS_NAME "nsk/jvmti/scenarios/hotswap/HS201/hs201t002a"
#define EXPECTED_CLASS_SIGN "Lnsk/jvmti/scenarios/hotswap/HS201/hs201t002a;"
#define METHOD_NAME "doInit"
#define METHOD_SIG "()V"
#define LOCAL_VARIABLE_NAME "localVariable"
#define PATH_TO_NEW_BYTECODE "pathToNewByteCode"
static jint testStep;
static jthread testedThread;
static jclass testClass;
// callbackException (isCatch == false) and callbackExceptionCatch (isCatch == true) handler
void handleException(bool isCatch,
jvmtiEnv* jvmti_env, JNIEnv* jni_env, jthread thread,
jmethodID method, jlocation location,
jobject exception);
const char* getThreadName(jvmtiEnv* jvmti_env, JNIEnv* jni_env, jthread thread);
const char* getClassName(jvmtiEnv *jvmti_env, JNIEnv* jni_env, jobject object);
int readNewBytecode(jvmtiEnv* jvmti, jint *newClassSize, unsigned char* *newClassBytes);
int getLocalVariableValue(jvmtiEnv *jvmti_env, jthread thread, jmethodID method);
/* ============================================================================= */
void setCurrentStep(JNIEnv* jni_env, int value) {
jfieldID fld;
if (!NSK_JNI_VERIFY(jni_env, (fld =
jni_env->GetStaticFieldID(testClass, "currentStep", "I")) != NULL)) {
jni_env->FatalError("TEST FAILED: while getting currentStep fieldID\n");
}
if (!NSK_JNI_VERIFY_VOID(jni_env, jni_env->SetStaticIntField(testClass, fld, value))) {
jni_env->FatalError("TEST FAILED: while setting value of currentStep fieldID\n");
}
}
/* ============================================================================= */
void enableEvent(jvmtiEnv *jvmti_env, jvmtiEvent event, jthread thread) {
if (!NSK_JVMTI_VERIFY(jvmti_env->SetEventNotificationMode(JVMTI_ENABLE, event, thread))) {
NSK_COMPLAIN1("TEST FAILED: enabling %s\n", TranslateEvent(event));
nsk_jvmti_setFailStatus();
}
}
/* ============================================================================= */
void disableEvent(jvmtiEnv *jvmti_env, jvmtiEvent event, jthread thread) {
if (!NSK_JVMTI_VERIFY(jvmti_env->SetEventNotificationMode(JVMTI_DISABLE, event, thread))) {
NSK_COMPLAIN1("TEST FAILED: disabling %s\n", TranslateEvent(event));
nsk_jvmti_setFailStatus();
}
}
/* ============================================================================= */
void redefineClass(jvmtiEnv *jvmti_env, jclass klass) {
jvmtiClassDefinition classDef;
char *className;
jint newClassSize;
unsigned char* newClassBytes;
if (!NSK_JVMTI_VERIFY(jvmti_env->GetClassSignature(klass, &className, NULL))) {
nsk_jvmti_setFailStatus();
return;
}
if (!NSK_VERIFY(readNewBytecode(jvmti_env, &newClassSize, &newClassBytes))) {
NSK_COMPLAIN0("TEST FAILED: new bytecode could not be read\n");
nsk_jvmti_setFailStatus();
jvmti_env->Deallocate((unsigned char*)className);
return;
}
classDef.klass = klass;
classDef.class_byte_count = newClassSize;
classDef.class_bytes = newClassBytes;
NSK_DISPLAY1("\tredefining class %s\n", className);
if (!NSK_JVMTI_VERIFY(jvmti_env->RedefineClasses(1, &classDef))) {
NSK_COMPLAIN1("TEST FAILED: while redefining class %s\n", className);
nsk_jvmti_setFailStatus();
}
if (!NSK_JVMTI_VERIFY(jvmti_env->Deallocate((unsigned char*)className))) {
nsk_jvmti_setFailStatus();
}
if (!NSK_JVMTI_VERIFY(jvmti_env->Deallocate(newClassBytes))) {
nsk_jvmti_setFailStatus();
}
}
/* ============================================================================= */
/** Agent algorithm. */
static void JNICALL
agentProc(jvmtiEnv* jvmti, JNIEnv* agentJNI, void* arg) {
jni = agentJNI;
NSK_DISPLAY0("Waiting for debuggee to become ready\n");
if (!nsk_jvmti_waitForSync(timeout))
return;
testStep = 1;
NSK_DISPLAY0(">>>> Debugge started, waiting for class loading \n");
if (!nsk_jvmti_resumeSync())
return;
NSK_DISPLAY0("Waiting for debuggee's threads to finish\n");
if (!nsk_jvmti_waitForSync(timeout))
return;
NSK_TRACE(jni->DeleteGlobalRef(testClass));
NSK_TRACE(jni->DeleteGlobalRef(testedThread));
NSK_DISPLAY0("Let debuggee to finish\n");
if (!nsk_jvmti_resumeSync())
return;
}
/* ============================================================================= */
void setBreakPoint(jvmtiEnv *jvmti_env, JNIEnv *jni_env, jclass klass) {
jmethodID mid;
if (!NSK_JNI_VERIFY(jni_env, (mid = jni_env->GetMethodID(klass, METHOD_NAME, METHOD_SIG)) != NULL))
jni_env->FatalError("[agent] failed to get ID for the java method\n");
if (!NSK_JVMTI_VERIFY(jvmti_env->SetBreakpoint(mid, 1)))
jni_env->FatalError("[agent] failed to set breakpoint\n");
}
/* ============================================================================= */
/**
* CLASS_LOAD callback.
* -
*/
JNIEXPORT void JNICALL
callbackClassLoad(jvmtiEnv *jvmti_env, JNIEnv* jni_env, jthread thread,
jclass klass) {
char *className;
if (!NSK_JVMTI_VERIFY(jvmti_env->GetClassSignature(klass, &className, NULL))) {
nsk_jvmti_setFailStatus();
return;
}
if (strcmp(className, EXPECTED_CLASS_SIGN)
== 0) {
NSK_DISPLAY1(">>>> Class loaded: %s, activating breakpoint\n", className);
setBreakPoint(jvmti_env, jni_env, klass);
}
if (!NSK_JVMTI_VERIFY(jvmti_env->Deallocate((unsigned char*)className))) {
nsk_jvmti_setFailStatus();
}
}
/* ============================================================================= */
/**
* BREAKPOINT callback.
* -
*/
JNIEXPORT void JNICALL
callbackBreakpoint(jvmtiEnv *jvmti_env, JNIEnv* jni_env, jthread thread,
jmethodID method, jlocation location) {
NSK_DISPLAY0(">>>>Breakpoint fired, enabling SINGLE_STEP\n");
enableEvent(jvmti_env, JVMTI_EVENT_SINGLE_STEP, thread);
}
/* ============================================================================= */
/**
* BREAKPOINT callback.
* -
*/
JNIEXPORT void JNICALL
callbackSingleStep(jvmtiEnv *jvmti_env, JNIEnv* jni_env, jthread thread,
jmethodID method, jlocation location) {
char *methodName;
if (!NSK_JVMTI_VERIFY(jvmti_env->GetMethodName(method, &methodName, NULL, NULL))) {
NSK_COMPLAIN0("TEST FAILED: unable to get method name during Breakpoint callback\n\n");
}
if (strcmp(methodName, METHOD_NAME) == 0) {
char *declaringClassName;
jclass declaringClass;
if (!NSK_JVMTI_VERIFY(jvmti_env->GetMethodDeclaringClass(method, &declaringClass))) {
NSK_COMPLAIN0("TEST FAILED: unable to get method name during Breakpoint callback\n\n");
}
if (!NSK_JVMTI_VERIFY(jvmti_env->GetClassSignature(declaringClass, &declaringClassName, NULL))) {
NSK_COMPLAIN0("TEST FAILED: unable to get method name during Breakpoint callback\n\n");
}
if (strcmp(declaringClassName, EXPECTED_CLASS_SIGN) == 0) {
int value;
jboolean is_obsolete;
/* getting local variable table*/
value = getLocalVariableValue(jvmti_env, thread, method);
switch (testStep) {
case 1:
if (value == 1) {
redefineClass(jvmti_env, declaringClass);
testStep++;
}
break;
case 2:
NSK_DISPLAY1(">>>> Checking if redefined method is not obsolete\n", testStep);
if (!NSK_JVMTI_VERIFY(jvmti->IsMethodObsolete(method, &is_obsolete))) {
NSK_COMPLAIN0("TEST FAILED: unable to check method to be obsolete\n");
nsk_jvmti_setFailStatus();
return;
}
if (is_obsolete) {
NSK_COMPLAIN0("TEST FAILED: method must not be obsolete\n");
nsk_jvmti_setFailStatus();
}
testStep++;
break;
case 3:
NSK_DISPLAY1(">>>> Popping the currently executing frame\n", testStep);
testStep++;
setCurrentStep(jni_env, testStep);
break;
case 5:
if (value < 10) {
NSK_DISPLAY1(">>>> Disabling single step\n", testStep);
disableEvent(jvmti_env, JVMTI_EVENT_SINGLE_STEP, thread);
setCurrentStep(jni_env, testStep);
}
} /* case */
}
if (!NSK_JVMTI_VERIFY(jvmti_env->Deallocate((unsigned char*) declaringClassName))) {
NSK_COMPLAIN0("TEST FAILED: unable to deallocate memory pointed to declaringClassName\n\n");
}
}
if (!NSK_JVMTI_VERIFY(jvmti_env->Deallocate((unsigned char*) methodName))) {
NSK_COMPLAIN0("TEST FAILED: unable to deallocate memory pointed to method name\n\n");
}
}
/* ============================================================================= */
/**
* EXCEPTION callback.
* -
*/
JNIEXPORT void JNICALL
callbackException(jvmtiEnv *jvmti_env, JNIEnv* jni_env, jthread thread,
jmethodID method, jlocation location, jobject exception,
jmethodID catch_method, jlocation catch_location) {
handleException(false, jvmti_env, jni_env, thread, method, location, exception);
}
/* ============================================================================= */
/**
* EXCEPTION_CATCH callback.
* -
*/
JNIEXPORT void JNICALL
callbackExceptionCatch(jvmtiEnv *jvmti_env, JNIEnv* jni_env, jthread thread,
jmethodID method, jlocation location,
jobject exception) {
handleException(true, jvmti_env, jni_env, thread, method, location, exception);
}
/* ============================================================================= */
void handleException(bool isCatch,
jvmtiEnv* jvmti_env, JNIEnv* jni_env, jthread thread,
jmethodID method, jlocation location,
jobject exception) {
const char* className = getClassName(jvmti_env, jni_env, exception);
if (className != NULL && strcmp(EXPECTED_CLASS_SIGN, className) == 0) {
jclass klass;
const char* threadName = getThreadName(jvmti_env, jni_env, thread);
NSK_DISPLAY3(">>>> %s %s in thread - %s\n", isCatch ? "Caught exception" : "Exception",
className, threadName != NULL ? threadName : "NULL");
jvmti->Deallocate((unsigned char*)className);
if (threadName != NULL) {
jvmti->Deallocate((unsigned char*)threadName);
}
testStep++;
if (!NSK_JNI_VERIFY(jni_env, (klass = jni_env->GetObjectClass(exception)) != NULL)) {
nsk_jvmti_setFailStatus();
return;
}
redefineClass(jvmti_env, klass);
}
}
int readNewBytecode(jvmtiEnv* jvmti, jint *newClassSize, unsigned char* *newClassBytes) {
char filename[256];
FILE *bytecode;
const char *pathToByteCode = nsk_jvmti_findOptionValue(PATH_TO_NEW_BYTECODE);
jint read_bytes;
if (!pathToByteCode) {
NSK_COMPLAIN0("TEST FAILED: error opening file\n");
return NSK_FALSE;
}
sprintf(filename,"%s/%s/%s.class",
pathToByteCode, "newclass", EXPECTED_CLASS_NAME);
NSK_DISPLAY1("\treading new bytecode for the tested class\n\tfile name: %s\n",
filename);
bytecode = fopen(filename, "rb");
if (bytecode == NULL) {
NSK_COMPLAIN0("TEST FAILED: error opening file\n");
return NSK_FALSE;
}
fseek(bytecode, 0, SEEK_END);
*newClassSize = ftell(bytecode);
rewind(bytecode);
if (!NSK_JVMTI_VERIFY(jvmti->Allocate(*newClassSize, newClassBytes))) {
NSK_COMPLAIN0("buffer couldn't be allocated\n");
return NSK_FALSE;
}
read_bytes = (jint) fread(*newClassBytes, 1, *newClassSize, bytecode);
fclose(bytecode);
if (read_bytes != *newClassSize) {
NSK_COMPLAIN0("TEST FAILED: error reading file\n");
jvmti->Deallocate(*newClassBytes);
*newClassBytes = NULL;
return NSK_FALSE;
}
return NSK_TRUE;
}
/* ============================================================================= */
const char* getThreadName(jvmtiEnv* jvmti_env, JNIEnv* jni_env, jthread thread) {
jmethodID methodID;
jclass klass;
jstring jthreadName;
jsize jthreadNameLen;
unsigned char *result = NULL;
const char *threadName;
if (!NSK_JNI_VERIFY(jni_env, (klass = jni_env->GetObjectClass(thread)) != NULL)) {
nsk_jvmti_setFailStatus();
return NULL;
}
if (!NSK_JNI_VERIFY(jni_env, (methodID =
jni_env->GetMethodID(klass, "getName", "()Ljava/lang/String;")) != NULL)) {
nsk_jvmti_setFailStatus();
return NULL;
}
jthreadName = (jstring) jni_env->CallObjectMethod(thread, methodID);
jthreadNameLen = jni_env->GetStringUTFLength(jthreadName);
if (!NSK_JVMTI_VERIFY(jvmti_env->Allocate(jthreadNameLen + 1, &result))) {
NSK_COMPLAIN0("buffer couldn't be allocated\n");
return NULL;
}
threadName = jni_env->GetStringUTFChars(jthreadName, 0);
memcpy(result, threadName, jthreadNameLen + 1);
jni_env->ReleaseStringUTFChars(jthreadName, threadName);
return (char*)result;
}
/* ============================================================================= */
const char* getClassName(jvmtiEnv *jvmti_env, JNIEnv* jni_env, jobject object) {
char *className;
jclass klass;
if (!NSK_JNI_VERIFY(jni_env, (klass = jni_env->GetObjectClass(object)) != NULL)) {
nsk_jvmti_setFailStatus();
return NULL;
}
if (!NSK_JVMTI_VERIFY(jvmti_env->GetClassSignature(klass, &className, NULL))) {
nsk_jvmti_setFailStatus();
return NULL;
}
return className;
}
/* ============================================================================= */
int getLocalVariableValue(jvmtiEnv *jvmti_env, jthread thread,
jmethodID method) {
jvmtiLocalVariableEntry *table = NULL;
jint entryCount = 0;
int i;
jint value = -1;
/* getting local variable table*/
if (!NSK_JVMTI_VERIFY(jvmti_env->GetLocalVariableTable(method, &entryCount, &table))) {
NSK_COMPLAIN0("TEST FAILED: unable to get local variable table\n\n");
}
if (table != NULL) {
jvmtiError error;
for (i = 0; i < entryCount; i++) {
if (strcmp(table[i].name, LOCAL_VARIABLE_NAME) == 0) {
error = jvmti_env->GetLocalInt(thread, 0, table[i].slot, &value);
if (!NSK_VERIFY(error == JVMTI_ERROR_NONE
|| error == JVMTI_ERROR_INVALID_SLOT))
NSK_COMPLAIN0("TEST FAILED: unable to get local variable table\n\n");
}
}
for (i = 0; i < entryCount; i++) {
if (!NSK_JVMTI_VERIFY(jvmti_env->Deallocate((unsigned char*)table[i].name))) {
NSK_COMPLAIN0("TEST FAILED: unable to deallocate memory pointed to method name\n\n");
}
if (!NSK_JVMTI_VERIFY(jvmti_env->Deallocate((unsigned char*)table[i].signature))) {
NSK_COMPLAIN0("TEST FAILED: unable to deallocate memory pointed to method signature\n\n");
}
}
if (!NSK_JVMTI_VERIFY(jvmti_env->Deallocate((unsigned char*)table))) {
NSK_COMPLAIN0("TEST FAILED: unable to deallocate memory pointed to local variable table\n\n");
}
}
return value;
}
/* ============================================================================= */
JNIEXPORT void JNICALL
Java_nsk_jvmti_scenarios_hotswap_HS201_hs201t002_setThread(JNIEnv *env,
jclass cls, jthread thread) {
if (!NSK_JNI_VERIFY(env, (testClass = (jclass) env->NewGlobalRef(cls)) != NULL))
nsk_jvmti_setFailStatus();
if (!NSK_JNI_VERIFY(env, (testedThread = env->NewGlobalRef(thread)) != NULL))
nsk_jvmti_setFailStatus();
enableEvent(jvmti, JVMTI_EVENT_CLASS_LOAD, testedThread);
enableEvent(jvmti, JVMTI_EVENT_BREAKPOINT, testedThread);
enableEvent(jvmti, JVMTI_EVENT_EXCEPTION, testedThread);
enableEvent(jvmti, JVMTI_EVENT_EXCEPTION_CATCH, testedThread);
}
/* ============================================================================= */
JNIEXPORT jboolean JNICALL
Java_nsk_jvmti_scenarios_hotswap_HS201_hs201t002_resumeThread(JNIEnv *env,
jclass cls, jthread thread) {
NSK_DISPLAY0("\tresuming thread...\n");
disableEvent(jvmti, JVMTI_EVENT_SINGLE_STEP, thread);
if (!NSK_JVMTI_VERIFY(jvmti->ResumeThread(thread))) {
NSK_COMPLAIN0("TEST FAILED: unable to resume the thread\n");
nsk_jvmti_setFailStatus();
return NSK_FALSE;
}
return NSK_TRUE;
}
/* ============================================================================= */
JNIEXPORT jboolean JNICALL
Java_nsk_jvmti_scenarios_hotswap_HS201_hs201t002_suspendThread(JNIEnv *env,
jclass cls, jthread thread) {
NSK_DISPLAY0("\tsuspending thread...\n");
disableEvent(jvmti, JVMTI_EVENT_SINGLE_STEP, thread);
if (!NSK_JVMTI_VERIFY(jvmti->SuspendThread(thread))) {
NSK_COMPLAIN0("TEST FAILED: unable to suspend the thread\n");
nsk_jvmti_setFailStatus();
return NSK_FALSE;
}
return NSK_TRUE;
}
/* ============================================================================= */
JNIEXPORT jboolean JNICALL
Java_nsk_jvmti_scenarios_hotswap_HS201_hs201t002_popFrame(JNIEnv *env,
jclass cls, jthread thread) {
NSK_DISPLAY0("\tpopping frame...\n");
if (!NSK_JVMTI_VERIFY(jvmti->PopFrame(thread))) {
NSK_COMPLAIN0("TEST FAILED: unable to pop the currently executed frame\n");
nsk_jvmti_setFailStatus();
return NSK_FALSE;
}
NSK_DISPLAY0("\tresuming thread...\n");
if (!NSK_JVMTI_VERIFY(jvmti->ResumeThread(thread))) {
NSK_COMPLAIN0("TEST FAILED: unable to resume the thread\n");
nsk_jvmti_setFailStatus();
return NSK_FALSE;
}
testStep++;
enableEvent(jvmti, JVMTI_EVENT_SINGLE_STEP, thread);
return NSK_TRUE;
}
/* ============================================================================= */
/** Agent library initialization. */
#ifdef STATIC_BUILD
JNIEXPORT jint JNICALL Agent_OnLoad_hs201t002(JavaVM *jvm, char *options, void *reserved) {
return Agent_Initialize(jvm, options, reserved);
}
JNIEXPORT jint JNICALL Agent_OnAttach_hs201t002(JavaVM *jvm, char *options, void *reserved) {
return Agent_Initialize(jvm, options, reserved);
}
JNIEXPORT jint JNI_OnLoad_hs201t002(JavaVM *jvm, char *options, void *reserved) {
return JNI_VERSION_1_8;
}
#endif
jint Agent_Initialize(JavaVM *jvm, char *options, void *reserved) {
if (!NSK_VERIFY(nsk_jvmti_parseOptions(options)))
return JNI_ERR;
timeout = nsk_jvmti_getWaitTime() * 60 * 1000;
if (!NSK_VERIFY((jvmti =
nsk_jvmti_createJVMTIEnv(jvm, reserved)) != NULL))
return JNI_ERR;
{
jvmtiCapabilities caps;
memset(&caps, 0, sizeof(caps));
caps.can_generate_exception_events = 1;
caps.can_generate_breakpoint_events = 1;
caps.can_generate_single_step_events = 1;
caps.can_access_local_variables = 1;
caps.can_redefine_classes = 1;
caps.can_pop_frame = 1;
caps.can_suspend = 1;
if (!NSK_JVMTI_VERIFY(jvmti->AddCapabilities(&caps)))
return JNI_ERR;
}
{
jvmtiEventCallbacks eventCallbacks;
memset(&eventCallbacks, 0, sizeof(eventCallbacks));
eventCallbacks.ClassLoad = callbackClassLoad;
eventCallbacks.Exception = callbackException;
eventCallbacks.ExceptionCatch = callbackExceptionCatch;
eventCallbacks.Breakpoint = callbackBreakpoint;
eventCallbacks.SingleStep = callbackSingleStep;
if (!NSK_JVMTI_VERIFY(jvmti->SetEventCallbacks(&eventCallbacks, sizeof(eventCallbacks))))
return JNI_ERR;
}
NSK_DISPLAY0("Enable events\n");
if (!NSK_VERIFY(nsk_jvmti_setAgentProc(agentProc, NULL)))
return JNI_ERR;
return JNI_OK;
}
/* ============================================================================= */
}