1 /*
   2  * Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <jni.h>
  27 #include <jvmti.h>
  28 #include <aod.h>
  29 #include <jvmti_aod.h>
  30 #include "ExceptionCheckingJniEnv.hpp"
  31 
  32 extern "C" {
  33 
  34 /*
  35  * Expected agent work scenario:
  36  * - during initialization agent registers native methods used be target application and enables ObjectFree events
  37  * - target application using native method and agent's jvmti environment tags object and provokes collection
  38  * of this object
  39  * - agent receives ObjectFree event for tagged object
  40  * - target application using native method calls nsk_aod_agentFinished and agent finishes work
  41  * (agent can't call nsk_aod_agentFinished from ObjectFree handler, nsk_aod_agentFinished calls
  42  * JNI functions and it is prohibited in ObjectFree handler)
  43  *
  44  */
  45 
  46 #define TAG_VALUE (jlong)777
  47 #define ATTACH021_TARGET_APP_CLASS_NAME "nsk/jvmti/AttachOnDemand/attach021/attach021Target"
  48 
  49 static jvmtiEnv* jvmti;
  50 
  51 static Options* options = NULL;
  52 static const char* agentName;
  53 
  54 // agent should set success status from objectFreeHandler
  55 volatile int success = 0;
  56 
  57 JNIEXPORT jboolean JNICALL
  58 Java_nsk_jvmti_AttachOnDemand_attach021_attach021Target_setTagFor(JNIEnv * jni,
  59         jclass klass, jobject obj) {
  60     if (!NSK_JVMTI_VERIFY(jvmti->SetTag(obj, TAG_VALUE))) {
  61         return JNI_FALSE;
  62     }
  63 
  64     NSK_DISPLAY2("%s: object is tagged (tag: %ld)\n", agentName, TAG_VALUE);
  65 
  66     return JNI_TRUE;
  67 }
  68 
  69 JNIEXPORT void JNICALL
  70 Java_nsk_jvmti_AttachOnDemand_attach021_attach021Target_shutdownAgent(JNIEnv * jni,
  71         jclass klass) {
  72     nsk_jvmti_aod_disableEventAndFinish(agentName, JVMTI_EVENT_OBJECT_FREE, success, jvmti, jni);
  73 }
  74 
  75 void JNICALL objectFreeHandler(jvmtiEnv *jvmti, jlong tag) {
  76     NSK_DISPLAY2("%s: object free event for object %ld\n", agentName, tag);
  77 
  78     if (tag != TAG_VALUE) {
  79         success = 0;
  80         NSK_COMPLAIN2("%s: unexpected tag value, expected is  %ld\n", agentName, TAG_VALUE);
  81     } else {
  82         success = 1;
  83     }
  84 
  85     /*
  86      * Can't use JNI functions from ObjectFree event handler, in this test target application calls
  87      * function nsk_aod_agentFinished
  88      */
  89 }
  90 
  91 int registerNativeMethods(JNIEnv* jni_env) {
  92     ExceptionCheckingJniEnvPtr jni(jni_env);
  93     jclass appClass;
  94     JNINativeMethod nativeMethods[] = {
  95             {(char*) "setTagFor", (char*) "(Ljava/lang/Object;)Z", (void*) Java_nsk_jvmti_AttachOnDemand_attach021_attach021Target_setTagFor},
  96             {(char*) "shutdownAgent", (char*) "()V", (void*) Java_nsk_jvmti_AttachOnDemand_attach021_attach021Target_shutdownAgent}};
  97     jint nativeMethodsNumber = 2;
  98 
  99     appClass = jni->FindClass(ATTACH021_TARGET_APP_CLASS_NAME, TRACE_JNI_CALL);
 100     if (appClass == NULL) {
 101         return NSK_FALSE;
 102     }
 103 
 104     if (jni->RegisterNatives(appClass, nativeMethods, nativeMethodsNumber, TRACE_JNI_CALL) != 0) {
 105         return NSK_FALSE;
 106     }
 107 
 108     return NSK_TRUE;
 109 }
 110 
 111 #ifdef STATIC_BUILD
 112 JNIEXPORT jint JNI_OnLoad_attach021Agent00(JavaVM *jvm, char *options, void *reserved) {
 113     return JNI_VERSION_1_8;
 114 }
 115 #endif
 116 
 117 JNIEXPORT jint JNICALL
 118 #ifdef STATIC_BUILD
 119 Agent_OnAttach_attach021Agent00(JavaVM *vm, char *optionsString, void *reserved)
 120 #else
 121 Agent_OnAttach(JavaVM *vm, char *optionsString, void *reserved)
 122 #endif
 123 {
 124     jvmtiEventCallbacks eventCallbacks;
 125     jvmtiCapabilities caps;
 126     JNIEnv* jni;
 127 
 128     options = (Options*) nsk_aod_createOptions(optionsString);
 129     if (!NSK_VERIFY(options != NULL))
 130         return JNI_ERR;
 131 
 132     agentName = nsk_aod_getOptionValue(options, NSK_AOD_AGENT_NAME_OPTION);
 133 
 134     jni = (JNIEnv*) nsk_aod_createJNIEnv(vm);
 135     if (jni == NULL)
 136         return JNI_ERR;
 137 
 138     jvmti = nsk_jvmti_createJVMTIEnv(vm, reserved);
 139     if (!NSK_VERIFY(jvmti != NULL))
 140         return JNI_ERR;
 141 
 142     if (!NSK_VERIFY(registerNativeMethods(jni))) {
 143         return JNI_ERR;
 144     }
 145 
 146     memset(&caps, 0, sizeof(caps));
 147     caps.can_tag_objects = 1;
 148     caps.can_generate_object_free_events = 1;
 149     if (!NSK_JVMTI_VERIFY(jvmti->AddCapabilities(&caps))) {
 150         return JNI_ERR;
 151     }
 152 
 153     memset(&eventCallbacks,0, sizeof(eventCallbacks));
 154     eventCallbacks.ObjectFree = objectFreeHandler;
 155     if (!NSK_JVMTI_VERIFY(jvmti->SetEventCallbacks(&eventCallbacks, sizeof(eventCallbacks)))) {
 156         return JNI_ERR;
 157     }
 158 
 159     if (!(nsk_jvmti_aod_enableEvent(jvmti, JVMTI_EVENT_OBJECT_FREE))) {
 160         return JNI_ERR;
 161     }
 162 
 163     NSK_DISPLAY1("%s: initialization was done\n", agentName);
 164 
 165     if (!NSK_VERIFY(nsk_aod_agentLoaded(jni, agentName)))
 166         return JNI_ERR;
 167 
 168     return JNI_OK;
 169 }
 170 
 171 }