com.oracle.svm.truffle.TruffleFeature Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-runtime-svm Show documentation
Show all versions of truffle-runtime-svm Show documentation
SVM Runtime for Truffle languages.
/*
* Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* 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
* 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.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.oracle.svm.truffle;
import static com.oracle.svm.graal.hosted.runtimecompilation.RuntimeCompilationFeature.AllowInliningPredicate.InlineDecision.INLINE;
import static com.oracle.svm.graal.hosted.runtimecompilation.RuntimeCompilationFeature.AllowInliningPredicate.InlineDecision.INLINING_DISALLOWED;
import static com.oracle.svm.graal.hosted.runtimecompilation.RuntimeCompilationFeature.AllowInliningPredicate.InlineDecision.NO_DECISION;
import java.lang.reflect.Executable;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.IdentityHashMap;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.Vector;
import java.util.WeakHashMap;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.BiPredicate;
import java.util.function.BinaryOperator;
import java.util.function.BooleanSupplier;
import java.util.function.Consumer;
import java.util.function.DoubleBinaryOperator;
import java.util.function.DoubleConsumer;
import java.util.function.DoubleFunction;
import java.util.function.DoublePredicate;
import java.util.function.DoubleSupplier;
import java.util.function.DoubleToIntFunction;
import java.util.function.DoubleToLongFunction;
import java.util.function.DoubleUnaryOperator;
import java.util.function.Function;
import java.util.function.IntBinaryOperator;
import java.util.function.IntConsumer;
import java.util.function.IntFunction;
import java.util.function.IntPredicate;
import java.util.function.IntSupplier;
import java.util.function.IntToDoubleFunction;
import java.util.function.IntToLongFunction;
import java.util.function.IntUnaryOperator;
import java.util.function.LongBinaryOperator;
import java.util.function.LongConsumer;
import java.util.function.LongFunction;
import java.util.function.LongPredicate;
import java.util.function.LongSupplier;
import java.util.function.LongToDoubleFunction;
import java.util.function.LongToIntFunction;
import java.util.function.LongUnaryOperator;
import java.util.function.ObjDoubleConsumer;
import java.util.function.ObjIntConsumer;
import java.util.function.ObjLongConsumer;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.function.ToDoubleBiFunction;
import java.util.function.ToDoubleFunction;
import java.util.function.ToIntBiFunction;
import java.util.function.ToIntFunction;
import java.util.function.ToLongBiFunction;
import java.util.function.ToLongFunction;
import java.util.function.UnaryOperator;
import jdk.graal.compiler.phases.common.InsertGuardFencesPhase;
import org.graalvm.collections.Pair;
import org.graalvm.nativeimage.AnnotationAccess;
import org.graalvm.nativeimage.ImageSingletons;
import org.graalvm.nativeimage.hosted.Feature;
import com.oracle.graal.pointsto.meta.AnalysisField;
import com.oracle.graal.pointsto.meta.AnalysisMethod;
import com.oracle.graal.pointsto.meta.HostedProviders;
import com.oracle.svm.core.Uninterruptible;
import com.oracle.svm.core.annotate.Alias;
import com.oracle.svm.core.annotate.RecomputeFieldValue;
import com.oracle.svm.core.annotate.TargetClass;
import com.oracle.svm.core.deopt.Deoptimizer;
import com.oracle.svm.core.feature.InternalFeature;
import com.oracle.svm.core.graal.meta.RuntimeConfiguration;
import com.oracle.svm.core.graal.meta.SubstrateForeignCallsProvider;
import com.oracle.svm.core.graal.snippets.NodeLoweringProvider;
import com.oracle.svm.core.heap.Heap;
import com.oracle.svm.core.option.HostedOptionKey;
import com.oracle.svm.core.option.HostedOptionValues;
import com.oracle.svm.core.option.SubstrateOptionsParser;
import com.oracle.svm.core.stack.JavaStackWalker;
import com.oracle.svm.core.util.UserError;
import com.oracle.svm.core.util.VMError;
import com.oracle.svm.graal.hosted.runtimecompilation.CallTreeInfo;
import com.oracle.svm.graal.hosted.runtimecompilation.RuntimeCompilationCandidate;
import com.oracle.svm.graal.hosted.runtimecompilation.RuntimeCompilationFeature;
import com.oracle.svm.graal.hosted.runtimecompilation.RuntimeCompiledMethod;
import com.oracle.svm.hosted.FeatureImpl;
import com.oracle.svm.hosted.FeatureImpl.AfterAnalysisAccessImpl;
import com.oracle.svm.hosted.FeatureImpl.BeforeAnalysisAccessImpl;
import com.oracle.svm.hosted.FeatureImpl.DuringAnalysisAccessImpl;
import com.oracle.svm.hosted.FeatureImpl.DuringSetupAccessImpl;
import com.oracle.svm.hosted.meta.HostedType;
import com.oracle.svm.truffle.api.SubstrateThreadLocalHandshake;
import com.oracle.svm.truffle.api.SubstrateThreadLocalHandshakeSnippets;
import com.oracle.svm.truffle.api.SubstrateTruffleCompiler;
import com.oracle.svm.truffle.api.SubstrateTruffleRuntime;
import com.oracle.svm.truffle.api.SubstrateTruffleUniverseFactory;
import com.oracle.svm.util.LogUtils;
import com.oracle.svm.util.StringUtil;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.Truffle;
import com.oracle.truffle.api.TruffleRuntime;
import com.oracle.truffle.api.frame.Frame;
import com.oracle.truffle.api.nodes.BytecodeOSRNode;
import com.oracle.truffle.api.nodes.ExplodeLoop;
import com.oracle.truffle.runtime.TruffleCallBoundary;
import jdk.graal.compiler.core.phases.HighTier;
import jdk.graal.compiler.graph.Node;
import jdk.graal.compiler.nodes.FrameState;
import jdk.graal.compiler.nodes.ValueNode;
import jdk.graal.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration;
import jdk.graal.compiler.nodes.graphbuilderconf.GraphBuilderContext;
import jdk.graal.compiler.nodes.graphbuilderconf.InvocationPlugin.RequiredInvocationPlugin;
import jdk.graal.compiler.nodes.graphbuilderconf.InvocationPlugins;
import jdk.graal.compiler.nodes.spi.Replacements;
import jdk.graal.compiler.options.Option;
import jdk.graal.compiler.options.OptionValues;
import jdk.graal.compiler.phases.common.CanonicalizerPhase;
import jdk.graal.compiler.phases.tiers.Suites;
import jdk.graal.compiler.phases.util.Providers;
import jdk.graal.compiler.truffle.KnownTruffleTypes;
import jdk.graal.compiler.truffle.PartialEvaluator;
import jdk.graal.compiler.truffle.host.HostInliningPhase;
import jdk.graal.compiler.truffle.host.TruffleHostEnvironment;
import jdk.graal.compiler.truffle.nodes.asserts.NeverPartOfCompilationNode;
import jdk.vm.ci.meta.MetaAccessProvider;
import jdk.vm.ci.meta.ResolvedJavaField;
import jdk.vm.ci.meta.ResolvedJavaMethod;
import jdk.vm.ci.meta.ResolvedJavaType;
/**
* Feature that enables compilation of Truffle ASTs to machine code. This feature requires
* {@link SubstrateTruffleRuntime} to be set as {@link TruffleRuntime}.
*/
public class TruffleFeature implements InternalFeature {
@Override
public String getURL() {
return "https://github.com/oracle/graal/blob/master/substratevm/src/com.oracle.svm.truffle/src/com/oracle/svm/truffle/TruffleFeature.java";
}
@Override
public String getDescription() {
return "Provides support for Truffle runtime compilation";
}
public static class Options {
@Option(help = "Print truffle boundaries found during the analysis")//
public static final HostedOptionKey PrintStaticTruffleBoundaries = new HostedOptionKey<>(false);
@Option(help = "Check that CompilerAsserts.neverPartOfCompilation is not reachable for runtime compilation")//
public static final HostedOptionKey TruffleCheckNeverPartOfCompilation = new HostedOptionKey<>(true);
@Option(help = "Enforce that the Truffle runtime provides the only implementation of Frame")//
public static final HostedOptionKey TruffleCheckFrameImplementation = new HostedOptionKey<>(true);
@Option(help = "Fail if a method known as not suitable for partial evaluation is reachable for runtime compilation", deprecated = true)//
public static final HostedOptionKey TruffleCheckBlackListedMethods = new HostedOptionKey<>(true);
@Option(help = "Fail if a method known as not suitable for partial evaluation is reachable for runtime compilation")//
public static final HostedOptionKey TruffleCheckBlockListMethods = new HostedOptionKey<>(true);
@Option(help = "No longer has any effect", deprecated = true)//
static final HostedOptionKey TruffleInlineDuringParsing = new HostedOptionKey<>(true);
}
public static final class IsEnabled implements BooleanSupplier {
@Override
public boolean getAsBoolean() {
return ImageSingletons.contains(TruffleFeature.class);
}
}
private final Set blocklistMethods;
private final Set tempTargetAllowlistMethods;
private final Set warnMethods;
private final Set> neverPartOfCompilationViolations;
Set runtimeCompiledMethods;
public TruffleFeature() {
blocklistMethods = new HashSet<>();
tempTargetAllowlistMethods = new HashSet<>();
warnMethods = new HashSet<>();
neverPartOfCompilationViolations = ConcurrentHashMap.newKeySet();
}
@Override
public void registerForeignCalls(SubstrateForeignCallsProvider foreignCalls) {
foreignCalls.register(SubstrateThreadLocalHandshake.FOREIGN_POLL);
}
@Override
@SuppressWarnings("unused")
public void registerLowerings(RuntimeConfiguration runtimeConfig, OptionValues options, Providers providers,
Map, NodeLoweringProvider> lowerings, boolean hosted) {
new SubstrateThreadLocalHandshakeSnippets(options, providers, lowerings);
}
@Override
public List> getRequiredFeatures() {
return List.of(RuntimeCompilationFeature.class, TruffleBaseFeature.class);
}
/*
* Duplicated from SafepointSamplingProfilingFeature. Make sure it is in sync.
*/
@Override
public boolean isInConfiguration(IsInConfigurationAccess access) {
return isInConfiguration();
}
public static boolean isInConfiguration() {
if (!Boolean.getBoolean("truffle.UseFallbackRuntime")) {
String property = System.getProperty("truffle.TruffleRuntime");
if (property != null) {
return property.equals("com.oracle.svm.truffle.api.SubstrateTruffleRuntime");
}
}
return false;
}
@Override
public void afterRegistration(AfterRegistrationAccess access) {
UserError.guarantee(Truffle.getRuntime() instanceof SubstrateTruffleRuntime, "TruffleFeature requires SubstrateTruffleRuntime");
SubstrateTruffleRuntime truffleRuntime = (SubstrateTruffleRuntime) Truffle.getRuntime();
truffleRuntime.resetHosted();
RuntimeCompilationFeature.singleton().setUniverseFactory(new SubstrateTruffleUniverseFactory(truffleRuntime));
}
@Override
public void cleanup() {
if (Truffle.getRuntime() instanceof SubstrateTruffleRuntime) {
((SubstrateTruffleRuntime) Truffle.getRuntime()).resetNativeImageState();
}
}
@Override
public void duringSetup(DuringSetupAccess a) {
var access = (DuringSetupAccessImpl) a;
access.getHostVM().registerNeverInlineTrivialHandler(this::neverInlineTrivial);
if (!ImageSingletons.contains(TruffleSupport.class)) {
ImageSingletons.add(TruffleSupport.class, new TruffleSupport());
}
ImageSingletons.lookup(TruffleBaseFeature.class).setGraalGraphObjectReplacer(RuntimeCompilationFeature.singleton().getObjectReplacer());
}
private void registerNeverPartOfCompilation(InvocationPlugins plugins) {
InvocationPlugins.Registration r = new InvocationPlugins.Registration(plugins, CompilerAsserts.class);
r.setAllowOverwrite(true);
r.register(new RequiredInvocationPlugin("neverPartOfCompilation") {
@Override
public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver) {
return handleNeverPartOfCompilation(b, targetMethod, null);
}
});
r.register(new RequiredInvocationPlugin("neverPartOfCompilation", String.class) {
@Override
public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode message) {
return handleNeverPartOfCompilation(b, targetMethod, message);
}
});
}
private boolean handleNeverPartOfCompilation(GraphBuilderContext b, ResolvedJavaMethod targetMethod, ValueNode messageNode) {
String message = "CompilerAsserts.neverPartOfCompilation()";
if (messageNode != null && messageNode.isConstant()) {
message = messageNode.asConstant().toValueString();
}
NeverPartOfCompilationNode neverPartOfCompilation = b.add(new NeverPartOfCompilationNode(message));
if (Options.TruffleCheckNeverPartOfCompilation.getValue()) {
if (neverPartOfCompilation.stateAfter().getMethod().getDeclaringClass().equals(targetMethod.getDeclaringClass())) {
/* Ignore internal use from another method in CompilerAsserts class. */
} else {
LinkedList callTree = new LinkedList<>();
FrameState cur = neverPartOfCompilation.stateAfter();
while (cur != null) {
callTree.add(cur.getMethod().format("%H.%n(%p)"));
cur = cur.outerFrameState();
}
neverPartOfCompilationViolations.add(Pair.create(b.getMethod(), String.join(",", callTree)));
}
}
return true;
}
@Override
public void beforeAnalysis(BeforeAnalysisAccess access) {
SubstrateTruffleRuntime truffleRuntime = (SubstrateTruffleRuntime) Truffle.getRuntime();
BeforeAnalysisAccessImpl config = (BeforeAnalysisAccessImpl) access;
TruffleHostEnvironment.overrideLookup(new SubstrateTruffleHostEnvironmentLookup(truffleRuntime, config.getMetaAccess()));
ImageSingletons.lookup(TruffleBaseFeature.class).setProfilingEnabled(truffleRuntime.isProfilingEnabled());
for (Class initType : truffleRuntime.getLookupTypes()) {
config.registerAsUsed(initType, "Truffle runtime init type.");
}
// register thread local foreign poll as compiled otherwise the stub won't work
config.registerAsRoot((AnalysisMethod) SubstrateThreadLocalHandshake.FOREIGN_POLL.findMethod(config.getMetaAccess()), true,
"Truffle thread local foreign poll, registered in " + TruffleFeature.class);
RuntimeCompilationFeature runtimeCompilationFeature = RuntimeCompilationFeature.singleton();
SubstrateTruffleCompiler truffleCompiler = truffleRuntime.preinitializeTruffleCompiler();
truffleRuntime.initializeKnownMethods(config.getMetaAccess());
truffleRuntime.initializeHostedKnownMethods(config.getUniverse().getOriginalMetaAccess());
PartialEvaluator partialEvaluator = truffleCompiler.getPartialEvaluator();
registerKnownTruffleFields(config, partialEvaluator.getTypes());
GraphBuilderConfiguration graphBuilderConfig = partialEvaluator.getGraphBuilderConfigPrototype();
TruffleAllowInliningPredicate allowInliningPredicate = new TruffleAllowInliningPredicate(runtimeCompilationFeature.getHostedProviders().getReplacements(),
graphBuilderConfig.getPlugins().getInvocationPlugins(),
partialEvaluator, this::allowRuntimeCompilation);
runtimeCompilationFeature.registerAllowInliningPredicate(allowInliningPredicate::allowInlining);
registerNeverPartOfCompilation(graphBuilderConfig.getPlugins().getInvocationPlugins());
graphBuilderConfig.getPlugins().getInvocationPlugins().closeRegistration();
Providers peProviders = partialEvaluator.getProviders();
HostedProviders newHostedProviders = new HostedProviders(
peProviders.getMetaAccess(),
peProviders.getCodeCache(),
peProviders.getConstantReflection(),
new HostedTruffleConstantFieldProvider(peProviders.getConstantFieldProvider()),
peProviders.getForeignCalls(),
peProviders.getLowerer(),
peProviders.getReplacements(),
peProviders.getStampProvider(),
runtimeCompilationFeature.getHostedProviders().getSnippetReflection(),
runtimeCompilationFeature.getHostedProviders().getWordTypes(),
runtimeCompilationFeature.getHostedProviders().getPlatformConfigurationProvider(),
runtimeCompilationFeature.getHostedProviders().getMetaAccessExtensionProvider(),
runtimeCompilationFeature.getHostedProviders().getLoopsDataProvider(),
runtimeCompilationFeature.getHostedProviders().getIdentityHashCodeProvider());
newHostedProviders.setGraphBuilderPlugins(graphBuilderConfig.getPlugins());
runtimeCompilationFeature.initializeRuntimeCompilationConfiguration(newHostedProviders, graphBuilderConfig, this::allowRuntimeCompilation, this::deoptimizeOnException, this::checkBlockList);
for (ResolvedJavaMethod method : partialEvaluator.getCompilationRootMethods()) {
runtimeCompilationFeature.prepareMethodForRuntimeCompilation(method, config);
}
runtimeCompilationFeature.initializeAnalysisProviders(config.getBigBang(), HostedTruffleConstantFieldProvider::new);
initializeMethodBlocklist(config.getMetaAccess(), access);
/*
* Stack frames that are visited by Truffle-level stack walking must have full frame
* information available, otherwise SubstrateStackIntrospection cannot visit them.
*/
for (ResolvedJavaMethod method : truffleRuntime.getAnyFrameMethod()) {
/*
* To avoid corner case errors, we also force these methods to be reachable. This only
* affects builds where no Truffle language is included, because any real language makes
* these methods reachable (and therefore compiled).
*/
runtimeCompilationFeature.requireFrameInformationForMethod(method, config, true);
}
/*
* The concrete subclass of OptimizedCallTarget needs to be registered as in heap for the
* forced compilation of frame methods to work. Forcing compilation of a method effectively
* adds it as a root and non-static root methods are only compiled if types implementing
* them or any of their subtypes are allocated.
*/
config.registerAsInHeap(TruffleSupport.singleton().getOptimizedCallTargetClass(), "Concrete subclass of OptimizedCallTarget registered by " + TruffleFeature.class);
/*
* This effectively initializes the Truffle fallback engine which does all the system
* property option parsing to initialize the profilingEnabled flag correctly. A polyglot
* fallback engine can not stay in the the image though, so we clear it right after. We
* don't expect it to be used except for profiling enabled check.
*/
TruffleBaseFeature.invokeStaticMethod("com.oracle.truffle.polyglot.PolyglotEngineImpl", "resetFallbackEngine", Collections.emptyList());
TruffleBaseFeature.preInitializeEngine();
/* Ensure org.graalvm.polyglot.io.IOHelper.IMPL is initialized. */
((BeforeAnalysisAccessImpl) access).ensureInitialized("org.graalvm.polyglot.io.IOHelper");
/* Support for deprecated bytecode osr frame transfer: GR-38296 */
config.registerSubtypeReachabilityHandler((acc, klass) -> {
DuringAnalysisAccessImpl impl = (DuringAnalysisAccessImpl) acc;
/* Pass known reachable classes to the initializer: it will decide there what to do. */
Boolean modified = TruffleBaseFeature.invokeStaticMethod(
"com.oracle.truffle.runtime.BytecodeOSRRootNode",
"initializeClassUsingDeprecatedFrameTransfer",
Collections.singleton(Class.class),
klass);
if (modified != null && modified) {
if (!impl.concurrentReachabilityHandlers()) {
impl.requireAnalysisIteration();
}
}
}, BytecodeOSRNode.class);
}
static class TruffleAllowInliningPredicate {
private final Replacements replacements;
private final InvocationPlugins invocationPlugins;
private final PartialEvaluator partialEvaluator;
private final Predicate allowRuntimeCompilationPredicate;
TruffleAllowInliningPredicate(Replacements replacements, InvocationPlugins invocationPlugins, PartialEvaluator partialEvaluator,
Predicate allowRuntimeCompilationPredicate) {
this.replacements = replacements;
this.invocationPlugins = invocationPlugins;
this.partialEvaluator = partialEvaluator;
this.allowRuntimeCompilationPredicate = allowRuntimeCompilationPredicate;
}
public RuntimeCompilationFeature.AllowInliningPredicate.InlineDecision allowInlining(GraphBuilderContext builder, ResolvedJavaMethod target) {
if (target.hasNeverInlineDirective()) {
return INLINING_DISALLOWED;
} else if (invocationPlugins.lookupInvocation(target, builder.getOptions()) != null) {
return INLINING_DISALLOWED;
} else if (target.getAnnotation(ExplodeLoop.class) != null) {
/*
* We cannot inline a method annotated with @ExplodeLoop, because then loops are no
* longer exploded.
*/
return INLINING_DISALLOWED;
} else if (builder.getMethod().getAnnotation(ExplodeLoop.class) != null) {
/*
* We cannot inline anything into a method annotated with @ExplodeLoop, because then
* loops of the inlined callee are exploded too.
*/
return INLINING_DISALLOWED;
} else if (replacements.hasSubstitution(target, builder.getOptions())) {
return INLINING_DISALLOWED;
}
for (ResolvedJavaMethod m : partialEvaluator.getNeverInlineMethods()) {
if (target.equals(m)) {
return INLINING_DISALLOWED;
}
}
if (target.getCode() != null && allowRuntimeCompilationPredicate.test(target)) {
return INLINE;
}
return NO_DECISION;
}
}
private static void registerKnownTruffleFields(BeforeAnalysisAccessImpl config, KnownTruffleTypes knownTruffleFields) {
for (Class klass = knownTruffleFields.getClass(); klass != Object.class; klass = klass.getSuperclass()) {
for (Field field : klass.getDeclaredFields()) {
if (Modifier.isPublic(field.getModifiers())) {
try {
Object value = field.get(knownTruffleFields);
if (value instanceof ResolvedJavaField) {
config.registerAsAccessed((AnalysisField) value, "known truffle field");
}
} catch (IllegalAccessException ex) {
throw VMError.shouldNotReachHere(ex);
}
}
}
}
}
private boolean allowRuntimeCompilation(ResolvedJavaMethod method) {
if (runtimeCompilationForbidden(method)) {
return false;
} else if (isBlocklisted(method)) {
return false;
}
return true;
}
private static boolean runtimeCompilationForbidden(ResolvedJavaMethod method) {
if (method.getAnnotation(CompilerDirectives.TruffleBoundary.class) != null) {
return true;
} else if (Uninterruptible.Utils.isUninterruptible(method)) {
Uninterruptible uninterruptibleAnnotation = Uninterruptible.Utils.getAnnotation(method);
if (uninterruptibleAnnotation == null || !uninterruptibleAnnotation.mayBeInlined()) {
/* The semantics of Uninterruptible would get lost during partial evaluation. */
return true;
}
}
if (!method.canBeInlined()) {
return true;
} else if (method.getAnnotation(TruffleCallBoundary.class) != null) {
return true;
}
return false;
}
boolean isBlocklisted(ResolvedJavaMethod method) {
if (!((AnalysisMethod) method).allowRuntimeCompilation()) {
return true;
}
return blocklistMethods.contains(method);
}
@SuppressWarnings("deprecation")
private boolean deoptimizeOnException(ResolvedJavaMethod method) {
if (method == null) {
return false;
}
CompilerDirectives.TruffleBoundary truffleBoundary = method.getAnnotation(CompilerDirectives.TruffleBoundary.class);
return truffleBoundary != null && truffleBoundary.transferToInterpreterOnException();
}
private void initializeMethodBlocklist(MetaAccessProvider metaAccess, FeatureAccess featureAccess) {
blocklistMethod(metaAccess, Object.class, "equals", Object.class);
blocklistMethod(metaAccess, Object.class, "hashCode");
blocklistMethod(metaAccess, Object.class, "toString");
blocklistMethod(metaAccess, String.class, "valueOf", Object.class);
blocklistMethod(metaAccess, String.class, "getBytes");
blocklistMethod(metaAccess, String.class, "indexOf", int.class);
blocklistMethod(metaAccess, String.class, "indexOf", int.class, int.class);
blocklistMethod(metaAccess, String.class, "indexOf", String.class);
blocklistMethod(metaAccess, String.class, "indexOf", String.class, int.class);
blocklistMethod(metaAccess, Throwable.class, "fillInStackTrace", int.class);
blocklistMethod(metaAccess, Throwable.class, "initCause", Throwable.class);
blocklistMethod(metaAccess, Throwable.class, "addSuppressed", Throwable.class);
blocklistMethod(metaAccess, System.class, "getProperty", String.class);
blocklistAllMethods(metaAccess, AssertionError.class);
blocklistAllMethods(metaAccess, BigInteger.class);
blocklistAllMethods(metaAccess, BigDecimal.class);
blocklistAllMethods(metaAccess, Comparable.class);
blocklistAllMethods(metaAccess, Comparator.class);
blocklistAllMethods(metaAccess, Collection.class);
blocklistAllMethods(metaAccess, List.class);
blocklistAllMethods(metaAccess, Set.class);
blocklistAllMethods(metaAccess, Map.class);
blocklistAllMethods(metaAccess, Map.Entry.class);
blocklistAllMethods(metaAccess, TreeMap.class);
blocklistAllMethods(metaAccess, HashMap.class);
blocklistAllMethods(metaAccess, ConcurrentHashMap.class);
blocklistAllMethods(metaAccess, WeakHashMap.class);
blocklistAllMethods(metaAccess, IdentityHashMap.class);
blocklistAllMethods(metaAccess, Iterable.class);
blocklistAllMethods(metaAccess, Iterator.class);
blocklistAllMethods(metaAccess, ListIterator.class);
blocklistAllMethods(metaAccess, ReentrantLock.class);
removeFromBlocklist(metaAccess, BigInteger.class, "signum");
removeFromBlocklist(metaAccess, ReentrantLock.class, "isLocked");
removeFromBlocklist(metaAccess, ReentrantLock.class, "isHeldByCurrentThread");
removeFromBlocklist(metaAccess, ReentrantLock.class, "getOwner");
removeFromBlocklist(metaAccess, ReentrantLock.class, "");
/* Methods with synchronization are currently not supported as deoptimization targets. */
blocklistAllMethods(metaAccess, StringBuffer.class);
blocklistAllMethods(metaAccess, Vector.class);
blocklistAllMethods(metaAccess, Hashtable.class);
/* Block list generic functional interfaces. */
blocklistAllMethods(metaAccess, BiConsumer.class);
blocklistAllMethods(metaAccess, BiFunction.class);
blocklistAllMethods(metaAccess, BinaryOperator.class);
blocklistAllMethods(metaAccess, BiPredicate.class);
blocklistAllMethods(metaAccess, BooleanSupplier.class);
blocklistAllMethods(metaAccess, Consumer.class);
blocklistAllMethods(metaAccess, DoubleBinaryOperator.class);
blocklistAllMethods(metaAccess, DoubleConsumer.class);
blocklistAllMethods(metaAccess, DoubleFunction.class);
blocklistAllMethods(metaAccess, DoublePredicate.class);
blocklistAllMethods(metaAccess, DoubleSupplier.class);
blocklistAllMethods(metaAccess, DoubleToIntFunction.class);
blocklistAllMethods(metaAccess, DoubleToLongFunction.class);
blocklistAllMethods(metaAccess, DoubleUnaryOperator.class);
blocklistAllMethods(metaAccess, Function.class);
blocklistAllMethods(metaAccess, IntBinaryOperator.class);
blocklistAllMethods(metaAccess, IntConsumer.class);
blocklistAllMethods(metaAccess, IntFunction.class);
blocklistAllMethods(metaAccess, IntPredicate.class);
blocklistAllMethods(metaAccess, IntSupplier.class);
blocklistAllMethods(metaAccess, IntToDoubleFunction.class);
blocklistAllMethods(metaAccess, IntToLongFunction.class);
blocklistAllMethods(metaAccess, IntUnaryOperator.class);
blocklistAllMethods(metaAccess, LongBinaryOperator.class);
blocklistAllMethods(metaAccess, LongConsumer.class);
blocklistAllMethods(metaAccess, LongFunction.class);
blocklistAllMethods(metaAccess, LongPredicate.class);
blocklistAllMethods(metaAccess, LongSupplier.class);
blocklistAllMethods(metaAccess, LongToDoubleFunction.class);
blocklistAllMethods(metaAccess, LongToIntFunction.class);
blocklistAllMethods(metaAccess, LongUnaryOperator.class);
blocklistAllMethods(metaAccess, ObjDoubleConsumer.class);
blocklistAllMethods(metaAccess, ObjIntConsumer.class);
blocklistAllMethods(metaAccess, ObjLongConsumer.class);
blocklistAllMethods(metaAccess, Predicate.class);
blocklistAllMethods(metaAccess, Supplier.class);
blocklistAllMethods(metaAccess, ToDoubleBiFunction.class);
blocklistAllMethods(metaAccess, ToDoubleFunction.class);
blocklistAllMethods(metaAccess, ToIntBiFunction.class);
blocklistAllMethods(metaAccess, ToIntFunction.class);
blocklistAllMethods(metaAccess, ToLongBiFunction.class);
blocklistAllMethods(metaAccess, ToLongFunction.class);
blocklistAllMethods(metaAccess, UnaryOperator.class);
/* Block list string concatenation. */
blocklistAllMethods(metaAccess, featureAccess.findClassByName("java.lang.StringConcatHelper"));
/*
* Core Substrate VM classes that very certainly should not be reachable for runtime
* compilation. Warn when they get reachable to detect explosion of reachable methods.
*/
warnAllMethods(metaAccess, JavaStackWalker.class);
warnAllMethods(metaAccess, Deoptimizer.class);
warnAllMethods(metaAccess, Heap.getHeap().getClass());
/*
* GR-41564 These methods should become part of the blocklist once the Truffle language
* implementations are refactored.
*/
tempTargetAllowlistMethod(metaAccess, Function.class, "apply", Object.class);
tempTargetAllowlistMethod(metaAccess, Predicate.class, "test", Object.class);
tempTargetAllowlistMethod(metaAccess, LongBinaryOperator.class, "applyAsLong", long.class, long.class);
tempTargetAllowlistMethod(metaAccess, IntBinaryOperator.class, "applyAsInt", int.class, int.class);
tempTargetAllowlistMethod(metaAccess, IntBinaryOperator.class, "applyAsInt", int.class, int.class);
tempTargetAllowlistMethod(metaAccess, List.class, "add", Object.class);
tempTargetAllowlistMethod(metaAccess, List.class, "size");
tempTargetAllowlistMethod(metaAccess, List.class, "isEmpty");
tempTargetAllowlistMethod(metaAccess, List.class, "clear");
tempTargetAllowlistMethod(metaAccess, List.class, "get", int.class);
tempTargetAllowlistMethod(metaAccess, List.class, "remove", int.class);
tempTargetAllowlistMethod(metaAccess, List.class, "toArray");
tempTargetAllowlistMethod(metaAccess, List.class, "toArray", Object[].class);
tempTargetAllowlistMethod(metaAccess, Iterator.class, "next");
tempTargetAllowlistMethod(metaAccess, Iterator.class, "hasNext");
tempTargetAllowlistMethod(metaAccess, Iterable.class, "iterator");
tempTargetAllowlistMethod(metaAccess, Object.class, "equals", Object.class);
tempTargetAllowlistMethod(metaAccess, Object.class, "hashCode");
}
private void blocklistAllMethods(MetaAccessProvider metaAccess, Class clazz) {
for (Executable m : clazz.getDeclaredMethods()) {
blocklistMethods.add(metaAccess.lookupJavaMethod(m));
}
for (Executable m : clazz.getDeclaredConstructors()) {
blocklistMethods.add(metaAccess.lookupJavaMethod(m));
}
}
private void blocklistMethod(MetaAccessProvider metaAccess, Class clazz, String name, Class... parameterTypes) {
try {
blocklistMethods.add(metaAccess.lookupJavaMethod(clazz.getDeclaredMethod(name, parameterTypes)));
} catch (NoSuchMethodException ex) {
throw VMError.shouldNotReachHere(ex);
}
}
private void tempTargetAllowlistMethod(MetaAccessProvider metaAccess, Class clazz, String name, Class... parameterTypes) {
try {
tempTargetAllowlistMethods.add(metaAccess.lookupJavaMethod(clazz.getDeclaredMethod(name, parameterTypes)));
} catch (NoSuchMethodException ex) {
throw VMError.shouldNotReachHere(ex);
}
}
/**
* Removes a previously blocklisted method from the blocklist.
*/
private void removeFromBlocklist(MetaAccessProvider metaAccess, Class clazz, String name, Class... parameterTypes) {
try {
Executable method;
if ("".equals(name)) {
method = clazz.getDeclaredConstructor(parameterTypes);
} else {
method = clazz.getDeclaredMethod(name, parameterTypes);
}
if (!blocklistMethods.remove(metaAccess.lookupJavaMethod(method))) {
throw VMError.shouldNotReachHereUnexpectedInput(method); // ExcludeFromJacocoGeneratedReport
}
} catch (NoSuchMethodException ex) {
throw VMError.shouldNotReachHere(ex);
}
}
private void warnAllMethods(MetaAccessProvider metaAccess, Class clazz) {
for (Executable m : clazz.getDeclaredMethods()) {
/*
* Filter out methods that are, e.g., only present on a certain platform. We do not need
* all methods in the warning list, just enough to trigger the warnings. Accessors are
* generally allowed too.
*/
if (AnnotationAccess.getAnnotationTypes(m).length == 0 && !m.getName().startsWith("get") && !m.getName().startsWith("set")) {
warnMethods.add(metaAccess.lookupJavaMethod(m));
}
}
for (Executable m : clazz.getDeclaredConstructors()) {
if (AnnotationAccess.getAnnotationTypes(m).length == 0) {
warnMethods.add(metaAccess.lookupJavaMethod(m));
}
}
}
private record BlocklistViolationInfo(RuntimeCompilationCandidate candidate, String[] callTrace) {
}
private void checkBlockList(CallTreeInfo treeInfo) {
RuntimeCompilationFeature runtimeCompilation = RuntimeCompilationFeature.singleton();
boolean failBlockListViolations;
if (Options.TruffleCheckBlackListedMethods.hasBeenSet()) {
failBlockListViolations = Options.TruffleCheckBlackListedMethods.getValue();
} else {
failBlockListViolations = Options.TruffleCheckBlockListMethods.getValue();
}
boolean printBlockListViolations = RuntimeCompilationFeature.Options.PrintRuntimeCompileMethods.getValue() || failBlockListViolations;
if (printBlockListViolations) {
Set blocklistViolations = new TreeSet<>((o1, o2) -> Arrays.compare(o1.callTrace(), o2.callTrace()));
for (RuntimeCompilationCandidate candidate : runtimeCompilation.getAllRuntimeCompilationCandidates()) {
// Determine blocklist violations
if (!runtimeCompilationForbidden(candidate.getImplementationMethod())) {
if (isBlocklisted(candidate.getImplementationMethod())) {
boolean tempAllow = !candidate.getTargetMethod().equals(candidate.getImplementationMethod()) &&
tempTargetAllowlistMethods.contains(candidate.getTargetMethod()) &&
!isBlocklisted(candidate.getImplementationMethod());
if (!tempAllow) {
BlocklistViolationInfo violation = new BlocklistViolationInfo(candidate, runtimeCompilation.getCallTrace(treeInfo, candidate));
blocklistViolations.add(violation);
}
}
}
}
if (!blocklistViolations.isEmpty()) {
System.out.println();
System.out.println("=== Found " + blocklistViolations.size() + " compilation blocklist violations ===");
System.out.println();
for (BlocklistViolationInfo violation : blocklistViolations) {
System.out.println("Blocklisted method");
System.out.format(" %s (target: %s)%n", violation.candidate.getImplementationMethod().format("%H.%n(%p)"), violation.candidate.getTargetMethod().format("%H.%n(%p)"));
System.out.println("trace:");
for (String item : violation.callTrace()) {
System.out.println(" " + item);
}
}
if (failBlockListViolations) {
throw VMError.shouldNotReachHere("Blocklisted methods are reachable for runtime compilation");
}
}
}
Set warnViolations = new HashSet<>();
for (RuntimeCompilationCandidate node : runtimeCompilation.getAllRuntimeCompilationCandidates()) {
var method = node.getImplementationMethod();
if (warnMethods.contains(method)) {
warnViolations.add(node);
}
}
if (warnViolations.size() > 0) {
/*
* It is enough to print one warning message with one stack trace. Take the shortest
* stack trace.
*/
LogUtils.warning("Suspicious methods reachable for runtime compilation.");
System.out.println("Check the complete tree of reachable methods using the option " + RuntimeCompilationFeature.Options.PrintRuntimeCompileMethods.getDescriptor().getFieldName());
for (RuntimeCompilationCandidate violation : warnViolations) {
System.out.println("Suspicious method: " + violation.getImplementationMethod().format("%H.%n(%p)"));
System.out.println("trace:");
for (String item : runtimeCompilation.getCallTrace(treeInfo, violation)) {
System.out.println(" " + item);
}
}
}
if (neverPartOfCompilationViolations.size() > 0) {
System.out.println("Error: CompilerAsserts.neverPartOfCompilation reachable for runtime compilation from " + neverPartOfCompilationViolations.size() + " places:");
for (Pair violation : neverPartOfCompilationViolations) {
System.out.println("called from: " + violation.getRight());
System.out.println("runtime trace: ");
for (String item : runtimeCompilation.getCallTrace(treeInfo, (AnalysisMethod) violation.getLeft())) {
System.out.println(" " + item);
}
}
throw VMError.shouldNotReachHere("CompilerAsserts.neverPartOfCompilation reachable for runtime compilation");
}
}
@Override
public void beforeCompilation(BeforeCompilationAccess config) {
if (Options.TruffleCheckFrameImplementation.getValue()) {
/*
* Check that only one Frame implementation is seen as instantiated by the static
* analysis. That allows de-virtualization of all calls to Frame methods in the
* interpreter.
*
* The DefaultTruffleRuntime uses multiple Frame implementations (DefaultVirtualFrame,
* DefaultMaterializedFrame, ReadOnlyFrame) to detect wrong usages of the Frame API, so
* we can only check when running with compilation enabled.
*/
Optional optionalFrameType = ((FeatureImpl.BeforeCompilationAccessImpl) config).getMetaAccess().optionalLookupJavaType(Frame.class);
if (optionalFrameType.isPresent()) {
HostedType frameType = (HostedType) optionalFrameType.get();
Set implementations = new HashSet<>();
collectImplementations(frameType, implementations);
if (implementations.size() > 1) {
throw UserError.abort("More than one implementation of %s found. For performance reasons, Truffle languages must not provide new implementations, " +
"and instead only use the single implementation provided by the Truffle runtime. To disable this check, add %s to the native-image command line. Classes found are %s.",
Frame.class.getTypeName(), SubstrateOptionsParser.commandArgument(Options.TruffleCheckFrameImplementation, "-"),
StringUtil.joinSingleQuoted(implementations.stream().map(m -> m.toJavaName(true)).toArray(String[]::new)));
} else {
assert implementations.size() == 0 || implementations.iterator().next().equals(frameType.getSingleImplementor());
}
}
}
}
/**
* Keep this method in sync with
* {@link SubstrateHostInliningPhase#isTruffleBoundary(TruffleHostEnvironment, ResolvedJavaMethod)}.
*/
private boolean neverInlineTrivial(AnalysisMethod caller, AnalysisMethod callee) {
TruffleHostEnvironment env = TruffleHostEnvironment.get(callee);
if (env == null) {
return false;
}
if (HostInliningPhase.shouldDenyTrivialInliningInAllMethods(env, callee)) {
/*
* Some methods should never be trivial inlined.
*/
return true;
} else if ((runtimeCompiledMethods == null || runtimeCompiledMethods.contains(caller)) && HostInliningPhase.shouldDenyTrivialInlining(env, callee)) {
/*
* Deny trivial inlining in methods which can be included as part of a runtime
* compilation.
*/
return true;
}
return false;
}
private static void collectImplementations(HostedType type, Set implementations) {
for (HostedType subType : type.getSubTypes()) {
if (!subType.isAbstract()) {
implementations.add(subType);
}
collectImplementations(subType, implementations);
}
}
@Override
public void afterAnalysis(AfterAnalysisAccess access) {
CallTreeInfo treeInfo = RuntimeCompilationFeature.singleton().getCallTreeInfo();
checkBlockList(treeInfo);
if (Options.PrintStaticTruffleBoundaries.getValue()) {
printStaticTruffleBoundaries(treeInfo);
}
SubstrateTruffleRuntime truffleRuntime = (SubstrateTruffleRuntime) Truffle.getRuntime();
AfterAnalysisAccessImpl config = (AfterAnalysisAccessImpl) access;
truffleRuntime.initializeHostedKnownMethods(config.getMetaAccess());
runtimeCompiledMethods = new LinkedHashSet<>();
runtimeCompiledMethods.addAll(Arrays.asList(config.getMetaAccess().lookupJavaType(CompilerDirectives.class).getDeclaredMethods(false)));
runtimeCompiledMethods.addAll(Arrays.asList(config.getMetaAccess().lookupJavaType(CompilerAsserts.class).getDeclaredMethods(false)));
for (RuntimeCompiledMethod runtimeCompiledMethod : treeInfo.runtimeCompilations()) {
runtimeCompiledMethods.add(runtimeCompiledMethod.getOriginalMethod());
/*
* The list of runtime compiled methods is not containing all methods that are always
* inlined for runtime compilation. See for example {@link
* TruffleParsingInlineInvokePlugin}, which always inlines certain methods to improve
* footprint. Luckily the Graal graph keeps track of all methods ever inlined in a
* graph. So we just need to remember them. The set of runtime compiled methods is later
* used for driving the entry points of the HostInliningPhase.
*/
for (ResolvedJavaMethod method : runtimeCompiledMethod.getInlinedMethods()) {
if (!(method instanceof AnalysisMethod)) {
throw VMError.shouldNotReachHere("method should be an analysis method");
}
if (method.getAnnotation(TruffleBoundary.class) != null) {
throw VMError.shouldNotReachHere("method used during runtime compilation must never be annotated with a truffle boundary");
}
runtimeCompiledMethods.add((AnalysisMethod) method);
}
}
}
private static void printStaticTruffleBoundaries(CallTreeInfo treeInfo) {
HashSet foundBoundaries = new HashSet<>();
int callSiteCount = 0;
int calleeCount = 0;
for (RuntimeCompiledMethod runtimeCompiledMethod : treeInfo.runtimeCompilations()) {
for (ResolvedJavaMethod targetMethod : runtimeCompiledMethod.getInvokeTargets()) {
TruffleBoundary truffleBoundary = targetMethod.getAnnotation(TruffleBoundary.class);
if (truffleBoundary != null) {
++callSiteCount;
if (foundBoundaries.contains(targetMethod)) {
// nothing to do
} else {
foundBoundaries.add(targetMethod);
System.out.println("Truffle boundary found: " + targetMethod);
calleeCount++;
}
}
}
}
System.out.printf("Number of Truffle call boundaries: %d, number of unique called methods outside the boundary: %d%n", callSiteCount, calleeCount);
}
@Override
public void registerGraalPhases(Providers providers, Suites suites, boolean hosted) {
/*
* Please keep this code in sync with the HotSpot configuration in
* TruffleCommunityCompilerConfiguration.
*/
if (hosted && HostInliningPhase.Options.TruffleHostInlining.getValue(HostedOptionValues.singleton()) && suites.getHighTier() instanceof HighTier) {
suites.getHighTier().prependPhase(new SubstrateHostInliningPhase(CanonicalizerPhase.create()));
}
/*
* On HotSpot, the InsertGuardFencesPhase is inserted into the mid-tier depending on the
* runtime option SpectrePHTBarriers. However, TruffleFeature registers phases during
* image-build time. Therefore, for Truffle compilations, we need to register the phase
* eagerly because the SpectrePHTBarriers options is set only at image-execution time.
*/
if (!hosted && suites.getMidTier().findPhase(InsertGuardFencesPhase.class, true) == null) {
suites.getMidTier().appendPhase(new InsertGuardFencesPhase());
}
}
}
@TargetClass(className = "com.oracle.truffle.runtime.OptimizedCallTarget", onlyWith = TruffleFeature.IsEnabled.class)
final class Target_com_oracle_truffle_runtime_OptimizedCallTarget {
/*
* Retry compilation when they failed during image generation.
*/
@Alias @RecomputeFieldValue(kind = RecomputeFieldValue.Kind.Reset) //
boolean compilationFailed;
/*
* The initialized time stamp is not useful when collected during image generation.
*/
@Alias @RecomputeFieldValue(kind = RecomputeFieldValue.Kind.Reset) //
long initializedTimestamp;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy