com.oracle.truffle.sl.nodes.expression.SLEqualNode Maven / Gradle / Ivy
Show all versions of truffle-sl Show documentation
/*
* Copyright (c) 2012, 2022, 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.truffle.sl.nodes.expression;
import static com.oracle.truffle.api.CompilerDirectives.shouldNotReachHere;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.dsl.Cached;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.interop.InteropLibrary;
import com.oracle.truffle.api.interop.UnsupportedMessageException;
import com.oracle.truffle.api.library.CachedLibrary;
import com.oracle.truffle.api.nodes.NodeInfo;
import com.oracle.truffle.api.strings.TruffleString;
import com.oracle.truffle.sl.SLLanguage;
import com.oracle.truffle.sl.nodes.SLBinaryNode;
import com.oracle.truffle.sl.runtime.SLBigInteger;
import com.oracle.truffle.sl.runtime.SLFunction;
import com.oracle.truffle.sl.runtime.SLNull;
/**
* The {@code ==} operator of SL is defined on all types. Therefore, we need a
* {@link #doGeneric(Object, Object, InteropLibrary, InteropLibrary) implementation} that can handle
* all possible types including interop types.
*
* Note that we do not need the analogous {@code !=} operator, because we can just
* {@link SLLogicalNotNode negate} the {@code ==} operator.
*/
@NodeInfo(shortName = "==")
public abstract class SLEqualNode extends SLBinaryNode {
@Specialization
protected boolean doLong(long left, long right) {
return left == right;
}
@Specialization
@TruffleBoundary
protected boolean doBigNumber(SLBigInteger left, SLBigInteger right) {
return left.equals(right);
}
@Specialization
protected boolean doBoolean(boolean left, boolean right) {
return left == right;
}
@Specialization
protected boolean doString(String left, String right) {
return left.equals(right);
}
@Specialization
protected boolean doTruffleString(TruffleString left, TruffleString right,
@Cached TruffleString.EqualNode equalNode) {
return equalNode.execute(left, right, SLLanguage.STRING_ENCODING);
}
@Specialization
protected boolean doNull(SLNull left, SLNull right) {
/* There is only the singleton instance of SLNull, so we do not need equals(). */
return left == right;
}
@Specialization
protected boolean doFunction(SLFunction left, Object right) {
/*
* Our function registry maintains one canonical SLFunction object per function name, so we
* do not need equals().
*/
return left == right;
}
/*
* This is a generic specialization of equality operation. Since it is generic this
* specialization covers the entire semantics. One can see this by having no method guards set
* and the types for the left and right value are Object. The previous specializations are only
* here for interpreter performance and footprint reasons. They could be removed and this
* operation be semantically equivalent.
*
* We cache four combinations of interop values until we fallback to the uncached version of
* this specialization. This limit is set arbitrary and for a real language should be set to the
* minimal possible value, for a set of given benchmarks.
*
* This specialization is generic and handles all the cases, but in this case we decided to not
* replace the previous specializations, as they are still more efficient in the interpeter.
*/
@Specialization(limit = "4")
public boolean doGeneric(Object left, Object right,
@CachedLibrary("left") InteropLibrary leftInterop,
@CachedLibrary("right") InteropLibrary rightInterop) {
/*
* This method looks very inefficient. In practice most of these branches fold as the
* interop type checks typically return a constant when using a cached library.
*
* Exercise: Try looking at what happens to this method during partial evaluation in IGV.
* Tip: comment out all the previous @Specialization annotations to make it easier to
* activate this specialization.
*/
try {
if (leftInterop.isBoolean(left) && rightInterop.isBoolean(right)) {
return doBoolean(leftInterop.asBoolean(left), rightInterop.asBoolean(right));
} else if (leftInterop.isString(left) && rightInterop.isString(right)) {
return doString(leftInterop.asString(left), (rightInterop.asString(right)));
} else if (leftInterop.isNull(left) && rightInterop.isNull(right)) {
return true;
} else if (leftInterop.fitsInLong(left) && rightInterop.fitsInLong(right)) {
return doLong(leftInterop.asLong(left), (rightInterop.asLong(right)));
} else if (left instanceof SLBigInteger && right instanceof SLBigInteger) {
return doBigNumber((SLBigInteger) left, (SLBigInteger) right);
} else if (leftInterop.hasIdentity(left) && rightInterop.hasIdentity(right)) {
return leftInterop.isIdentical(left, right, rightInterop);
} else {
/*
* We return false in good dynamic language manner. Stricter languages might throw
* an error here.
*/
return false;
}
} catch (UnsupportedMessageException e) {
// this case must not happen as we always check interop types before converting
throw shouldNotReachHere(e);
}
}
}