File: PopFramesTest.java

package info (click to toggle)
openjdk-21 21.0.8%2B9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 823,976 kB
  • sloc: java: 5,613,338; xml: 1,643,607; cpp: 1,296,296; ansic: 420,291; asm: 404,850; objc: 20,994; sh: 15,271; javascript: 11,245; python: 6,895; makefile: 2,362; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (361 lines) | stat: -rw-r--r-- 13,477 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
/*
 * Copyright (c) 2023, 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.
 */

/**
 * @test
 * @summary Call popFrames() on threads in various states not covered
 *          well by other tests. Most notably, this test includes
 *          test cases for a suspended but unmounted virtual thread.
 *          It is mostly for testing for OpaqueFrameException and
 *          NativeMethodException.
 *
 * @run build TestScaffold VMConnection TargetListener TargetAdapter
 * @run compile -g PopFramesTest.java
 * @run driver PopFramesTest SLEEP_NATIVE
 * @run driver PopFramesTest LOOP_NATIVE
 * @run driver PopFramesTest SLEEP_PRENATIVE
 * @run driver PopFramesTest LOOP_PRENATIVE
 * @run driver PopFramesTest SLEEP_NONATIVE
 * @run driver PopFramesTest LOOP_NONATIVE
 */
import com.sun.jdi.*;
import com.sun.jdi.event.*;
import java.util.*;

/*
 * There are six test modes covered by this test:
 *   SLEEP_NATIVE
 *   LOOP_NATIVE
 *   SLEEP_PRENATIVE
 *   LOOP_PRENATIVE
 *   SLEEP_NONATIVE
 *   LOOP_NONATIVE
 *
 * SLEEP:     the debuggee blocks in Thread.sleep().
 * LOOP:      the debuggee sits in a tight loop.
 * NATIVE:    there is a native frame within the set of frames to pop.
 * PRENATIVE: there is a native frame before the set of frames to pop.
 * NONATIVE:  there is no native frame (purposefully) present in the stack.
 *
 * In all cases the thread is suspended and errors such as IllegalArgumentException
 * and InvalidStackFrameException should not happen. The popFrames() calls should
 * either pass, or produce OpaqueFrameException or NativeMethodException.
 *
 * Call stacks for each test mode (and expected result):
 *  - Note in all cases the popMethod() frame is the frame passed to popFrames().
 *  - Note that Thread.sleep() usually results in the native Thread.sleep0() frame
 *    being at the top of the stack. However, for a mounted virtual thread that is
 *    not pinned, it does not result in any native frames due to how the VM
 *    parks non-pinned virtual threads.
 *
 * SLEEP_NATIVE (NativeMethodException):
 *   Thread.sleep() + methods called by Thread.sleep()
 *   loopOrSleep()
 *   upcallMethod()
 *   doUpcall()  <-- native method
 *   popMethod()
 *   main()
 *
 * LOOP_NATIVE (NativeMethodException):
 *   loopOrSleep()  <-- tight loop
 *   upcallMethod()
 *   doUpcall()  <-- native method
 *   popMethod()
 *   main()
 *
 * SLEEP_PRENATIVE (NativeMethodException due to Thread.sleep() blocking in a native method):
 *   Thread.sleep() + methods called by Thread.sleep()
 *   loopOrSleep()
 *   popMethod()
 *   upcallMethod()
 *   doUpcall()  <-- native method
 *   main()
 *
 * LOOP_PRENATIVE (no exception):
 *   loopOrSleep()  <-- tight loop
 *   popMethod()
 *   upcallMethod()
 *   doUpcall()  <-- native method
 *   main()
 *
 * SLEEP_NONATIVE (NativeMethodException for platform thread or OpaqueFrameException
 * for virtual thread. See explanation in runTests().):
 *   Thread.sleep() + methods called by Thread.sleep()
 *   loopOrSleep()
 *   popMethod()
 *   main()
 *
 * LOOP_NONATIVE (no exception):
 *   loopOrSleep()  <-- tight loop
 *   popMethod()
 *   main()
 */

