/*
 * Copyright (c) 2020, 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * 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;

import static org.graalvm.compiler.nodeinfo.InputType.Memory;
import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_0;
import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_0;

import org.graalvm.compiler.graph.NodeClass;
import org.graalvm.compiler.nodeinfo.NodeInfo;
import org.graalvm.compiler.nodes.memory.MultiMemoryKill;
import org.graalvm.word.LocationIdentity;

A begin node that kills multiple memory locations. See KillingBeginNode for a version with a single killed location. /**
 * A begin node that kills multiple memory locations. See {@link KillingBeginNode} for a version
 * with a single killed location.
 */
@NodeInfo(allowedUsageTypes = {Memory}, cycles = CYCLES_0, size = SIZE_0)
public final class MultiKillingBeginNode extends AbstractBeginNode implements MultiMemoryKill {

    public static final NodeClass<MultiKillingBeginNode> TYPE = NodeClass.create(MultiKillingBeginNode.class);
    protected LocationIdentity[] locationIdentities;

    public MultiKillingBeginNode(LocationIdentity[] locationIdentities) {
        super(TYPE);
        this.locationIdentities = locationIdentities;
    }

    public static AbstractBeginNode begin(FixedNode with, LocationIdentity[] locationIdentities) {
        if (with instanceof MultiKillingBeginNode) {
            return (MultiKillingBeginNode) with;
        }
        AbstractBeginNode begin = with.graph().add(MultiKillingBeginNode.create(locationIdentities));
        begin.setNext(with);
        return begin;
    }

    public static AbstractBeginNode create(LocationIdentity[] locationIdentities) {
        return new MultiKillingBeginNode(locationIdentities);
    }

    @Override
    public LocationIdentity[] getKilledLocationIdentities() {
        return locationIdentities;
    }
}