[hat] Tensor - Matrix-Multiplication Example for GPUs

hat/examples/matmul/src/main/java/matmul/Main.java

@@ -32,17 +32,17 @@
 import hat.NDRange.Local2D;
 import hat.annotations.Kernel;
 import hat.backend.Backend;
-import hat.examples.common.HATExampleException;
-import hat.examples.common.ParseArgs;
-import hat.types.F16;
 import hat.buffer.F16Array;
 import hat.buffer.F32Array;
 import hat.buffer.F32ArrayPadded;
-import hat.types.Float4;
 import hat.device.DeviceSchema;
 import hat.device.NonMappableIface;
-import optkl.ifacemapper.MappableIface.WO;
+import hat.examples.common.HATExampleException;
+import hat.examples.common.ParseArgs;
+import hat.types.F16;
+import hat.types.Float4;
 import jdk.incubator.code.Reflect;
+import optkl.ifacemapper.MappableIface.WO;
 
 import java.lang.invoke.MethodHandles;
 import java.util.ArrayList;
@@ -144,7 +144,6 @@ private interface MyLocalArrayFixedSize extends NonMappableIface {
         DeviceSchema<MyLocalArrayFixedSize> deviceSchema = DeviceSchema.of(MyLocalArrayFixedSize.class,
                 myPrivateArray -> myPrivateArray.array("array", 256));// It is a bound schema, so we fix the size here
 
-
         static MyLocalArrayFixedSize create(Accelerator accelerator) {
             return null;
         }
@@ -690,7 +689,7 @@ public static void matrixMultiplyKernel1DWithFunctionCalls(KernelContext kc, F32
 
     @Reflect
     public static void matrixMultiply1D(@RO ComputeContext cc, @RO F32Array matrixA, @RO F32Array matrixB, @WO F32Array matrixC, int globalSize) {
-        cc.dispatchKernel(of1D(globalSize,16),
+        cc.dispatchKernel(of1D(globalSize, 16),
                 kc -> matrixMultiplyKernel1D(kc, matrixA, matrixB, matrixC, globalSize)
         );
     }
@@ -700,21 +699,21 @@ public static void matrixMultiply1D(@RO ComputeContext cc, @RO F32Array matrixA,
 
     @Reflect
     public static void matrixMultiply1DWithFunctionCalls(@RO ComputeContext cc, @RO F32Array matrixA, @RO F32Array matrixB, @WO F32Array matrixC, int size) {
-        cc.dispatchKernel(of1D(size,16),
+        cc.dispatchKernel(of1D(size, 16),
                 kc -> matrixMultiplyKernel1DWithFunctionCalls(kc, matrixA, matrixB, matrixC, size)
         );
     }
 
     @Reflect
     public static void matrixMultiply2D(@RO ComputeContext cc, @RO F32Array matrixA, @RO F32Array matrixB, @WO F32Array matrixC, int globalSize) {
-        cc.dispatchKernel(of2D(globalSize, globalSize,BLOCK_SIZE, BLOCK_SIZE),
+        cc.dispatchKernel(of2D(globalSize, globalSize, BLOCK_SIZE, BLOCK_SIZE),
                 kc -> matrixMultiplyKernel2D(kc, matrixA, matrixB, matrixC, globalSize)
         );
     }
 
     @Reflect
     public static void matrixMultiply2DLI(@RO ComputeContext cc, @RO F32Array matrixA, @RO F32Array matrixB, @WO F32Array matrixC, int globalSize) {
-        cc.dispatchKernel(of2D(globalSize, globalSize,BLOCK_SIZE, BLOCK_SIZE),
+        cc.dispatchKernel(of2D(globalSize, globalSize, BLOCK_SIZE, BLOCK_SIZE),
                 kc -> matrixMultiplyKernel2DLI(kc, matrixA, matrixB, matrixC, globalSize)
         );
     }
@@ -750,7 +749,7 @@ public static void matrixMultiply2DRegisterTiling(@RO ComputeContext cc, @RO F32
     public static void matrixMultiply2DRegisterTilingVectorizedAccesses(@RO ComputeContext cc, @RO F32ArrayPadded matrixA, @RO F32ArrayPadded matrixB, @WO F32ArrayPadded matrixC, int globalSize) {
         // Note: if we change the static constant BM, we also need to adapt the BM and BN within the kernel to match the same value
         int size = ceil(globalSize, BM) * BLOCK_SIZE;
-        cc.dispatchKernel(of2D(size, size ,BLOCK_SIZE, BLOCK_SIZE),
+        cc.dispatchKernel(of2D(size, size, BLOCK_SIZE, BLOCK_SIZE),
                 kc -> matrixMultiplyKernel2DRegisterTilingVectorized(kc, matrixA, matrixB, matrixC, globalSize)
         );
     }
@@ -998,7 +997,7 @@ static void main(String[] args) {
                 default -> throw new HATExampleException("Unknown configuration: " + configuration);
             }
             long end = System.nanoTime();
-            timers.add((end-start));
+            timers.add((end - start));
             if (verbose) {
                 IO.println("Elapsed Time: " + (end - start) + " ns");
             }

hat/examples/pom.xml

@@ -1,28 +1,30 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0">
-<!--Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
-DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
+         xmlns="http://maven.apache.org/POM/4.0.0">
+    <!--Copyright (c) 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.  Oracle designates this
-particular file as subject to the "Classpath" exception as provided
-by Oracle in the LICENSE file that accompanied this code.
+    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.  Oracle designates this
+    particular file as subject to the "Classpath" exception as provided
+    by Oracle in the LICENSE file that accompanied this code.
 
-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).
+    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.
+    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.
---><!--Auto generated by mkpoms-->
+    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.
+    --><!--Auto generated by mkpoms-->
     <modelVersion>4.0.0</modelVersion>
     <packaging>pom</packaging>
     <artifactId>hat-examples</artifactId>
@@ -54,13 +56,14 @@ questions.
         <module>view</module>
         <module>life</module>
         <module>nbody</module>
+        <module>tensors</module>
         <module>experiments</module>
     </modules>
     <profiles>
         <profile>
             <id>opengl</id>
             <modules>
-               <module>nbodygl</module>
+                <module>nbodygl</module>
             </modules>
         </profile>
     </profiles>

hat/examples/shared/src/main/java/hat/examples/common/ParseArgs.java

@@ -86,5 +86,14 @@ private static void showHelp() {
 
     }
 
-    public record Options(boolean verbose, int size, int iterations, boolean skipSequential, boolean checkResult) {}
+    public record Options(boolean verbose, int size, int iterations, boolean skipSequential, boolean checkResult) {
+        public void printOptions() {
+            IO.println("Options:");
+            IO.println("Size           : " + size);
+            IO.println("Iterations     : " + iterations);
+            IO.println("Verbose        : " + verbose);
+            IO.println("Skip Sequential: " + skipSequential);
+            IO.println("Check Result   : " + checkResult);
+        }
+    }
 }

hat/examples/tensors/pom.xml

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Copyright (c) 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.  Oracle designates this
+particular file as subject to the "Classpath" exception as provided
+by Oracle in the LICENSE file that accompanied this code.
+
+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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>oracle.code</groupId>
+    <artifactId>hat-example-tensors</artifactId>
+    <version>1.0</version>
+    <packaging>jar</packaging>
+
+    <parent>
+        <groupId>oracle.code</groupId>
+        <artifactId>hat-examples</artifactId>
+        <version>1.0</version>
+    </parent>
+    <dependencies>
+        <dependency>
+            <groupId>oracle.code</groupId>
+            <artifactId>hat-core</artifactId>
+            <version>1.0</version>
+        </dependency>
+        <dependency>
+            <groupId>oracle.code</groupId>
+            <artifactId>hat-example-shared</artifactId>
+            <version>1.0</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-antrun-plugin</artifactId>
+                <version>1.8</version>
+                <executions>
+                    <execution>
+                        <id>1</id>
+                        <phase>install</phase>
+                        <goals>
+                            <goal>run</goal>
+                        </goals>
+                        <configuration>
+                            <target>
+                                <copy file="target/${project.artifactId}-${project.version}.jar" toDir="${hat.build}"/>
+                            </target>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>