|
| 1 | +// Licensed to the Apache Software Foundation (ASF) under one |
| 2 | +// or more contributor license agreements. See the NOTICE file |
| 3 | +// distributed with this work for additional information |
| 4 | +// regarding copyright ownership. The ASF licenses this file |
| 5 | +// to you under the Apache License, Version 2.0 (the |
| 6 | +// "License"); you may not use this file except in compliance |
| 7 | +// with the License. You may obtain a copy of the License at |
| 8 | +// |
| 9 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +// |
| 11 | +// Unless required by applicable law or agreed to in writing, |
| 12 | +// software distributed under the License is distributed on an |
| 13 | +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 | +// KIND, either express or implied. See the License for the |
| 15 | +// specific language governing permissions and limitations |
| 16 | +// under the License. |
| 17 | + |
| 18 | +package org.apache.teaclave.javasdk.tool.optimize; |
| 19 | + |
| 20 | +import jdk.vm.ci.hotspot.HotSpotJVMCIRuntime; |
| 21 | +import jdk.vm.ci.meta.MetaAccessProvider; |
| 22 | +import jdk.vm.ci.meta.ResolvedJavaMethod; |
| 23 | +import jdk.vm.ci.meta.ResolvedJavaType; |
| 24 | +import org.apache.teaclave.javasdk.common.annotations.EnclaveService; |
| 25 | +import org.graalvm.collections.EconomicMap; |
| 26 | +import org.graalvm.compiler.core.common.CompilationIdentifier; |
| 27 | +import org.graalvm.compiler.debug.DebugContext; |
| 28 | +import org.graalvm.compiler.graph.NodeSourcePosition; |
| 29 | +import org.graalvm.compiler.hotspot.HotSpotGraalCompiler; |
| 30 | +import org.graalvm.compiler.java.GraphBuilderPhase; |
| 31 | +import org.graalvm.compiler.nodes.InvokeWithExceptionNode; |
| 32 | +import org.graalvm.compiler.nodes.StructuredGraph; |
| 33 | +import org.graalvm.compiler.nodes.cfg.Block; |
| 34 | +import org.graalvm.compiler.nodes.cfg.ControlFlowGraph; |
| 35 | +import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration; |
| 36 | +import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins; |
| 37 | +import org.graalvm.compiler.options.OptionKey; |
| 38 | +import org.graalvm.compiler.options.OptionValues; |
| 39 | +import org.graalvm.compiler.phases.OptimisticOptimizations; |
| 40 | + |
| 41 | +import java.lang.reflect.Method; |
| 42 | +import java.util.ArrayDeque; |
| 43 | +import java.util.ArrayList; |
| 44 | +import java.util.Deque; |
| 45 | +import java.util.List; |
| 46 | + |
| 47 | +import static org.graalvm.compiler.debug.DebugOptions.Dump; |
| 48 | + |
| 49 | +public class ECallInLoopDetector { |
| 50 | + |
| 51 | + private static HotSpotGraalCompiler compiler; |
| 52 | + private static MetaAccessProvider accessProvider; |
| 53 | + private static final boolean DEBUG; |
| 54 | + private static OptionValues options; |
| 55 | + |
| 56 | + static { |
| 57 | + DEBUG = Boolean.parseBoolean(System.getProperty("optimization.debug", "false")); |
| 58 | + HotSpotJVMCIRuntime jvmciRuntime = HotSpotJVMCIRuntime.runtime(); |
| 59 | + compiler = (HotSpotGraalCompiler) jvmciRuntime.getCompiler(); |
| 60 | + accessProvider = jvmciRuntime.getHostJVMCIBackend().getMetaAccess(); |
| 61 | + options = compiler.getGraalRuntime().getOptions(); |
| 62 | + if (DEBUG) { |
| 63 | + Dump.update((EconomicMap<OptionKey<?>, Object>) options.getMap(), ":3"); |
| 64 | + } |
| 65 | + } |
| 66 | + |
| 67 | + /** |
| 68 | + * Check if there is Ecall inside loop in the given method. See the test case {@code ECallInLoopDetectorTest} for |
| 69 | + * example illustration. |
| 70 | + * |
| 71 | + * @param m method to check |
| 72 | + * @return a list of inside-loop-Ecall positions in the method, empty if none. |
| 73 | + */ |
| 74 | + public static List<NodeSourcePosition> check(Method m) { |
| 75 | + StructuredGraph graph = getGraph(m); |
| 76 | + List<NodeSourcePosition> ret = new ArrayList<>(); |
| 77 | + ControlFlowGraph cfg = ControlFlowGraph.computeForSchedule(graph); |
| 78 | + graph.getNodes(InvokeWithExceptionNode.TYPE).forEach(n -> { |
| 79 | + Block block = cfg.blockFor(n); |
| 80 | + if (block != null && block.getLoop() != null) { |
| 81 | + ResolvedJavaMethod method = n.getTargetMethod(); |
| 82 | + if (isEnclaveService(method.getDeclaringClass())) { |
| 83 | + ret.add(n.getNodeSourcePosition()); |
| 84 | + } |
| 85 | + } |
| 86 | + }); |
| 87 | + if (!ret.isEmpty()) { |
| 88 | + int len = ret.size(); |
| 89 | + System.out.println("Detected " + len + " enclave service calls inside loop."); |
| 90 | + for (int i = 0; i < len; i++) { |
| 91 | + System.out.println((i + 1) + ". " + ret.get(i)); |
| 92 | + } |
| 93 | + } |
| 94 | + return ret; |
| 95 | + } |
| 96 | + |
| 97 | + private static StructuredGraph getGraph(Method method) { |
| 98 | + ResolvedJavaMethod javaMethod = accessProvider.lookupJavaMethod(method); |
| 99 | + DebugContext debug = new DebugContext.Builder(options, compiler.getDebugHandlersFactories()).build(); |
| 100 | + |
| 101 | + StructuredGraph graph = compiler.createGraph(javaMethod, -1, null, |
| 102 | + CompilationIdentifier.INVALID_COMPILATION_ID, options, debug); |
| 103 | + try (DebugContext.Scope s = debug.scope("detectECallInLoop", graph)) { |
| 104 | + InvocationPlugins plugins = new InvocationPlugins(); |
| 105 | + GraphBuilderConfiguration graphBuilderConfig = GraphBuilderConfiguration.getDefault(new GraphBuilderConfiguration.Plugins(plugins)) |
| 106 | + .withNodeSourcePosition(true) |
| 107 | + .withEagerResolving(true) |
| 108 | + .withRetainLocalVariables(true); |
| 109 | + |
| 110 | + GraphBuilderPhase.Instance graphBuilder = new GraphBuilderPhase.Instance(compiler.getGraalRuntime().getHostProviders(), graphBuilderConfig, OptimisticOptimizations.NONE, null); |
| 111 | + graphBuilder.apply(graph); |
| 112 | + if (DEBUG) { |
| 113 | + debug.dump(3, graph, ""); |
| 114 | + } |
| 115 | + } catch (Throwable throwable) { |
| 116 | + throwable.printStackTrace(); |
| 117 | + } |
| 118 | + return graph; |
| 119 | + } |
| 120 | + |
| 121 | + /** |
| 122 | + * Scan the entire class hierarchy tree to find if it implements any interface |
| 123 | + * annotated with @EnclaveService |
| 124 | + */ |
| 125 | + private static boolean isEnclaveService(ResolvedJavaType type) { |
| 126 | + Deque<ResolvedJavaType> workList = new ArrayDeque<>(); |
| 127 | + workList.push(type); |
| 128 | + while (!workList.isEmpty()) { |
| 129 | + ResolvedJavaType top = workList.pop(); |
| 130 | + if (top.getAnnotation(EnclaveService.class) != null) { |
| 131 | + return true; |
| 132 | + } else { |
| 133 | + for (ResolvedJavaType anInterface : top.getInterfaces()) { |
| 134 | + workList.push(anInterface); |
| 135 | + } |
| 136 | + } |
| 137 | + } |
| 138 | + return false; |
| 139 | + } |
| 140 | +} |
0 commit comments