/*
 * 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.virtual.nodes;

import com.oracle.graal.api.meta.*;
import com.oracle.graal.graph.*;
import com.oracle.graal.nodes.*;
import com.oracle.graal.nodes.spi.*;
import com.oracle.graal.nodes.type.*;
import com.oracle.graal.nodes.virtual.*;

@NodeInfo(nameTemplate = "Materialize {i#virtualObject}")
public final class MaterializeObjectNode extends FixedWithNextNode implements VirtualizableAllocation, Lowerable, Node.IterableNodeType, Canonicalizable, ArrayLengthProvider {

    @Input private final NodeInputList<ValueNode> values;
    @Input private final VirtualObjectNode virtualObject;
    private final int lockCount;

    public MaterializeObjectNode(VirtualObjectNode virtualObject, int lockCount) {
        super(StampFactory.exactNonNull(virtualObject.type()));
        this.virtualObject = virtualObject;
        this.lockCount = lockCount;
        this.values = new NodeInputList<>(this, virtualObject.entryCount());
    }

    public NodeInputList<ValueNode> getValues() {
        return values;
    }

    public VirtualObjectNode getVirtualObject() {
        return virtualObject;
    }

    public int getLockCount() {
        return lockCount;
    }

    @Override
    public ValueNode length() {
        assert virtualObject.type().isArray();
        return ConstantNode.forInt(values.size(), graph());
    }

    /**
     * @return true if the object that will be created is without locks and has only entries that
     *         are {@link Constant#defaultForKind(Kind)}, false otherwise.
     */
    public boolean isDefault() {
        if (lockCount > 0) {
            return false;
        } else {
            for (ValueNode value : values) {
                if (!value.isConstant() || !value.asConstant().isDefaultForKind()) {
                    return false;
                }
            }
        }
        return true;
    }

    @Override
    public void lower(LoweringTool tool) {
        virtualObject.materializeAt(this, values, isDefault(), lockCount);
    }

    @Override
    public ValueNode canonical(CanonicalizerTool tool) {
        if (usages().isEmpty()) {
            return null;
        } else {
            return this;
        }
    }

    @Override
    public void virtualize(VirtualizerTool tool) {
        tool.createVirtualObject(virtualObject, values.toArray(new ValueNode[values.size()]), lockCount);
        tool.replaceWithVirtual(virtualObject);
    }
}