Merge pull request #549 from jjfumero/fix/prebuilt/devices

Prebuilt API test using a multi-backend setup and selecting specific device
beehive-lab · Sep 3, 2024 · 6612338 · 6612338
2 parents f9e880b + 6d52e55
commit 6612338
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -358,23 +358,23 @@ For Academic & Industry collaborations, please contact [here](https://www.tornad
 
 Visit our [website](https://tornadovm.org) to meet the [team](https://www.tornadovm.org/about-us).
 
-## 11. Licenses
+## 11. Licenses Per Module
 
-To use TornadoVM, you can link the TornadoVM API to your application which is under Apache 2.
+To use TornadoVM, you can link the TornadoVM API to your application which is under [Apache 2](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2).
 
 Each Java TornadoVM module is licensed as follows:
 
-| Module                         | License                                                                                                                                                       |
-|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Tornado-API                    | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)       |
+| Module                         | License                                                                                                                                                          |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Tornado-API                    | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)          |
 | Tornado-Runtime                | [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2%20Classpath%20Exeception-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) |
-| Tornado-Assembly               | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)       |
+| Tornado-Assembly               | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)          |
 | Tornado-Drivers                | [![License: GPL v2](https://img.shields.io/badge/License-GPL%20V2%20Classpath%20Exeception-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) |
-| Tornado-Drivers-OpenCL-Headers | [![License](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/KhronosGroup/OpenCL-Headers/blob/master/LICENSE)                   |
-| Tornado-scripts                | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)       |
-| Tornado-Annotation             | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)       |
-| Tornado-Unittests              | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)       |
-| Tornado-Benchmarks             | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)       |
-| Tornado-Examples               | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)       |
-| Tornado-Matrices               | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)       |
-|                                |
+| Tornado-Drivers-OpenCL-Headers | [![License](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/KhronosGroup/OpenCL-Headers/blob/master/LICENSE)                      |
+| Tornado-scripts                | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)          |
+| Tornado-Annotation             | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)          |
+| Tornado-Unittests              | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)          |
+| Tornado-Benchmarks             | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)          |
+| Tornado-Examples               | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)          |
+| Tornado-Matrices               | [![License: Apache 2](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/beehive-lab/TornadoVM/blob/master/LICENSE_APACHE2)          |
+|                                |                                                                                                                                                                  | 
diff --git a/tornado-api/src/main/java/uk/ac/manchester/tornado/api/TornadoExecutionPlan.java b/tornado-api/src/main/java/uk/ac/manchester/tornado/api/TornadoExecutionPlan.java
@@ -171,7 +171,7 @@ public TornadoExecutionPlan withDevice(String taskName, TornadoDevice device) {
      * or different devices. Note that the TornadoVM runtime does not check for
      * data dependencies across tasks when using this API call. Thus, it is
      * the responsibility of the programmer to provide tasks with no data dependencies
-     * when invoking the method {@link TornadoExecutionPlan#withConcurrentDevices()}.
+     * when invoking the method {@link TornadoExecutionPlan#withConcurrentDevices}.
      *
      * @return {@link TornadoExecutionPlan}
      */

diff --git a/.../src/main/java/uk/ac/manchester/tornado/api/exceptions/TornadoExecutionPlanException.java b/.../src/main/java/uk/ac/manchester/tornado/api/exceptions/TornadoExecutionPlanException.java
@@ -19,11 +19,7 @@
 
 public class TornadoExecutionPlanException extends Exception {
 
-    private String reason;
-
-    public TornadoExecutionPlanException() {
-
-    }
+    private final String reason;
 
     public TornadoExecutionPlanException(String reason) {
         this.reason = reason;

diff --git a/tornado-assembly/src/bin/tornado-test b/tornado-assembly/src/bin/tornado-test
@@ -56,7 +56,7 @@ __TEST_THE_WORLD__ = [
     TestEntry("uk.ac.manchester.tornado.unittests.vectortypes.TestDoubles"),
     TestEntry("uk.ac.manchester.tornado.unittests.vectortypes.TestInts"),
     TestEntry("uk.ac.manchester.tornado.unittests.vectortypes.TestVectorAllocation"),
-    TestEntry("uk.ac.manchester.tornado.unittests.prebuilt.PrebuiltTest"),
+    TestEntry("uk.ac.manchester.tornado.unittests.prebuilt.PrebuiltTests"),
     TestEntry("uk.ac.manchester.tornado.unittests.virtualization.TestsVirtualLayer"),
     TestEntry("uk.ac.manchester.tornado.unittests.tasks.TestSingleTaskSingleDevice"),
     TestEntry("uk.ac.manchester.tornado.unittests.tasks.TestMultipleTasksSingleDevice"),
@@ -254,7 +254,7 @@ else:
 
 ENABLE_ASSERTIONS = "-ea "
 
-__VERSION__ = "1.0.7"
+__VERSION__ = "1.0.8-dev"
 
 try:
     javaHome = os.environ["JAVA_HOME"]

diff --git a/...nado/unittests/prebuilt/PrebuiltTest.java → ...ado/unittests/prebuilt/PrebuiltTests.java b/...nado/unittests/prebuilt/PrebuiltTest.java → ...ado/unittests/prebuilt/PrebuiltTests.java
@@ -19,6 +19,7 @@
 
 import static org.junit.Assert.assertEquals;
 
+import java.util.List;
 import java.util.stream.IntStream;
 
 import org.junit.BeforeClass;
@@ -29,6 +30,8 @@
 import uk.ac.manchester.tornado.api.ImmutableTaskGraph;
 import uk.ac.manchester.tornado.api.KernelContext;
 import uk.ac.manchester.tornado.api.TaskGraph;
+import uk.ac.manchester.tornado.api.TornadoBackend;
+import uk.ac.manchester.tornado.api.TornadoDeviceMap;
 import uk.ac.manchester.tornado.api.TornadoExecutionPlan;
 import uk.ac.manchester.tornado.api.WorkerGrid;
 import uk.ac.manchester.tornado.api.WorkerGrid1D;
@@ -41,16 +44,18 @@
 import uk.ac.manchester.tornado.api.runtime.TornadoRuntimeProvider;
 import uk.ac.manchester.tornado.api.types.arrays.IntArray;
 import uk.ac.manchester.tornado.unittests.common.TornadoTestBase;
+import uk.ac.manchester.tornado.unittests.common.TornadoVMMultiDeviceNotSupported;
+import uk.ac.manchester.tornado.unittests.common.TornadoVMPTXNotSupported;
 
 /**
  * <p>
  * How to run?
  * </p>
  * <code>
- * tornado-test -V uk.ac.manchester.tornado.unittests.prebuilt.PrebuiltTest
+ * tornado-test -V uk.ac.manchester.tornado.unittests.prebuilt.PrebuiltTests
  * </code>
  */
-public class PrebuiltTest extends TornadoTestBase {
+public class PrebuiltTests extends TornadoTestBase {
     private static final String TORNADO_SDK = "TORNADO_SDK";
     private static TornadoDevice defaultDevice;
     private static String FILE_PATH;
@@ -122,7 +127,7 @@ public void testPrebuilt01() throws TornadoExecutionPlanException {
     }
 
     @Test
-    public void testPrebuilt01Multi() throws TornadoExecutionPlanException {
+    public void testPrebuilt01MultiIterations() throws TornadoExecutionPlanException {
 
         final int numElements = 8;
         IntArray a = new IntArray(numElements);
@@ -234,7 +239,7 @@ public void testPrebuilt02SPIRV() throws TornadoExecutionPlanException {
     }
 
     /**
-     * This test case verifies that the {@link PrebuiltTest#testPrebuilt03SPIRV} runs correctly though a
+     * This test case verifies that the {@link PrebuiltTests#testPrebuilt03SPIRV} runs correctly though a
      * SPIR-V or OpenCL runtime if the device supports SPIR-V.
      *
      * <p>Expected outcome: - If the current backend type is PTX, the test should have
@@ -342,4 +347,83 @@ public void testPrebuilt04SPIRVThroughOpenCLRuntime() throws TornadoExecutionPla
         assertEquals(512, finalSum, 0.0f);
 
     }
+
+    /**
+     * This test is intended to be passed with multiple backends (e.g., OpenCL and PTX).
+     * The PTX backend needs to be installed. Otherwise, an exception is thrown.
+     *
+     * <p> How to run?
+     * <code>
+     * tornado-test -V uk.ac.manchester.tornado.unittests.prebuilt.PrebuiltTests#testPrebuiltMutiBackend
+     * </code>
+     * </p>
+     * 
+     * @throws TornadoExecutionPlanException
+     */
+    @Test
+    public void testPrebuiltMutiBackend() throws TornadoExecutionPlanException {
+
+        final int numElements = 8;
+        IntArray a = new IntArray(numElements);
+        IntArray b = new IntArray(numElements);
+        IntArray c = new IntArray(numElements);
+
+        a.init(1);
+        b.init(2);
+
+        // Force to use the PTX Backend.
+        FILE_PATH += "add.ptx";
+
+        TornadoDeviceMap tornadoDeviceMap = TornadoExecutionPlan.getTornadoDeviceMap();
+        if (tornadoDeviceMap.getNumBackends() < 2) {
+            throw new TornadoVMMultiDeviceNotSupported("Test designed to run with multiple backends");
+        }
+
+        List<TornadoBackend> ptxBackend = tornadoDeviceMap.getBackendsWithPredicate(backend -> backend.getBackendType() == TornadoVMBackendType.PTX);
+
+        if (ptxBackend == null || ptxBackend.isEmpty()) {
+            throw new TornadoVMPTXNotSupported("Test designed to run with multiple backends, including a PTX backend");
+        }
+
+        // Access the first device within the NVIDIA PTX Backend
+        TornadoDevice device = ptxBackend.getFirst().getDevice(0);
+
+        // Define accessors for each parameter
+        AccessorParameters accessorParameters = new AccessorParameters(3);
+        accessorParameters.set(0, a, Access.READ_WRITE);
+        accessorParameters.set(1, b, Access.READ_WRITE);
+        accessorParameters.set(2, c, Access.WRITE_ONLY);
+
+        // Define the Task-Graph
+        TaskGraph taskGraph = new TaskGraph("s0") //
+                .transferToDevice(DataTransferMode.EVERY_EXECUTION, a, b) //
+                .prebuiltTask("t0",      //task name
+                        "add",              // name of the low-level kernel to invoke
+                        FILE_PATH,          // file name
+                        accessorParameters) // accessors
+                .transferToHost(DataTransferMode.EVERY_EXECUTION, c);
+
+        // When using the prebuilt API, we need to define the WorkerGrid, otherwise it will launch 1 thread
+        // on the target device
+        WorkerGrid workerGrid = new WorkerGrid1D(numElements);
+        GridScheduler gridScheduler = new GridScheduler("s0.t0", workerGrid);
+
+        // Launch the application on the target device
+        try (TornadoExecutionPlan executionPlan = new TornadoExecutionPlan(taskGraph.snapshot())) {
+
+            executionPlan.withGridScheduler(gridScheduler) //
+                    .withDevice(device) //
+                    .execute();
+
+            // Run task multiple times
+            for (int i = 0; i < 10; i++) {
+                executionPlan.execute();
+                for (int j = 0; j < c.getSize(); j++) {
+                    assertEquals(a.get(j) + b.get(j), c.get(j));
+                }
+                IntStream.range(0, numElements).forEach(k -> a.set(k, c.get(k)));
+            }
+        }
+    }
+
 }