/*
 * Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
 * 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 com.oracle.graal.nodes.calc;

import com.oracle.max.cri.ci.*;
import com.oracle.graal.nodes.*;
import com.oracle.graal.nodes.spi.*;
import com.oracle.graal.nodes.spi.types.*;
import com.oracle.graal.nodes.type.*;

/**
 * A NullCheckNode will be true if the supplied value is non-null, and false if it is null.
 * This behavior can be inverted by setting {@link #expectedNull} to true.
 */
public final class NullCheckNode extends BooleanNode implements Canonicalizable, LIRLowerable, ConditionalTypeFeedbackProvider, TypeCanonicalizable {

    @Input private ValueNode object;
    public final boolean expectedNull;

    public ValueNode object() {
        return object;
    }

    /**
     * Constructs a new NullCheck instruction.
     *
     * @param object the instruction producing the object to check against null
     * @param expectedNull True when this node checks that the value is null, false when this node checks for non-null
     */
    public NullCheckNode(ValueNode object, boolean expectedNull) {
        super(StampFactory.illegal());
        assert object.kind() == CiKind.Object : object.kind();
        this.object = object;
        this.expectedNull = expectedNull;
    }

    @Override
    public void generate(LIRGeneratorTool gen) {
        // Nothing to do.
    }

    @Override
    public boolean verify() {
        assertTrue(object().kind().isObject(), "null check input must be an object");
        return super.verify();
    }

    @Override
    public ValueNode canonical(CanonicalizerTool tool) {
        CiConstant constant = object().asConstant();
        if (constant != null) {
            assert constant.kind == CiKind.Object;
            return ConstantNode.forBoolean(constant.isNull() == expectedNull, graph());
        }
        if (object.stamp().nonNull()) {
            return ConstantNode.forBoolean(!expectedNull, graph());
        }
        return this;
    }

    @Override
    public BooleanNode negate() {
        return graph().unique(new NullCheckNode(object(), !expectedNull));
    }

    @Override
    public void typeFeedback(TypeFeedbackTool tool) {
        Condition expectedCondition = expectedNull ? Condition.EQ : Condition.NE;
        tool.addObject(object()).constantBound(expectedCondition, CiConstant.NULL_OBJECT);
    }

    @Override
    public Result canonical(TypeFeedbackTool tool) {
        Condition expectedCondition = expectedNull ? Condition.EQ : Condition.NE;
        ObjectTypeQuery query = tool.queryObject(object());
        if (query.constantBound(expectedCondition, CiConstant.NULL_OBJECT)) {
            return new Result(ConstantNode.forBoolean(true, graph()), query);
        } else if (query.constantBound(expectedCondition.negate(), CiConstant.NULL_OBJECT)) {
            return new Result(ConstantNode.forBoolean(false, graph()), query);
        }
        return null;
    }
}