[GR-64030] Added support for compressing option help text in libgraal image.

PullRequest: graal/20486

Author: dougxc

compiler/src/jdk.graal.compiler.libgraal/src/jdk/graal/compiler/libgraal/LibGraalFeature.java

@@ -232,7 +232,7 @@ void afterAnalysis(AfterAnalysisAccess access) {
             Map<String, String> modules = libgraalLoader.getClassModuleMap();
             for (OptionKey<?> option : options) {
                 OptionDescriptor descriptor = option.getDescriptor();
-                if (descriptor != null && descriptor.getContainer().optionsAreServiceLoadable()) {
+                if (descriptor != null && descriptor.getContainer().optionsAreDiscoverable()) {
                     GraalError.guarantee(access.isReachable(option.getClass()), "%s", option.getClass());
                     GraalError.guarantee(access.isReachable(descriptor.getClass()), "%s", descriptor.getClass());
 
@@ -252,6 +252,7 @@ void afterAnalysis(AfterAnalysisAccess access) {
                     }
                 }
             }
+            OptionDescriptor.sealHelpStrings();
         }
     }
 

compiler/src/jdk.graal.compiler.libgraal/src/jdk/graal/compiler/libgraal/LibGraalSupportImpl.java

@@ -218,8 +218,7 @@ public void printOptions(PrintStream out, String namePrefix) {
                             d.valueType(),
                             assign,
                             "[community edition]",
-                            d.help(),
-                            List.of());
+                            List.of(d.help()));
         });
     }
 

compiler/src/jdk.graal.compiler.processor/src/jdk/graal/compiler/options/processor/OptionProcessor.java

@@ -213,13 +213,11 @@ private void processElement(Element element, OptionsDeclarer optionsDeclarer) {
         }
 
         String briefHelp = helpLines.getFirst();
