/*

 * Copyright (c) 2013, 2019, 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 org.graalvm.compiler.hotspot.test;

import static org.graalvm.compiler.test.SubprocessUtil.getPackageOpeningOptions;

import static org.graalvm.compiler.test.SubprocessUtil.getVMCommandLine;

import static org.graalvm.compiler.test.SubprocessUtil.withoutDebuggerArguments;

import java.io.File;

import java.io.IOException;

import java.nio.file.Path;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.Enumeration;

import java.util.List;

import java.util.zip.ZipEntry;

import java.util.zip.ZipFile;

import org.graalvm.compiler.core.GraalCompilerOptions;

import org.graalvm.compiler.core.test.GraalCompilerTest;

import org.graalvm.compiler.test.SubprocessUtil;

import org.graalvm.compiler.test.SubprocessUtil.Subprocess;

import org.junit.Assert;

import org.junit.Test;

/**

 * Tests support for dumping graphs and other info useful for debugging a compiler crash.

 */

public class CompilationWrapperTest extends GraalCompilerTest {

    private static List<String> join(List<String> l1, List<String> l2) {

        ArrayList<String> result = new ArrayList<>(l1.size() + l2.size());

        result.addAll(l1);

        result.addAll(l2);

        return result;

    }

    /**

     * Tests compilation requested by the VM.

     */

    @Test

    public void testVMCompilation1() throws IOException, InterruptedException {

        assumeManagementLibraryIsLoadable();

        testHelper(Collections.emptyList(), Arrays.asList("-XX:-TieredCompilation",

                        "-XX:+UseJVMCICompiler",

                        "-Dgraal.CompilationFailureAction=ExitVM",

                        "-Dgraal.CrashAt=TestProgram.*",

                        "-Xcomp",

                        "-XX:CompileCommand=compileonly,*/TestProgram.print*",

                        TestProgram.class.getName()));

    }

    /**

     * Tests that {@code -Dgraal.ExitVMOnException=true} works as an alias for

     * {@code -Dgraal.CompilationFailureAction=ExitVM}.

     */

    @Test

    public void testVMCompilation2() throws IOException, InterruptedException {

        assumeManagementLibraryIsLoadable();

        testHelper(Collections.emptyList(), Arrays.asList("-XX:-TieredCompilation",

                        "-XX:+UseJVMCICompiler",

                        "-Dgraal.ExitVMOnException=true",

                        "-Dgraal.CrashAt=TestProgram.*",

                        "-Xcomp",

                        "-XX:CompileCommand=compileonly,*/TestProgram.print*",

                        TestProgram.class.getName()));

    }

    static class Probe {

        final String substring;

        final int expectedOccurrences;

        int actualOccurrences;

        String lastMatchingLine;

        Probe(String substring, int expectedOccurrences) {

            this.substring = substring;

            this.expectedOccurrences = expectedOccurrences;

        }

        boolean matches(String line) {

            if (line.contains(substring)) {

                actualOccurrences++;

                lastMatchingLine = line;

                return true;

            }

            return false;

        }

        String test() {

            return expectedOccurrences == actualOccurrences ? null : String.format("expected %d, got %d occurrences", expectedOccurrences, actualOccurrences);

        }

    }

    /**

     * Tests {@link GraalCompilerOptions#MaxCompilationProblemsPerAction} in context of a

     * compilation requested by the VM.

     */

    @Test

    public void testVMCompilation3() throws IOException, InterruptedException {

        assumeManagementLibraryIsLoadable();

        final int maxProblems = 2;

        Probe retryingProbe = new Probe("Retrying compilation of", maxProblems) {

            @Override

            String test() {

                return actualOccurrences > 0 && actualOccurrences <= maxProblems ? null : String.format("expected occurrences to be in [1 .. %d]", maxProblems);

            }

        };

        Probe adjustmentProbe = new Probe("adjusting CompilationFailureAction from Diagnose to Print", 1) {

            @Override

            String test() {

                if (retryingProbe.actualOccurrences >= maxProblems) {

                    if (actualOccurrences == 0) {

                        return "expected at least one occurrence";

                    }

                }

                return null;

            }

        };

        Probe[] probes = {

                        retryingProbe,

                        adjustmentProbe

        };

        testHelper(Arrays.asList(probes), Arrays.asList("-XX:-TieredCompilation",

                        "-XX:+UseJVMCICompiler",

                        "-Dgraal.CompilationFailureAction=Diagnose",

                        "-Dgraal.MaxCompilationProblemsPerAction=" + maxProblems,

                        "-Dgraal.CrashAt=TestProgram.*",

                        "-Xcomp",

                        "-XX:CompileCommand=compileonly,*/TestProgram.print*",

                        TestProgram.class.getName()));

    }

    /**

     * Tests compilation requested by Truffle.

     */

    @Test

    public void testTruffleCompilation1() throws IOException, InterruptedException {

        assumeManagementLibraryIsLoadable();

        testHelper(Collections.emptyList(),

                        join(getPackageOpeningOptions(),

                                        Arrays.asList(

                                                        "-Dgraal.CompilationFailureAction=ExitVM",

                                                        "-Dgraal.TrufflePerformanceWarningsAreFatal=true",

                                                        "-Dgraal.CrashAt=root test1")),

                        "org.graalvm.compiler.truffle.test.SLTruffleGraalTestSuite", "test");

    }

    /**

     * Tests that TruffleCompilationExceptionsAreFatal works as expected.

     */

