1 /*
2 * Copyright (c) 2024, 2026, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package hat;
26
27 import hat.backend.Backend;
28
29 import hat.buffer.DispatchContext;
30 import optkl.util.carriers.ArenaAndLookupCarrier;
31 import optkl.ifacemapper.BufferTracker;
32 import optkl.ifacemapper.MappableIface;
33
34 import java.lang.foreign.Arena;
35 import java.lang.invoke.MethodHandles;
36 import java.lang.reflect.Method;
37
38 import jdk.incubator.code.Op;
39 import jdk.incubator.code.Quoted;
40 import jdk.incubator.code.dialect.java.JavaOp;
41
42 import java.util.HashMap;
43 import java.util.Map;
44 import java.util.ServiceLoader;
45 import java.util.function.Consumer;
46 import java.util.function.Predicate;
47
48 import static hat.backend.Backend.FIRST;
49 import static optkl.OpHelper.Invoke.getTargetInvoke;
50 import static optkl.OpHelper.Lambda.lambda;
51
52 /**
53 * This class provides the developer facing view of HAT, and wraps a <a href="backend/Backend.html">Backend</a> capable of
54 * executing <b>NDRange</b> style execution.
55 * <p/>
56 * An Accelerator is provided a <a href="java/lang/invoke/MethodHandles.Lookup.html">MethodHandles.Lookup</a> with visibility to the
57 * compute to be performed.
58 * <p/>
59 * As well we either a <a href="backend/Backend.html">Backend</a> directly
60 * <pre>
61 * Accelerator accelerator =
62 * new Accelerator(MethodHandles.lookup(),
63 * new JavaMultiThreadedBackend());
64 * </pre>
65 * or a {@code java.util.function.Predicate<Backend>} which can be used to select the required {@code Backend}
66 * loaded via Javas ServiceLoader mechanism
67 * {@code}
68 * <pre>
69 * Accelerator accelerator =
70 * new Accelerator(MethodHandles.lookup(),
71 * be -> be.name().startsWith("OpenCL));
72 * </pre>}
73 *
74 * @author Gary Frost
75 */
76 public class Accelerator implements ArenaAndLookupCarrier, BufferTracker {
77
78 private final MethodHandles.Lookup lookup;
79 @Override public MethodHandles.Lookup lookup(){return lookup;}
80 public final Backend backend;
81
82 private final Map<Method, hat.ComputeContext> cache = new HashMap<>();
83
84 // public KernelContext kernelContext(NDRange ndRange) {
85 // return new KernelContext(ndRange);
86 // }
87 public DispatchContext dispatchContext(NDRange ndRange) {
88 var dispatchContext = DispatchContext.createDefaultContext(this);
89 throw new RuntimeException("fill me");
90 // return dispatchContext;
91 }
92
93 protected Accelerator(MethodHandles.Lookup lookup, ServiceLoader.Provider<Backend> provider) {
94 this(lookup, provider.get());
95 }
96 public Accelerator(MethodHandles.Lookup lookup) {
97 this(lookup, FIRST);
98 }
99
100 /**
101 * @param lookup
102 * @param backend
103 */
104 public Accelerator(MethodHandles.Lookup lookup, Backend backend) {
105 this.lookup = lookup;
106 this.backend = backend;
107 }
108
109 /**
110 * @param lookup
111 * @param backendPredicate
112 */
113 public Accelerator(MethodHandles.Lookup lookup, Predicate<Backend> backendPredicate) {
114 this(lookup, Backend.getBackend(backendPredicate));
115 }
116
117 @Override
118 public void preMutate(MappableIface mappableIface) {
119 if (backend instanceof BufferTracker bufferTracker) {
120 bufferTracker.preMutate(mappableIface);
121 }
122 }
123
124 @Override
125 public void postMutate(MappableIface mappableIface) {
126 if (backend instanceof BufferTracker bufferTracker) {
127 bufferTracker.postMutate(mappableIface);
128 }
129 }
130
131 @Override
132 public void preAccess(MappableIface mappableIface) {
133 if (backend instanceof BufferTracker bufferTracker) {
134 bufferTracker.preAccess(mappableIface);
135 }
136 }
137
138 @Override
139 public void postAccess(MappableIface mappableIface) {
140 if (backend instanceof BufferTracker bufferTracker) {
141 bufferTracker.postAccess(mappableIface);
142 }
143 }
144
145 @Override
146 public Arena arena() {
147 return backend.arena();
148 }
149
150 /**
151 * An interface used for wrapping the compute entrypoint of work to be performed by the Accelerator.
152 * <p/>
153 * So given a ComputeClass such as...
154 * <pre>
155 * public class MyComputeClass {
156 * @ Reflect
157 * public static void addDeltaKernel(KernelContext kc, S32Array arrayOfInt, int delta) {
158 * arrayOfInt.array(kc.x, arrayOfInt.array(kc.x)+delta);
159 * }
160 *
161 * @ Reflect
162 * static public void doSomeWork(final ComputeContext cc, S32Array arrayOfInt) {
163 * }
164 * }
165 * </pre>
166 * The accelerator will be passed the doSomeWork entrypoint, wrapped in a {@code Compute}
167 * <pre>
168 * accelerator.compute(cc ->
169 * MyCompute.doSomeWork(cc, arrayOfInt)
170 * );
171 * </pre>
172 */
173 @FunctionalInterface
174 public interface Compute extends Consumer<ComputeContext> {
175 }
176
177 // convenience
178 public Config config() {
179 return backend.config();
180 }
181
182 /**
183 * This method provides the Accelerator with the {@code Compute Entrypoint} from a Compute class.
184 * <p>
185 * The entrypoint is wrapped in a {@link Compute} lambda.
186 *
187 * <pre>
188 * accelerator.compute(cc ->
189 * MyCompute.doSomeWork(cc, intArray)
190 * )
191 * </pre>
192 */
193 public void compute(Compute compute) {
194 Quoted<JavaOp.LambdaOp> quoted = Op.ofLambda(compute).orElseThrow();
195 JavaOp.LambdaOp lambda = quoted.op();
196 Method method = getTargetInvoke(this.lookup, lambda, ComputeContext.class).resolveMethodOrThrow();
197 // Create (or get cached) a compute context which closes over compute entrypoint and reachable kernels.
198 // The models of all compute and kernel methods are passed to the backend during creation
199 // The backend may well mutate the models.
200 // It will also use this opportunity to generate ISA specific code for the kernels.
201 ComputeContext computeContext = cache.computeIfAbsent(method, _ -> new ComputeContext(this, method));
202 // Here we get the captured values from the lambda
203 Object[] args = lambda(lookup, lambda).getQuotedCapturedValues(quoted, method);
204 args[0] = computeContext;
205 // now ask the backend to execute
206 backend.dispatchCompute(computeContext, args);
207 }
208 }