RFR: 8324641: [IR Framework] Add Setup method to provide custom arguments and set fields

[Emanuel Peter]

On Wed, 24 Jan 2024 14:39:39 GMT, Emanuel Peter <epeter at openjdk.org> wrote:

> **Bigger goal**
> 
> I am tired of always writing IR tests where I have to write elaborate code in the `@Run` method to create inputs, and then run the test method to create `gold` output values in (hopefully) interpreter mode, and then later verify the results of the compiled method.
> 
> Hence, I now introduce the "Setup" method, which can create custom argument values.
> In a later RFE, I will implement automatic result verification, which implicitly intercepts the inputs and outputs of the test method, and compares the behaviour of the interpreter and the compiled code. That way, the pattern will be:
> 
> 
> @Setup
> ... specify your arguments and fields ...
> 
> -> intercept arguments, cache them
> 
> @Test
> ... write a test with arbitrary inputs and outputs...
> 
> -> interpreter mode: intercept outputs and cache them (i.e. gold values)
> -> compiled mode: intercept outputs and compare them to the gold values.
> 
> (optional)
> @Check
> .. do custom verification...
> 
> 
> **In this RFE: the Setup Method**
> 
> The first step is the setup method.
> 
> Example:
> https://github.com/openjdk/jdk/blob/08670a5d45b1c45e954e2dc85eb8c92e11e48fb2/test/hotspot/jtreg/testlibrary_tests/ir_framework/examples/SetupExample.java#L49-L87

test/hotspot/jtreg/compiler/lib/ir_framework/Setup.java line 34:

> 32:  * {@link Arguments} annotation. A setup method can optionally take a {@link SetupInfo} as an argument. The for the
> 33:  * arguments for the test methods are returned in an Object[].
> 34:  *

Suggestion:

 *
 * Examples on how to use test methods can be found in {@link ir_framework.examples.SetupExample} and also as part of the internal testing in the package {@link ir_framework.tests}.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/17557#discussion_r1478280342