-        List<String> extraHelp;
         if (briefHelp.isEmpty()) {
             if (helpLines.size() > 1) {
                 processingEnv.getMessager().printMessage(Kind.ERROR, "First line of multi-line help text cannot be empty", element);
                 return;
             }
-            extraHelp = List.of();
         } else {
             if (helpLines.size() > 1) {
                 if (briefHelp.charAt(briefHelp.length() - 1) != '.' && !helpLines.get(1).isBlank()) {
@@ -233,7 +231,6 @@ private void processElement(Element element, OptionsDeclarer optionsDeclarer) {
                 processingEnv.getMessager().printMessage(Kind.ERROR, "Option help text must start with an upper case letter", element);
                 return;
             }
-            extraHelp = helpLines.subList(1, helpLines.size());
         }
 
         String stability = getAnnotationValue(annotation, "stability", VariableElement.class).getSimpleName().toString();
@@ -252,12 +249,16 @@ private void processElement(Element element, OptionsDeclarer optionsDeclarer) {
         }
         boolean deprecated = getAnnotationValue(annotation, "deprecated", Boolean.class);
         String deprecationMessage = getAnnotationValue(annotation, "deprecationMessage", String.class);
-        OptionInfo info = new OptionInfo(optionName, optionTypeName, briefHelp, extraHelp, optionType, declaringClass, fieldName, stability, deprecated, deprecationMessage);
+        OptionInfo info = new OptionInfo(optionName, optionTypeName, String.join("\n", helpLines), optionType, declaringClass, fieldName, stability, deprecated, deprecationMessage);
         optionsDeclarer.options.add(info);
     }
 
     private static String literal(String help) {
-        return "\"" + help.replace("\\", "\\\\").replace("\"", "\\\"") + "\"";
+        String quoted = help.replace("\\", "\\\\").replace("\"", "\\\"");
+        if (help.indexOf('\n') != -1) {
+            return "\"\"\"\n" + quoted + "\"\"\"";
+        }
+        return "\"" + quoted + "\"";
     }
 
     static void createOptionsDescriptorsFile(ProcessingEnvironment processingEnv, OptionsDeclarer optionsDeclarer) {
@@ -310,7 +311,6 @@ static void createOptionsDescriptorsFile(ProcessingEnvironment processingEnv, Op
                 String optionType = option.optionType;
                 String type = option.type;
                 String help = option.help;
-                List<String> extraHelp = option.extraHelp;
                 String fieldName = option.field;
                 String stability = option.stability;
                 boolean deprecated = option.deprecated;
@@ -320,16 +320,9 @@ static void createOptionsDescriptorsFile(ProcessingEnvironment processingEnv, Op
                 out.printf("                /*optionType*/ %s.%s,\n", getSimpleName(OPTION_TYPE_CLASS_NAME), optionType);
                 out.printf("                /*optionValueType*/ %s.class,\n", type);
                 out.printf("                /*help*/ %s,\n", literal(help));
-                if (!extraHelp.isEmpty()) {
-                    out.printf("                /*extraHelp*/ new String[] {\n");
-                    for (String line : extraHelp) {
-                        out.printf("                         %s,\n", literal(line));
-                    }
-                    out.printf("                              },\n");
-                }
                 out.printf("                /*container*/ getContainer(),\n");
-                out.printf("                /*fieldName*/ \"%s\",\n", fieldName);
                 out.printf("                /*option*/ %s,\n", optionField);
+                out.printf("                /*fieldName*/ \"%s\",\n", fieldName);
                 out.printf("                /*stability*/ %s.%s,\n", getSimpleName(OPTION_STABILITY_CLASS_NAME), stability);
                 out.printf("                /*deprecated*/ %b,\n", deprecated);
                 out.printf("                /*deprecationMessage*/ \"%s\");\n", deprecationMessage);
@@ -368,7 +361,7 @@ static void createOptionsDescriptorsFile(ProcessingEnvironment processingEnv, Op
     /**
      * The details of a single option, derived from an {@code @Option} annotated field.
      */
-    record OptionInfo(String name, String optionType, String help, List<String> extraHelp, String type,
+    record OptionInfo(String name, String optionType, String help, String type,
                     String declaringClass, String field, String stability, boolean deprecated,
                     String deprecationMessage) implements Comparable<OptionInfo> {
 

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/core/test/ReflectionOptionDescriptors.java

@@ -95,7 +95,7 @@ public ReflectionOptionDescriptors(Class<?> declaringClass, String... fieldsAndH
 
     private void addOption(String fieldName, String help) {
         try {
-            Field f = container.getDeclaringClass().getDeclaredField(fieldName);
+            Field f = container.declaringClass().getDeclaredField(fieldName);
             if (!OptionKey.class.isAssignableFrom(f.getType())) {
                 throw new IllegalArgumentException(String.format("Option field must be of type %s: %s", OptionKey.class.getName(), f));
             }

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/hotspot/test/CompileTheWorld.java

@@ -146,7 +146,7 @@ public static EconomicMap<OptionKey<?>, Object> parseOptions(String options) {
             for (String optionSetting : options.split("\\s+|#")) {
                 OptionsParser.parseOptionSettingTo(optionSetting, optionSettings);
             }
-            Iterable<OptionDescriptors> loader = OptionsContainer.load(OptionDescriptors.class.getClassLoader());
+            Iterable<OptionDescriptors> loader = OptionsContainer.getDiscoverableOptions(OptionDescriptors.class.getClassLoader());
             OptionsParser.parseOptions(optionSettings, values, loader);
         }
         if (!values.containsKey(HighTier.Options.Inline)) {

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/options/test/TestOptionKey.java

@@ -111,14 +111,13 @@ public static class Options {
             /*name*/ "MyDeprecatedOption",
             /*optionType*/ OptionType.User,
             /*optionValueType*/ String.class,
-            /*help*/ "Help for MyDeprecatedOption with",
-            /*extraHelp*/ new String[] {
-                 "some extra text on",
-                 "following lines.",
-            },
+            /*help*/ """
+                 Help for MyDeprecatedOption with
+                 some extra text on
+                 following lines.""",
             /*declaringClass*/ Options.class,
-            /*fieldName*/ "MyDeprecatedOption",
             /*option*/ MyDeprecatedOption,
+            /*fieldName*/ "MyDeprecatedOption",
             /*stability*/ OptionStability.EXPERIMENTAL,
             /*deprecated*/ true,
             /*deprecationMessage*/ "Some deprecation message"));
@@ -401,8 +400,9 @@ public void testOptionDescriptors() {
         Assert.assertTrue(desc.isDeprecated());
         Assert.assertEquals(desc.getOptionType(), OptionType.User);
         Assert.assertEquals(desc.getDeprecationMessage(), "Some deprecation message");
-        Assert.assertEquals(desc.getHelp(), "Help for MyDeprecatedOption with");
-        Assert.assertEquals(desc.getExtraHelp(), List.of("some extra text on", "following lines."));
+        List<String> help = desc.getHelp();
+        Assert.assertEquals(help.getFirst(), "Help for MyDeprecatedOption with");
+        Assert.assertEquals(help.subList(1, help.size()), List.of("some extra text on", "following lines."));
         Assert.assertEquals(desc.getLocation(), Options.class.getName() + ".MyDeprecatedOption");
 
         EconomicMap<String, OptionDescriptor> map = EconomicMap.create();

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/debug/DebugOptions.java

@@ -245,7 +245,7 @@ public enum OptimizationLogTarget {
                    The accepted values are:
                          File - Dump IGV graphs to the local file system (see DumpPath).
                       Network - Dump IGV graphs to the network destination specified by PrintGraphHost and PrintGraphPort.
-                                If a network connection cannot be opened, dumping falls back to file dumping.\s
+                                If a network connection cannot be opened, dumping falls back to file dumping.
                       Disable - Do not dump IGV graphs.""", type = OptionType.Debug)
     public static final EnumOptionKey<PrintGraphTarget> PrintGraph = new EnumOptionKey<>(PrintGraphTarget.File);