Refactor common compiler phases among different backends to drivers.common.compiler.phases package and restructure compiler utilities

pom.xml

@@ -325,6 +325,9 @@
                                     jdk.internal.vm.compiler/org.graalvm.compiler.phases=tornado.runtime,tornado.drivers.common
                                 </arg>
                                 <arg>--add-exports</arg>
+                                <arg>jdk.internal.vm.compiler/org.graalvm.compiler.nodes.java=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.phases.tiers=tornado.runtime</arg>
                                 <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.phases.util=tornado.runtime</arg>
@@ -347,6 +350,9 @@
                                     jdk.internal.vm.compiler/org.graalvm.compiler.core.common.spi=tornado.runtime,tornado.drivers.common
                                 </arg>
                                 <arg>--add-exports</arg>
+                                <arg>jdk.internal.vm.compiler/org.graalvm.compiler.nodes.loop=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.api.replacements=tornado.runtime
                                 </arg>
                                 <arg>--add-exports</arg>
@@ -363,6 +369,10 @@
                                 <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.nodes.extended=tornado.runtime</arg>
                                 <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.nodes.extended=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.nodes.loop=tornado.runtime</arg>
                                 <arg>--add-exports</arg>
                                 <arg>
@@ -399,6 +409,42 @@
                                     jdk.internal.vm.compiler/org.graalvm.compiler.nodes.gc=tornado.runtime,tornado.drivers.common
                                 </arg>
                                 <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.nodes=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.nodes.loop=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.nodes.calc=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.options=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.nodes.debug=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.nodes.util=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.nodes.virtual=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.loop.phases=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.core.common.util=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
                                 <arg>
                                     jdk.internal.vm.compiler/org.graalvm.compiler.nodes.memory.address=tornado.runtime,tornado.drivers.common
                                 </arg>
@@ -501,6 +547,9 @@
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.phases.tiers=tornado.drivers.opencl
                                 </arg>
                                 <arg>--add-exports</arg>
+                                <arg>jdk.internal.vm.compiler/org.graalvm.compiler.phases.tiers=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.phases.util=tornado.drivers.opencl
                                 </arg>
                                 <arg>--add-exports</arg>
@@ -521,6 +570,10 @@
                                     jdk.internal.vm.compiler/org.graalvm.compiler.phases.common=tornado.drivers.opencl
                                 </arg>
                                 <arg>--add-exports</arg>
+                                <arg>
+                                    jdk.internal.vm.compiler/org.graalvm.compiler.phases.common=tornado.drivers.common
+                                </arg>
+                                <arg>--add-exports</arg>
                                 <arg>
                                     jdk.internal.vm.compiler/org.graalvm.compiler.core.common.spi=tornado.drivers.opencl
                                 </arg>
@@ -1273,6 +1326,8 @@
                                 <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.options=tornado.drivers.opencl</arg>
                                 <arg>--add-exports</arg>
+                                <arg>jdk.internal.vm.compiler/org.graalvm.compiler.options=tornado.drivers.common</arg>
+                                <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.phases=tornado.drivers.opencl</arg>
                                 <arg>--add-exports</arg>
                                 <arg>jdk.internal.vm.compiler/org.graalvm.compiler.phases.tiers=tornado.drivers.opencl

tornado-assembly/src/etc/exportLists/common-exports

@@ -86,3 +86,13 @@
 --add-exports jdk.internal.vm.compiler/org.graalvm.compiler.core.common.memory=tornado.drivers.common
 --add-exports jdk.internal.vm.compiler/org.graalvm.compiler.graph=tornado.runtime,tornado.drivers.common
 --add-exports jdk.internal.vm.compiler/org.graalvm.compiler.graph.iterators=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.nodes.java=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.nodes.extended=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.nodes.loop=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.nodes.calc=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.options=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.nodes.debug=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.nodes.util=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.nodes.virtual=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.loop.phases=tornado.drivers.common
+--add-exports jdk.internal.vm.compiler/org.graalvm.compiler.core.common.util=tornado.drivers.common

tornado-drivers/drivers-common/src/main/java/module-info.java

@@ -1,13 +1,18 @@
-module tornado.drivers.common {
-    requires transitive jdk.internal.vm.compiler;
+open module tornado.drivers.common {
     requires transitive jdk.internal.vm.ci;
+    requires transitive jdk.internal.vm.compiler;
     requires transitive tornado.runtime;
 
-    exports uk.ac.manchester.tornado.drivers.graal;
+    exports uk.ac.manchester.tornado.drivers.providers;
     exports uk.ac.manchester.tornado.drivers.common;
     exports uk.ac.manchester.tornado.drivers.common.architecture;
     exports uk.ac.manchester.tornado.drivers.common.mm;
     exports uk.ac.manchester.tornado.drivers.common.code;
-    exports uk.ac.manchester.tornado.drivers.common.graal.compiler;
     exports uk.ac.manchester.tornado.drivers.common.logging;
+    exports uk.ac.manchester.tornado.drivers.common.compiler.phases.guards;
+    exports uk.ac.manchester.tornado.drivers.common.compiler.phases.memalloc;
+    exports uk.ac.manchester.tornado.drivers.common.compiler.phases.loops;
+    exports uk.ac.manchester.tornado.drivers.common.compiler.phases.utils;
+    exports uk.ac.manchester.tornado.drivers.common.compiler.phases.analysis;
+    exports uk.ac.manchester.tornado.drivers.common.utils;
 }

tornado-drivers/drivers-common/src/main/java/uk/ac/manchester/tornado/drivers/TornadoDeviceQuery.java

@@ -12,7 +12,7 @@
  *
  * 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
+ * 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).
  *
@@ -27,7 +27,7 @@
 import java.util.HashMap;
 
 import uk.ac.manchester.tornado.api.enums.TornadoVMBackendType;
-import uk.ac.manchester.tornado.drivers.common.ColoursTerminal;
+import uk.ac.manchester.tornado.drivers.common.utils.ColoursTerminal;
 import uk.ac.manchester.tornado.runtime.TornadoAcceleratorDriver;
 import uk.ac.manchester.tornado.runtime.TornadoCoreRuntime;
 import uk.ac.manchester.tornado.runtime.common.TornadoOptions;
@@ -45,14 +45,6 @@
  */
 public class TornadoDeviceQuery {
 
-    private static String formatSize(long v) {
-        if (v < 1024) {
-            return v + " B";
-        }
-        int z = (63 - Long.numberOfLeadingZeros(v)) / 10;
-        return String.format("%.1f %sB", (double) v / (1L << (z * 10)), " KMGTPE".charAt(z));
-    }
-
     private static HashMap<TornadoVMBackendType, String> colourMapping;
 
     static {
@@ -62,6 +54,14 @@ private static String formatSize(long v) {
         colourMapping.put(TornadoVMBackendType.SPIRV, ColoursTerminal.PURPLE);
     }
 
+    private static String formatSize(long v) {
+        if (v < 1024) {
+            return v + " B";
+        }
+        int z = (63 - Long.numberOfLeadingZeros(v)) / 10;
+        return String.format("%.1f %sB", (double) v / (1L << (z * 10)), " KMGTPE".charAt(z));
+    }
+
     public static void main(String[] args) {
 
         String verboseFlag = "";

tornado-runtime/src/main/java/uk/ac/manchester/tornado/runtime/graal/phases/TornadoFeatureExtraction.java → tornado-drivers/drivers-common/src/main/java/uk/ac/manchester/tornado/drivers/common/compiler/phases/analysis/TornadoFeatureExtraction.java

@@ -10,7 +10,7 @@
  *
  * 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
+ * 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).
  *
@@ -21,7 +21,7 @@
  * Authors: Michalis Papadimitriou
  *
  */
-package uk.ac.manchester.tornado.runtime.graal.phases;
+package uk.ac.manchester.tornado.drivers.common.compiler.phases.analysis;
 
 import java.util.LinkedHashMap;
 import java.util.Optional;
@@ -63,6 +63,14 @@
 
 import jdk.vm.ci.meta.JavaKind;
 import uk.ac.manchester.tornado.api.TornadoDeviceContext;
+import uk.ac.manchester.tornado.runtime.graal.nodes.interfaces.MarkCastNode;
+import uk.ac.manchester.tornado.runtime.graal.nodes.interfaces.MarkFloatingPointIntrinsicsNode;
+import uk.ac.manchester.tornado.runtime.graal.nodes.interfaces.MarkGlobalThreadID;
+import uk.ac.manchester.tornado.runtime.graal.nodes.interfaces.MarkIntIntrinsicNode;
+import uk.ac.manchester.tornado.runtime.graal.nodes.interfaces.MarkLocalArray;
+import uk.ac.manchester.tornado.runtime.graal.nodes.interfaces.MarkOCLWriteNode;
+import uk.ac.manchester.tornado.runtime.graal.nodes.interfaces.MarkVectorLoad;
+import uk.ac.manchester.tornado.runtime.graal.nodes.interfaces.MarkVectorValueNode;
 import uk.ac.manchester.tornado.runtime.profiler.FeatureExtractionUtilities;
 import uk.ac.manchester.tornado.runtime.profiler.ProfilerCodeFeatures;
 

tornado-runtime/src/main/java/uk/ac/manchester/tornado/runtime/graal/phases/TornadoShapeAnalysis.java → tornado-drivers/drivers-common/src/main/java/uk/ac/manchester/tornado/drivers/common/compiler/phases/analysis/TornadoShapeAnalysis.java

@@ -19,7 +19,7 @@
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  */
-package uk.ac.manchester.tornado.runtime.graal.phases;
+package uk.ac.manchester.tornado.drivers.common.compiler.phases.analysis;
 
 import java.util.Collections;
 import java.util.List;
@@ -41,6 +41,7 @@
 import uk.ac.manchester.tornado.runtime.domain.IntDomain;
 import uk.ac.manchester.tornado.runtime.graal.nodes.ParallelRangeNode;
 import uk.ac.manchester.tornado.runtime.graal.nodes.TornadoLoopsData;
+import uk.ac.manchester.tornado.runtime.graal.phases.TornadoHighTierContext;
 
 /**
  * It analyses the loop index space and determines the correct indices using
@@ -71,8 +72,7 @@ private int getMaxLevelNestedLoops(StructuredGraph graph) {
 
             final List<LoopEx> loops = data.outerFirst();
 
-            for (int i = 0; i < loops.size(); i++) {
-                LoopEx loopEx = loops.get(i);
+            for (LoopEx loopEx : loops) {
                 LoopFragmentInside inside = loopEx.inside();
                 NodeBitMap nodes = inside.nodes();
 

tornado-runtime/src/main/java/uk/ac/manchester/tornado/runtime/graal/phases/TornadoValueTypeReplacement.java → tornado-drivers/drivers-common/src/main/java/uk/ac/manchester/tornado/drivers/common/compiler/phases/analysis/TornadoValueTypeReplacement.java

@@ -19,7 +19,7 @@
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  */
-package uk.ac.manchester.tornado.runtime.graal.phases;
+package uk.ac.manchester.tornado.drivers.common.compiler.phases.analysis;
 
 import static uk.ac.manchester.tornado.runtime.graal.compiler.TornadoCodeGenerator.debug;
 
@@ -37,6 +37,7 @@
 
 import jdk.vm.ci.meta.ResolvedJavaField;
 import uk.ac.manchester.tornado.api.internal.annotations.Vector;
+import uk.ac.manchester.tornado.runtime.graal.phases.TornadoHighTierContext;
 
 public class TornadoValueTypeReplacement extends BasePhase<TornadoHighTierContext> {
 

tornado-drivers/opencl/src/main/java/uk/ac/manchester/tornado/drivers/opencl/graal/phases/BoundCheckEliminationPhase.java → tornado-drivers/drivers-common/src/main/java/uk/ac/manchester/tornado/drivers/common/compiler/phases/guards/BoundCheckEliminationPhase.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, APT Group, Department of Computer Science,
+ * Copyright (c) 2020, 2023 APT Group, Department of Computer Science,
  * School of Engineering, The University of Manchester. All rights reserved.
  * Copyright (c) 2009, 2017, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
@@ -10,16 +10,15 @@
  *
  * 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
+ * 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.
- *
- * */
-package uk.ac.manchester.tornado.drivers.opencl.graal.phases;
+ */
+package uk.ac.manchester.tornado.drivers.common.compiler.phases.guards;
 
 import java.util.Optional;
 
@@ -36,7 +35,7 @@
  * After canonicalization, we might end up with a Guard of type Bounds Check
  * Exception without any array access. For those cases, we clean the graph and
  * remove also the guard (deopt) node and avoid empty basic blocks before the
- * OpenCL code generation.
+ * code generation.
  */
 public class BoundCheckEliminationPhase extends Phase {
     @Override

tornado-runtime/src/main/java/uk/ac/manchester/tornado/runtime/graal/phases/ExceptionCheckingElimination.java → tornado-drivers/drivers-common/src/main/java/uk/ac/manchester/tornado/drivers/common/compiler/phases/guards/ExceptionCheckingElimination.java

@@ -18,7 +18,7 @@
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  */
-package uk.ac.manchester.tornado.runtime.graal.phases;
+package uk.ac.manchester.tornado.drivers.common.compiler.phases.guards;
 
 import java.util.Optional;
 
@@ -35,6 +35,8 @@
 import org.graalvm.compiler.nodes.extended.GuardedNode;
 import org.graalvm.compiler.phases.BasePhase;
 
+import uk.ac.manchester.tornado.runtime.graal.phases.TornadoMidTierContext;
+
 public class ExceptionCheckingElimination extends BasePhase<TornadoMidTierContext> {
     @Override
     public Optional<NotApplicable> notApplicableTo(GraphState graphState) {
@@ -47,10 +49,9 @@ public Optional<NotApplicable> notApplicableTo(GraphState graphState) {
     @Override
     protected void run(StructuredGraph graph, TornadoMidTierContext context) {
 
-        graph.getNodes().filter(n -> n instanceof GuardedNode).snapshot().forEach((node) -> {
+        graph.getNodes().filter(GuardedNode.class::isInstance).snapshot().forEach((node) -> {
             GuardedNode guardedNode = (GuardedNode) node;
-            if (guardedNode.getGuard() instanceof GuardNode) {
-                GuardNode guard = (GuardNode) guardedNode.getGuard();
+            if (guardedNode.getGuard() instanceof GuardNode guard) {
 
                 LogicNode condition = guard.getCondition();
 
@@ -64,13 +65,10 @@ protected void run(StructuredGraph graph, TornadoMidTierContext context) {
                     }
 
                 } else if (condition instanceof IntegerBelowNode) {
-
                     ValueNode x = ((IntegerBelowNode) condition).getX();
                     condition.replaceFirstInput(x, graph.addOrUnique(ConstantNode.forInt(Integer.MAX_VALUE)));
                 }
             }
-
         });
-
     }
 }

tornado-runtime/src/main/java/uk/ac/manchester/tornado/runtime/graal/phases/ExceptionSuppression.java → tornado-drivers/drivers-common/src/main/java/uk/ac/manchester/tornado/drivers/common/compiler/phases/guards/ExceptionSuppression.java

@@ -19,7 +19,7 @@
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  */
-package uk.ac.manchester.tornado.runtime.graal.phases;
+package uk.ac.manchester.tornado.drivers.common.compiler.phases.guards;
 
 import java.util.HashSet;
 import java.util.Optional;
@@ -33,6 +33,8 @@
 import org.graalvm.compiler.nodes.extended.ValueAnchorNode;
 import org.graalvm.compiler.phases.BasePhase;
 
+import uk.ac.manchester.tornado.runtime.graal.phases.TornadoHighTierContext;
+
 public class ExceptionSuppression extends BasePhase<TornadoHighTierContext> {
     @Override
     public Optional<NotApplicable> notApplicableTo(GraphState graphState) {
@@ -45,10 +47,9 @@ protected void run(StructuredGraph graph, TornadoHighTierContext context) {
         Set<LogicNode> conditions = new HashSet<>();
         Set<GuardNode> guards = new HashSet<>();
 
-        graph.getNodes().filter(n -> n instanceof GuardedNode).forEach((node) -> {
+        graph.getNodes().filter(GuardedNode.class::isInstance).forEach(node -> {
             GuardedNode guardedNode = (GuardedNode) node;
-            if (guardedNode.getGuard() instanceof GuardNode) {
-                GuardNode guard = (GuardNode) guardedNode.getGuard();
+            if (guardedNode.getGuard() instanceof GuardNode guard) {
                 LogicNode condition = guard.getCondition();
 
                 conditions.add(condition);
@@ -59,8 +60,7 @@ protected void run(StructuredGraph graph, TornadoHighTierContext context) {
         });
 
         graph.getNodes().filter(ValueAnchorNode.class).forEach(anchor -> {
-            if (anchor.getAnchoredNode() instanceof GuardNode) {
-                final GuardNode guard = (GuardNode) anchor.getAnchoredNode();
+            if (anchor.getAnchoredNode() instanceof GuardNode guard) {
                 guards.add(guard);
                 conditions.add(guard.getCondition());
                 anchor.removeAnchoredNode();