1 /*
 2  * Copyright (c) 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.dialect;
26 
27 import jdk.incubator.code.dialect.core.CoreOp;
28 import jdk.incubator.code.dialect.java.MethodRef;
29 
30 import java.util.List;
31 import java.util.Map;
32 import java.util.stream.Collectors;
33 import java.util.stream.Stream;
34 
35 public record DialectModule(DialectFunction entryPoint, List<DialectFunction> helpers) {
36 
37     public DialectModule {
38         if (entryPoint == null) {
39             throw new IllegalStateException("entryPoint is null");
40         }
41         // Make helpers immutable list, thus, we can't accidentally modify them
42         helpers = List.copyOf(helpers);
43     }
44 
45     /**
46      * Returns a stream of functions in the correct order for code generation. The last function
47      * in the stream is always the entrypoint.
48      *
49      * @return {@link Stream<DialectFunction>}
50      */
51     public Stream<DialectFunction> functions() {
52         return Stream.concat(helpers.stream(), Stream.of(entryPoint));
53     }
54 
55     /**
56      * Convert a function stream into a HashMap which identifies MethodRef -> Function.
57      * This is useful when HAT builds the {@link hat.callgraph.MethodCallDag} before generating the low-level code.
58      *
59      * @return {@code Map<MethodRef, CoreOp.FuncOp>}
60      */
61     public Map<MethodRef, CoreOp.FuncOp> functionsByMethod() {
62         return functions()
63                 .collect(Collectors.toMap(
64                         DialectFunction::methodRef,
65                         DialectFunction::function,
66                         (a, b) -> b));
67     }
68 }