1 /*
  2  * Copyright (c) 2003, 2022, 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 
 24 #include <stdio.h>
 25 #include <string.h>
 26 #include "jvmti.h"
 27 #include "jvmti_common.h"
 28 #include "../get_stack_trace.h"
 29 
 30 extern "C" {
 31 
 32 static jvmtiEnv *jvmti = NULL;
 33 static jvmtiCapabilities caps;
 34 static jvmtiEventCallbacks callbacks;
 35 static jmethodID mid;
 36 static frame_info expected_platform_frames[] = {
 37     {"Lgetstacktr05$TestThread;", "chain4", "()V"},
 38     {"Lgetstacktr05$TestThread;", "chain3", "()V"},
 39     {"Lgetstacktr05$TestThread;", "chain2", "()V"},
 40     {"Lgetstacktr05$TestThread;", "chain1", "()V"},
 41     {"Lgetstacktr05$TestThread;", "run", "()V"},
 42     {"Ljava/lang/Thread;", "runWith", "(Ljava/lang/Object;Ljava/lang/Runnable;)V"},
 43     {"Ljava/lang/Thread;", "run", "()V"},
 44 };
 45 
 46 static frame_info expected_virtual_frames[] = {
 47     {"Lgetstacktr05$TestThread;", "chain4", "()V"},
 48     {"Lgetstacktr05$TestThread;", "chain3", "()V"},
 49     {"Lgetstacktr05$TestThread;", "chain2", "()V"},
 50     {"Lgetstacktr05$TestThread;", "chain1", "()V"},
 51     {"Lgetstacktr05$TestThread;", "run", "()V"},
 52     {"Ljava/lang/VirtualThread;", "runWith", "(Ljava/lang/Object;Ljava/lang/Runnable;)V"},
 53     {"Ljava/lang/VirtualThread;", "run", "(Ljava/lang/Runnable;)V"},
 54     {"Ljava/lang/VirtualThread$VThreadContinuation$1;", "run", "()V"},
 55     {"Ljdk/internal/vm/Continuation;", "enter0", "()V"},
 56     {"Ljdk/internal/vm/Continuation;", "enter", "(Ljdk/internal/vm/Continuation;Z)V"},
 57 };
 58 
 59 
 60 void JNICALL
 61 Breakpoint(jvmtiEnv *jvmti_env, JNIEnv *jni, jthread thread, jmethodID method, jlocation location) {
 62   jint frame_count = 0;
 63 
 64   if (mid != method) {
 65     jni->FatalError("ERROR: didn't know where we got called from");
 66   }
 67 
 68   LOG(">>> (bp) checking frame count ...\n");
 69 
 70   check_jvmti_status(jni, jvmti_env->GetFrameCount(thread, &frame_count), "GetFrameCount failed.");
 71   int expected_number_of_stack_frames = jni->IsVirtualThread(thread)
 72       ? ((int) (sizeof(expected_virtual_frames) / sizeof(frame_info)))
 73       : ((int) (sizeof(expected_platform_frames) / sizeof(frame_info)));
 74   if (frame_count != expected_number_of_stack_frames + 1) {
 75     LOG("(bp) wrong frame count, expected: %d, actual: %d\n", expected_number_of_stack_frames + 1, frame_count);
 76     jni->FatalError("Wrong number of frames.");
 77   }
 78 
 79   LOG(">>> (bp)   frame_count: %d\n", frame_count);
 80 
 81   set_event_notification_mode(jvmti_env, JVMTI_ENABLE, JVMTI_EVENT_SINGLE_STEP, thread);
 82   LOG(">>> stepping ...\n");
 83 }
 84 
 85 
 86 void JNICALL
 87 SingleStep(jvmtiEnv *jvmti_env, JNIEnv *jni, jthread thread, jmethodID method, jlocation location) {
 88   set_event_notification_mode(jvmti, jni, JVMTI_DISABLE, JVMTI_EVENT_SINGLE_STEP, thread);
 89   frame_info *expected_frames = jni->IsVirtualThread(thread)
 90       ? expected_virtual_frames
 91       : expected_platform_frames;
 92   int expected_number_of_stack_frames = jni->IsVirtualThread(thread)
 93       ? ((int) (sizeof(expected_virtual_frames) / sizeof(frame_info)))
 94       : ((int) (sizeof(expected_platform_frames) / sizeof(frame_info)));
 95 
 96   if (!compare_stack_trace(jvmti_env, jni, thread, expected_frames, expected_number_of_stack_frames)) {
 97     jni->ThrowNew(jni->FindClass("java/lang/RuntimeException"), "Stacktrace differs from expected.");
 98   }
 99 }
100 
101 JNIEXPORT jint JNICALL
102 Agent_OnLoad(JavaVM *jvm, char *options, void *reserved) {
103   jvmtiError err;
104   jint res = jvm->GetEnv((void **) &jvmti, JVMTI_VERSION_1_1);
105   if (res != JNI_OK || jvmti == NULL) {
106     LOG("Wrong result of a valid call to GetEnv!\n");
107     return JNI_ERR;
108   }
109 
110   jvmtiCapabilities caps;
111   memset(&caps, 0, sizeof(caps));
112   caps.can_generate_breakpoint_events = 1;
113   caps.can_generate_single_step_events = 1;
114 
115   err = jvmti->AddCapabilities(&caps);
116   if (err != JVMTI_ERROR_NONE) {
117    LOG("(AddCapabilities) unexpected error: %s (%d)\n", TranslateError(err), err);
118     return JNI_ERR;
119   }
120 
121   callbacks.Breakpoint = &Breakpoint;
122   callbacks.SingleStep = &SingleStep;
123   err = jvmti->SetEventCallbacks(&callbacks, sizeof(callbacks));
124   if (err != JVMTI_ERROR_NONE) {
125     LOG("(SetEventCallbacks) unexpected error: %s (%d)\n", TranslateError(err), err);
126     return JNI_ERR;
127   }
128 
129   return JNI_OK;
130 }
131 
132 JNIEXPORT void JNICALL
133 Java_getstacktr05_getReady(JNIEnv *jni, jclass cls, jclass clazz) {
134   mid = jni->GetMethodID(clazz, "checkPoint", "()V");
135   if (mid == NULL) {
136     jni->FatalError("Cannot find Method ID for method checkPoint\n");
137   }
138   check_jvmti_status(jni, jvmti->SetBreakpoint(mid, 0), "SetBreakpoint failed.");
139   set_event_notification_mode(jvmti, jni, JVMTI_ENABLE,JVMTI_EVENT_BREAKPOINT, NULL);
140 }
141 
142 }