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