Skip to content

[GR-64644] Use eager probes for instrumenting statement nodes. #11234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+115 −190
Closed

[GR-64644] Use eager probes for instrumenting statement nodes. #11234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion ...le.espresso/src/com/oracle/truffle/espresso/nodes/AbstractInstrumentableBytecodeNode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 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
Expand All @@ -24,6 +24,7 @@

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Set;

import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.frame.Frame;
Expand Down Expand Up @@ -160,4 +161,6 @@ private static boolean checkLocals(Local[] liveLocals, Method method) {
public boolean hasTag(Class<? extends Tag> tag) {
return tag == StandardTags.RootBodyTag.class;
}

public abstract void prepareForInstrumentation(Set<Class<?>> tags);
}
121 changes: 24 additions & 97 deletions ...o/src/com.oracle.truffle.espresso/src/com/oracle/truffle/espresso/nodes/BytecodeNode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,10 +290,8 @@
import com.oracle.truffle.api.frame.FrameDescriptor;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.instrumentation.GenerateWrapper.YieldException;
import com.oracle.truffle.api.instrumentation.InstrumentableNode;
import com.oracle.truffle.api.instrumentation.ProbeNode;
import com.oracle.truffle.api.instrumentation.StandardTags.StatementTag;
import com.oracle.truffle.api.instrumentation.Tag;
import com.oracle.truffle.api.interop.InteropLibrary;
import com.oracle.truffle.api.nodes.BytecodeOSRNode;
import com.oracle.truffle.api.nodes.ControlFlowException;
Expand Down Expand Up @@ -1816,17 +1814,17 @@ public int getBci(Frame frame) {
}

