/*
 * Copyright (c) 2016, Oracle and/or its affiliates.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided
 * with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
 * endorse or promote products derived from this software without specific prior written
 * permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.oracle.truffle.llvm.nodes.control;

import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.nodes.ExplodeLoop;
import com.oracle.truffle.api.source.SourceSection;
import com.oracle.truffle.llvm.runtime.nodes.api.LLVMControlFlowNode;
import com.oracle.truffle.llvm.runtime.nodes.api.LLVMExpressionNode;

public abstract class LLVMSwitchNode extends LLVMControlFlowNode {

    @CompilationFinal(dimensions = 2) final LLVMExpressionNode[][] phiWriteNodes;
    @Child protected LLVMExpressionNode cond;
    @Children public final LLVMExpressionNode[] cases;
    @CompilationFinal(dimensions = 1) private final int[] successors;

    public LLVMSwitchNode(int[] successors, LLVMExpressionNode[][] phiWriteNodes, LLVMExpressionNode cond, LLVMExpressionNode[] cases, SourceSection sourceSection) {
        super(sourceSection);
        assert successors.length == cases.length + 1 : "the last entry of the successors array must be the default case";
        this.successors = successors;
        this.phiWriteNodes = phiWriteNodes;
        this.cond = cond;
        this.cases = cases;
    }

    @Override
    public int getSuccessorCount() {
        return successors.length;
    }

    public abstract Object executeCondition(VirtualFrame frame);

    @ExplodeLoop
    public void writePhis(VirtualFrame frame, int successorIndex) {
        LLVMExpressionNode[] phis = phiWriteNodes[successorIndex];
        for (int i = 0; i < phis.length; i++) {
            phis[i].executeGeneric(frame);
        }
    }

    public int[] getSuccessors() {
        return successors;
    }

    public static final class LLVMI8SwitchNode extends LLVMSwitchNode {
        public LLVMI8SwitchNode(LLVMExpressionNode cond, LLVMExpressionNode[] cases, int[] successors, LLVMExpressionNode[][] phiWriteNodes, SourceSection source) {
            super(successors, phiWriteNodes, cond, cases, source);
        }

        @Override
        public Object executeCondition(VirtualFrame frame) {
            return cond.executeI8(frame);
        }

    }

    public static final class LLVMI16SwitchNode extends LLVMSwitchNode {
        public LLVMI16SwitchNode(LLVMExpressionNode cond, LLVMExpressionNode[] cases, int[] successors, LLVMExpressionNode[][] phiWriteNodes, SourceSection source) {
            super(successors, phiWriteNodes, cond, cases, source);
        }

        @Override
        public Object executeCondition(VirtualFrame frame) {
            return cond.executeI16(frame);
        }

    }

    public static final class LLVMI32SwitchNode extends LLVMSwitchNode {
        public LLVMI32SwitchNode(LLVMExpressionNode cond, LLVMExpressionNode[] cases, int[] successors, LLVMExpressionNode[][] phiWriteNodes, SourceSection source) {
            super(successors, phiWriteNodes, cond, cases, source);
        }

        @Override
        public Object executeCondition(VirtualFrame frame) {
            return cond.executeI32(frame);
        }

    }

    public static final class LLVMI64SwitchNode extends LLVMSwitchNode {
        public LLVMI64SwitchNode(LLVMExpressionNode cond, LLVMExpressionNode[] cases, int[] successors, LLVMExpressionNode[][] phiWriteNodes, SourceSection source) {
            super(successors, phiWriteNodes, cond, cases, source);
        }

        @Override
        public Object executeCondition(VirtualFrame frame) {
            return cond.executeI64(frame);
        }

    }
}