    @Test

    public void testTruffleCompilation2() throws IOException, InterruptedException {

        Probe[] probes = {

                        new Probe("Exiting VM due to TruffleCompilationExceptionsAreFatal=true", 1),

        };

        testHelper(Arrays.asList(probes),

                        join(getPackageOpeningOptions(),

                                        Arrays.asList(

                                                        "-Dgraal.CompilationFailureAction=Silent",

                                                        "-Dgraal.TruffleCompilationExceptionsAreFatal=true",

                                                        "-Dgraal.CrashAt=root test1")),

                        "org.graalvm.compiler.truffle.test.SLTruffleGraalTestSuite", "test");

    }

    /**

     * Tests that TrufflePerformanceWarningsAreFatal generates diagnostic output.

     */

    @Test

    public void testTruffleCompilation3() throws IOException, InterruptedException {

        assumeManagementLibraryIsLoadable();

        Probe[] probes = {

                        new Probe("Exiting VM due to TrufflePerformanceWarningsAreFatal=true", 1),

        };

        testHelper(Arrays.asList(probes),

                        join(getPackageOpeningOptions(),

                                        Arrays.asList(

                                                        "-Dgraal.CompilationFailureAction=Silent",

                                                        "-Dgraal.TrufflePerformanceWarningsAreFatal=true",

                                                        "-Dgraal.CrashAt=root test1:PermanentBailout")),

                        "org.graalvm.compiler.truffle.test.SLTruffleGraalTestSuite", "test");

    }

    private static final boolean VERBOSE = Boolean.getBoolean(CompilationWrapperTest.class.getSimpleName() + ".verbose");

    private static void testHelper(List<Probe> initialProbes, List<String> extraVmArgs, String... mainClassAndArgs) throws IOException, InterruptedException {

        final File dumpPath = new File(CompilationWrapperTest.class.getSimpleName() + "_" + System.currentTimeMillis()).getAbsoluteFile();

        List<String> vmArgs = withoutDebuggerArguments(getVMCommandLine());

        vmArgs.removeIf(a -> a.startsWith("-Dgraal."));

        vmArgs.remove("-esa");

        vmArgs.remove("-ea");

        vmArgs.add("-Dgraal.DumpPath=" + dumpPath);

        // Force output to a file even if there's a running IGV instance available.

        vmArgs.add("-Dgraal.PrintGraphFile=true");

        vmArgs.addAll(extraVmArgs);

        Subprocess proc = SubprocessUtil.java(vmArgs, mainClassAndArgs);

        if (VERBOSE) {

            System.out.println(proc);

        }

        try {

            List<Probe> probes = new ArrayList<>(initialProbes);

            Probe diagnosticProbe = new Probe("Graal diagnostic output saved in ", 1);

            probes.add(diagnosticProbe);

            probes.add(new Probe("Forced crash after compiling", Integer.MAX_VALUE) {

                @Override

                String test() {

                    return actualOccurrences > 0 ? null : "expected at least 1 occurrence";

                }

            });

            for (String line : proc.output) {

                for (Probe probe : probes) {

                    if (probe.matches(line)) {

                        break;

                    }

                }

            }

            for (Probe probe : probes) {

                String error = probe.test();

                if (error != null) {

                    Assert.fail(String.format("Did not find expected occurences of '%s' in output of command: %s%n%s", probe.substring, error, proc));

                }

            }

            String line = diagnosticProbe.lastMatchingLine;

            int substringStart = line.indexOf(diagnosticProbe.substring);

            int substringLength = diagnosticProbe.substring.length();

            String diagnosticOutputZip = line.substring(substringStart + substringLength).trim();

            List<String> dumpPathEntries = Arrays.asList(dumpPath.list());

            File zip = new File(diagnosticOutputZip).getAbsoluteFile();

            Assert.assertTrue(zip.toString(), zip.exists());

            Assert.assertTrue(zip + " not in " + dumpPathEntries, dumpPathEntries.contains(zip.getName()));

            try {

                int bgvOrCfgFiles = 0;

                ZipFile dd = new ZipFile(diagnosticOutputZip);

                List<String> entries = new ArrayList<>();

                for (Enumeration<? extends ZipEntry> e = dd.entries(); e.hasMoreElements();) {

                    ZipEntry ze = e.nextElement();

                    String name = ze.getName();

                    entries.add(name);

                    if (name.endsWith(".bgv") || name.endsWith(".cfg")) {

                        bgvOrCfgFiles++;

                    }

                }

                if (bgvOrCfgFiles == 0) {

                    Assert.fail(String.format("Expected at least one .bgv or .cfg file in %s: %s%n%s", diagnosticOutputZip, entries, proc));

                }

            } finally {

                zip.delete();

            }

        } finally {

            Path directory = dumpPath.toPath();

            removeDirectory(directory);

        }

    }

}

class TestProgram {

    public static void main(String[] args) {

        printHello1();

        printWorld1();

        printHello2();

        printWorld2();

        printHello3();

        printWorld3();

    }

    private static void printHello1() {

        System.out.println("Hello1");

    }

    private static void printWorld1() {

        System.out.println("World1");

    }

    private static void printHello2() {

        System.out.println("Hello2");

    }

    private static void printWorld2() {

        System.out.println("World2");

    }

    private static void printHello3() {

        System.out.println("Hello3");

    }

    private static void printWorld3() {

        System.out.println("World3");

    }

}