/*
 * Copyright (c) 2021, 2024, 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 ir_framework.examples;

import compiler.lib.ir_framework.*;
import compiler.lib.ir_framework.test.TestVM; // Only used for Javadocs

/*
 * @test
 * @summary Example test to use the new test framework.
 * @library /test/lib /
 * @run driver ir_framework.examples.NormalTestExample
 */

/**
 * If there is no warm up specified the Test Framework will do the following:
 * <ol>
 *     <li><p>Invoke @Test method {@link TestVM#WARMUP_ITERATIONS} many times.</li>
 *     <li><p>Then do compilation of @Test method. <b>(**)</b></li>
 *     <li><p>Invoke @Test method once again</li>
 * </ol>
 * <p>
 *
 * Configurable things for simple tests (no @Run or @Check) at @Test method:
 * <ul>
 *     <li><p>compLevel: Specify at which compilation level the test should be compiled by the framework at step <b>(**)</b>.
 *                       If {@link CompLevel#WAIT_FOR_COMPILATION} is specified, the framework will continue invoke the
 *                       method until HotSpot compiles it. If it is not compiled after 10s, an exception is thrown.</li>
 *     <li><p>@Warmup: Change warm-up iterations of test (defined by default by TestVM.WARMUP_ITERATIONS)</li>
 *     <li><p>@Arguments: If a @Test method specifies arguments, you need to provide arguments by using @Arguments such
 *                        that the framework knows how to call the method. If you need more complex values, use @Run.</li>
 *     <li><p>@IR: Arbitrary number of @IR rules.</li>
 * </ul>
 *
 * @see Test
 * @see Arguments
 * @see Warmup
 * @see TestFramework
 */
public class NormalTestExample {
    int iFld;

    public static void main(String[] args) {
        TestFramework.run(); // equivalent to TestFramework.run(NormalTestExample.class)
    }

    // Test without arguments.
    @Test
    public void mostBasicTest() {
        iFld = 42;
    }

    // Test with arguments. Use Argument class to choose a value.
    // Object arguments need to have an associated default constructor in its class.
    @Test
    @Arguments(values = {Argument.DEFAULT, Argument.MAX})
    public void basicTestWithArguments(int x, long y) {
        iFld = x;
    }

    // @Warmup needs to be positive or zero. In case of zero, the method is directly compiled (simulated -Xcomp).
    @Test
    @Arguments(values = {Argument.DEFAULT, Argument.MAX})
    @Warmup(100)
    public void basicTestWithDifferentWarmup(int x, long y) {
        iFld = x;
    }

    // The IR framework will compile this method with C1 at level 2 (with limited profiling information) after the
    // warm-up iterations are done.
    @Test(compLevel = CompLevel.C1_LIMITED_PROFILE)
    public void basicTestCompileWithC1() {
        iFld = 34;
    }
}