-
Notifications
You must be signed in to change notification settings - Fork 51
/
AbstractNativeMojo.java
541 lines (460 loc) · 22 KB
/
AbstractNativeMojo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
/*
* Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.graalvm.buildtools.maven;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.maven.toolchain.ToolchainManager;
import org.codehaus.plexus.logging.Logger;
import org.graalvm.buildtools.Utils;
import org.graalvm.buildtools.maven.config.ExcludeConfigConfiguration;
import org.graalvm.buildtools.maven.config.MetadataRepositoryConfiguration;
import org.graalvm.buildtools.utils.FileUtils;
import org.graalvm.buildtools.utils.NativeImageUtils;
import org.graalvm.buildtools.utils.SharedConstants;
import org.graalvm.reachability.JvmReachabilityMetadataRepository;
import org.graalvm.reachability.internal.FileSystemRepository;
import javax.inject.Inject;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.net.URL;
import java.nio.file.FileSystem;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* @author Sebastien Deleuze
*/
public abstract class AbstractNativeMojo extends AbstractMojo {
protected static final String NATIVE_IMAGE_META_INF = "META-INF/native-image";
protected static final String NATIVE_IMAGE_PROPERTIES_FILENAME = "native-image.properties";
protected static final String NATIVE_IMAGE_DRY_RUN = "nativeDryRun";
@Parameter(defaultValue = "${plugin}", readonly = true) // Maven 3 only
protected PluginDescriptor plugin;
@Parameter(defaultValue = "${session}", readonly = true)
protected MavenSession session;
@Parameter(defaultValue = "${project}", readonly = true, required = true)
protected MavenProject project;
@Parameter(defaultValue = "${mojoExecution}")
protected MojoExecution mojoExecution;
@Parameter(property = "plugin.artifacts", required = true, readonly = true)
protected List<Artifact> pluginArtifacts;
@Parameter(defaultValue = "${project.build.directory}", property = "outputDir", required = true)
protected File outputDirectory;
@Parameter(property = "mainClass")
protected String mainClass;
@Parameter(property = "imageName", defaultValue = "${project.artifactId}")
protected String imageName;
@Parameter(property = "classpath")
protected List<String> classpath;
@Parameter(property = "classesDirectory")
protected File classesDirectory;
@Parameter(defaultValue = "${project.build.outputDirectory}", readonly = true, required = true)
protected File defaultClassesDirectory;
protected final List<Path> imageClasspath;
protected final Set<Path> metadataRepositoryPaths;
@Parameter(property = "debug", defaultValue = "false")
protected boolean debug;
@Parameter(property = "fallback", defaultValue = "false")
protected boolean fallback;
@Parameter(property = "verbose", defaultValue = "false")
protected boolean verbose;
@Parameter(property = "sharedLibrary", defaultValue = "false")
protected boolean sharedLibrary;
@Parameter(property = "quickBuild", defaultValue = "false")
protected boolean quickBuild;
@Parameter(property = "useArgFile")
protected Boolean useArgFile;
@Parameter(property = "buildArgs")
protected List<String> buildArgs;
@Parameter(defaultValue = "${project.build.directory}/native/generated", property = "resourcesConfigDirectory", required = true)
protected File resourcesConfigDirectory;
@Parameter(property = "agentResourceDirectory")
protected File agentResourceDirectory;
@Parameter(property = "excludeConfig")
protected List<ExcludeConfigConfiguration> excludeConfig;
@Parameter(property = "environmentVariables")
protected Map<String, String> environment;
@Parameter(property = "systemPropertyVariables")
protected Map<String, String> systemProperties;
@Parameter(property = "configurationFileDirectories")
protected List<String> configFiles;
@Parameter(property = "jvmArgs")
protected List<String> jvmArgs;
@Parameter(alias = "metadataRepository")
protected MetadataRepositoryConfiguration metadataRepositoryConfiguration;
@Parameter(property = NATIVE_IMAGE_DRY_RUN, defaultValue = "false")
protected boolean dryRun;
protected JvmReachabilityMetadataRepository metadataRepository;
@Component
protected Logger logger;
@Component
protected ToolchainManager toolchainManager;
@Inject
protected AbstractNativeMojo() {
imageClasspath = new ArrayList<>();
metadataRepositoryPaths = new HashSet<>();
useArgFile = SharedConstants.IS_WINDOWS;
}
protected List<String> getBuildArgs() throws MojoExecutionException {
final List<String> cliArgs = new ArrayList<>();
if (excludeConfig != null) {
excludeConfig.forEach(entry -> {
cliArgs.add("--exclude-config");
cliArgs.add(entry.getJarPath());
cliArgs.add(String.format("\"%s\"", entry.getResourcePattern()));
});
}
cliArgs.add("-cp");
cliArgs.add(getClasspath());
if (debug) {
cliArgs.add("-g");
}
if (!fallback) {
cliArgs.add("--no-fallback");
}
if (verbose) {
cliArgs.add("--verbose");
}
if (sharedLibrary) {
cliArgs.add("--shared");
}
// Let's allow user to specify environment option to toggle quick build.
String quickBuildEnv = System.getenv("GRAALVM_QUICK_BUILD");
if (quickBuildEnv != null) {
logger.info("Quick build environment variable is set.");
quickBuild = quickBuildEnv.isEmpty() || Boolean.parseBoolean(quickBuildEnv);
}
if (quickBuild) {
cliArgs.add("-Ob");
}
cliArgs.add("-H:Path=" + outputDirectory.toPath().toAbsolutePath());
cliArgs.add("-H:Name=" + imageName);
if (systemProperties != null) {
for (Map.Entry<String, String> entry : systemProperties.entrySet()) {
cliArgs.add("-D" + entry.getKey() + "=" + entry.getValue());
}
}
if (jvmArgs != null) {
jvmArgs.forEach(jvmArg -> cliArgs.add("-J" + jvmArg));
}
maybeAddGeneratedResourcesConfig(buildArgs);
maybeAddReachabilityMetadata(configFiles);
if (configFiles != null && !configFiles.isEmpty()) {
cliArgs.add("-H:ConfigurationFileDirectories=" +
configFiles.stream()
.map(Paths::get)
.map(Path::toAbsolutePath)
.map(Path::toString)
.collect(Collectors.joining(","))
);
}
if (mainClass != null && !mainClass.equals(".")) {
cliArgs.add("-H:Class=" + mainClass);
}
if (buildArgs != null && !buildArgs.isEmpty()) {
for (String buildArg : buildArgs) {
cliArgs.addAll(Arrays.asList(buildArg.split("\\s+")));
}
}
if (useArgFile) {
return NativeImageUtils.convertToArgsFile(cliArgs);
}
return Collections.unmodifiableList(cliArgs);
}
protected Path processArtifact(Artifact artifact, String artifactType) throws MojoExecutionException {
File artifactFile = artifact.getFile();
if (!artifactType.equals(artifact.getType())) {
logger.warn("Ignoring non-jar type ImageClasspath Entry " + artifact);
return null;
}
if (!artifactFile.exists()) {
throw new MojoExecutionException("Missing jar-file for " + artifact + ". " +
"Ensure that " + plugin.getArtifactId() + " runs in package phase.");
}
Path jarFilePath = artifactFile.toPath();
logger.info("ImageClasspath Entry: " + artifact + " (" + jarFilePath.toUri() + ")");
warnIfWrongMetaInfLayout(jarFilePath, artifact);
return jarFilePath;
}
protected void addArtifactToClasspath(Artifact artifact) throws MojoExecutionException {
Optional.ofNullable(processArtifact(artifact, "jar")).ifPresent(imageClasspath::add);
}
protected void warnIfWrongMetaInfLayout(Path jarFilePath, Artifact artifact) throws MojoExecutionException {
if (jarFilePath.toFile().isDirectory()) {
logger.warn("Artifact `" + jarFilePath + "` is a directory.");
return;
}
URI jarFileURI = URI.create("jar:" + jarFilePath.toUri());
try (FileSystem jarFS = FileSystems.newFileSystem(jarFileURI, Collections.emptyMap())) {
Path nativeImageMetaInfBase = jarFS.getPath("/" + NATIVE_IMAGE_META_INF);
if (Files.isDirectory(nativeImageMetaInfBase)) {
try (Stream<Path> stream = Files.walk(nativeImageMetaInfBase)) {
List<Path> nativeImageProperties = stream
.filter(p -> p.endsWith(NATIVE_IMAGE_PROPERTIES_FILENAME)).collect(Collectors.toList());
for (Path nativeImageProperty : nativeImageProperties) {
Path relativeSubDir = nativeImageMetaInfBase.relativize(nativeImageProperty).getParent();
boolean valid = relativeSubDir != null && (relativeSubDir.getNameCount() == 2);
valid = valid && relativeSubDir.getName(0).toString().equals(artifact.getGroupId());
valid = valid && relativeSubDir.getName(1).toString().equals(artifact.getArtifactId());
if (!valid) {
String example = NATIVE_IMAGE_META_INF + "/${groupId}/${artifactId}/" + NATIVE_IMAGE_PROPERTIES_FILENAME;
logger.warn(nativeImageProperty.toUri() + " does not match recommended " + example + " layout.");
}
}
}
}
} catch (IOException e) {
throw new MojoExecutionException("Artifact " + artifact + "cannot be added to image classpath", e);
}
}
protected abstract List<String> getDependencyScopes();
protected void addDependenciesToClasspath() throws MojoExecutionException {
configureMetadataRepository();
for (Artifact dependency : project.getArtifacts().stream()
.filter(artifact -> getDependencyScopes().contains(artifact.getScope()))
.collect(Collectors.toSet())) {
addArtifactToClasspath(dependency);
maybeAddDependencyMetadata(dependency);
}
}
/**
* Returns path to where application classes are stored, or jar artifact if it is produced.
* @return Path to application classes
* @throws MojoExecutionException failed getting main build path
*/
protected Path getMainBuildPath() throws MojoExecutionException {
if (classesDirectory != null) {
return classesDirectory.toPath();
} else {
Path artifactPath = processArtifact(project.getArtifact(), project.getPackaging());
if (artifactPath != null) {
return artifactPath;
} else {
return defaultClassesDirectory.toPath();
}
}
}
protected void populateApplicationClasspath() throws MojoExecutionException {
imageClasspath.add(getMainBuildPath());
}
protected void populateClasspath() throws MojoExecutionException {
if (classpath != null && !classpath.isEmpty()) {
imageClasspath.addAll(classpath.stream()
.map(Paths::get)
.map(Path::toAbsolutePath)
.collect(Collectors.toSet())
);
} else {
populateApplicationClasspath();
addDependenciesToClasspath();
}
}
protected String getClasspath() throws MojoExecutionException {
populateClasspath();
if (imageClasspath.isEmpty()) {
throw new MojoExecutionException("Image classpath is empty. " +
"Check if your classpath configuration is correct.");
}
return imageClasspath.stream()
.map(Path::toString)
.collect(Collectors.joining(File.pathSeparator));
}
protected void buildImage() throws MojoExecutionException {
Path nativeImageExecutable = Utils.getNativeImage(logger);
try {
ProcessBuilder processBuilder = new ProcessBuilder(nativeImageExecutable.toString());
processBuilder.command().addAll(getBuildArgs());
if (environment != null) {
processBuilder.environment().putAll(environment);
}
if (!outputDirectory.exists() && !outputDirectory.mkdirs()) {
throw new MojoExecutionException("Failed creating output directory");
}
processBuilder.directory(outputDirectory);
processBuilder.inheritIO();
String commandString = String.join(" ", processBuilder.command());
logger.info("Executing: " + commandString);
if (dryRun) {
logger.warn("Skipped native-image building due to `" + NATIVE_IMAGE_DRY_RUN + "` being specified.");
return;
}
Process imageBuildProcess = processBuilder.start();
if (imageBuildProcess.waitFor() != 0) {
throw new MojoExecutionException("Execution of " + commandString + " returned non-zero result");
}
} catch (IOException | InterruptedException e) {
throw new MojoExecutionException("Building image with " + nativeImageExecutable + " failed", e);
}
}
protected void maybeAddGeneratedResourcesConfig(List<String> into) {
if (resourcesConfigDirectory.exists() || agentResourceDirectory != null) {
File[] dirs = resourcesConfigDirectory.listFiles();
Stream<File> configDirs =
Stream.concat(dirs == null ? Stream.empty() : Arrays.stream(dirs),
agentResourceDirectory == null ? Stream.empty() : Stream.of(agentResourceDirectory).filter(File::isDirectory));
String value = configDirs.map(File::getAbsolutePath).collect(Collectors.joining(","));
if (!value.isEmpty()) {
into.add("-H:ConfigurationFileDirectories=" + value);
if (agentResourceDirectory != null && agentResourceDirectory.isDirectory()) {
// The generated reflect config file contains references to java.*
// and org.apache.maven.surefire that we'd need to remove using
// a proper JSON parser/writer instead
into.add("-H:+AllowIncompleteClasspath");
}
}
}
}
protected boolean isMetadataRepositoryEnabled() {
return metadataRepositoryConfiguration != null && metadataRepositoryConfiguration.isEnabled();
}
protected void configureMetadataRepository() {
if (isMetadataRepositoryEnabled()) {
Path repoPath = null;
if (metadataRepositoryConfiguration.getVersion() != null) {
logger.warn("The official GraalVM reachability metadata repository is not released yet. Only local repositories are supported");
}
if (metadataRepositoryConfiguration.getLocalPath() != null) {
Path localPath = metadataRepositoryConfiguration.getLocalPath().toPath();
repoPath = unzipLocalMetadata(localPath);
} else if (metadataRepositoryConfiguration.getUrl() != null) {
Optional<Path> download = downloadMetadata(metadataRepositoryConfiguration.getUrl());
if (download.isPresent()) {
logger.info("Downloaded GraalVM reachability metadata repository from " + metadataRepositoryConfiguration.getUrl());
repoPath = unzipLocalMetadata(download.get());
}
}
if (repoPath == null) {
logger.warn("GraalVM reachability metadata repository is enabled, but no repository has been configured");
} else {
metadataRepository = new FileSystemRepository(repoPath, new FileSystemRepository.Logger() {
@Override
public void log(String groupId, String artifactId, String version, Supplier<String> message) {
logger.info(String.format("[graalvm reachability metadata repository for %s:%s:%s]: %s", groupId, artifactId, version, message.get()));
}
});
}
}
}
public boolean isArtifactExcludedFromMetadataRepository(Artifact dependency) {
if (metadataRepositoryConfiguration == null) {
return false;
} else {
return metadataRepositoryConfiguration.isArtifactExcluded(dependency);
}
}
protected void maybeAddReachabilityMetadata(List<String> configDirs) {
if (isMetadataRepositoryEnabled() && !metadataRepositoryPaths.isEmpty()) {
String arg = metadataRepositoryPaths.stream()
.map(Path::toAbsolutePath)
.map(Path::toFile)
.map(File::getAbsolutePath)
.collect(Collectors.joining(","));
if (!arg.isEmpty()) {
configDirs.add(arg);
}
}
}
protected void maybeAddDependencyMetadata(Artifact dependency) {
if (isMetadataRepositoryEnabled() && metadataRepository != null && !isArtifactExcludedFromMetadataRepository(dependency)) {
metadataRepositoryPaths.addAll(metadataRepository.findConfigurationDirectoriesFor(q -> {
q.useLatestConfigWhenVersionIsUntested();
q.forArtifact(artifact -> {
artifact.gav(String.join(":",
dependency.getGroupId(),
dependency.getArtifactId(),
dependency.getVersion()));
getMetadataVersion(dependency).ifPresent(artifact::forceConfigVersion);
});
}));
}
}
protected Optional<String> getMetadataVersion(Artifact dependency) {
if (metadataRepositoryConfiguration == null) {
return Optional.empty();
} else {
return metadataRepositoryConfiguration.getMetadataVersion(dependency);
}
}
protected Optional<Path> downloadMetadata(URL url) {
Path destination = outputDirectory.toPath().resolve("graalvm-reachability-metadata");
return FileUtils.download(url, destination, logger::error);
}
protected Path unzipLocalMetadata(Path localPath) {
if (Files.exists(localPath)) {
if (FileUtils.isZip(localPath)) {
Path destination = outputDirectory.toPath().resolve("graalvm-reachability-metadata");
if (!Files.exists(destination) && !destination.toFile().mkdirs()) {
throw new RuntimeException("Failed creating destination directory");
}
FileUtils.extract(localPath, destination, logger::error);
return destination;
} else if (Files.isDirectory(localPath)) {
return localPath;
} else {
logger.warn("Unable to extract metadata repository from " + localPath + ". " +
"It needs to be either a ZIP file or an exploded directory");
}
} else {
logger.error("GraalVM reachability metadata repository path does not exist: " + localPath);
}
return null;
}
}