001/*
002 * Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.nodes;
024
025import jdk.internal.jvmci.meta.*;
026
027import com.oracle.graal.compiler.common.type.*;
028import com.oracle.graal.graph.*;
029import com.oracle.graal.graph.spi.*;
030import com.oracle.graal.nodeinfo.*;
031import com.oracle.graal.nodes.spi.*;
032
033@NodeInfo
034public abstract class BinaryOpLogicNode extends LogicNode implements LIRLowerable, Canonicalizable.Binary<ValueNode> {
035
036    public static final NodeClass<BinaryOpLogicNode> TYPE = NodeClass.create(BinaryOpLogicNode.class);
037    @Input protected ValueNode x;
038    @Input protected ValueNode y;
039
040    public ValueNode getX() {
041        return x;
042    }
043
044    public ValueNode getY() {
045        return y;
046    }
047
048    public BinaryOpLogicNode(NodeClass<? extends BinaryOpLogicNode> c, ValueNode x, ValueNode y) {
049        super(c);
050        assert x != null && y != null && x.getKind() == y.getKind();
051        this.x = x;
052        this.y = y;
053    }
054
055    @Override
056    public boolean verify() {
057        assertTrue(x.stamp().isCompatible(y.stamp()), "stamps not compatible: %s, %s", x.stamp(), y.stamp());
058        return super.verify();
059    }
060
061    @Override
062    public void generate(NodeLIRBuilderTool gen) {
063    }
064
065    /**
066     * Ensure a canonical ordering of inputs for commutative nodes to improve GVN results. Order the
067     * inputs by increasing {@link Node#id} and call {@link Graph#findDuplicate(Node)} on the node
068     * if it's currently in a graph.
069     *
070     * @return the original node or another node with the same inputs, ignoring ordering.
071     */
072    @SuppressWarnings("deprecation")
073    public LogicNode maybeCommuteInputs() {
074        assert this instanceof BinaryCommutative;
075        if (x.getId() > y.getId()) {
076            ValueNode tmp = x;
077            x = y;
078            y = tmp;
079            if (graph() != null) {
080                // See if this node already exists
081                LogicNode duplicate = graph().findDuplicate(this);
082                if (duplicate != null) {
083                    return duplicate;
084                }
085            }
086        }
087        return this;
088    }
089
090    public abstract Stamp getSucceedingStampForX(boolean negated);
091
092    public abstract Stamp getSucceedingStampForY(boolean negated);
093
094    public abstract TriState tryFold(Stamp xStamp, Stamp yStamp);
095}