/* * Copyright (c) 2021, 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 Basic test for JFR jdk.VirtualThreadXXX events * @requires vm.continuations * @modules jdk.jfr java.base/java.lang:+open * @library /test/lib * @run junit/othervm --enable-native-access=ALL-UNNAMED JfrEvents */ import java.io.IOException; import java.nio.file.Path; import java.util.List; import java.util.Map; import java.util.concurrent.Executor; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.RejectedExecutionException; import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import java.util.concurrent.locks.LockSupport; import java.util.function.Consumer; import java.util.stream.Collectors; import java.util.stream.Stream; import jdk.jfr.EventType; import jdk.jfr.Recording; import jdk.jfr.consumer.RecordedEvent; import jdk.jfr.consumer.RecordingFile; import jdk.test.lib.thread.VThreadPinner; import jdk.test.lib.thread.VThreadRunner.ThrowingRunnable; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; import static org.junit.jupiter.api.Assertions.*; class JfrEvents { /** * Test jdk.VirtualThreadStart and jdk.VirtualThreadEnd events. */ @Test void testVirtualThreadStartAndEnd() throws Exception { try (Recording recording = new Recording()) { recording.enable("jdk.VirtualThreadStart"); recording.enable("jdk.VirtualThreadEnd"); // execute 100 tasks, each in their own virtual thread recording.start(); ThreadFactory factory = Thread.ofVirtual().factory(); try (var executor = Executors.newThreadPerTaskExecutor(factory)) { for (int i = 0; i < 100; i++) { executor.submit(() -> { }); } Thread.sleep(1000); // give time for thread end events to be recorded } finally { recording.stop(); } Map events = sumEvents(recording); System.err.println(events); int startCount = events.getOrDefault("jdk.VirtualThreadStart", 0); int endCount = events.getOrDefault("jdk.VirtualThreadEnd", 0); assertEquals(100, startCount); assertEquals(100, endCount); } } /** * Arguments for testVirtualThreadPinned to test jdk.VirtualThreadPinned event. * [0] label/description * [1] the operation to park/wait * [2] the Thread.State when parked/waiting * [3] the action to unpark/notify the thread */ static Stream pinnedCases() { Object lock = new Object(); // park with native frame on stack var finish1 = new AtomicBoolean(); var parkWhenPinned = Arguments.of( "LockSupport.park when pinned", (ThrowingRunnable) () -> { VThreadPinner.runPinned(() -> { while (!finish1.get()) { LockSupport.park(); } }); }, Thread.State.WAITING, (Consumer) t -> { finish1.set(true); LockSupport.unpark(t); } ); // timed park with native frame on stack var finish2 = new AtomicBoolean(); var timedParkWhenPinned = Arguments.of( "LockSupport.parkNanos when pinned", (ThrowingRunnable) () -> { VThreadPinner.runPinned(() -> { while (!finish2.get()) { LockSupport.parkNanos(Long.MAX_VALUE); } }); }, Thread.State.TIMED_WAITING, (Consumer) t -> { finish2.set(true); LockSupport.unpark(t); } ); return Stream.of(parkWhenPinned, timedParkWhenPinned); } /** * Test jdk.VirtualThreadPinned event. */ @ParameterizedTest @MethodSource("pinnedCases") void testVirtualThreadPinned(String label, ThrowingRunnable parker, Thread.State expectedState, Consumer unparker) throws Exception { try (Recording recording = new Recording()) { recording.enable("jdk.VirtualThreadPinned"); recording.start(); try { var exception = new AtomicReference(); var thread = Thread.ofVirtual().start(() -> { try { parker.run(); } catch (Throwable e) { exception.set(e); } }); try { // wait for thread to park/wait Thread.State state = thread.getState(); while (state != expectedState) { assertTrue(state != Thread.State.TERMINATED, thread.toString()); Thread.sleep(10); state = thread.getState(); } } finally { unparker.accept(thread); thread.join(); assertNull(exception.get()); } } finally { recording.stop(); } Map events = sumEvents(recording); System.err.println(events); // should have at least one pinned event int pinnedCount = events.getOrDefault("jdk.VirtualThreadPinned", 0); assertTrue(pinnedCount >= 1, "Expected one or more events"); } } /** * Test jdk.VirtualThreadSubmitFailed event. */ @Test void testVirtualThreadSubmitFailed() throws Exception { try (Recording recording = new Recording()) { recording.enable("jdk.VirtualThreadSubmitFailed"); recording.start(); try (ExecutorService pool = Executors.newCachedThreadPool()) { Executor scheduler = task -> pool.execute(task); // create virtual thread that uses custom scheduler ThreadFactory factory = ThreadBuilders.virtualThreadBuilder(scheduler).factory(); // start a thread Thread thread = factory.newThread(LockSupport::park); thread.start(); // wait for thread to park while (thread.getState() != Thread.State.WAITING) { Thread.sleep(10); } // shutdown scheduler pool.shutdown(); // unpark, the submit should fail try { LockSupport.unpark(thread); fail(); } catch (RejectedExecutionException expected) { } // start another thread, it should fail and an event should be recorded try { factory.newThread(LockSupport::park).start(); throw new RuntimeException("RejectedExecutionException expected"); } catch (RejectedExecutionException expected) { } } finally { recording.stop(); } Map events = sumEvents(recording); System.err.println(events); int count = events.getOrDefault("jdk.VirtualThreadSubmitFailed", 0); assertEquals(2, count); } } /** * Read the events from the recording and return a map of event name to count. */ private static Map sumEvents(Recording recording) throws IOException { Path recordingFile = recordingFile(recording); List events = RecordingFile.readAllEvents(recordingFile); return events.stream() .map(RecordedEvent::getEventType) .collect(Collectors.groupingBy(EventType::getName, Collectors.summingInt(x -> 1))); } /** * Return the file path to the recording file. */ private static Path recordingFile(Recording recording) throws IOException { Path recordingFile = recording.getDestination(); if (recordingFile == null) { ProcessHandle h = ProcessHandle.current(); recordingFile = Path.of("recording-" + recording.getId() + "-pid" + h.pid() + ".jfr"); recording.dump(recordingFile); } return recordingFile; } }