1 /*
2 * Copyright (c) 2024, 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
26 import job.*;
27
28 static void logo(){
29 System.out.println("""
30 ⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⣀⣀⣀⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
31 ⠀⠀⠀⠀⠀⠀⠀⢰⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⣶⣤⣀⠀⠀⠀⠀⠀⠀⠀
32 ⠀⠀⠀⠀⠀⠀⠀ ⠙⠿⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠿⠀⠀⠀⠀⠀⠀⠀
33 ⠀⠀⠀⠀⠀⠀⠀⠀⣷⣶⣤⣄⣈⣉⣉⣉⣉⣉⣉⣉⣁⣤⡄⠀⠀⠀⠀⠀⠀⠀
34 ⠀⠀⠀⠀⠀⠀ ⠀⣿⣿⣿⣿⣿ HAT ⣿⣿⣿⣿⡇⠀⠀⠀⠀⠀⠀⠀
35 ⠀⠀⢀⣠⣶⣾⡏⢀⡈⠛⠻⠿⢿⣿⣿⣿⣿⣿⠿⠿⠟⠛⢁⠀⢶⣤⣀⠀⠀⠀
36 ⠀⢠⣿⣿⣿⣿⡇⠸⣿⣿⣶⣶⣤⣤⣤⣤⣤⣤⣤⣶⣶⣿⡿⠂⣸⣿⣿⣷⡄⠀
37 ⠀⢸⣿⣿⣿⣿⣿⣦⣄⡉⠛⠛⠛⠿⠿⠿⠿⠛⠛⠛⢉⣁⣤⣾⣿⣿⣿⣿⡷⠀
38 ⠀⠀⠙⢿⣿⣿⣿⣿⣿⣿⣿⣷⣶⣶⣶⣶⣶⣶⣾⣿⣿⣿⣿⣿⣿⣿⡿⠛⠁⠀
39 ⠀⠀⠀⠀⠈⠙⠛⠿⠿⢿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠿⠿⠿⠛⠛⠉⠁⠀⠀⠀⠀
40 """);
41 }
42 static void help(){
43 System.out.println("""
44 Usage bld|clean|run ...
45 bld:
46 Compile all buildable (based on capabilities) available jars and native code.
47
48 dot:
49 Create dot graph (bld.dot) of buildable dependencies (based on capabilities)
50 dot bld.dot -Tsvg > bld.svg && chrome bld.svg
51 clean:
52 Removes build directory entirely
53 conf dir and jextracted artifacts (opencl/cuda/opengl) remain
54
55
56 run: [ffi|my|seq]-[opencl|java|cuda|mock|hip] [-DXXX ...] runnable args
57 run ffi-opencl mandel
58 run ffi-opencl nbody HAT
59 run ffi-opencl nbodygl 4096
60 run ffi-opencl -DHAT=SHOW_CODE nbodygl 4096
61 run ffi-opencl -DHAT=SHOW_KERNEL_MODEL heal
62 run ffi-opencl -DHAT=MINIMIZE_BUFFERS life
63
64 exp: [ffi|my|seq]-[opencl|java|cuda|mock|hip] [-DXXX ... ] experimentClassName args
65 exp ffi-opencl QuotedConstantArgs
66
67 test-suite: [ffi|my|seq]-[opencl|java|cuda|mock|hip]
68 test-suite ffi-opencl
69
70 test: [ffi|my|seq]-[opencl|java|cuda|mock|hip] classToTest (also classToTest#method)
71 test ffi-opencl hat.test.TestMatMul
72
73 sanity: Check source files for copyright and WS issues (tabs and trailing EOL WS)
74 """);
75 }
76
77 static void logoAndHelp(){
78 logo();
79 help();
80 }
81
82 public static void main(String[] argArr) throws IOException, InterruptedException {
83 var args = new ArrayList<>(List.of(argArr));
84 if (args.isEmpty()) {
85 help();
86 } else {
87 var hat = new Project(
88 Util.currentDirAsPath(),
89 // These opts will be applied to all javac, cmake and jextract tools
90 Jar.JavacConfig.of(o -> o.progress(true)
91 .debug().enablePreview().source(26).addModules("jdk.incubator.code")
92 ),
93 CMake.Config.of(o -> o.progress(true)),
94 JExtract.Config.of(o -> o.progress(true))
95 );
96
97 var commonJavaOpts = Jar.JavaConfig.of(o -> o
98 .verbose(true)
99 .command(true)
100 .enablePreview()
101 .addModules("jdk.incubator.code")
102 .enableNativeAccess("ALL-UNNAMED"));
103
104 var cmake = hat.isAvailable("cmake", "--version");
105 if (!cmake.isAvailable()) {
106 System.out.println("We need cmake, to check the availability of opencl, cuda etc so we wont be able to build much ");
107 }
108 var jextract = hat.isAvailable("jextract", "--version");
109 if (!jextract.isAvailable()) {
110 System.out.println("We will need jextract to create jextracted backends and for examples requiring opengl ");
111 }
112
113 // This is an example of a user defined optional dependency.
114 // Anything depending on this will only build if (In this case) the property is true
115 // So in our case if the headless system property
116 var ui = new Opt(hat.id("ui"), !Boolean.getBoolean("headless")); //-Dheadless=true|false
117
118 // These dependencies are 'true' on the appropriate platform.
119 // So any target depending on one these, will only build on that platform
120 var mac = new Mac(hat.id("os-mac"));
121 var linux = new Linux(hat.id("os-linux"));
122
123 // These next three 'optional' dependencies use cmake to determine availability. We delegate to cmake which
124 // a) determines if capability is available,
125 // b) if they are, they extract from cmake vars (see conf/cmake-info/OpenCL/properties for example) information export headers and libs needed by JExtract
126 var jextractOpts = JExtract.Config.of(o -> o.command(true));
127 var cmakeOpts = CMake.Config.of(o -> o.command(true));
128 var openclCmakeInfo = new OpenCL(hat.id("cmake-info-opencl"), cmake);
129 var openglCmakeInfo = new OpenGL(hat.id("cmake-info-opengl"), cmake);
130 var cudaCmakeInfo = new Cuda(hat.id("cmake-info-cuda"), cmake);
131
132 // Now we just create jars and shared libs and declare dependencies
133 var optkl = hat.jar("optkl");
134 var core = hat.jar("core", optkl);
135 var tools = hat.jar("tools", core);
136 var tests = hat.jar("tests", core, tools);
137
138 var backend_ffi_native = hat.cmakeAndJar("backend{s}-ffi", core, cmake);
139 var ffiSharedBackend = hat.jar("backend{s}-ffi-shared", backend_ffi_native);
140 var backend_ffi_cuda = hat.jar("backend{s}-ffi-cuda", ffiSharedBackend);
141 var backend_ffi_opencl = hat.jar("backend{s}-ffi-opencl", ffiSharedBackend);
142 var backend_ffi_mock = hat.jar("backend{s}-ffi-mock", ffiSharedBackend);
143
144 // These examples just rely on core
145 var backend_mt_java = hat.jar("backend{s}-java-mt", core);
146 var backend_seq_java = hat.jar("backend{s}-java-seq", core);
147 var example_squares = hat.jar("example{s}-squares", core);
148 var example_matmul = hat.jar("example{s}-matmul", core);
149 var example_flash_attention = hat.jar("example{s}-flashattention", core);
150 var example_blackscholes = hat.jar("example{s}-blackscholes", core);
151 var example_view = hat.jar("example{s}-view", core);
152 var example_normmap = hat.jar("example{s}-normmap", core); // will probabvly need shared when we hatify
153
154 // example_shared allows us to break out common UI functions, views, even loops etc
155 var example_shared = hat.jar("example{s}-shared", ui, core);
156 var example_nbody = hat.jar("example{s}-nbody", ui, core);
157
158 // These examples use example_shared, so they are UI based
159 var example_mandel = hat.jar("example{s}-mandel", example_shared);
160 var example_life = hat.jar("example{s}-life", example_shared);
161 var example_heal = hat.jar("example{s}-heal", example_shared);
162 var example_shade = hat.jar("example{s}-shade", example_shared);
163 var example_violajones = hat.jar("example{s}-violajones", example_shared);
164
165 // experiments include code that expects an opencl backend, this is not idea, but we can accomodate
166 var example_experiments = hat.jar("example{s}-experiments", core);
167
168 // Now we have the more complex nonsense for nbodygl (which needs opengl and opencl extracted)
169 var wrapped_shared = hat.jar("wrap{s}-shared");
170 var jextracted_opencl = hat.jextract("extract{ions|ed}-opencl", jextract, openclCmakeInfo, core);
171 var wrapped_jextracted_opencl = hat.jar("wrap{s}-opencl", jextracted_opencl, wrapped_shared);
172 var backend_jextracted_shared = hat.jar("backend{s}-jextracted-shared", core);
173 var backend_jextracted_opencl = hat.jar("backend{s}-jextracted-opencl", wrapped_jextracted_opencl, backend_jextracted_shared);
174 var jextracted_opengl = hat.jextract("extract{ions|ed}-opengl", jextract, ui, openglCmakeInfo, core);
175
176 // Sigh... We have different src exclusions for wrapped opengl depending on the OS
177 var excludedOpenGLWrapSrc = hat.rootPath().resolve(
178 "wraps/opengl/src/main/java/wrap/opengl/GL" + (mac.isAvailable() ? "Callback" : "Func") + "EventHandler.java");
179
180 var wrapped_jextracted_opengl = hat.jar("wrap{s}-opengl", Set.of(excludedOpenGLWrapSrc), jextracted_opengl, wrapped_shared);
181
182 // Finally we have everything needed for nbodygl
183 var example_nbodygl = hat.jar("example{s}-nbodygl", ui, wrapped_jextracted_opengl, wrapped_jextracted_opencl);
184
185 var testEnginePackage = "hat.test.engine";
186 var testEngineClassName = "HATTestEngine";
187 while (!args.isEmpty()) {
188 var arg = args.removeFirst();
189 switch (arg) {
190 case "help" -> logoAndHelp();
191 case "clean" -> hat.clean(true);
192 case "dot" -> {
193 Files.writeString(Path.of("bld.dot"), hat.all().available().toDot());
194 System.out.println("Consider...\n dot bld.dot -Tsvg > bld.svg");
195 }
196 case "bld" -> {
197 hat.build(hat.all().available());
198 }
199 case "sanity" -> {
200 final var copyrightPattern = Pattern.compile("^.*Copyright.*202[0-9].*(Intel|Oracle).*$");
201 final var copyrightExemptPattern = Pattern.compile("^(robertograham|CMakeFiles|hip)");
202 final var tabOrEolWsPattern = Pattern.compile("^(.*\\t.*|.* )$");
203 final var textSuffix = Pattern.compile("^(.*\\.(java|cpp|h|hpp|md)|pom.xml)$");
204 final var sourceSuffix = Pattern.compile("^(.*\\.(java|cpp|h|hpp)|pom.xml)$");
205
206 Stream.of("hat", "tests", "optkl", "core", "tools", "examples", "backends", "docs", "wraps")
207 .map(hat.rootPath()::resolve)
208 .forEach(dir -> {
209 System.out.println("Checking " + dir);
210 Util.recurse(dir,
211 (d) -> true, // we do this for all subdirs
212 (f) -> textSuffix.matcher(f.getFileName().toString()).matches() && Util.grepLines(tabOrEolWsPattern, f),
213 (c) -> System.out.println("File contains WS issue (TAB or EOLWs) " + c)
214 );
215 Util.recurse(dir,
216 (d) -> !copyrightExemptPattern.matcher(d.getFileName().toString()).matches(), // we skip these subdirs
217 (f) -> sourceSuffix.matcher(f.getFileName().toString()).matches() && !Util.grepLines(copyrightPattern, f),
218 (c) -> System.out.println("File does not contain copyright " + c)
219 );
220 });
221 args.clear();
222 }
223 case "run" -> {
224 if (args.size() > 1) {
225 var backendName = args.removeFirst();
226 if (hat.get(backendName) instanceof Jar backend) {
227 var javaOpts = commonJavaOpts.with(o -> o
228 .collectVmOpts(args).mainClass(args.removeFirst(), "Main")
229 .startOnFirstThreadIf(o.packageName().equals("nbodygl") && mac.isAvailable()).collectArgs(args)
230 );
231 if (hat.get(javaOpts.packageName()) instanceof Jar runnable) {
232 runnable.run(javaOpts, runnable, backend);
233 } else {
234 System.err.println("Found backend " + backendName + " but failed to find runnable/example " + javaOpts.packageName());
235 }
236 } else {
237 System.err.println("Failed to find backend " + backendName);
238 }
239 } else {
240 System.err.println("For run we expect 'run backend runnable' ");
241 }
242 }
243 case "test-suite" -> {
244 if (!args.isEmpty()) {
245 var backendName = args.removeFirst();
246 if (hat.get(backendName) instanceof Jar backend) {
247 System.out.println("""
248 *****************************************************************
249 HAT Test Report
250 *****************************************************************
251 """);
252 var test_reports_txt = Paths.get("test_report.txt");
253 Files.deleteIfExists(test_reports_txt); // because we will append to it in the next loop
254 var commonTestSuiteJavaOpts = commonJavaOpts.with(o -> o
255 .command(false).collectVmOpts(args).mainClass(testEnginePackage, testEngineClassName)
256 // note no app args as add them below
257 );
258
259 tests.forEachMatchingEntry("(hat/test/Test[a-zA-Z0-9]*).class", (_, matcher) ->
260 tests.run(Jar.JavaConfig.of(commonTestSuiteJavaOpts, o -> o.arg(matcher.group(1).replace('/', '.'))), tests, backend)
261 );
262 args.clear();
263 var pattern = Pattern.compile("passed: (\\d+), failed: (\\d+), unsupported: (\\d+), precision-errors: (\\d+)");
264 class Stats {
265 int passed = 0;
266 int failed = 0;
267 int unsupported = 0;
268 int precisionError = 0;
269
270 @Override
271 public String toString() {
272 return String.format("Global passed: %d, failed: %d, unsupported: %d, precision-errors: %d, pass-rate: %.2f%%\\n",
273 passed, failed, unsupported, precisionError, ((float) (passed * 100 / (passed + failed + unsupported + precisionError))));
274 }
275 }
276 var stats = new Stats();
277 Files.readAllLines(test_reports_txt).forEach(line -> {
278 if (!commonTestSuiteJavaOpts.verbose()) { //We already dumped this info to stdout above
279 System.out.println(line);
280 }
281 if (pattern.matcher(line) instanceof Matcher matcher && matcher.find()) {
282 stats.passed += Integer.parseInt(matcher.group(1));
283 stats.failed += Integer.parseInt(matcher.group(2));
284 stats.unsupported += Integer.parseInt(matcher.group(3));
285 stats.precisionError += Integer.parseInt(matcher.group(4));
286 }
287 });
288 System.out.println(stats);
289 if (stats.failed > 0) {
290 System.exit(-1);
291 } else {
292 System.exit(0);
293 }
294 } else {
295 System.err.println("Failed to find backend " + backendName);
296 }
297 } else {
298 System.err.println("For test-suite we require a backend ");
299 }
300 }
301 case "test" -> {
302 if (args.size() >= 2) {
303 var backendName = args.removeFirst();
304 if (hat.get(backendName) instanceof Jar backend) {
305 var javaOpts = commonJavaOpts.with(o -> o
306 .verbose(true).command(true).collectVmOpts(args).mainClass(testEnginePackage, testEngineClassName).collectArgs(args)
307 );
308 tests.run(javaOpts, tests, backend);
309 } else {
310 System.err.println("Failed to find backend " + backendName);
311 }
312 } else {
313 System.err.println("""
314 For test we require a backend and a TestClass.");
315 Examples:
316 $ test ffi-opencl hat.test.TestMatMul
317 $ test ffi-opencl hat.test.TestMatMul#method
318 """);
319 }
320 args.clear(); //!! :)
321 }
322 case "exp" -> {
323 if (args.size() > 1) {
324 var backendName = args.removeFirst();
325 if (hat.get(backendName) instanceof Jar backend) {
326 var javaOpts = Jar.JavaConfig.of(commonJavaOpts, o -> o
327 .collectVmOpts(args).mainClass("experiments", args.removeFirst()).collectArgs(args)
328 );
329 if (hat.get(javaOpts.packageName()) instanceof Jar runnable) {
330 runnable.run(javaOpts, runnable, backend);
331 } else {
332 System.err.println("Failed to find runnable " + javaOpts.mainClassName());
333 }
334 } else {
335 System.err.println("Failed to find " + backendName);
336 }
337 } else {
338 System.err.println("For exp we expect 'exp backend [-DXXX ...] testclass' ");
339 }
340 args.clear(); //!! :)
341 }
342 default -> {
343 System.err.println("'" + arg + "' was unexpected ");
344 help();
345 args.clear();
346 }
347 }
348 }
349 }
350 }