class PopFramesTestTarg {
    static TestMode mode;

    static {
        System.loadLibrary("PopFramesTestTarg");
    }

    /*
     * This is the method whose frame (and all those after it) will be popped.
     */
    public static void popMethod() {
        System.out.println("    debuggee: in popMethod");
        if (mode.isCallNative()) {
            doUpcall();
        } else {
            loopOrSleep();
        }
    }

    public static void loopOrSleep() {
        if (mode.isDoLoop()) {
            while (true);
        } else {
            try {
                Thread.sleep(10000);
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
            }
        }
    }

    public static native void doUpcall(); // native method that will call upcallMethod()

    public static void upcallMethod() {
        if (mode.isCallPrenative()) {
            popMethod();
        } else {
            loopOrSleep();
        }
    }

    public static void main(String[] args) {
        System.out.println("    debuggee: Howdy!");

        // We expect just one argument, which is the test mode, such as SLEEP_NONATIVE.
        if (args.length != 1) {
            throw new RuntimeException("Must pass 1 arguments to PopFramesTestTarg");
        }
        System.out.println("    debuggee: args[0]: " + args[0]);
        mode = Enum.valueOf(TestMode.class, args[0]); // convert test mode string to an enum
        System.out.println("    debuggee: test mode: " + mode);

        if (mode.isCallNative()) {
            popMethod(); // call popMethod() directly, and it will call out to native
        } else if (mode.isCallPrenative()) {
            doUpcall();  // call native method that will call back into java to call popMethod()
        } else {
            popMethod(); // call popMethod() directly
        }

        System.out.println("    debuggee: Goodbye from PopFramesTest!");
    }
}

/*
 * The different modes the test can be run in. See test description comment above.
 */
enum TestMode {
    SLEEP_NATIVE,
    LOOP_NATIVE,
    SLEEP_PRENATIVE,
    LOOP_PRENATIVE,
    SLEEP_NONATIVE,
    LOOP_NONATIVE;

    // Returns true if debuggee should block in an infinite loop. Otherwise it calls Thread.sleep().
    boolean isDoLoop() {
        return this == LOOP_NATIVE || this == LOOP_PRENATIVE || this == LOOP_NONATIVE;
    }

    // Returns true if debuggee should introduce a native frame within the set of frames to pop.
    boolean isCallNative() {
        return this == LOOP_NATIVE || this == SLEEP_NATIVE;
    }

    // Returns true if debuggee should introduce a native frame before the set of frames to pop.
    // The purpose is to cause the virtual thread to be pinned.
    boolean isCallPrenative() {
        return this == LOOP_PRENATIVE || this == SLEEP_PRENATIVE;
    }
}

/********** test program **********/

public class PopFramesTest extends TestScaffold {
    private static TestMode mode;

    PopFramesTest(String args[]) {
        super(args);
    }

    public static void main(String[] args) throws Exception {
        // We should get one argument that indicates the test mode, such as SLEEP_NONATIVE.
        if (args.length != 1) {
            throw new RuntimeException("Must pass one argument to PopFramesTestTarg");
        }
        mode = Enum.valueOf(TestMode.class, args[0]); // convert test mode string to an enum

        /*
         * The @run command looks something like:
         *   @run driver PopFramesTest SLEEP_NONATIVE
         * We need to pass SLEEP_NONATIVE to the debuggee. We also need to insert
         * -Djava.library.path so the native method can be accessed if called.
         */
        String nativePath = "-Djava.library.path=" + System.getProperty("java.library.path");
        String[] newArgs = new String[2];
        newArgs[0] = nativePath;
        newArgs[1] = args[0]; // pass test mode, such as SLEEP_NONATIVE

        new PopFramesTest(newArgs).startTests();
    }

    StackFrame frameFor(ThreadReference thread, String methodName) throws Exception {
        Iterator it = thread.frames().iterator();

        while (it.hasNext()) {
            StackFrame frame = (StackFrame)it.next();
            if (frame.location().method().name().equals(methodName)) {
                return frame;
            }
        }
        failure("FAIL: " + methodName + " not on stack");
        return null;
    }

    public void printStack(ThreadReference thread, String msg) throws Exception {
        System.out.println(msg);
        List<StackFrame> stack_frames = thread.frames();
        int i = 0;
        String sourceName;
        for (StackFrame f : stack_frames) {
            try {
                sourceName = f.location().sourceName();
            } catch (AbsentInformationException aie) {
                sourceName = "Unknown source";
            }
            System.out.println("frame[" + i++ +"]: " + f.location().method() +
                               " (bci:"+ f.location().codeIndex() + ")" +
                               " (" + sourceName + ":"+ f.location().lineNumber() + ")");
        }
    }

    /********** test core **********/

    protected void runTests() throws Exception {
        BreakpointEvent bpe = startTo("PopFramesTestTarg", "loopOrSleep", "()V");
        ThreadReference mainThread = bpe.thread();

        // Resume main thread until it is in Thread.sleep() or the infinite loop.
        mainThread.resume();
        try {
            Thread.sleep(1000); // give thread chance to get into Thread.sleep() or loop
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
        mainThread.suspend(); // Suspend thread while in Thread.sleep() or loop
        printStack(mainThread, "Debuggee stack before popFrames():");

        /*
         * Figure out which exception popFrames() should throw.
         */
        Class expected_exception;
        switch(mode) {
        case SLEEP_NATIVE:
        case LOOP_NATIVE:
        case SLEEP_PRENATIVE:
            /*
             * For the two NATIVE cases, there is a native frame within the set of frames
             * to pop. For the SLEEP_PRENATIVE case, there also ends up being a native
             * frame. It will either be Thread.sleep0() for platform threads or
             * Unsafe.park() for virtual threads. See the SLEEP_NATIVE comment below
             * for more details.
             */
            expected_exception = NativeMethodException.class;
            break;
        case LOOP_PRENATIVE:
        case LOOP_NONATIVE:
            /*
             * For these two test cases, there are no native frames within the set of
             * frames to pop, nor in the frame previous to the frame to pop, so no
             * exception is expected.
             */
            expected_exception = null;
            break;
        case SLEEP_NONATIVE:
            /*
             * For platform threads, Thread.sleep() results in the Thread.sleep0() native
             * frame on the stack, so the end result is NativeMethodException. For virtual
             * threads it is not quite so simple. If the thead is pinned (such as when
             * there is already a native method on the stack), you end up in
             * VirtualThread.parkOnCarrierThread(), which calls Unsafe.park(), which is a
             * native method, so again this results in NativeMethodException. However, for
             * a virtual thread that is not pinned (which is true for this test case), you
             * end up with no native methods on the stack due to how Continuation.yield()
             * works. So you have an unmounted virtual thread with no native frames, which
             * results in OpaqueFrameException being thrown.
             */
            if (DebuggeeWrapper.isVirtual()) {
                expected_exception = OpaqueFrameException.class;
            } else {
                expected_exception = NativeMethodException.class;
            }
            break;
        default:
            throw new RuntimeException("Bad test mode: " + mode);
        }

        /*
         * Pop all the frames up to and including the popMethod() frame.
         */
        try {
            mainThread.popFrames(frameFor(mainThread, "popMethod"));
            if (expected_exception != null) {
                failure("failure: popFrames() did not get expected exception: " + expected_exception);
            }
        } catch (Exception ex) {
            if (expected_exception == ex.getClass()) {
                System.out.println("success: popFrames() got expected exception: " + ex);
            } else {
                failure("failure: popFrames() got unexpected exception: " + ex);
            }
        }

        printStack(mainThread, "Debuggee stack after popFrames():");

        /*
         * Most tests do a listenUntilVMDisconnect() here, but there is no real need for it
         * with this test, and doing so would require finding a way to get the debuggee
         * to exit the endless loop it might be in. When we return, TestScaffold will
         * call TestScaffold.shutdown(), causing the debuggee process to be terminated quickly.
         */

        if (testFailed) {
            throw new Exception("PopFramesTest failed");
        }
        System.out.println("Passed:");
    }
}