Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support different agent modes in the native-image Gradle plugin #230

Merged
merged 10 commits into from May 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -42,12 +42,8 @@
package org.graalvm.build.tasks

import org.eclipse.jgit.api.Git
import org.gradle.api.DefaultTask
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputDirectory
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction

abstract class GitAdd : AbstractGitTask() {
Expand Down
Expand Up @@ -42,9 +42,7 @@
package org.graalvm.build.tasks

import org.eclipse.jgit.api.Git
import org.eclipse.jgit.api.TransportConfigCallback
import org.eclipse.jgit.transport.SshTransport
import org.eclipse.jgit.transport.Transport
import org.eclipse.jgit.util.FileUtils
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.provider.Property
Expand Down
Expand Up @@ -42,12 +42,8 @@
package org.graalvm.build.tasks

import org.eclipse.jgit.api.Git
import org.gradle.api.DefaultTask
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputDirectory
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction

abstract class GitCommit : AbstractGitTask() {
Expand Down
Expand Up @@ -43,12 +43,8 @@ package org.graalvm.build.tasks

import org.eclipse.jgit.api.Git
import org.eclipse.jgit.transport.SshTransport
import org.gradle.api.DefaultTask
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputDirectory
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction

abstract class GitPush : AbstractGitTask() {
Expand Down
Expand Up @@ -43,12 +43,8 @@ package org.graalvm.build.tasks

import org.eclipse.jgit.api.Git
import org.eclipse.jgit.api.ResetCommand
import org.gradle.api.DefaultTask
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputDirectory
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction

abstract class GitReset : AbstractGitTask() {
Expand Down
@@ -0,0 +1,109 @@
/*
* Copyright (c) 2022, 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.agent;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

public class AgentConfiguration implements Serializable {

private final Collection<String> callerFilterFiles;
private final Collection<String> accessFilterFiles;
private final boolean builtinCallerFilter;
private final boolean builtinHeuristicFilter;
private final boolean experimentalPredefinedClasses;
private final boolean experimentalUnsafeAllocationTracing;
private final boolean trackReflectionMetadata;

private final AgentMode agentMode;

public AgentConfiguration(Collection<String> callerFilterFiles,
Collection<String> accessFilterFiles,
boolean builtinCallerFilter,
boolean builtinHeuristicFilter,
boolean experimentalPredefinedClasses,
boolean experimentalUnsafeAllocationTracing,
boolean trackReflectionMetadata,
AgentMode agentMode) {
this.callerFilterFiles = callerFilterFiles;
this.accessFilterFiles = accessFilterFiles;
this.builtinCallerFilter = builtinCallerFilter;
this.builtinHeuristicFilter = builtinHeuristicFilter;
this.experimentalPredefinedClasses = experimentalPredefinedClasses;
this.experimentalUnsafeAllocationTracing = experimentalUnsafeAllocationTracing;
this.trackReflectionMetadata = trackReflectionMetadata;
this.agentMode = agentMode;
}

public List<String> getAgentCommandLine() {
List<String> cmdLine = new ArrayList<>(agentMode.getAgentCommandLine());
appendOptionToValues("caller-filter-file=", callerFilterFiles, cmdLine);
appendOptionToValues("access-filter-file=", accessFilterFiles, cmdLine);
cmdLine.add("builtin-caller-filter=" + builtinCallerFilter);
cmdLine.add("builtin-heuristic-filter=" + builtinHeuristicFilter);
cmdLine.add("experimental-class-define-support=" + experimentalPredefinedClasses);
cmdLine.add("experimental-unsafe-allocation-support=" + experimentalUnsafeAllocationTracing);
cmdLine.add("track-reflection-metadata=" + trackReflectionMetadata);
return cmdLine;
}

public Collection<String> getAgentFiles() {
List<String> files = new ArrayList<>(callerFilterFiles.size() + accessFilterFiles.size());
files.addAll(callerFilterFiles);
files.addAll(accessFilterFiles);
files.addAll(agentMode.getInputFiles());
return files;
}

public boolean isEnabled() {
return !(agentMode instanceof DisabledAgentMode);
}

public static void appendOptionToValues(String option, Collection<String> values, Collection<String> target) {
values.stream().map(value -> option + value).forEach(target::add);
}

public AgentMode getAgentMode() {
return agentMode;
}
}
@@ -0,0 +1,52 @@
/*
* Copyright (c) 2022, 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.agent;

import java.io.Serializable;
import java.util.List;

public interface AgentMode extends Serializable {
List<String> getAgentCommandLine();

List<String> getNativeImageConfigureOptions(List<String> inputDirectories, List<String> outputDirectories);

List<String> getInputFiles();
}
@@ -0,0 +1,108 @@
/*
* Copyright (c) 2022, 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.agent;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import static org.graalvm.buildtools.utils.SharedConstants.AGENT_OUTPUT_DIRECTORY_MARKER;
import static org.graalvm.buildtools.utils.SharedConstants.AGENT_OUTPUT_DIRECTORY_OPTION;

public class ConditionalAgentMode implements AgentMode {

private final String userCodeFilterPath;
private final String extraFilterPath;
private final boolean parallel;

public ConditionalAgentMode(String userCodeFilterPath, String extraFilterPath, boolean parallel) {
this.userCodeFilterPath = userCodeFilterPath;
this.extraFilterPath = extraFilterPath;
this.parallel = parallel;
}

@Override
public List<String> getAgentCommandLine() {
List<String> cmdLine = new ArrayList<>();
cmdLine.add(AGENT_OUTPUT_DIRECTORY_OPTION + AGENT_OUTPUT_DIRECTORY_MARKER);
if (parallel) {
cmdLine.add("experimental-conditional-config-part");
} else {
cmdLine.add("experimental-conditional-config-filter-file=" + userCodeFilterPath);
if (!extraFilterPath.isEmpty()) {
cmdLine.add("conditional-config-class-filter-file=" + extraFilterPath);
}
}
return cmdLine;
}

@Override
public List<String> getNativeImageConfigureOptions(List<String> inputDirectories, List<String> outputDirectories) {
int inputDirCount = inputDirectories.size();
int outputDirCount = outputDirectories.size();
if (inputDirCount > 0 && outputDirCount > 0) {
List<String> cmdLine = new ArrayList<>(inputDirCount + outputDirCount + 3);
if (parallel) {
cmdLine.add("generate-conditional");
cmdLine.add("--user-code-filter=" + userCodeFilterPath);
if (!extraFilterPath.isEmpty()) {
cmdLine.add("--class-name-filter=" + extraFilterPath);
}
} else {
cmdLine.add("generate");
}
AgentConfiguration.appendOptionToValues("--input-dir=", inputDirectories, cmdLine);
AgentConfiguration.appendOptionToValues("--output-dir=", outputDirectories, cmdLine);
return cmdLine;
}
return Collections.emptyList();
}

@Override
public List<String> getInputFiles() {
List<String> files = new ArrayList<>();
files.add(userCodeFilterPath);
if (!extraFilterPath.isEmpty()) {
files.add(extraFilterPath);
}
return files;
}
}