Refactor one of the core runtime classes - API new methods for adding Compilation Flags #539

jjfumero · 2024-08-23T14:09:28Z

Description

This PR refactors the old AbstractMetaData class and it adds a new method in the TornadoExecutionPlan to select the compilation flags. This addition is due to the refactoring the of the aforementioned class.

API Changes:

 try (TornadoExecutionPlan executionPlan = new TornadoExecutionPlan(taskGraph.snapshot())) {
            executionPlan.withCompilerFlags(TornadoVMBackendType.OPENCL, "-cl-opt-disable") //
                    .withCompilerFlags(TornadoVMBackendType.PTX, " ") //
                    .withCompilerFlags(TornadoVMBackendType.SPIRV, "-ze-opt-level 1") //
                    .execute();
        }

We can specify the flags we want per backend. This is by design, because the TornadoVM runtime can migrate execution from one device to another, and even from different backends.

Problem description

This PR removes old fields and old functionality no longer needed.

Backend/s tested

Mark the backends affected by this PR.

OpenCL
PTX
SPIRV

OS tested

Mark the OS where this PR is tested.

Linux
OSx
Windows

Did you check on FPGAs?

If it is applicable, check your changes on FPGAs.

Yes
No

How to test the new patch?

make tests
tornado-test -V uk.ac.manchester.tornado.unittests.compiler.TestCompilerFlagsAPI

…g driver/s

…actMetaData -> AbstractRTContext

mikepapadim · 2024-08-26T07:45:46Z

...s/opencl/src/main/java/uk/ac/manchester/tornado/drivers/opencl/runtime/OCLTornadoDevice.java

-        if (meta instanceof TaskMetaData) {
-            TaskMetaData metaData = (TaskMetaData) task.meta();
+        TaskContextInterface meta = task.meta();
+        if (meta instanceof TaskDataContext) {


this can be simplified to avoid type casting

mikepapadim · 2024-08-26T07:47:23Z

tornado-runtime/src/main/java/uk/ac/manchester/tornado/runtime/common/TornadoOptions.java

+    /**
+     * Default PTX Compiler Flags.
+     */
+    public static final String DEFAULT_PTX_COMPILER_FLAGS = getProperty("tornado.ptx.compiler.flags", "");


are we sure that PTX does not require any flags that we can use by default?

I did not detect we pass any flags to the PTX driver compiler.

mikepapadim · 2024-08-26T07:47:59Z

...do-runtime/src/main/java/uk/ac/manchester/tornado/runtime/graph/TornadoExecutionContext.java

@@ -571,38 +571,6 @@ public boolean useDefaultThreadScheduler() {
        return defaultScheduler;
    }

-    public void createImmutableExecutionContext(TornadoExecutionContext executionContext) {


Why we removed this?

This method is never invoked.

mikepapadim · 2024-08-26T07:49:22Z

LGTM, just a few comments

stratika

Thanks, it looks good to me. Shall we test if this option works also for the FPGAs? Have you tested it? is it supposed to overlap with the compiler flags for HLS in the configuration file?

tornado-api/src/main/java/uk/ac/manchester/tornado/api/TornadoExecutionPlan.java

…ExecutionPlan.java Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>

jjfumero · 2024-08-26T08:29:36Z

Thanks, it looks good to me. Shall we test if this option works also for the FPGAs? Have you tested it? is it supposed to overlap with the compiler flags for HLS in the configuration file?

I did not test on FPGAs. It does not overlap with the FPGA compilation option, but let's do some testing.

stratika · 2024-08-26T09:09:19Z

Thanks, it looks good to me. Shall we test if this option works also for the FPGAs? Have you tested it? is it supposed to overlap with the compiler flags for HLS in the configuration file?

I did not test on FPGAs. It does not overlap with the FPGA compilation option, but let's do some testing.

I have just tried it in emulation mode, and it works.

jjfumero · 2024-08-26T09:23:20Z

Great, I'll merge this PR.

Improvements ~~~~~~~~~~~~~~~~~~ - beehive-lab#468: Cleanup Abstract Metadata Class. - beehive-lab#473: Add maven plugin to build TornadoVM source for the releases. - beehive-lab#474: Refactor `<X>TornadoDevice` to place common methods in the `TornadoXPUInterface`. - beehive-lab#482: Help messages improve when an out-of-memory exception is raised. - beehive-lab#484: Double-type for the trigonometric functions added in the `TornadoMath` class. - beehive-lab#487: Prebuilt API simplified. - beehive-lab#494: Add test to trigger unsupported features related to direct use of Memory Segments. - beehive-lab#509: Add a quick pass configuration to skip the heavy tests during active development. - beehive-lab#532: Improve thread scheduler to support RISC-V Accelerators from Codeplay. - beehive-lab#533: Support for scalar values to be passed via lambda expressions as tasks. - beehive-lab#538: `README` file updated. - beehive-lab#539: Refactor core classes and add new API methods to pass compilation flags to the low-level driver compilers (OpenCL, PTX and Level Zero). - beehive-lab#542: Tagged LevelZero JNI and Beehive Toolkit dependencies added in the build and installer. Compatibility ~~~~~~~~~~~~~~~~~~ - beehive-lab#465: Support for JDK 22 and GraalVM 24.0.2. - beehive-lab#486: Temurin for Windows added in the list of supported JDKs. - beehive-lab#525: Revert usage of String Templates in preparation for JDK 23. - beehive-lab#527: SPIR-V version parameter added. TornadoVM may run previous SPIR-V versions (e.g., ComputeAorta from Codeplay). - beehive-lab#513: LevelZero JNI Library updated to v0.1.4. Bug Fixes ~~~~~~~~~~~~~~~~~~ - beehive-lab#470: README documentation fixed. - beehive-lab#478: Fix the test names that are present in the white list. - beehive-lab#488: FP64 Kind for radian operations and the PTX backend fixed. - beehive-lab#493: Tests Whitelist for PTX backend fixed. - beehive-lab#502: Fix barrier type in the documentation regarding programmability of reductions. - beehive-lab#514: Installer script fixed. - beehive-lab#540: Fix issue with clean-up execution IDs function. - beehive-lab#541: Fix Data Accessors for the prebuilt API. - beehive-lab#543: Fix checkstyle condition and FP16 error message improved.

Improvements ~~~~~~~~~~~~~~~~~~ - beehive-lab#468: Cleanup Abstract Metadata Class. - beehive-lab#473: Add maven plugin to build TornadoVM source for the releases. - beehive-lab#474: Refactor `<X>TornadoDevice` to place common methods in the `TornadoXPUInterface`. - beehive-lab#482: Help messages improved when an out-of-memory exception is raised. - beehive-lab#484: Double-type for the trigonometric functions added in the `TornadoMath` class. - beehive-lab#487: Prebuilt API simplified. - beehive-lab#494: Add test to trigger unsupported features related to direct use of Memory Segments. - beehive-lab#509: Add a quick pass configuration to skip the heavy tests during active development. - beehive-lab#532: Improve thread scheduler to support RISC-V Accelerators from Codeplay. - beehive-lab#533: Support for scalar values to be passed via lambda expressions as tasks. - beehive-lab#538: `README` file updated. - beehive-lab#539: Refactor core classes and add new API methods to pass compilation flags to the low-level driver compilers (OpenCL, PTX and Level Zero). - beehive-lab#542: Tagged LevelZero JNI and Beehive Toolkit dependencies added in the build and installer. Compatibility ~~~~~~~~~~~~~~~~~~ - beehive-lab#465: Support for JDK 22 and GraalVM 24.0.2. - beehive-lab#486: Temurin for Windows added in the list of supported JDKs. - beehive-lab#525: Revert usage of String Templates in preparation for JDK 23. - beehive-lab#527: SPIR-V version parameter added. TornadoVM may run previous SPIR-V versions (e.g., ComputeAorta from Codeplay). - beehive-lab#513: LevelZero JNI Library updated to v0.1.4. Bug Fixes ~~~~~~~~~~~~~~~~~~ - beehive-lab#470: README documentation fixed. - beehive-lab#478: Fix the test names that are present in the white list. - beehive-lab#488: FP64 Kind for radian operations and the PTX backend fixed. - beehive-lab#493: Tests Whitelist for PTX backend fixed. - beehive-lab#502: Fix barrier type in the documentation regarding programmability of reductions. - beehive-lab#514: Installer script fixed. - beehive-lab#540: Fix issue with clean-up execution IDs function. - beehive-lab#541: Fix Data Accessors for the prebuilt API. - beehive-lab#543: Fix checkstyle condition and FP16 error message improved. minor change

jjfumero added 6 commits August 23, 2024 12:21

[wip][api] New API calls to pass compiler options to the correspondin…

ffddb98

…g driver/s

minor refactor

b973507

[wip] Renamed TaskMetaDataInterface -> TaskContextInterface and Abstr…

2ca1329

…actMetaData -> AbstractRTContext

[wip] Rename core RT classes for handling execution

2d5fb8c

minor change

665973d

[Clean-Up] AbstractRTContext old fields removed

af77c51

jjfumero added API runtime refactoring labels Aug 23, 2024

jjfumero requested review from mikepapadim, mairooni and stratika August 23, 2024 14:09

jjfumero self-assigned this Aug 23, 2024

mikepapadim reviewed Aug 26, 2024

View reviewed changes

stratika reviewed Aug 26, 2024

View reviewed changes

jjfumero and others added 4 commits August 26, 2024 09:56

Update tornado-api/src/main/java/uk/ac/manchester/tornado/api/Tornado…

5bd5a86

…ExecutionPlan.java Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>

Update tornado-api/src/main/java/uk/ac/manchester/tornado/api/Tornado…

79f1c09

…ExecutionPlan.java Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>

Update tornado-api/src/main/java/uk/ac/manchester/tornado/api/Tornado…

529934e

…ExecutionPlan.java Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>

Update tornado-api/src/main/java/uk/ac/manchester/tornado/api/Tornado…

0826c85

…ExecutionPlan.java Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>

stratika approved these changes Aug 26, 2024

View reviewed changes

mikepapadim approved these changes Aug 26, 2024

View reviewed changes

jjfumero merged commit 68abbcd into beehive-lab:develop Aug 26, 2024
2 checks passed

jjfumero deleted the feat/plan/api branch August 26, 2024 09:23

jjfumero mentioned this pull request Aug 30, 2024

[release] TornadoVM 1.0.7 #546

Merged

stratika mentioned this pull request Sep 9, 2024

[fix] OCL compiler flags for math tests on Integrated GPUs #553

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor one of the core runtime classes - API new methods for adding Compilation Flags #539

Refactor one of the core runtime classes - API new methods for adding Compilation Flags #539

jjfumero commented Aug 23, 2024

mikepapadim Aug 26, 2024

mikepapadim Aug 26, 2024

jjfumero Aug 26, 2024

mikepapadim Aug 26, 2024

jjfumero Aug 26, 2024

mikepapadim commented Aug 26, 2024

stratika left a comment

jjfumero commented Aug 26, 2024

stratika commented Aug 26, 2024

jjfumero commented Aug 26, 2024

Refactor one of the core runtime classes - API new methods for adding Compilation Flags #539

Refactor one of the core runtime classes - API new methods for adding Compilation Flags #539

Conversation

jjfumero commented Aug 23, 2024

Description

Problem description

Backend/s tested

OS tested

Did you check on FPGAs?

How to test the new patch?

mikepapadim Aug 26, 2024

Choose a reason for hiding this comment

mikepapadim Aug 26, 2024

Choose a reason for hiding this comment

jjfumero Aug 26, 2024

Choose a reason for hiding this comment

mikepapadim Aug 26, 2024

Choose a reason for hiding this comment

jjfumero Aug 26, 2024

Choose a reason for hiding this comment

mikepapadim commented Aug 26, 2024

stratika left a comment

Choose a reason for hiding this comment

jjfumero commented Aug 26, 2024

stratika commented Aug 26, 2024

jjfumero commented Aug 26, 2024