/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package org.graalvm.compiler.nodes.calc;

import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_2;

import org.graalvm.compiler.core.common.calc.CanonicalCondition;

import org.graalvm.compiler.core.common.type.Stamp;

import org.graalvm.compiler.core.common.type.StampFactory;

import org.graalvm.compiler.graph.IterableNodeType;

import org.graalvm.compiler.graph.NodeClass;

import org.graalvm.compiler.graph.spi.CanonicalizerTool;

import org.graalvm.compiler.nodeinfo.NodeCycles;

import org.graalvm.compiler.nodeinfo.NodeInfo;

import org.graalvm.compiler.nodes.ConstantNode;

import org.graalvm.compiler.nodes.LogicConstantNode;

import org.graalvm.compiler.nodes.LogicNode;

import org.graalvm.compiler.nodes.NodeView;

import org.graalvm.compiler.nodes.ValueNode;

import jdk.vm.ci.meta.ConstantReflectionProvider;

import jdk.vm.ci.meta.JavaKind;

/**

 * Returns -1, 0, or 1 if either x < y, x == y, or x > y. If the comparison is undecided (one

 * of the inputs is NaN), the result is 1 if isUnorderedLess is false and -1 if isUnorderedLess is

 * true.

 */

@NodeInfo(cycles = NodeCycles.CYCLES_2, size = SIZE_2)

public final class NormalizeCompareNode extends BinaryNode implements IterableNodeType {

    public static final NodeClass<NormalizeCompareNode> TYPE = NodeClass.create(NormalizeCompareNode.class);

    protected final boolean isUnorderedLess;

    public NormalizeCompareNode(ValueNode x, ValueNode y, JavaKind kind, boolean isUnorderedLess) {

        super(TYPE, StampFactory.forInteger(kind, -1, 1), x, y);

        this.isUnorderedLess = isUnorderedLess;

    }

    public static ValueNode create(ValueNode x, ValueNode y, boolean isUnorderedLess, JavaKind kind, ConstantReflectionProvider constantReflection) {

        ValueNode result = tryConstantFold(x, y, isUnorderedLess, kind, constantReflection);

        if (result != null) {

            return result;

        }

        return new NormalizeCompareNode(x, y, kind, isUnorderedLess);

    }

    protected static ValueNode tryConstantFold(ValueNode x, ValueNode y, boolean isUnorderedLess, JavaKind kind, ConstantReflectionProvider constantReflection) {

        LogicNode result = CompareNode.tryConstantFold(CanonicalCondition.EQ, x, y, null, false);

        if (result instanceof LogicConstantNode) {

            LogicConstantNode logicConstantNode = (LogicConstantNode) result;

            LogicNode resultLT = CompareNode.tryConstantFold(CanonicalCondition.LT, x, y, constantReflection, isUnorderedLess);

            if (resultLT instanceof LogicConstantNode) {

                LogicConstantNode logicConstantNodeLT = (LogicConstantNode) resultLT;

                if (logicConstantNodeLT.getValue()) {

                    return ConstantNode.forIntegerKind(kind, -1);

                } else if (logicConstantNode.getValue()) {

                    return ConstantNode.forIntegerKind(kind, 0);

                } else {

                    return ConstantNode.forIntegerKind(kind, 1);

                }

            }

        }

        return null;

    }

    @Override

    public ValueNode canonical(CanonicalizerTool tool, ValueNode forX, ValueNode forY) {

        NodeView view = NodeView.from(tool);

        ValueNode result = tryConstantFold(x, y, isUnorderedLess, stamp(view).getStackKind(), tool.getConstantReflection());

        if (result != null) {

            return result;

        }

        return this;

    }

    @Override

    public boolean inferStamp() {

        return false;

    }

    @Override

    public Stamp foldStamp(Stamp stampX, Stamp stampY) {

        return stamp(NodeView.DEFAULT);

    }

    public boolean isUnorderedLess() {

        return isUnorderedLess;

    }

}