Search in sources :

Example 1 with Option

use of org.graalvm.compiler.options.Option in project graal by oracle.

the class OptionProcessor method processElement.

private void processElement(Element element, OptionsInfo info) {
    if (!element.getModifiers().contains(Modifier.STATIC)) {
        processingEnv.getMessager().printMessage(Kind.ERROR, "Option field must be static", element);
        return;
    }
    if (element.getModifiers().contains(Modifier.PRIVATE)) {
        processingEnv.getMessager().printMessage(Kind.ERROR, "Option field cannot be private", element);
        return;
    }
    Option annotation = element.getAnnotation(Option.class);
    assert annotation != null;
    assert element instanceof VariableElement;
    assert element.getKind() == ElementKind.FIELD;
    VariableElement field = (VariableElement) element;
    String fieldName = field.getSimpleName().toString();
    Elements elements = processingEnv.getElementUtils();
    Types types = processingEnv.getTypeUtils();
    TypeMirror fieldType = field.asType();
    if (fieldType.getKind() != TypeKind.DECLARED) {
        processingEnv.getMessager().printMessage(Kind.ERROR, "Option field must be of type " + OptionKey.class.getName(), element);
        return;
    }
    DeclaredType declaredFieldType = (DeclaredType) fieldType;
    TypeMirror optionKeyType = elements.getTypeElement(OptionKey.class.getName()).asType();
    if (!types.isSubtype(fieldType, types.erasure(optionKeyType))) {
        String msg = String.format("Option field type %s is not a subclass of %s", fieldType, optionKeyType);
        processingEnv.getMessager().printMessage(Kind.ERROR, msg, element);
        return;
    }
    if (!field.getModifiers().contains(Modifier.STATIC)) {
        processingEnv.getMessager().printMessage(Kind.ERROR, "Option field must be static", element);
        return;
    }
    if (field.getModifiers().contains(Modifier.PRIVATE)) {
        processingEnv.getMessager().printMessage(Kind.ERROR, "Option field cannot be private", element);
        return;
    }
    String optionName = annotation.name();
    if (optionName.equals("")) {
        optionName = fieldName;
    }
    if (!Character.isUpperCase(optionName.charAt(0))) {
        processingEnv.getMessager().printMessage(Kind.ERROR, "Option name must start with an upper case letter", element);
        return;
    }
    DeclaredType declaredOptionKeyType = declaredFieldType;
    while (!types.isSameType(types.erasure(declaredOptionKeyType), types.erasure(optionKeyType))) {
        List<? extends TypeMirror> directSupertypes = types.directSupertypes(declaredFieldType);
        assert !directSupertypes.isEmpty();
        declaredOptionKeyType = (DeclaredType) directSupertypes.get(0);
    }
    assert !declaredOptionKeyType.getTypeArguments().isEmpty();
    String optionType = declaredOptionKeyType.getTypeArguments().get(0).toString();
    if (optionType.startsWith("java.lang.")) {
        optionType = optionType.substring("java.lang.".length());
    }
    Element enclosing = element.getEnclosingElement();
    String declaringClass = "";
    String separator = "";
    Set<Element> originatingElementsList = info.originatingElements;
    originatingElementsList.add(field);
    PackageElement enclosingPackage = null;
    while (enclosing != null) {
        if (enclosing.getKind() == ElementKind.CLASS || enclosing.getKind() == ElementKind.INTERFACE) {
            if (enclosing.getModifiers().contains(Modifier.PRIVATE)) {
                String msg = String.format("Option field cannot be declared in a private %s %s", enclosing.getKind().name().toLowerCase(), enclosing);
                processingEnv.getMessager().printMessage(Kind.ERROR, msg, element);
                return;
            }
            originatingElementsList.add(enclosing);
            declaringClass = enclosing.getSimpleName() + separator + declaringClass;
            separator = ".";
        } else if (enclosing.getKind() == ElementKind.PACKAGE) {
            enclosingPackage = (PackageElement) enclosing;
        }
        enclosing = enclosing.getEnclosingElement();
    }
    if (enclosingPackage == null) {
        processingEnv.getMessager().printMessage(Kind.ERROR, "Option field cannot be declared in the unnamed package", element);
        return;
    }
    String[] helpValue = annotation.help();
    String help = "";
    String[] extraHelp = {};
    if (helpValue.length == 1) {
        help = helpValue[0];
        if (help.startsWith("file:")) {
            String path = help.substring("file:".length());
            Filer filer = processingEnv.getFiler();
            try {
                FileObject file;
                try {
                    file = filer.getResource(StandardLocation.SOURCE_PATH, enclosingPackage.getQualifiedName(), path);
                } catch (IllegalArgumentException | IOException e) {
                    // Handle the case when a compiler doesn't support the SOURCE_PATH location
                    file = filer.getResource(StandardLocation.CLASS_OUTPUT, enclosingPackage.getQualifiedName(), path);
                }
                try (BufferedReader br = new BufferedReader(new InputStreamReader(file.openInputStream()))) {
                    help = br.readLine();
                    if (help == null) {
                        help = "";
                    }
                    String line = br.readLine();
                    List<String> lines = new ArrayList<>();
                    while (line != null) {
                        lines.add(line);
                        line = br.readLine();
                    }
                    extraHelp = lines.toArray(new String[lines.size()]);
                }
            } catch (IOException e) {
                String msg = String.format("Error reading %s containing the help text for option field: %s", path, e);
                processingEnv.getMessager().printMessage(Kind.ERROR, msg, element);
                return;
            }
        }
    } else if (helpValue.length > 1) {
        help = helpValue[0];
        extraHelp = Arrays.copyOfRange(helpValue, 1, helpValue.length);
    }
    if (help.length() != 0) {
        char firstChar = help.charAt(0);
        if (!Character.isUpperCase(firstChar)) {
            processingEnv.getMessager().printMessage(Kind.ERROR, "Option help text must start with an upper case letter", element);
            return;
        }
    }
    info.options.add(new OptionInfo(optionName, annotation.type(), help, extraHelp, optionType, declaringClass, field));
}
Also used : SupportedAnnotationTypes(javax.annotation.processing.SupportedAnnotationTypes) Types(javax.lang.model.util.Types) InputStreamReader(java.io.InputStreamReader) PackageElement(javax.lang.model.element.PackageElement) VariableElement(javax.lang.model.element.VariableElement) TypeElement(javax.lang.model.element.TypeElement) Element(javax.lang.model.element.Element) ArrayList(java.util.ArrayList) VariableElement(javax.lang.model.element.VariableElement) IOException(java.io.IOException) Elements(javax.lang.model.util.Elements) TypeMirror(javax.lang.model.type.TypeMirror) BufferedReader(java.io.BufferedReader) Option(org.graalvm.compiler.options.Option) PackageElement(javax.lang.model.element.PackageElement) FileObject(javax.tools.FileObject) JavaFileObject(javax.tools.JavaFileObject) Filer(javax.annotation.processing.Filer) DeclaredType(javax.lang.model.type.DeclaredType)

