com.oracle.graal.python.nodes.attributes.LookupNativeSlotNode Maven / Gradle / Ivy
/*
* Copyright (c) 2023, 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.attributes;
import com.oracle.graal.python.PythonLanguage;
import com.oracle.graal.python.builtins.objects.PNone;
import com.oracle.graal.python.builtins.objects.cext.PythonAbstractNativeObject;
import com.oracle.graal.python.builtins.objects.cext.capi.PyProcsWrapper;
import com.oracle.graal.python.builtins.objects.cext.capi.SlotMethodDef;
import com.oracle.graal.python.builtins.objects.cext.structs.CFields;
import com.oracle.graal.python.builtins.objects.cext.structs.CStructAccess;
import com.oracle.graal.python.builtins.objects.common.HashingStorageNodes.HashingStorageGuards;
import com.oracle.graal.python.builtins.objects.dict.PDict;
import com.oracle.graal.python.builtins.objects.type.MroShape;
import com.oracle.graal.python.builtins.objects.type.MroShape.MroShapeLookupResult;
import com.oracle.graal.python.builtins.objects.type.PythonAbstractClass;
import com.oracle.graal.python.builtins.objects.type.PythonBuiltinClass;
import com.oracle.graal.python.builtins.objects.type.PythonClass;
import com.oracle.graal.python.builtins.objects.type.PythonManagedClass;
import com.oracle.graal.python.builtins.objects.type.SpecialMethodSlot;
import com.oracle.graal.python.builtins.objects.type.TypeNodes.GetMroStorageNode;
import com.oracle.graal.python.builtins.objects.type.TypeNodes.IsSameTypeNode;
import com.oracle.graal.python.nodes.PGuards;
import com.oracle.graal.python.nodes.PNodeWithContext;
import com.oracle.graal.python.nodes.attributes.LookupAttributeInMRONode.AttributeAssumptionPair;
import com.oracle.graal.python.nodes.object.GetDictIfExistsNode;
import com.oracle.graal.python.runtime.PythonContext;
import com.oracle.graal.python.runtime.sequence.storage.MroSequenceStorage;
import com.oracle.truffle.api.Assumption;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
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.Cached.Shared;
import com.oracle.truffle.api.dsl.GenerateCached;
import com.oracle.truffle.api.dsl.GenerateInline;
import com.oracle.truffle.api.dsl.GenerateUncached;
import com.oracle.truffle.api.dsl.ImportStatic;
import com.oracle.truffle.api.dsl.ReportPolymorphism.Megamorphic;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.interop.InteropLibrary;
import com.oracle.truffle.api.library.CachedLibrary;
import com.oracle.truffle.api.nodes.ExplodeLoop;
import com.oracle.truffle.api.nodes.Node;
@ImportStatic(LookupAttributeInMRONode.class)
public abstract class LookupNativeSlotNode extends PNodeWithContext {
protected final SlotMethodDef slot;
public LookupNativeSlotNode(SlotMethodDef slot) {
this.slot = slot;
}
public abstract Object execute(PythonManagedClass type);
private static final LookupNativeSlotNode[] UNCACHED = new LookupNativeSlotNode[SlotMethodDef.values().length];
static {
for (int i = 0; i < SlotMethodDef.values().length; i++) {
SlotMethodDef slot = SlotMethodDef.values()[i];
UNCACHED[i] = new Uncached(slot);
}
}
public static LookupNativeSlotNode getUncached(SlotMethodDef slot) {
return UNCACHED[slot.ordinal()];
}
@TruffleBoundary
public static Object executeUncached(PythonManagedClass type, SlotMethodDef slot) {
return getUncached(slot).execute(type);
}
protected AttributeAssumptionPair findAttrAndAssumptionInMRO(Object klass) {
CompilerAsserts.neverPartOfCompilation();
// - avoid cases when attributes are stored in a dict containing elements
// with a potential MRO sideeffect on access.
// Also note that attr should not be read more than once.
// - assuming that keys/elements can't be added or replaced in a class dict.
// (PythonMangedClass returns MappingProxy, which is read-only). Native classes could
// possibly do so, but for now leaving it as it is.
PDict dict;
if (klass instanceof PythonAbstractNativeObject nativeKlass) {
Object nativedict = CStructAccess.ReadObjectNode.getUncached().readFromObj(nativeKlass, CFields.PyTypeObject__tp_dict);
dict = nativedict == PNone.NO_VALUE ? null : (PDict) nativedict;
} else {
dict = GetDictIfExistsNode.getUncached().execute(klass);
}
if (dict != null && HashingStorageGuards.mayHaveSideEffects(dict)) {
return null;
}
MroSequenceStorage mro = GetMroStorageNode.executeUncached(klass);
Assumption attrAssumption = mro.createAttributeInMROFinalAssumption(slot.methodName);
for (int i = 0; i < mro.length(); i++) {
PythonAbstractClass clsObj = mro.getItemNormalized(i);
if (i > 0) {
assert clsObj != klass : "MRO chain is incorrect: '" + klass + "' was found at position " + i;
GetMroStorageNode.executeUncached(clsObj).addAttributeInMROFinalAssumption(slot.methodName, attrAssumption);
}
Object value = readSlot(clsObj, ReadAttributeFromObjectNode.getUncachedForceType(), CStructAccess.ReadPointerNode.getUncached(), InteropLibrary.getUncached());
if (value != null) {
return new AttributeAssumptionPair(attrAssumption, value);
}
}
return new AttributeAssumptionPair(attrAssumption, getNULL());
}
@Specialization(guards = {"isSingleContext()", "isSameTypeNode.execute(inliningTarget, cachedKlass, klass)", "cachedAttrInMROInfo != null"}, //
limit = "getAttributeAccessInlineCacheMaxDepth()", //
assumptions = "cachedAttrInMROInfo.assumption")
protected static Object lookupConstantMROCached(@SuppressWarnings("unused") PythonManagedClass klass,
@SuppressWarnings("unused") @Bind("this") Node inliningTarget,
@Exclusive @SuppressWarnings("unused") @Cached IsSameTypeNode isSameTypeNode,
@Cached("klass") @SuppressWarnings("unused") Object cachedKlass,
@Cached("findAttrAndAssumptionInMRO(cachedKlass)") AttributeAssumptionPair cachedAttrInMROInfo) {
return cachedAttrInMROInfo.value;
}
// This specialization works well only for multi-context mode
// Note: MroShape creation and updates are disabled in multi-context mode, see
// PythonClass#initializeMroShape
@Specialization(guards = {"!isSingleContext()", "cachedMroShape != null", "klass.getMroShape() == cachedMroShape"}, //
limit = "getAttributeAccessInlineCacheMaxDepth()")
@SuppressWarnings("truffle-static-method")
protected Object lookupConstantMROShape(PythonClass klass,
@Bind("this") Node inliningTarget,
@Exclusive @Cached GetMroStorageNode getMroStorageNode,
@SuppressWarnings("unused") @Cached("klass.getMroShape()") MroShape cachedMroShape,
@Cached("lookupInMroShape(cachedMroShape, klass)") MroShapeLookupResult lookupResult) {
return wrapManagedMethod(klass, lookupResult.getFromMro(getMroStorageNode.execute(inliningTarget, klass), slot.methodName));
}
protected static MroSequenceStorage getMroStorageUncached(Object object) {
return GetMroStorageNode.executeUncached(object);
}
@Specialization(guards = {"isSingleContext()", "isSameTypeNode.execute(inliningTarget, cachedKlass, klass)", "mroLength < 32"}, //
limit = "getAttributeAccessInlineCacheMaxDepth()", //
replaces = "lookupConstantMROShape", //
assumptions = "lookupStable")
@ExplodeLoop(kind = ExplodeLoop.LoopExplosionKind.FULL_UNROLL_UNTIL_RETURN)
@SuppressWarnings("truffle-static-method")
protected Object lookupConstantMRO(@SuppressWarnings("unused") PythonManagedClass klass,
@SuppressWarnings("unused") @Bind("this") Node inliningTarget,
@Exclusive @SuppressWarnings("unused") @Cached IsSameTypeNode isSameTypeNode,
@Cached("klass") @SuppressWarnings("unused") Object cachedKlass,
@Cached("getMroStorageUncached(cachedKlass)") MroSequenceStorage mro,
@Cached("mro.getLookupStableAssumption()") @SuppressWarnings("unused") Assumption lookupStable,
@Cached("mro.length()") int mroLength,
@Cached("create(mroLength)") ReadAttributeFromObjectNode[] readAttrNodes,
@Shared @Cached CStructAccess.ReadPointerNode readPointerNode,
@Exclusive @CachedLibrary(limit = "1") InteropLibrary interopLibrary) {
for (int i = 0; i < mroLength; i++) {
PythonAbstractClass kls = mro.getItemNormalized(i);
Object value = readSlot(kls, readAttrNodes[i], readPointerNode, interopLibrary);
if (value != null) {
return value;
}
}
return getNULL();
}
@Specialization(guards = {"mroLength == cachedMroLength", "cachedMroLength < 32"}, //
replaces = {"lookupConstantMROCached", "lookupConstantMRO"}, //
limit = "getAttributeAccessInlineCacheMaxDepth()")
@ExplodeLoop(kind = ExplodeLoop.LoopExplosionKind.FULL_UNROLL_UNTIL_RETURN)
@SuppressWarnings("truffle-static-method")
protected Object lookupCachedLen(@SuppressWarnings("unused") PythonManagedClass klass,
@SuppressWarnings("unused") @Bind("this") Node inliningTarget,
@Exclusive @SuppressWarnings("unused") @Cached GetMroStorageNode getMroStorageNode,
@Bind("getMroStorageNode.execute(inliningTarget, klass)") MroSequenceStorage mro,
@Bind("mro.length()") @SuppressWarnings("unused") int mroLength,
@Cached("mro.length()") int cachedMroLength,
@Cached("create(cachedMroLength)") ReadAttributeFromObjectNode[] readAttrNodes,
@Shared @Cached CStructAccess.ReadPointerNode readPointerNode,
@Exclusive @CachedLibrary(limit = "1") InteropLibrary interopLibrary) {
for (int i = 0; i < cachedMroLength; i++) {
PythonAbstractClass kls = mro.getItemNormalized(i);
Object value = readSlot(kls, readAttrNodes[i], readPointerNode, interopLibrary);
if (value != null) {
return value;
}
}
return getNULL();
}
@Specialization(replaces = {"lookupConstantMROCached", "lookupConstantMRO", "lookupCachedLen"})
@Megamorphic
@SuppressWarnings("truffle-static-method")
protected Object lookupGeneric(PythonManagedClass klass,
@Bind("this") Node inliningTarget,
@Exclusive @Cached GetMroStorageNode getMroStorageNode,
@Exclusive @Cached("createForceType()") ReadAttributeFromObjectNode readAttrNode,
@Shared @Cached CStructAccess.ReadPointerNode readPointerNode,
@Exclusive @CachedLibrary(limit = "1") InteropLibrary interopLibrary) {
MroSequenceStorage mro = getMroStorageNode.execute(inliningTarget, klass);
for (int i = 0; i < mro.length(); i++) {
PythonAbstractClass kls = mro.getItemNormalized(i);
Object value = readSlot(kls, readAttrNode, readPointerNode, interopLibrary);
if (value != null) {
return value;
}
}
return getNULL();
}
public MroShapeLookupResult lookupInMroShape(MroShape shape, Object klass) {
assert MroShape.validate(klass, PythonLanguage.get(this));
return shape.lookup(slot.methodName);
}
private Object getNULL() {
return getContext().getNativeNull().getPtr();
}
private Object readSlot(PythonAbstractClass currentType, ReadAttributeFromObjectNode readNode, CStructAccess.ReadPointerNode readPointerNode,
InteropLibrary interopLibrary) {
if (currentType instanceof PythonAbstractNativeObject nativeObject) {
Object value = readPointerNode.readFromObj(nativeObject, slot.typeField);
if (!PGuards.isNullOrZero(value, interopLibrary)) {
if (slot.methodsField == null) {
return value;
} else {
value = readPointerNode.read(value, slot.methodsField);
if (!PGuards.isNullOrZero(value, interopLibrary)) {
return value;
}
}
}
} else {
assert currentType instanceof PythonManagedClass;
if (slot.methodFlag != 0 && currentType instanceof PythonBuiltinClass builtinClass) {
if ((builtinClass.getType().getMethodsFlags() & slot.methodFlag) == 0) {
return null;
}
}
Object value = readNode.execute(currentType, slot.methodName);
if (value != PNone.NO_VALUE) {
return wrapManagedMethod((PythonManagedClass) currentType, value);
}
}
return null;
}
private Object wrapManagedMethod(PythonManagedClass owner, Object value) {
if (value instanceof PNone) {
return getNULL();
}
return getContext().getCApiContext().getOrCreateProcWrapper(owner, slot, () -> slot.wrapperFactory.apply(value));
}
@GenerateCached(false)
private static final class Uncached extends LookupNativeSlotNode {
Uncached(SlotMethodDef slot) {
super(slot);
}
@Override
public boolean isAdoptable() {
return false;
}
@Override
@TruffleBoundary
public Object execute(PythonManagedClass type) {
return lookupGeneric(type, null, GetMroStorageNode.getUncached(), ReadAttributeFromObjectNode.getUncachedForceType(), CStructAccess.ReadPointerNode.getUncached(),
InteropLibrary.getUncached());
}
}
@GenerateUncached
@ImportStatic({SpecialMethodSlot.class, SlotMethodDef.class})
@GenerateInline(value = false) // Used lazily
public abstract static class LookupNativeGetattroSlotNode extends Node {
public abstract Object execute(PythonManagedClass type);
public static Object executeUncached(PythonManagedClass type) {
return LookupNativeSlotNodeGen.LookupNativeGetattroSlotNodeGen.getUncached().execute(type);
}
@Specialization
Object get(PythonManagedClass type,
@Cached(parameters = "GetAttr") LookupCallableSlotInMRONode lookupGetattr,
@Cached(parameters = "GetAttribute") LookupCallableSlotInMRONode lookupGetattribute,
@Cached(parameters = "TP_GETATTRO") LookupNativeSlotNode lookupNativeGetattro) {
Object getattr = lookupGetattr.execute(type);
if (getattr == PNone.NO_VALUE) {
return lookupNativeGetattro.execute(type);
} else {
Object getattribute = lookupGetattribute.execute(type);
return PythonContext.get(this).getCApiContext().getOrCreateProcWrapper(type, SlotMethodDef.TP_GETATTRO, () -> new PyProcsWrapper.GetAttrCombinedWrapper(getattribute, getattr));
}
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy