/
BuildNativeImageTask.java
244 lines (215 loc) · 10 KB
/
BuildNativeImageTask.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
/*
* Copyright (c) 2021, 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.gradle.tasks;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.nio.charset.StandardCharsets;
import java.util.List;
import javax.inject.Inject;
import org.graalvm.buildtools.gradle.NativeImagePlugin;
import org.graalvm.buildtools.gradle.dsl.NativeImageOptions;
import org.graalvm.buildtools.gradle.internal.GraalVMLogger;
import org.graalvm.buildtools.gradle.internal.NativeImageCommandLineProvider;
import org.graalvm.buildtools.gradle.internal.NativeImageExecutableLocator;
import org.graalvm.buildtools.utils.NativeImageUtils;
import org.gradle.api.DefaultTask;
import org.gradle.api.file.Directory;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.RegularFile;
import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.plugins.JavaBasePlugin;
import org.gradle.api.provider.MapProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.provider.Provider;
import org.gradle.api.provider.ProviderFactory;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputDirectory;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.TaskAction;
import org.gradle.api.tasks.options.Option;
import org.gradle.process.ExecOperations;
import org.gradle.process.ExecResult;
import static org.graalvm.buildtools.gradle.internal.NativeImageExecutableLocator.graalvmHomeProvider;
import static org.graalvm.buildtools.utils.SharedConstants.EXECUTABLE_EXTENSION;
/**
* This task is responsible for generating a native image by
* calling the corresponding tool in the GraalVM toolchain.
*/
public abstract class BuildNativeImageTask extends DefaultTask {
private final Provider<String> graalvmHomeProvider;
private final NativeImageExecutableLocator.Diagnostics diagnostics;
@Nested
public abstract Property<NativeImageOptions> getOptions();
@Option(option = "quick-build-native", description = "Enables quick build mode")
public void overrideQuickBuild() {
getOptions().get().getQuickBuild().set(true);
}
@Option(option = "debug-native", description = "Enables debug mode")
public void overrideDebugBuild() {
getOptions().get().getDebug().set(true);
}
@Inject
protected abstract ExecOperations getExecOperations();
@Internal
protected abstract DirectoryProperty getWorkingDirectory();
@OutputDirectory
public abstract DirectoryProperty getOutputDirectory();
@InputDirectory
@Optional
public abstract DirectoryProperty getTestListDirectory();
@Optional
@Input
protected Provider<String> getGraalVMHome() {
return graalvmHomeProvider;
}
@Internal
public Provider<String> getExecutableShortName() {
return getOptions().flatMap(NativeImageOptions::getImageName);
}
@Internal
public Provider<String> getExecutableName() {
return getOptions().flatMap(options -> options.getImageName().map(name -> name + EXECUTABLE_EXTENSION));
}
@Internal
public Provider<RegularFile> getOutputFile() {
return getOutputDirectory().map(dir -> dir.file(getExecutableName()).get());
}
@Input
public abstract Property<Boolean> getDisableToolchainDetection();
@Inject
protected abstract ProviderFactory getProviders();
@Inject
protected abstract ObjectFactory getObjects();
@InputFile
@Optional
public abstract RegularFileProperty getClasspathJar();
@Input
@Optional
public abstract Property<Boolean> getUseArgFile();
public BuildNativeImageTask() {
DirectoryProperty buildDir = getProject().getLayout().getBuildDirectory();
Provider<Directory> outputDir = buildDir.dir("native/" + getName());
getWorkingDirectory().set(outputDir);
setDescription("Builds a native image.");
setGroup(JavaBasePlugin.VERIFICATION_GROUP);
getOutputDirectory().convention(outputDir);
ProviderFactory providers = getProject().getProviders();
this.diagnostics = new NativeImageExecutableLocator.Diagnostics();
this.graalvmHomeProvider = graalvmHomeProvider(providers, diagnostics);
getDisableToolchainDetection().convention(false);
}
private List<String> buildActualCommandLineArgs() {
getOptions().finalizeValue();
return new NativeImageCommandLineProvider(
getOptions(),
getExecutableShortName(),
getProviders().provider(() -> getWorkingDirectory().get().getAsFile().getAbsolutePath()),
// Can't use getOutputDirectory().map(...) because Gradle would complain that we use
// a mapped value before the task was called, when we are actually calling it...
getProviders().provider(() -> getOutputDirectory().getAsFile().get().getAbsolutePath()),
getClasspathJar(),
getUseArgFile()).asArguments();
}
// This property provides access to the service instance
// It should be Property<NativeImageService> but because of a bug in Gradle
// we have to use a more generic type, see https://github.com/gradle/gradle/issues/17559
@Internal
public abstract Property<Object> getService();
@TaskAction
public void exec() {
NativeImageOptions options = getOptions().get();
GraalVMLogger logger = GraalVMLogger.of(getLogger());
List<String> args = buildActualCommandLineArgs();
if (options.getVerbose().get()) {
logger.lifecycle("Args are: " + args);
}
File executablePath = NativeImageExecutableLocator.findNativeImageExecutable(
options.getJavaLauncher(),
getDisableToolchainDetection(),
getGraalVMHome(),
getExecOperations(),
logger,
diagnostics);
checkRequiredVersionIfNeeded(executablePath, options);
for (String diagnostic : diagnostics.getDiagnostics()) {
logger.lifecycle(diagnostic);
}
String executable = executablePath.getAbsolutePath();
File outputDir = getOutputDirectory().getAsFile().get();
if (outputDir.isDirectory() || outputDir.mkdirs()) {
getExecOperations().exec(spec -> {
MapProperty<String, Object> environmentVariables = options.getEnvironmentVariables();
if (environmentVariables.isPresent() && !environmentVariables.get().isEmpty()) {
spec.environment(environmentVariables.get());
}
spec.setWorkingDir(getWorkingDirectory());
if (getTestListDirectory().isPresent()) {
NativeImagePlugin.TrackingDirectorySystemPropertyProvider directoryProvider = getObjects().newInstance(NativeImagePlugin.TrackingDirectorySystemPropertyProvider.class);
directoryProvider.getDirectory().set(getTestListDirectory());
spec.getArgumentProviders().add(directoryProvider);
}
spec.args(args);
getService().get();
spec.setExecutable(executable);
});
logger.lifecycle("Native Image written to: " + outputDir);
}
}
private void checkRequiredVersionIfNeeded(File executablePath, NativeImageOptions options) {
if (!options.getRequiredVersion().isPresent()) {
return;
}
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
ExecResult execResult = getExecOperations().exec(spec -> {
spec.setStandardOutput(outputStream);
spec.args("--version");
spec.setExecutable(executablePath.getAbsolutePath());
});
execResult.assertNormalExitValue();
String versionToCheck = new String(outputStream.toByteArray(), StandardCharsets.UTF_8).replace("\n", "");
NativeImageUtils.checkVersion(options.getRequiredVersion().get(), versionToCheck);
}
}