Example 2 with Option

use of org.graalvm.compiler.options.Option in project graal by oracle.

the class Target_com_oracle_truffle_api_interop_java_ObjectProxyHandler method beforeCompilation.

@Override
public void beforeCompilation(BeforeCompilationAccess config) {
    BeforeCompilationAccessImpl access = (BeforeCompilationAccessImpl) config;
    if (GraalFeature.Options.PrintRuntimeCompileMethods.getValue() && blacklistViolations.size() > 0) {
        System.out.println();
        System.out.println("=== Found " + blacklistViolations.size() + " compilation blacklist violations ===");
        System.out.println();
        for (GraalFeature.CallTreeNode node : blacklistViolations) {
            System.out.println("Blacklisted method");
            System.out.println(node.getImplementationMethod().format("  %H.%n(%p)"));
            System.out.println("called from");
            for (GraalFeature.CallTreeNode cur = node; cur != null; cur = cur.getParent()) {
                System.out.println("  " + cur.getSourceReference());
            }
        }
    }
    if (warnViolations.size() > 0) {
        /*
             * It is enough to print one warning message with one stack trace. Take the shortest
             * stack trace.
             */
        GraalFeature.CallTreeNode printNode = null;
        int printLength = Integer.MAX_VALUE;
        for (GraalFeature.CallTreeNode warnNode : warnViolations) {
            int warnLength = 0;
            for (GraalFeature.CallTreeNode cur = warnNode; cur != null; cur = cur.getParent()) {
                warnLength++;
            }
            if (warnLength < printLength) {
                printNode = warnNode;
                printLength = warnLength;
            }
        }
        System.out.println("WARNING: suspicious method reachable for runtime compilation: " + printNode.getImplementationMethod().format("%H.%n(%p)"));
        System.out.println("Check the complete tree of reachable methods using the option " + GraalFeature.Options.PrintRuntimeCompileMethods.getDescriptor().getFieldName());
        System.out.println("Suspicious method is called from");
        for (GraalFeature.CallTreeNode cur = printNode; cur != null; cur = cur.getParent()) {
            System.out.println("  " + cur.getSourceReference());
        }
    }
    if (neverPartOfCompilationViolations.size() > 0) {
        System.out.println("ERROR: CompilerAsserts.neverPartOfCompilation reachable for runtime compilation from " + neverPartOfCompilationViolations.size() + " places:");
        for (GraalFeature.CallTreeNode neverPartOfCompilationNode : neverPartOfCompilationViolations) {
            System.out.println("called from");
            for (GraalFeature.CallTreeNode cur = neverPartOfCompilationNode; cur != null; cur = cur.getParent()) {
                System.out.println("  " + cur.getSourceReference());
            }
        }
        throw VMError.shouldNotReachHere("CompilerAsserts.neverPartOfCompilation reachable for runtime compilation");
    }
    if (Options.TruffleCheckFrameImplementation.getValue() && useTruffleCompiler()) {
        /*
             * 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<? extends ResolvedJavaType> optionalFrameType = access.getMetaAccess().optionalLookupJavaType(Frame.class);
        if (optionalFrameType.isPresent()) {
            HostedType frameType = (HostedType) optionalFrameType.get();
            Set<HostedType> implementations = new HashSet<>();
            collectImplementations(frameType, implementations);
            if (implementations.size() > 1) {
                throw UserError.abort("More than one implementation of " + Frame.class.getTypeName() + " 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 " + SubstrateOptionsParser.commandArgument(Options.TruffleCheckFrameImplementation, "-") + " to the native-image command line. " + "Found classes: " + implementations.stream().map(m -> m.toJavaName(true)).collect(Collectors.joining(", ")));
            } else {
                assert implementations.size() == 0 || implementations.iterator().next() == frameType.getSingleImplementor();
            }
        }
    }
}
Also used : BeforeAnalysisAccessImpl(com.oracle.svm.hosted.FeatureImpl.BeforeAnalysisAccessImpl) HostedProviders(com.oracle.graal.pointsto.meta.HostedProviders) Arrays(java.util.Arrays) ResolvedJavaType(jdk.vm.ci.meta.ResolvedJavaType) KnownTruffleTypes(org.graalvm.compiler.truffle.compiler.substitutions.KnownTruffleTypes) ResolvedJavaField(jdk.vm.ci.meta.ResolvedJavaField) BooleanSupplier(java.util.function.BooleanSupplier) InlineInfo.createStandardInlineInfo(org.graalvm.compiler.nodes.graphbuilderconf.InlineInvokePlugin.InlineInfo.createStandardInlineInfo) BigDecimal(java.math.BigDecimal) Vector(java.util.Vector) CompilerDirectives(com.oracle.truffle.api.CompilerDirectives) SubstrateTruffleCompiler(com.oracle.svm.truffle.api.SubstrateTruffleCompiler) Deoptimizer(com.oracle.svm.core.deopt.Deoptimizer) Map(java.util.Map) RootNode(com.oracle.truffle.api.nodes.RootNode) Executable(java.lang.reflect.Executable) BigInteger(java.math.BigInteger) TruffleCallBoundary(org.graalvm.compiler.truffle.runtime.TruffleCallBoundary) Alias(com.oracle.svm.core.annotate.Alias) JavaStackWalker(com.oracle.svm.core.stack.JavaStackWalker) FilesFeature(com.oracle.svm.core.jdk.FilesFeature) Set(java.util.Set) FilesSupport(com.oracle.svm.core.jdk.FilesSupport) AnalysisField(com.oracle.graal.pointsto.meta.AnalysisField) GraphBuilderContext(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext) HostedOptionValues(com.oracle.svm.core.option.HostedOptionValues) MetaAccessProvider(jdk.vm.ci.meta.MetaAccessProvider) GraphBuilderConfiguration(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration) GraalFeature(com.oracle.svm.graal.hosted.GraalFeature) InlineDuringParsingMaxDepth(org.graalvm.compiler.java.BytecodeParserOptions.InlineDuringParsingMaxDepth) ConstantNode(org.graalvm.compiler.nodes.ConstantNode) TreeSet(java.util.TreeSet) HostedOptionKey(com.oracle.svm.core.option.HostedOptionKey) InvocationPlugin(org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin) AnalysisMethod(com.oracle.graal.pointsto.meta.AnalysisMethod) NeverPartOfCompilationNode(org.graalvm.compiler.truffle.compiler.nodes.asserts.NeverPartOfCompilationNode) TruffleInstrument(com.oracle.truffle.api.instrumentation.TruffleInstrument) SubstratePartialEvaluator(com.oracle.svm.truffle.api.SubstratePartialEvaluator) Field(java.lang.reflect.Field) Replacements(org.graalvm.compiler.nodes.spi.Replacements) StructuredGraph(org.graalvm.compiler.nodes.StructuredGraph) TreeMap(java.util.TreeMap) RuntimeBytecodeParser(com.oracle.svm.graal.hosted.GraalFeature.RuntimeBytecodeParser) RecomputeFieldValue(com.oracle.svm.core.annotate.RecomputeFieldValue) SubstrateOptimizedCallTarget(com.oracle.svm.truffle.api.SubstrateOptimizedCallTarget) Providers(org.graalvm.compiler.phases.util.Providers) DefaultTruffleRuntime(com.oracle.truffle.api.impl.DefaultTruffleRuntime) ListIterator(java.util.ListIterator) InvocationPlugins(org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins) TruffleRuntime(com.oracle.truffle.api.TruffleRuntime) SubstrateTruffleRuntime(com.oracle.svm.truffle.api.SubstrateTruffleRuntime) JavaKind(jdk.vm.ci.meta.JavaKind) Option(org.graalvm.compiler.options.Option) UserError(com.oracle.svm.core.util.UserError) Method(java.lang.reflect.Method) IdentityHashMap(java.util.IdentityHashMap) Predicate(java.util.function.Predicate) Collection(java.util.Collection) ConcurrentHashMap(java.util.concurrent.ConcurrentHashMap) InstrumentPhase(org.graalvm.compiler.truffle.compiler.phases.InstrumentPhase) OptimizedCallTarget(org.graalvm.compiler.truffle.runtime.OptimizedCallTarget) Collectors(java.util.stream.Collectors) Registration(org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins.Registration) FileTypeDetector(java.nio.file.spi.FileTypeDetector) TargetClass(com.oracle.svm.core.annotate.TargetClass) VMError(com.oracle.svm.core.util.VMError) ValueNode(org.graalvm.compiler.nodes.ValueNode) CallTreeNode(com.oracle.svm.graal.hosted.GraalFeature.CallTreeNode) List(java.util.List) Modifier(java.lang.reflect.Modifier) SnippetReflectionProvider(org.graalvm.compiler.api.replacements.SnippetReflectionProvider) Optional(java.util.Optional) NeverInline(com.oracle.svm.core.annotate.NeverInline) SubstrateOptionsParser(com.oracle.svm.core.option.SubstrateOptionsParser) InliningUtilities(com.oracle.svm.hosted.code.InliningUtilities) Architecture(jdk.vm.ci.code.Architecture) HashMap(java.util.HashMap) Profile(com.oracle.truffle.api.profiles.Profile) InlineInvokePlugin(org.graalvm.compiler.nodes.graphbuilderconf.InlineInvokePlugin) HashSet(java.util.HashSet) Hashtable(java.util.Hashtable) WeakHashMap(java.util.WeakHashMap) HostedType(com.oracle.svm.hosted.meta.HostedType) CompilerAsserts(com.oracle.truffle.api.CompilerAsserts) ImageSingletons(org.graalvm.nativeimage.ImageSingletons) Iterator(java.util.Iterator) ReentrantLock(java.util.concurrent.locks.ReentrantLock) Feature(org.graalvm.nativeimage.Feature) Heap(com.oracle.svm.core.heap.Heap) Delete(com.oracle.svm.core.annotate.Delete) BeforeCompilationAccessImpl(com.oracle.svm.hosted.FeatureImpl.BeforeCompilationAccessImpl) ExplodeLoop(com.oracle.truffle.api.nodes.ExplodeLoop) Frame(com.oracle.truffle.api.frame.Frame) AfterRegistrationAccessImpl(com.oracle.svm.hosted.FeatureImpl.AfterRegistrationAccessImpl) PartialEvaluator(org.graalvm.compiler.truffle.compiler.PartialEvaluator) Truffle(com.oracle.truffle.api.Truffle) Kind(com.oracle.svm.core.annotate.RecomputeFieldValue.Kind) Comparator(java.util.Comparator) Collections(java.util.Collections) ResolvedJavaMethod(jdk.vm.ci.meta.ResolvedJavaMethod) HostedType(com.oracle.svm.hosted.meta.HostedType) CallTreeNode(com.oracle.svm.graal.hosted.GraalFeature.CallTreeNode) GraalFeature(com.oracle.svm.graal.hosted.GraalFeature) BeforeCompilationAccessImpl(com.oracle.svm.hosted.FeatureImpl.BeforeCompilationAccessImpl) HashSet(java.util.HashSet)

Aggregations

Option (org.graalvm.compiler.options.Option)2 AnalysisField (com.oracle.graal.pointsto.meta.AnalysisField)1 AnalysisMethod (com.oracle.graal.pointsto.meta.AnalysisMethod)1 HostedProviders (com.oracle.graal.pointsto.meta.HostedProviders)1 Alias (com.oracle.svm.core.annotate.Alias)1 Delete (com.oracle.svm.core.annotate.Delete)1 NeverInline (com.oracle.svm.core.annotate.NeverInline)1 RecomputeFieldValue (com.oracle.svm.core.annotate.RecomputeFieldValue)1 Kind (com.oracle.svm.core.annotate.RecomputeFieldValue.Kind)1 TargetClass (com.oracle.svm.core.annotate.TargetClass)1 Deoptimizer (com.oracle.svm.core.deopt.Deoptimizer)1 Heap (com.oracle.svm.core.heap.Heap)1 FilesFeature (com.oracle.svm.core.jdk.FilesFeature)1 FilesSupport (com.oracle.svm.core.jdk.FilesSupport)1 HostedOptionKey (com.oracle.svm.core.option.HostedOptionKey)1 HostedOptionValues (com.oracle.svm.core.option.HostedOptionValues)1 SubstrateOptionsParser (com.oracle.svm.core.option.SubstrateOptionsParser)1 JavaStackWalker (com.oracle.svm.core.stack.JavaStackWalker)1 UserError (com.oracle.svm.core.util.UserError)1 VMError (com.oracle.svm.core.util.VMError)1