com.oracle.graal.python.lib.PyDictGetItem Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of python-language Show documentation
GraalPython language
There is a newer version: 24.1.1
/*
 * Copyright (c) 2021, 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.lib;

import com.oracle.graal.python.builtins.objects.common.HashingStorageNodes.HashingStorageGetItem;
import com.oracle.graal.python.builtins.objects.dict.PDict;
import com.oracle.truffle.api.HostCompilerDirectives.InliningCutoff;
import com.oracle.truffle.api.dsl.Cached;
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.NeverDefault;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.frame.Frame;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.strings.TruffleString;

/**
 * Equivalent to use for the various PyDict_GetItem* functions available in CPython. Note that these
 * functions lead to places where there are hard casts to PyDictObject anyway, so we just accept
 * PDict. Returns {@code null} when the key is not present.
 */
@GenerateUncached
@GenerateInline(inlineByDefault = true)
@GenerateCached
public abstract class PyDictGetItem extends Node {
    public static Object executeUncached(PDict dict, Object item) {
        return PyDictGetItemNodeGen.getUncached().execute(null, null, dict, item);
    }

    public final Object executeCached(VirtualFrame frame, PDict dict, Object key) {
        return execute(frame, this, dict, key);
    }

    public abstract Object execute(Frame frame, Node inliningTarget, PDict dict, Object item);

    // We never need a frame for reading string keys
    @Specialization
    static Object getString(Node inliningTarget, PDict dict, TruffleString item,
                    @Shared("getItem") @Cached HashingStorageGetItem getItem) {
        return getItem.execute(inliningTarget, dict.getDictStorage(), item);
    }

    @Specialization(replaces = "getString")
    static Object getItemCached(VirtualFrame frame, Node inliningTarget, PDict dict, Object item,
                    @Shared("getItem") @Cached HashingStorageGetItem getItem) {
        return getItem.execute(frame, inliningTarget, dict.getDictStorage(), item);
    }

    @Specialization(replaces = "getItemCached")
    @InliningCutoff
    static Object getItem(Node inliningTarget, PDict dict, Object item,
                    @Shared("getItem") @Cached HashingStorageGetItem getItem) {
        return getItem.execute(null, inliningTarget, dict.getDictStorage(), item);
    }

    @NeverDefault
    public static PyDictGetItem create() {
        return PyDictGetItemNodeGen.create();
    }

    public static PyDictGetItem getUncached() {
        return PyDictGetItemNodeGen.getUncached();
    }
}