Skip to content

[GR-41478] Reduce LookupAndCallXYZNode inline caches. #797

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
graalvmbot wants to merge 1 commit into from
Closed

[GR-41478] Reduce LookupAndCallXYZNode inline caches. #797

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
57 changes: 6 additions & 51 deletions ...e.graal.python/src/com/oracle/graal/python/nodes/call/special/AbstractCallMethodNode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018, 2025, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2026, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
Expand Down Expand Up @@ -40,7 +40,6 @@
*/
package com.oracle.graal.python.nodes.call.special;

import com.oracle.graal.python.PythonLanguage;
import com.oracle.graal.python.annotations.Slot.SlotSignature;
import com.oracle.graal.python.annotations.Builtin;
import com.oracle.graal.python.builtins.objects.PNone;
Expand All @@ -50,7 +49,6 @@
import com.oracle.graal.python.builtins.objects.type.slots.TpSlot.TpSlotBuiltin;
import com.oracle.graal.python.nodes.PGuards;
import com.oracle.graal.python.nodes.PNodeWithContext;
import com.oracle.graal.python.nodes.PRootNode;
import com.oracle.graal.python.nodes.builtins.FunctionNodes.GetCallTargetNode;
import com.oracle.graal.python.nodes.function.BuiltinFunctionRootNode;
import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
Expand All @@ -59,15 +57,13 @@
import com.oracle.graal.python.nodes.function.builtins.PythonTernaryBuiltinNode;
import com.oracle.graal.python.nodes.function.builtins.PythonUnaryBuiltinNode;
import com.oracle.graal.python.runtime.PythonOptions;
import com.oracle.graal.python.util.PythonUtils.NodeCounterWithLimit;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.RootCallTarget;
import com.oracle.truffle.api.dsl.ImportStatic;
import com.oracle.truffle.api.dsl.NodeFactory;
import com.oracle.truffle.api.dsl.NodeField;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.nodes.RootNode;

@ImportStatic({PythonOptions.class, PGuards.class})
Expand Down Expand Up @@ -142,53 +138,12 @@ private static int getBuiltinNodeArity(Class<? extends PythonBuiltinBaseNode> no
}

private <T extends PythonBuiltinBaseNode> boolean callerExceedsMaxSize(T builtinNode) {
CompilerAsserts.neverPartOfCompilation();
if (isAdoptable() && !isMaxSizeExceeded()) {
// to avoid building up AST of recursive builtin calls we check that the same builtin
// isn't already our parent.
Class<? extends PythonBuiltinBaseNode> builtinClass = builtinNode.getClass();
Node parent = getParent();
int recursiveCalls = 0;
PythonLanguage language = PythonLanguage.get(this);
while (parent != null && !(parent instanceof RootNode)) {
if (parent.getClass() == builtinClass) {
int recursionLimit = language.getEngineOption(PythonOptions.NodeRecursionLimit);
if (recursiveCalls == recursionLimit) {
return true;
}
recursiveCalls++;
}
parent = parent.getParent();
}

RootNode root = getRootNode();
// nb: option 'BuiltinsInliningMaxCallerSize' is defined as a compatible option, i.e.,
// ASTs will only be shared between contexts that have the same value for this option.
int maxSize = language.getEngineOption(PythonOptions.BuiltinsInliningMaxCallerSize);
if (root instanceof PRootNode) {
PRootNode pRoot = (PRootNode) root;
int rootNodeCount = pRoot.getNodeCountForInlining();
if (rootNodeCount < maxSize) {
NodeCounterWithLimit counter = new NodeCounterWithLimit(rootNodeCount, maxSize);
builtinNode.accept(counter);
if (counter.isOverLimit()) {
setMaxSizeExceeded(true);
return true;
}
pRoot.setNodeCountForInlining(counter.getCount());
}
} else {
NodeCounterWithLimit counter = new NodeCounterWithLimit(maxSize);
root.accept(counter);
if (!counter.isOverLimit()) {
builtinNode.accept(counter);
}
if (counter.isOverLimit()) {
setMaxSizeExceeded(true);
return true;
}
if (!isMaxSizeExceeded()) {
BuiltinInliningPolicy.CallerSizeCheck result = BuiltinInliningPolicy.checkCallerSize(this, builtinNode);
if (result == BuiltinInliningPolicy.CallerSizeCheck.EXCEEDS_MAX_SIZE) {
setMaxSizeExceeded(true);
}
return false;
return BuiltinInliningPolicy.exceedsCallerSize(result);
}
return true;
}
Expand Down
116 changes: 116 additions & 0 deletions ...le.graal.python/src/com/oracle/graal/python/nodes/call/special/BuiltinInliningPolicy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/*
* Copyright (c) 2026, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.oracle.graal.python.nodes.call.special;

import com.oracle.graal.python.PythonLanguage;
import com.oracle.graal.python.nodes.PRootNode;
import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
import com.oracle.graal.python.runtime.PythonOptions;
import com.oracle.graal.python.util.PythonUtils.NodeCounterWithLimit;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.nodes.RootNode;

final class BuiltinInliningPolicy {

enum CallerSizeCheck {
OK,
EXCEEDS_MAX_SIZE,
DISABLED
}

private BuiltinInliningPolicy() {
}

static <T extends PythonBuiltinBaseNode> CallerSizeCheck checkCallerSize(Node caller, T builtinNode) {
CompilerAsserts.neverPartOfCompilation();
if (caller.isAdoptable()) {
// To avoid building up ASTs of recursive builtin calls, check that the same builtin
// isn't already the call node's parent.
Class<? extends PythonBuiltinBaseNode> builtinClass = builtinNode.getClass();
Node parent = caller.getParent();
int recursiveCalls = 0;
PythonLanguage language = PythonLanguage.get(caller);
while (parent != null && !(parent instanceof RootNode)) {
if (parent.getClass() == builtinClass) {
int recursionLimit = language.getEngineOption(PythonOptions.NodeRecursionLimit);
if (recursiveCalls == recursionLimit) {
return CallerSizeCheck.DISABLED;
}
recursiveCalls++;
}
parent = parent.getParent();
}

RootNode root = caller.getRootNode();
// nb: option 'BuiltinsInliningMaxCallerSize' is defined as a compatible option, i.e.,
// ASTs will only be shared between contexts that have the same value for this option.
int maxSize = language.getEngineOption(PythonOptions.BuiltinsInliningMaxCallerSize);
if (root instanceof PRootNode) {
PRootNode pRoot = (PRootNode) root;
int rootNodeCount = pRoot.getNodeCountForInlining();
if (rootNodeCount < maxSize) {
NodeCounterWithLimit counter = new NodeCounterWithLimit(rootNodeCount, maxSize);
builtinNode.accept(counter);
if (counter.isOverLimit()) {
return CallerSizeCheck.EXCEEDS_MAX_SIZE;
}
pRoot.setNodeCountForInlining(counter.getCount());
}
} else {
NodeCounterWithLimit counter = new NodeCounterWithLimit(maxSize);
root.accept(counter);
if (!counter.isOverLimit()) {
builtinNode.accept(counter);
}
if (counter.isOverLimit()) {
return CallerSizeCheck.EXCEEDS_MAX_SIZE;
}
}
return CallerSizeCheck.OK;
}
return CallerSizeCheck.DISABLED;
}

static boolean exceedsCallerSize(CallerSizeCheck result) {
return result != CallerSizeCheck.OK;
}
}
58 changes: 20 additions & 38 deletions ....graal.python/src/com/oracle/graal/python/nodes/call/special/LookupAndCallBinaryNode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,17 @@
import com.oracle.graal.python.builtins.objects.function.PBuiltinFunction;
import com.oracle.graal.python.nodes.PGuards;
import com.oracle.graal.python.nodes.attributes.LookupAttributeInMRONode;
import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
import com.oracle.graal.python.nodes.function.builtins.PythonBinaryBuiltinNode;
import com.oracle.graal.python.nodes.object.GetClassNode;
import com.oracle.graal.python.runtime.PythonOptions;
import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.dsl.Bind;
import com.oracle.truffle.api.dsl.Cached;
import com.oracle.truffle.api.dsl.Cached.Exclusive;
import com.oracle.truffle.api.dsl.ImportStatic;
import com.oracle.truffle.api.dsl.NeverDefault;
import com.oracle.truffle.api.dsl.ReportPolymorphism.Megamorphic;
import com.oracle.truffle.api.dsl.NodeFactory;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.nodes.Node;
Expand All @@ -67,7 +68,6 @@
*/
@ImportStatic(PythonOptions.class)
public abstract class LookupAndCallBinaryNode extends Node {
@Child private CallBinaryMethodNode dispatchNode;
protected final TruffleString name;

LookupAndCallBinaryNode(TruffleString name) {
Expand All @@ -81,26 +81,26 @@ public static LookupAndCallBinaryNode create(TruffleString name) {
return LookupAndCallBinaryNodeGen.create(name);
}

protected final CallBinaryMethodNode ensureDispatch() {
// this also serves as a branch profile
if (dispatchNode == null) {
CompilerDirectives.transferToInterpreterAndInvalidate();
dispatchNode = insert(CallBinaryMethodNode.create());
}
return dispatchNode;
}

protected final PythonBinaryBuiltinNode getBinaryBuiltin(PythonBuiltinClassType clazz) {
CompilerAsserts.neverPartOfCompilation();
Object attribute = LookupAttributeInMRONode.Dynamic.getUncached().execute(clazz, name);
if (attribute instanceof PBuiltinFunction) {
PBuiltinFunction builtinFunction = (PBuiltinFunction) attribute;
if (PythonBinaryBuiltinNode.class.isAssignableFrom(builtinFunction.getBuiltinNodeFactory().getNodeClass())) {
return (PythonBinaryBuiltinNode) builtinFunction.getBuiltinNodeFactory().createNode();
NodeFactory<? extends PythonBuiltinBaseNode> builtinNodeFactory = builtinFunction.getBuiltinNodeFactory();
if (builtinNodeFactory != null && PythonBinaryBuiltinNode.class.isAssignableFrom(builtinNodeFactory.getNodeClass())) {
PythonBinaryBuiltinNode builtinNode = (PythonBinaryBuiltinNode) builtinNodeFactory.createNode();
if (!callerExceedsMaxSize(builtinNode)) {
return builtinNode;
}
}
}
return null;
}

private <T extends PythonBuiltinBaseNode> boolean callerExceedsMaxSize(T builtinNode) {
return BuiltinInliningPolicy.exceedsCallerSize(BuiltinInliningPolicy.checkCallerSize(this, builtinNode));
}

protected static PythonBuiltinClassType getBuiltinClass(Node inliningTarget, Object receiver, GetClassNode getClassNode) {
Object clazz = getClassNode.execute(inliningTarget, receiver);
return clazz instanceof PythonBuiltinClassType ? (PythonBuiltinClassType) clazz : null;
Expand All @@ -112,7 +112,7 @@ protected static boolean isClazz(Node inliningTarget, PythonBuiltinClassType cla

// Object, Object

@Specialization(guards = {"clazz != null", "function != null", "isClazz(inliningTarget, clazz, left, getClassNode)"}, limit = "getCallSiteInlineCacheMaxDepth()")
@Specialization(guards = {"clazz != null", "function != null", "isClazz(inliningTarget, clazz, left, getClassNode)"}, limit = "1")
static Object callObjectBuiltin(VirtualFrame frame, Object left, Object right,
@SuppressWarnings("unused") @Bind Node inliningTarget,
@SuppressWarnings("unused") @Exclusive @Cached GetClassNode getClassNode,
Expand All @@ -121,37 +121,19 @@ static Object callObjectBuiltin(VirtualFrame frame, Object left, Object right,
return function.execute(frame, left, right);
}

@Specialization(guards = {"left.getClass() == cachedLeftClass", "right.getClass() == cachedRightClass"}, limit = "5")
@SuppressWarnings("truffle-static-method")
Object callObjectGeneric(VirtualFrame frame, Object left, Object right,
@Bind Node inliningTarget,
@SuppressWarnings("unused") @Cached("left.getClass()") Class<?> cachedLeftClass,
@SuppressWarnings("unused") @Cached("right.getClass()") Class<?> cachedRightClass,
@Exclusive @Cached InlinedBranchProfile notFoundProfile,
@Exclusive @Cached GetClassNode getClassNode,
@Exclusive @Cached("create(name)") LookupSpecialMethodNode getattr) {
return doCallObject(frame, inliningTarget, notFoundProfile, left, right, getClassNode, getattr);
}

@Specialization(replaces = "callObjectGeneric")
@Megamorphic
@SuppressWarnings("truffle-static-method")
Object callObjectMegamorphic(VirtualFrame frame, Object left, Object right,
@Specialization(replaces = "callObjectBuiltin")
static Object callObject(VirtualFrame frame, Object left, Object right,
@Bind Node inliningTarget,
@Exclusive @Cached InlinedBranchProfile notFoundProfile,
@Exclusive @Cached GetClassNode getClassNode,
@Exclusive @Cached("create(name)") LookupSpecialMethodNode getattr) {
return doCallObject(frame, inliningTarget, notFoundProfile, left, right, getClassNode, getattr);
}

private Object doCallObject(VirtualFrame frame, Node inliningTarget, InlinedBranchProfile notFoundProfile, Object left, Object right, GetClassNode getClassNode,
LookupSpecialMethodNode getattr) {
@Exclusive @Cached("create(name)") LookupSpecialMethodNode getattr,
@Cached CallBinaryMethodNode dispatchNode) {
Object leftClass = getClassNode.execute(inliningTarget, left);
Object leftCallable = getattr.execute(frame, leftClass, left);
if (PGuards.isNoValue(leftCallable)) {
notFoundProfile.enter(inliningTarget);
throw SpecialMethodNotFound.INSTANCE;
}
return ensureDispatch().executeObject(frame, leftCallable, left, right);
return dispatchNode.executeObject(frame, leftCallable, left, right);
}
}
Loading
Loading