@Override
public InstrumentableNode materializeInstrumentableNodes(Set<Class<? extends Tag>> materializedTags) {
public void prepareForInstrumentation(Set<Class<?>> tags) {
InstrumentationSupport info = this.instrumentation;
if (info == null && materializedTags.contains(StatementTag.class)) {
if (info == null && tags.contains(StatementTag.class)) {
Lock lock = getLock();
lock.lock();
try {
info = this.instrumentation;
// double checked locking
if (info == null) {
generifyBytecodeLevelInlining();
this.instrumentation = info = insert(new InstrumentationSupport(getMethodVersion(), frameDescriptor));
this.instrumentation = info = insert(new InstrumentationSupport(getMethodVersion()));
// the debug info contains instrumentable nodes so we need to notify for
// instrumentation updates.
notifyInserted(info);
Expand All @@ -1835,7 +1833,6 @@ public InstrumentableNode materializeInstrumentableNodes(Set<Class<? extends Tag
lock.unlock();
}
}
return this;
}

private static boolean takeBranchRef1(StaticObject operand, int opcode) {
Expand Down Expand Up @@ -2018,15 +2015,11 @@ private int beforeJumpChecks(VirtualFrame frame, int curBCI, int targetBCI, int
if (CompilerDirectives.inInterpreter() && BytecodeOSRNode.pollOSRBackEdge(this, REPORT_LOOP_STRIDE)) {
livenessAnalysis.catchUpOSR(frame, targetBCI, skipLivenessActions);
Object osrResult;
StoredWrapperNode storedWrapperNode = null;
try {
storedWrapperNode = storeWrapperNodeIfSet(frame, instrument);
osrResult = BytecodeOSRNode.tryOSR(this, targetBCI, new EspressoOSRInterpreterState(top, nextStatementIndex), null, frame);
} catch (Throwable any) {
// Has already been guest-handled in OSR. Shortcut out of the method.
throw new EspressoOSRReturnException(any);
} finally {
restoreWrapperNode(frame, storedWrapperNode, instrument);
}
if (osrResult != null) {
throw new EspressoOSRReturnException(osrResult);
Expand All @@ -2039,32 +2032,6 @@ private int beforeJumpChecks(VirtualFrame frame, int curBCI, int targetBCI, int
return nextStatementIndex;
}

private static void restoreWrapperNode(VirtualFrame frame, StoredWrapperNode storedWrapperNode, InstrumentationSupport instrument) {
// restore wrapper nodes after OSR
if (storedWrapperNode != null) {
frame.setAuxiliarySlot(instrument.wrapperSlotIndex, storedWrapperNode.storedWrapperNode());
if (InstrumentationSupport.assertionsEnabled()) {
frame.setAuxiliarySlot(instrument.indexSlotIndex, storedWrapperNode.storedIndex());
}
}
}

private static StoredWrapperNode storeWrapperNodeIfSet(VirtualFrame frame, InstrumentationSupport instrument) {
// check if we have stores wrapper nodes and index in the frame and store if so
if (instrument != null) {
Object storedWrapperNode = frame.getAuxiliarySlot(instrument.wrapperSlotIndex);
int storedIndex = 0;
if (InstrumentationSupport.assertionsEnabled()) {
storedIndex = (int) frame.getAuxiliarySlot(instrument.indexSlotIndex);
}
return new StoredWrapperNode(storedWrapperNode, storedIndex);
}
return null;
}

private record StoredWrapperNode(Object storedWrapperNode, int storedIndex) {
}

@ExplodeLoop
@SuppressWarnings("unused")
private ExceptionHandler resolveExceptionHandlers(int bci, StaticObject ex) {
Expand Down Expand Up @@ -2938,8 +2905,6 @@ private boolean lockIsHeld() {

static final class InstrumentationSupport extends EspressoNode {
static final int NO_STATEMENT = -1;
private static final Object WRAPPER_SLOT_KEY = new Object();
private static final Object WRAPPER_INDEX_SLOT_KEY = new Object();

@SuppressWarnings("all")
private static boolean assertionsEnabled() {
Expand All @@ -2948,22 +2913,16 @@ private static boolean assertionsEnabled() {
return areAssertionsEnabled;
}

@Children private final EspressoBaseStatementNode[] statementNodes;
@Children private final EspressoStatementNode[] statementNodes;
@Child private MapperBCI hookBCIToNodeIndex;

private final EspressoContext context;
private final MethodVersion method;

private final int wrapperSlotIndex;
private final int indexSlotIndex;

InstrumentationSupport(MethodVersion method, FrameDescriptor frameDescriptor) {
InstrumentationSupport(MethodVersion method) {
this.method = method;
this.context = method.getMethod().getContext();

this.wrapperSlotIndex = frameDescriptor.findOrAddAuxiliarySlot(WRAPPER_SLOT_KEY);
this.indexSlotIndex = frameDescriptor.findOrAddAuxiliarySlot(WRAPPER_INDEX_SLOT_KEY);

LineNumberTableAttribute table = method.getLineNumberTableAttribute();

if (table != LineNumberTableAttribute.EMPTY) {
Expand All @@ -2974,9 +2933,8 @@ private static boolean assertionsEnabled() {
Arrays.fill(seenLines, -1);
int maxSeenLine = -1;

this.statementNodes = new EspressoBaseStatementNode[entries.size()];
this.hookBCIToNodeIndex = new MapperBCI(table);

EspressoStatementNode[] statements = new EspressoStatementNode[entries.size()];
MapperBCI mapper = new MapperBCI(table);
for (int i = 0; i < entries.size(); i++) {
LineNumberTableAttribute.Entry entry = entries.get(i);
int lineNumber = entry.getLineNumber();
Expand All @@ -2991,11 +2949,13 @@ private static boolean assertionsEnabled() {
}
}
if (!seen) {
statementNodes[hookBCIToNodeIndex.initIndex(i, entry.getBCI())] = new EspressoStatementNode(entry.getBCI(), lineNumber);
statements[mapper.initIndex(i, entry.getBCI())] = new EspressoStatementNode(entry.getBCI(), method.getMethod().getSource().createSection(lineNumber));
seenLines[i] = lineNumber;
maxSeenLine = Math.max(maxSeenLine, lineNumber);
}
}
this.hookBCIToNodeIndex = mapper;
this.statementNodes = statements;
} else {
this.statementNodes = null;
this.hookBCIToNodeIndex = null;
Expand Down Expand Up @@ -3040,22 +3000,18 @@ public void notifyResume(VirtualFrame frame, AbstractInstrumentableBytecodeNode
}

void notifyExceptionAt(VirtualFrame frame, Throwable t, int statementIndex) {
assert (int) frame.getAuxiliarySlot(indexSlotIndex) == statementIndex;
WrapperNode wrapperNode = (WrapperNode) frame.getAuxiliarySlot(wrapperSlotIndex);
if (wrapperNode == null) {
ProbeNode probeNode = getProbeAt(statementIndex);
if (probeNode == null) {
return;
}
ProbeNode probeNode = wrapperNode.getProbeNode();
probeNode.onReturnExceptionalOrUnwind(frame, t, false);
}

void notifyYieldAt(VirtualFrame frame, Object o, int statementIndex) {
assert (int) frame.getAuxiliarySlot(indexSlotIndex) == statementIndex;
WrapperNode wrapperNode = (WrapperNode) frame.getAuxiliarySlot(wrapperSlotIndex);
if (wrapperNode == null) {
ProbeNode probeNode = getProbeAt(statementIndex);
if (probeNode == null) {
return;
}
ProbeNode probeNode = wrapperNode.getProbeNode();
probeNode.onYield(frame, o);
}

Expand All @@ -3076,21 +3032,10 @@ public void notifyFieldAccess(VirtualFrame frame, int index, Field field, Static
}

private void enterAt(VirtualFrame frame, int index) {
WrapperNode wrapperNode = getWrapperAt(index);
/*
* We need to store this wrapper node in the frame to make sure we exit on the same
* wrapper. Wrapper nodes can be replaced at arbitrary time for example when the
* debugger is disposed and the session is ended.
*/
frame.setAuxiliarySlot(wrapperSlotIndex, wrapperNode);
// only add wrapper index in frame when assertions enabled
if (assertionsEnabled()) {
frame.setAuxiliarySlot(indexSlotIndex, index);
}
if (wrapperNode == null) {
ProbeNode probeNode = getProbeAt(index);
if (probeNode == null) {
return;
}
ProbeNode probeNode = wrapperNode.getProbeNode();
try {
probeNode.onEnter(frame);
} catch (Throwable t) {
Expand All @@ -3109,21 +3054,10 @@ private void enterAt(VirtualFrame frame, int index) {
}

private void resumeAt(VirtualFrame frame, int index) {
WrapperNode wrapperNode = getWrapperAt(index);
/*
* We need to store this wrapper node in the frame to make sure we exit on the same
* wrapper. Wrapper nodes can be replaced at arbitrary time for example when the
* debugger is disposed and the session is ended.
*/
frame.setAuxiliarySlot(wrapperSlotIndex, wrapperNode);
// only add wrapper index in frame when assertions enabled
if (assertionsEnabled()) {
frame.setAuxiliarySlot(indexSlotIndex, index);
}
if (wrapperNode == null) {
ProbeNode probeNode = getProbeAt(index);
if (probeNode == null) {
return;
}
ProbeNode probeNode = wrapperNode.getProbeNode();
try {
probeNode.onResume(frame);
} catch (Throwable t) {
Expand All @@ -3142,12 +3076,10 @@ private void resumeAt(VirtualFrame frame, int index) {
}

private void exitAt(VirtualFrame frame, int index, Object returnValue) {
assert (int) frame.getAuxiliarySlot(indexSlotIndex) == index;
WrapperNode wrapperNode = (WrapperNode) frame.getAuxiliarySlot(wrapperSlotIndex);
if (wrapperNode == null) {
ProbeNode probeNode = getProbeAt(index);
if (probeNode == null) {
return;
}
ProbeNode probeNode = wrapperNode.getProbeNode();
try {
probeNode.onReturnValue(frame, returnValue);
} catch (Throwable t) {
Expand Down Expand Up @@ -3190,21 +3122,16 @@ int getStartStatementIndex(int startBci) {
return hookBCIToNodeIndex.lookupBucket(startBci);
}

/*
* This method must only be called when entering a node. The returned node should be stored
* in the frame in the WRAPPER_SLOT along with the index. This is needed to make sure that
* we always exit on the same wrapper.
*/
private WrapperNode getWrapperAt(int index) {
private ProbeNode getProbeAt(int index) {
if (statementNodes == null || index < 0) {
return null;
}
EspressoBaseStatementNode node = statementNodes[index];
if (!(node instanceof WrapperNode)) {
EspressoStatementNode node = statementNodes[index];
if (node == null) {
return null;
}
CompilerAsserts.partialEvaluationConstant(node);
return ((WrapperNode) node);
return node.findProbe();
}
}

Expand Down
78 changes: 0 additions & 78 deletions ...cle.truffle.espresso/src/com/oracle/truffle/espresso/nodes/EspressoBaseStatementNode.java
View file
Open in desktop

This file was deleted.

8 changes: 7 additions & 1 deletion ...ruffle.espresso/src/com/oracle/truffle/espresso/nodes/EspressoInstrumentableRootNode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 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
Expand Down Expand Up @@ -29,6 +29,8 @@
import com.oracle.truffle.espresso.impl.Method;
import com.oracle.truffle.espresso.vm.continuation.UnwindContinuationException;

import java.util.Set;

/**
* All methods in this class that can be overridden in subclasses must be abstract. If a generic
* implementation should be provided it should be in {@link EspressoInstrumentableRootNodeImpl}.
Expand Down Expand Up @@ -61,4 +63,8 @@ public WrapperNode createWrapper(ProbeNode probeNode) {

@Override
public abstract String toString();

public void prepareForInstrumentation(@SuppressWarnings("unused") Set<Class<?>> tags) {
// do nothing by default, only method nodes with bytecode needs to take action
}
}
Loading
Loading