Skip to content

Commit 077e5ad

Browse files
ziyilinziyilin
committed
Parse pointsto options for standalone pointsto
The standalone pointsto need to take the input options. The options and parsing should follow the same way as native image's hosted options. So we extract the commom part of SubstrateOptionsParser to a new project where both pointsto and svm can share.
1 parent 53da61f commit 077e5ad

File tree

23 files changed

+1062
-536
lines changed

23 files changed

+1062
-536
lines changed

‎compiler/mx.compiler/suite.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2168,7 +2168,7 @@
21682168
"jdk.unsupported" # sun.misc.Unsafe
21692169
],
21702170
"exports" : [
2171-
"* to com.oracle.graal.graal_enterprise,org.graalvm.nativeimage.pointsto,org.graalvm.nativeimage.builder,org.graalvm.nativeimage.llvm,com.oracle.svm.svm_enterprise",
2171+
"* to com.oracle.graal.graal_enterprise,org.graalvm.nativeimage.pointsto,org.graalvm.nativeimage.builder,org.graalvm.nativeimage.llvm,com.oracle.svm.svm_enterprise,org.graalvm.nativeimage.base",
21722172
"org.graalvm.compiler.core.common to jdk.internal.vm.compiler.management,org.graalvm.nativeimage.agent.tracing",
21732173
"org.graalvm.compiler.debug to jdk.internal.vm.compiler.management,org.graalvm.nativeimage.objectfile",
21742174
"org.graalvm.compiler.hotspot to jdk.internal.vm.compiler.management",

‎substratevm/mx.substratevm/mx_substratevm.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -782,6 +782,7 @@ def native_image_context_run(func, func_args=None, config=None, build_if_missing
782782
'substratevm:SVM',
783783
'substratevm:OBJECTFILE',
784784
'substratevm:POINTSTO',
785+
'substratevm:NATIVE_IMAGE_BASE',
785786
],
786787
support_distributions=['substratevm:SVM_GRAALVM_SUPPORT'],
787788
stability="earlyadopter",

‎substratevm/mx.substratevm/suite.py‎

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,19 @@
147147
"checkstyle": "com.oracle.svm.core",
148148
"workingSets": "SVM",
149149
},
150+
"org.graalvm.nativeimage.base": {
151+
"subDir": "src",
152+
"sourceDirs": ["src"],
153+
"dependencies": [
154+
"com.oracle.svm.util"
155+
],
156+
"javaCompliance": "8+",
157+
"annotationProcessors": [
158+
"compiler:GRAAL_PROCESSOR",
159+
],
160+
"checkstyle": "com.oracle.svm.core",
161+
"workingSets": "SVM",
162+
},
150163
"com.oracle.svm.util.jdk11": {
151164
"subDir": "src",
152165
"sourceDirs": ["src"],
@@ -174,7 +187,7 @@
174187
"headers",
175188
],
176189
"dependencies": [
177-
"com.oracle.svm.util",
190+
"org.graalvm.nativeimage.base",
178191
],
179192
"javaCompliance": "8+",
180193
"checkstyleVersion" : "8.36.1",
@@ -387,7 +400,7 @@
387400
"subDir": "src",
388401
"sourceDirs": ["src"],
389402
"dependencies": [
390-
"com.oracle.svm.util",
403+
"org.graalvm.nativeimage.base",
391404
],
392405
"checkstyle": "com.oracle.graal.pointsto",
393406
"javaCompliance": "8+",
@@ -1099,6 +1112,7 @@
10991112
"OBJECTFILE",
11001113
"POINTSTO",
11011114
"compiler:GRAAL",
1115+
"NATIVE_IMAGE_BASE",
11021116
],
11031117
"moduleInfo" : {
11041118
"name" : "org.graalvm.nativeimage.builder",
@@ -1112,7 +1126,7 @@
11121126
"com.oracle.svm.hosted to java.base",
11131127
"com.oracle.svm.hosted.agent to java.instrument",
11141128
"com.oracle.svm.truffle.api to org.graalvm.truffle",
1115-
"* to jdk.internal.vm.compiler,org.graalvm.nativeimage.driver,org.graalvm.nativeimage.configure,org.graalvm.nativeimage.librarysupport,org.graalvm.nativeimage.junitsupport,org.graalvm.nativeimage.llvm,org.graalvm.nativeimage.agent.jvmtibase,org.graalvm.nativeimage.agent.tracing,org.graalvm.nativeimage.agent.diagnostics,com.oracle.svm.svm_enterprise",
1129+
"* to org.graalvm.nativeimage.base,jdk.internal.vm.compiler,org.graalvm.nativeimage.driver,org.graalvm.nativeimage.configure,org.graalvm.nativeimage.librarysupport,org.graalvm.nativeimage.junitsupport,org.graalvm.nativeimage.llvm,org.graalvm.nativeimage.agent.jvmtibase,org.graalvm.nativeimage.agent.tracing,org.graalvm.nativeimage.agent.diagnostics,com.oracle.svm.svm_enterprise",
11161130
],
11171131
"opens" : [
11181132
"com.oracle.svm.core to jdk.internal.vm.compiler",
@@ -1247,6 +1261,9 @@
12471261
"static junit",
12481262
"static hamcrest",
12491263
],
1264+
"exports" : [
1265+
"* to org.graalvm.nativeimage.base,org.graalvm.nativeimage.pointsto,org.graalvm.nativeimage.builder",
1266+
],
12501267
},
12511268
},
12521269

@@ -1414,6 +1431,26 @@
14141431
},
14151432
},
14161433

1434+
"NATIVE_IMAGE_BASE": {
1435+
"subDir": "src",
1436+
"description" : "Native Image base that can be shared by native image building and pointsto.",
1437+
"dependencies": [
1438+
"org.graalvm.nativeimage.base",
1439+
"com.oracle.svm.util",
1440+
],
1441+
"distDependencies": [
1442+
"compiler:GRAAL",
1443+
],
1444+
"exclude": [
1445+
],
1446+
"moduleInfo" : {
1447+
"name" : "org.graalvm.nativeimage.base",
1448+
"exports" : [
1449+
"com.oracle.svm.util",
1450+
"org.graalvm.nativeimage.base.option",
1451+
],
1452+
}
1453+
},
14171454

14181455
"POINTSTO": {
14191456
"subDir": "src",
@@ -1424,13 +1461,13 @@
14241461
],
14251462
"distDependencies": [
14261463
"compiler:GRAAL",
1464+
"NATIVE_IMAGE_BASE",
14271465
],
14281466
"exclude": [
14291467
],
14301468
"moduleInfo" : {
14311469
"name" : "org.graalvm.nativeimage.pointsto",
14321470
"exports" : [
1433-
"com.oracle.svm.util",
14341471
"com.oracle.graal.pointsto",
14351472
"com.oracle.graal.pointsto.api",
14361473
"com.oracle.graal.pointsto.reports",
@@ -1607,7 +1644,7 @@
16071644
"moduleInfo" : {
16081645
"name" : "org.graalvm.nativeimage.llvm",
16091646
"exports" : [
1610-
"* to org.graalvm.nativeimage.builder",
1647+
"* to org.graalvm.nativeimage.builder,org.graalvm.nativeimage.base",
16111648
],
16121649
},
16131650
"maven" : False,

‎substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/api/PointstoOptions.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,4 +219,10 @@ public String value() {
219219
return value;
220220
}
221221
}
222+
223+
@Option(help = "Specify the analysis entry point class. It should be a main Class.")//
224+
public static final OptionKey<String> AnalysisEntryClass = new OptionKey<>(null);
225+
226+
@Option(help = "Configurations used in native image building time can also be used in analysis. Specify the configurations' directory.")//
227+
public static final OptionKey<String> AnalysisConfigDir = new OptionKey<>(null);
222228
}

‎substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/util/AnalysisError.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,14 @@ private static String message(PointsToAnalysis bb, TypeFlow<?> objectFlow, Bytec
125125
}
126126
}
127127

128+
public static class InterruptAnalysis extends AnalysisError {
129+
private static final long serialVersionUID = 7126612141948542452L;
130+
131+
InterruptAnalysis(String msg) {
132+
super(msg);
133+
}
134+
}
135+
128136
public static TypeNotFoundError typeNotFound(ResolvedJavaType type) {
129137
throw new TypeNotFoundError(type);
130138
}
@@ -166,4 +174,8 @@ public static void guarantee(boolean condition, String format, Object... args) {
166174
// Checkstyle: resume
167175
}
168176
}
177+
178+
public static RuntimeException interruptAnalysis(String msg) {
179+
throw new InterruptAnalysis(msg);
180+
}
169181
}

‎substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/util/ClassPathSearcher.java‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
/*
2+
* Copyright (c) 2021, 2021, Oracle and/or its affiliates. All rights reserved.
3+
* Copyright (c) 2021, 2021, Alibaba Group Holding Limited. All rights reserved.
4+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5+
*
6+
* This code is free software; you can redistribute it and/or modify it
7+
* under the terms of the GNU General Public License version 2 only, as
8+
* published by the Free Software Foundation. Oracle designates this
9+
* particular file as subject to the "Classpath" exception as provided
10+
* by Oracle in the LICENSE file that accompanied this code.
11+
*
12+
* This code is distributed in the hope that it will be useful, but WITHOUT
13+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15+
* version 2 for more details (a copy is included in the LICENSE file that
16+
* accompanied this code).
17+
*
18+
* You should have received a copy of the GNU General Public License version
19+
* 2 along with this work; if not, write to the Free Software Foundation,
20+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21+
*
22+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
23+
* or visit www.oracle.com if you need additional information or have any
24+
* questions.
25+
*/
26+
27+
package com.oracle.graal.pointsto.util;
28+
29+
import java.io.File;
30+
import java.io.IOException;
31+
import java.nio.file.FileVisitResult;
32+
import java.nio.file.Files;
33+
import java.nio.file.Path;
34+
import java.nio.file.SimpleFileVisitor;
35+
import java.nio.file.attribute.BasicFileAttributes;
36+
import java.util.Enumeration;
37+
import java.util.function.Consumer;
38+
import java.util.jar.JarEntry;
39+
import java.util.jar.JarFile;
40+
41+
public class ClassPathSearcher {
42+
43+
public static void search(Consumer<String> matchClass) {
44+
String classpath = System.getProperty("java.class.path");
45+
String[] classPathEntries = classpath.split(File.pathSeparator);
46+
for (String entry : classPathEntries) {
47+
File file = new File(entry);
48+
if (file.isFile() && file.getName().endsWith(".jar")) {
49+
scanJar(file, matchClass);
50+
} else if (file.isDirectory()) {
51+
scanDir(file, matchClass);
52+
} else if (file.isFile()) {
53+
matchClass.accept(file.toString());
54+
}
55+
}
56+
}
57+
58+
private static void scanDir(File p, Consumer<String> matchClass) {
59+
try {
60+
Files.walkFileTree(p.toPath(), new SimpleFileVisitor<Path>() {
61+
@Override
62+
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
63+
Path relativePath = p.toPath().relativize(file);
64+
matchClass.accept(relativePath.toString());
65+
return FileVisitResult.CONTINUE;
66+
}
67+
68+
});
69+
} catch (IOException e) {
70+
e.printStackTrace();
71+
}
72+
}
73+
74+
private static void scanJar(File file, Consumer<String> matchClass) {
75+
try {
76+
JarFile jf = new JarFile(file);
77+
Enumeration<JarEntry> entries = jf.entries();
78+
while (entries.hasMoreElements()) {
79+
matchClass.accept(entries.nextElement().getName());
80+
}
81+
} catch (IOException e) {
82+
e.printStackTrace();
83+
}
84+
}
85+
}

‎substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/util/PointsToOptionParser.java‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
/*
2+
* Copyright (c) 2021, 2021, Oracle and/or its affiliates. All rights reserved.
3+
* Copyright (c) 2021, 2021, Alibaba Group Holding Limited. All rights reserved.
4+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5+
*
6+
* This code is free software; you can redistribute it and/or modify it
7+
* under the terms of the GNU General Public License version 2 only, as
8+
* published by the Free Software Foundation. Oracle designates this
9+
* particular file as subject to the "Classpath" exception as provided
10+
* by Oracle in the LICENSE file that accompanied this code.
11+
*
12+
* This code is distributed in the hope that it will be useful, but WITHOUT
13+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15+
* version 2 for more details (a copy is included in the LICENSE file that
16+
* accompanied this code).
17+
*
18+
* You should have received a copy of the GNU General Public License version
19+
* 2 along with this work; if not, write to the Free Software Foundation,
20+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21+
*
22+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
23+
* or visit www.oracle.com if you need additional information or have any
24+
* questions.
25+
*/
26+
27+
package com.oracle.graal.pointsto.util;
28+
29+
import org.graalvm.nativeimage.base.option.CommonOptionParser;
30+
import org.graalvm.nativeimage.base.option.CommonOptionParser.BooleanOptionFormat;
31+
import org.graalvm.nativeimage.base.option.CommonOptionParser.OptionParseResult;
32+
import org.graalvm.nativeimage.base.option.UnsupportedOptionClassException;
33+
import org.graalvm.collections.EconomicMap;
34+
import org.graalvm.compiler.options.OptionDescriptor;
35+
import org.graalvm.compiler.options.OptionDescriptors;
36+
import org.graalvm.compiler.options.OptionKey;
37+
import org.graalvm.compiler.options.OptionValues;
38+
39+
import java.io.PrintStream;
40+
import java.util.ArrayList;
41+
import java.util.Arrays;
42+
import java.util.HashSet;
43+
import java.util.List;
44+
import java.util.ServiceLoader;
45+
import java.util.Set;
46+
import java.util.function.Predicate;
47+
48+
import static org.graalvm.nativeimage.base.option.CommonOptionParser.BooleanOptionFormat.PLUS_MINUS;
49+
50+
public final class PointsToOptionParser {
51+
52+
private static PointsToOptionParser instance = new PointsToOptionParser();
53+
54+
private OptionValues optionValues = null;
55+
private EconomicMap<OptionKey<?>, Object> analysisValues = OptionValues.newOptionMap();
56+
private EconomicMap<String, OptionDescriptor> allAnalysisOptions = EconomicMap.create();
57+
58+
public static PointsToOptionParser getInstance() {
59+
return instance;
60+
}
61+
62+
@SuppressWarnings("unchecked")
63+
private PointsToOptionParser() {
64+
ClassLoader appClassLoader = ClassPathSearcher.class.getClassLoader();
65+
CommonOptionParser.collectOptions(ServiceLoader.load(OptionDescriptors.class, appClassLoader), descriptor -> {
66+
String name = descriptor.getName();
67+
if (descriptor.getOptionKey() instanceof OptionKey) {
68+
OptionDescriptor existing = allAnalysisOptions.put(name, descriptor);
69+
if (existing != null) {
70+
AnalysisError.shouldNotReachHere("Option name \"" + name + "\" has multiple definitions: " + existing.getLocation() + " and " + descriptor.getLocation());
71+
}
72+
}
73+
});
74+
}
75+
76+
public void setOptionValue(OptionKey<?> optionKey, Object value) {
77+
if (optionValues == null) {
78+
parse(new String[0]);
79+
}
80+
optionKey.update((EconomicMap<OptionKey<?>, Object>) optionValues.getMap(), value);
81+
}
82+
83+
public OptionValues parse(String[] args) {
84+
List<String> remainingArgs = new ArrayList<>();
85+
Set<String> errors = new HashSet<>();
86+
for (String arg : args) {
87+
boolean isAnalysisOption = false;
88+
isAnalysisOption |= parseOption(CommonOptionParser.HOSTED_OPTION_PREFIX, allAnalysisOptions, analysisValues, PLUS_MINUS, errors, arg, System.out);
89+
if (!isAnalysisOption) {
90+
remainingArgs.add(arg);
91+
}
92+
}
93+
optionValues = new OptionValues(analysisValues);
94+
if (!remainingArgs.isEmpty()) {
95+
AnalysisError.interruptAnalysis(String.format("Unknown options: %s", Arrays.toString(remainingArgs.toArray(new String[0]))));
96+
}
97+
if (!errors.isEmpty()) {
98+
StringBuilder errMsg = new StringBuilder("Option format error:\n");
99+
for (String err : errors) {
100+
errMsg.append(err).append("\n");
101+
}
102+
AnalysisError.interruptAnalysis(errMsg.toString());
103+
}
104+
return optionValues;
105+
}
106+
107+
private static boolean parseOption(String optionPrefix, EconomicMap<String, OptionDescriptor> options, EconomicMap<OptionKey<?>, Object> valuesMap,
108+
BooleanOptionFormat booleanOptionFormat, Set<String> errors, String arg, PrintStream out) {
109+
if (!arg.startsWith(optionPrefix)) {
110+
return false;
111+
}
112+
try {
113+
Predicate<OptionKey<?>> optionKeyPredicate = optionKey -> {
114+
Class<?> clazz = optionKey.getClass();
115+
// All classes from com.oracle.graal.pointsto.api.PointstoOptions are taken as non-hosted options.
116+
if (clazz.getName().startsWith("com.oracle.graal.pointsto.api.PointstoOptions")) {
117+
return false;
118+
}
119+
if (!clazz.equals(OptionKey.class) && OptionKey.class.isAssignableFrom(clazz)) {
120+
return true;
121+
} else {
122+
return false;
123+
}
124+
};
125+
OptionParseResult optionParseResult = CommonOptionParser.parseOption(options, optionKeyPredicate, arg.substring(optionPrefix.length()), valuesMap,
126+
optionPrefix, booleanOptionFormat);
127+
if (optionParseResult.printFlags() || optionParseResult.printFlagsWithExtraHelp()) {
128+
CommonOptionParser.printFlags(d -> optionParseResult.matchesFlags(d, () -> true), options, optionPrefix, out, optionParseResult.printFlagsWithExtraHelp());
129+
System.out.println("Abort analysis due to print flags are requested");
130+
System.exit(1);
131+
}
132+
if (!optionParseResult.isValid()) {
133+
errors.add(optionParseResult.getError());
134+
}
135+
} catch (UnsupportedOptionClassException e) {
136+
AnalysisError.shouldNotReachHere(e);
137+
}
138+
return true;
139+
}
140+
}

0 commit comments

Comments
 (0)