Event filters reworked, method breakpoints submitted to classes as they are loaded. (GR-68719)

Author: entlicher

espresso/src/com.oracle.truffle.espresso.jdwp/src/com/oracle/truffle/espresso/jdwp/api/VMEventListener.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2025, 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
@@ -22,6 +22,8 @@
  */
 package com.oracle.truffle.espresso.jdwp.api;
 
+import java.util.function.Consumer;
+
 import com.oracle.truffle.espresso.jdwp.impl.BreakpointInfo;
 import com.oracle.truffle.espresso.jdwp.impl.ClassPrepareRequest;
 import com.oracle.truffle.espresso.jdwp.impl.FieldBreakpointEvent;
@@ -40,6 +42,10 @@ public interface VMEventListener extends VMListener {
 
     boolean vmDied();
 
+    void addClassConsumer(Consumer<KlassRef> classConsumer);
+
+    void removeClassConsumer(Consumer<KlassRef> classConsumer);
+
     void addClassUnloadRequestId(int id);
 
     void addThreadStartedRequestId(int id, byte suspendPolicy);

espresso/src/com.oracle.truffle.espresso.jdwp/src/com/oracle/truffle/espresso/jdwp/api/VMEventListenerImpl.java

@@ -24,11 +24,13 @@
 
 import java.lang.reflect.Modifier;
 import java.util.ArrayList;
-import java.util.HashMap;
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.Callable;
-import java.util.regex.Pattern;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.function.Consumer;
 
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.debug.Breakpoint;
@@ -40,6 +42,7 @@
 import com.oracle.truffle.espresso.jdwp.impl.BreakpointInfo;
 import com.oracle.truffle.espresso.jdwp.impl.ClassPrepareRequest;
 import com.oracle.truffle.espresso.jdwp.impl.DebuggerController;
+import com.oracle.truffle.espresso.jdwp.impl.EventInfo;
 import com.oracle.truffle.espresso.jdwp.impl.FieldBreakpointEvent;
 import com.oracle.truffle.espresso.jdwp.impl.FieldBreakpointInfo;
 import com.oracle.truffle.espresso.jdwp.impl.JDWP;
@@ -58,13 +61,14 @@ public final class VMEventListenerImpl implements VMEventListener {
 
     public static final InteropLibrary UNCACHED = InteropLibrary.getUncached();
 
-    private final HashMap<Integer, ClassPrepareRequest> classPrepareRequests = new HashMap<>();
-    private final HashMap<Integer, BreakpointInfo> breakpointRequests = new HashMap<>();
-    private final HashMap<Integer, RequestFilter> monitorContendedRequests = new HashMap<>();
-    private final HashMap<Integer, RequestFilter> monitorContendedEnteredRequests = new HashMap<>();
-    private final HashMap<Integer, RequestFilter> monitorWaitRequests = new HashMap<>();
-    private final HashMap<Integer, RequestFilter> monitorWaitedRequests = new HashMap<>();
-    private final HashMap<Integer, FieldRef> fieldRequests = new HashMap<>();
+    private final Map<Integer, ClassPrepareRequest> classPrepareRequests = new ConcurrentHashMap<>();
+    private final Map<Integer, BreakpointInfo> breakpointRequests = new ConcurrentHashMap<>();
+    private final Map<Integer, RequestFilter> monitorContendedRequests = new ConcurrentHashMap<>();
+    private final Map<Integer, RequestFilter> monitorContendedEnteredRequests = new ConcurrentHashMap<>();
+    private final Map<Integer, RequestFilter> monitorWaitRequests = new ConcurrentHashMap<>();
+    private final Map<Integer, RequestFilter> monitorWaitedRequests = new ConcurrentHashMap<>();
+    private final Map<Integer, FieldRef> fieldRequests = new ConcurrentHashMap<>();
+    private final Collection<Consumer<KlassRef>> classConsumers = new CopyOnWriteArrayList<>();
 
     // The connection field is null only until the connection is established. Thus, we need
     // to guard any attempted usage prior to that, e.g. vm dies event.
@@ -82,7 +86,7 @@ public final class VMEventListenerImpl implements VMEventListener {
     private byte vmDeathSuspendPolicy = SuspendStrategy.NONE;
     private int vmStartRequestId;
     private final List<PacketStream> heldEvents = new ArrayList<>();
-    private final Map<Object, Object> currentContendedMonitor = new HashMap<>();
+    private final Map<Object, Object> currentContendedMonitor = new ConcurrentHashMap<>();
     private Object initialThread;
 
     public void activate(Object mainThread, DebuggerController control, JDWPContext jdwpContext) {
@@ -125,19 +129,25 @@ public void setConnection(SocketConnection connection) {
         this.connection = connection;
     }
 
+    @Override
+    public void addClassConsumer(Consumer<KlassRef> classConsumer) {
+        classConsumers.add(classConsumer);
+    }
+
+    @Override
+    public void removeClassConsumer(Consumer<KlassRef> classConsumer) {
+        classConsumers.remove(classConsumer);
+    }
+
     @Override
     public void addClassPrepareRequest(ClassPrepareRequest request) {
-        synchronized (classPrepareRequests) {
-            classPrepareRequests.put(request.getRequestId(), request);
-        }
+        classPrepareRequests.put(request.getRequestId(), request);
     }
 
     @Override
     @TruffleBoundary
     public void removeClassPrepareRequest(int requestId) {
-        synchronized (classPrepareRequests) {
-            classPrepareRequests.remove(requestId);
-        }
+        classPrepareRequests.remove(requestId);
     }
 
     @Override
@@ -159,6 +169,7 @@ public void removeBreakpointRequest(int requestId) {
 
     @Override
     public void clearAllBreakpointRequests() {
+        classConsumers.clear();
         breakpointRequests.clear();
     }
 
@@ -286,25 +297,22 @@ public boolean onMethodReturn(MethodRef method, Node node, Object returnValue) {
     @Override
     @TruffleBoundary
     public void classPrepared(KlassRef klass, Object prepareThread) {
+        for (Consumer<KlassRef> c : classConsumers) {
+            c.accept(klass);
+        }
         // check if event should be reported based on the current patterns, otherwise return early
         if (classPrepareRequests.isEmpty()) {
             return;
         }
 
-        String dotName = klass.getNameAsString().replace('/', '.');
         ArrayList<ClassPrepareRequest> toSend = new ArrayList<>();
         byte suspendPolicy = SuspendStrategy.NONE;
 
-        // take a snapshot of the current class prepare events
-        // to avoid concurrent modification exceptions
-        ClassPrepareRequest[] prepareRequests;
-        synchronized (classPrepareRequests) {
-            prepareRequests = classPrepareRequests.values().toArray(new ClassPrepareRequest[0]);
-        }
-        for (ClassPrepareRequest cpr : prepareRequests) {
-            Pattern[] patterns = cpr.getPatterns();
-            for (Pattern pattern : patterns) {
-                if ("".equals(pattern.pattern()) || pattern.matcher(dotName).matches()) {
+        Collection<ClassPrepareRequest> prepareRequests = classPrepareRequests.values();
+        if (!prepareRequests.isEmpty()) {
+            EventInfo event = new EventInfo.Klass(klass, prepareThread);
+            for (ClassPrepareRequest cpr : prepareRequests) {
+                if (cpr.isHit(event)) {
                     toSend.add(cpr);
                     byte cprPolicy = cpr.getSuspendPolicy();
                     if (cprPolicy == SuspendStrategy.ALL) {
@@ -313,6 +321,9 @@ public void classPrepared(KlassRef klass, Object prepareThread) {
                         suspendPolicy = SuspendStrategy.EVENT_THREAD;
                     }
                 }
+                if (!cpr.isActive()) {
+                    classPrepareRequests.remove(cpr.getRequestId());
+                }
             }
         }
         if (!toSend.isEmpty()) {
@@ -700,18 +711,21 @@ public void monitorWait(Object monitor, long timeout) {
         if (monitorWaitRequests.isEmpty()) {
             return;
         }
+        CallFrame frame = context.locateObjectWaitFrame();
+        EventInfo event = new EventInfo.Frame(context, frame, guestThread);
         for (Map.Entry<Integer, RequestFilter> entry : monitorWaitRequests.entrySet()) {
             RequestFilter filter = entry.getValue();
-            if (guestThread == filter.getThread()) {
+            if (filter.isHit(event)) {
                 // monitor wait(timeout) is called on a requested thread
                 // create the call frame for the caller location of Object.wait(timeout)
-                CallFrame frame = context.locateObjectWaitFrame();
-
                 debuggerController.immediateSuspend(guestThread, filter.getSuspendPolicy(), () -> {
                     sendMonitorWaitEvent(monitor, timeout, filter, frame);
                     return null;
                 });
             }
+            if (!filter.isActive()) {
+                monitorWaitRequests.remove(filter.getRequestId());
+            }
         }
     }
 
@@ -770,12 +784,13 @@ public void monitorWaited(Object monitor, boolean timedOut) {
         if (monitorWaitedRequests.isEmpty()) {
             return;
         }
+        CallFrame frame = context.locateObjectWaitFrame();
+        EventInfo event = new EventInfo.Frame(context, frame, currentThread);
         for (Map.Entry<Integer, RequestFilter> entry : monitorWaitedRequests.entrySet()) {
             RequestFilter filter = entry.getValue();
-            if (currentThread == filter.getThread()) {
+            if (filter.isHit(event)) {
                 // monitor wait(timeout) is called on a requested thread
                 // create the call frame for the caller location of Object.wait(timeout)
-                CallFrame frame = context.locateObjectWaitFrame();
 
                 debuggerController.immediateSuspend(currentThread, filter.getSuspendPolicy(), new Callable<Void>() {
                     @Override
@@ -785,6 +800,9 @@ public Void call() {
                     }
                 });
             }
+            if (!filter.isActive()) {
+                monitorWaitedRequests.remove(filter.getRequestId());
+            }
         }
     }
 
@@ -801,18 +819,22 @@ public void onContendedMonitorEnter(Object monitor) {
             return;
         }
 
+        final CallFrame topFrame = context.getStackTrace(guestThread)[0];
+        EventInfo event = new EventInfo.Frame(context, topFrame, guestThread);
         for (Map.Entry<Integer, RequestFilter> entry : monitorContendedRequests.entrySet()) {
             RequestFilter filter = entry.getValue();
-            if (guestThread == filter.getThread()) {
+            if (filter.isHit(event)) {
                 // monitor is contended on a requested thread
-                MonitorEvent event = new MonitorEvent(monitor, filter);
-                final CallFrame topFrame = context.getStackTrace(guestThread)[0];
+                MonitorEvent mevent = new MonitorEvent(monitor, filter);
 
                 debuggerController.immediateSuspend(guestThread, filter.getSuspendPolicy(), () -> {
-                    sendMonitorContendedEnterEvent(event, topFrame);
+                    sendMonitorContendedEnterEvent(mevent, topFrame);
                     return null;
                 });
             }
+            if (!filter.isActive()) {
+                monitorContendedRequests.remove(filter.getRequestId());
+            }
         }
     }
 
@@ -829,18 +851,22 @@ public void onContendedMonitorEntered(Object monitor) {
             return;
         }
 
+        final CallFrame topFrame = context.getStackTrace(guestThread)[0];
+        EventInfo event = new EventInfo.Frame(context, topFrame, guestThread);
         for (Map.Entry<Integer, RequestFilter> entry : monitorContendedEnteredRequests.entrySet()) {
             RequestFilter filter = entry.getValue();
-            if (guestThread == filter.getThread()) {
+            if (filter.isHit(event)) {
                 // monitor is contended on a requested thread
-                MonitorEvent event = new MonitorEvent(monitor, filter);
-                final CallFrame topFrame = context.getStackTrace(guestThread)[0];
+                MonitorEvent mevent = new MonitorEvent(monitor, filter);
 
                 debuggerController.immediateSuspend(guestThread, filter.getSuspendPolicy(), () -> {
-                    sendMonitorContendedEnteredEvent(event, topFrame);
+                    sendMonitorContendedEnteredEvent(mevent, topFrame);
                     return null;
                 });
             }
+            if (!filter.isActive()) {
+                monitorContendedEnteredRequests.remove(filter.getRequestId());
+            }
         }
     }
 

espresso/src/com.oracle.truffle.espresso.jdwp/src/com/oracle/truffle/espresso/jdwp/impl/AbstractBreakpointInfo.java

@@ -88,11 +88,6 @@ public boolean isUnCaught() {
         return false;
     }
 
-    @Override
-    public Object getThread() {
-        return null;
-    }
-
     @Override
     public long getClassId() {
         return 0;

espresso/src/com.oracle.truffle.espresso.jdwp/src/com/oracle/truffle/espresso/jdwp/impl/BreakpointInfo.java

@@ -43,8 +43,6 @@ public interface BreakpointInfo {
 
     boolean isUnCaught();
 
-    Object getThread();
-
     long getClassId();
 
     long getMethodId();

espresso/src/com.oracle.truffle.espresso.jdwp/src/com/oracle/truffle/espresso/jdwp/impl/ClassPrepareRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2025, 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
@@ -22,8 +22,6 @@
  */
 package com.oracle.truffle.espresso.jdwp.impl;
 
-import java.util.regex.Pattern;
-
 public final class ClassPrepareRequest {
 
     private final RequestFilter filter;
@@ -32,19 +30,16 @@ public final class ClassPrepareRequest {
         this.filter = filter;
     }
 
-    public Pattern[] getPatterns() {
-        if (filter.getIncludePatterns().length == 0) {
-            return new Pattern[]{Pattern.compile("")};
-        }
-        return filter.getIncludePatterns();
+    public boolean isHit(EventInfo event) {
+        return filter.isHit(event);
     }
 
-    public int getRequestId() {
-        return filter.getRequestId();
+    public boolean isActive() {
+        return filter.isActive();
     }
 
-    public Object getThread() {
-        return filter.getThread();
+    public int getRequestId() {
+        return filter.getRequestId();
     }
 
     public byte getSuspendPolicy() {