diff --git a/.github/workflows/fortune-demo.yml b/.github/workflows/native-build-tools-gradle.yml similarity index 50% rename from .github/workflows/fortune-demo.yml rename to .github/workflows/native-build-tools-gradle.yml index 737dc2823..f0069dd3c 100644 --- a/.github/workflows/fortune-demo.yml +++ b/.github/workflows/native-build-tools-gradle.yml @@ -1,13 +1,13 @@ -name: fortune-demo +name: native-build-tools-gradle on: push: paths: - - 'fortune-demo/**' - - '.github/workflows/fortune-demo.yml' + - 'native-image/native-build-tools/gradle-plugin/**' + - '.github/workflows/native-build-tools-gradle.yml' pull_request: paths: - - 'fortune-demo/**' - - '.github/workflows/fortune-demo.yml' + - 'native-image/native-build-tools/gradle-plugin/**' + - '.github/workflows/native-build-tools-gradle.yml' schedule: - cron: "0 0 1 * *" # run every month workflow_dispatch: @@ -15,7 +15,7 @@ permissions: contents: read jobs: run: - name: Run 'fortune-demo' + name: Run 'native-build-tools-gradle' runs-on: ubuntu-latest timeout-minutes: 30 steps: @@ -25,11 +25,7 @@ jobs: java-version: '21' distribution: 'graalvm' github-token: ${{ secrets.GITHUB_TOKEN }} - - name: Run 'fortune' + - name: Run 'native-build-tools-gradle' run: | - cd fortune-demo/fortune-maven - ./build.sh - - name: Run 'fortune-gradle' - run: | - cd fortune-demo/fortune-gradle - ./build.sh + cd native-image/native-build-tools/gradle-plugin + ./run.sh \ No newline at end of file diff --git a/.github/workflows/native-build-tools-maven.yml b/.github/workflows/native-build-tools-maven.yml new file mode 100644 index 000000000..a91526352 --- /dev/null +++ b/.github/workflows/native-build-tools-maven.yml @@ -0,0 +1,31 @@ +name: native-build-tools-maven +on: + push: + paths: + - 'native-image/native-build-tools/maven-plugin/**' + - '.github/workflows/native-build-tools-maven.yml' + pull_request: + paths: + - 'native-image/native-build-tools/maven-plugin/**' + - '.github/workflows/native-build-tools-maven.yml' + schedule: + - cron: "0 0 1 * *" # run every month + workflow_dispatch: +permissions: + contents: read +jobs: + run: + name: Run 'native-build-tools-maven' + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - uses: actions/checkout@v4 + - uses: graalvm/setup-graalvm@v1 + with: + java-version: '24-ea' + distribution: 'graalvm' + github-token: ${{ secrets.GITHUB_TOKEN }} + - name: Run 'native-build-tools-maven' + run: | + cd native-image/native-build-tools/maven-plugin + ./run.sh \ No newline at end of file diff --git a/README.md b/README.md index b3d85fc71..f08fb10e3 100644 --- a/README.md +++ b/README.md @@ -47,10 +47,6 @@ cd graalvm-demos java-simple-stream-benchmark
java-simple-stream-benchmark Demonstrates how the Graal compiler can achieve better performance for highly abstracted programs like those using Streams, Lambdas
Technologies: Graal compiler, C2
Reference: Simple Java Stream Benchmark - - fortune-demo
fortune-demo - A fortune teller Unix program. Build a native executable using Gradle or Maven Native Image plugins.
Technologies: Native Image, Native Build Tools Maven plugin
Reference: Getting Started with Maven Plugin for GraalVM Native Image - multithreading-demo
streams Demonstrates how to optimize a Java application that does synchronous and asynchronous threads execution
Technologies: Native Image Build Reports, Native Build Tools Maven plugin
Reference: Making sense of Native Image contents diff --git a/fortune-demo/README.md b/fortune-demo/README.md deleted file mode 100644 index 424f37b48..000000000 --- a/fortune-demo/README.md +++ /dev/null @@ -1,64 +0,0 @@ -# Native Image Fortune Demo - -The demo is a Java program that simulates the traditional `fortune` Unix program (for more information, see [fortune](https://en.wikipedia.org/wiki/Fortune_(Unix))). The data for the fortune phrases is provided by [YourFortune](https://github.com/your-fortune). - -The Fortune demo is comprised of three sub-projects: -- The _fortune-maven_ project uses the [Maven plugin for GraalVM Native Image building](https://graalvm.github.io/native-build-tools/latest/maven-plugin.html). -- The _fortune-gradle_ project uses the [Gradle plugin for GraalVM Native Image building](https://graalvm.github.io/native-build-tools/latest/gradle-plugin.html). - -## Preparation - -1. Download and install GraalVM. The easiest way for Linux/macOS is with [SDKMAN!](https://sdkman.io/jdks#graal): - ```bash - sdk install java -graal - ``` - For other installation options, visit the [Downloads](https://www.graalvm.org/downloads/) section. - -2. Download or clone the GraalVM demos repository: - ```bash - git clone https://github.com/graalvm/graalvm-demos - ``` - -## Fortune Maven Demo - -1. Change to the _fortune-demo/fortune-maven_ directory: - ```bash - cd fortune-demo/fortune-maven - ``` - -2. Create a native executable using the [Maven plugin for Native Image](https://graalvm.github.io/native-build-tools/latest/maven-plugin.html): - ```bash - mvn -Pnative package - ``` - The command compiles the project, creates a JAR file with all dependencies, and then generates a native executable, `fortune`, in the _target/_ directory, ready for use. - -3. Run the application: - ```bash - ./target/fortune - ``` - The application will return a random saying. - -## Fortune Gradle Demo - -> Requires GraalVM for JDK 21 for compatibility with Gradle. See [Gradle Java Compatibility Matrix](https://docs.gradle.org/current/userguide/compatibility.html). - -1. Change to the _fortune-demo/fortune-gradle/_ directory: - ```bash - cd ../fortune-gradle - ``` - -2. Create a native executable using the [Gradle plugin for Native Image](https://graalvm.github.io/native-build-tools/latest/gradle-plugin.html): - ```bash - ./gradlew nativeCompile - ``` - When the command completes, a native executable, `fortune`, is generated in the _build/native/nativeCompile/_ directory of the project and ready for use. - -3. Run the native executable: - ```bash - ./fortune/build/native/nativeCompile/fortune - ``` - -### Learn More - -- [Native Image and Static Linking](https://www.graalvm.org/latest/reference-manual/native-image/guides/build-static-executables/) -- [Native Build Tools](https://graalvm.github.io/native-build-tools/latest/index.html) \ No newline at end of file diff --git a/fortune-demo/fortune-gradle/build.sh b/fortune-demo/fortune-gradle/build.sh deleted file mode 100755 index 794c36ed6..000000000 --- a/fortune-demo/fortune-gradle/build.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/bash - -# Exit on error -set -e - -# Run the application with the agent on JVM -./gradlew -Pagent run -# Build a native executable using configuration (`nativeRun` compiles the app, then invokes `nativeCompile`, and then runs the native binary) -./gradlew nativeCompile -# Run the application -./fortune/build/native/nativeCompile/fortune \ No newline at end of file diff --git a/fortune-demo/fortune-maven/build.sh b/fortune-demo/fortune-maven/build.sh deleted file mode 100755 index c20549efd..000000000 --- a/fortune-demo/fortune-maven/build.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/bash - -# Exit on error -set -e - -# Build the native executable -mvn -Pnative package -# Run the application -./target/fortune \ No newline at end of file diff --git a/fortune-demo/fortune-maven/pom.xml b/fortune-demo/fortune-maven/pom.xml deleted file mode 100644 index 3bdf2a4e5..000000000 --- a/fortune-demo/fortune-maven/pom.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - 4.0.0 - - demo - fortune - 1.0-SNAPSHOT - - - 21 - 21 - 0.10.2 - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.12.1 - - true - - - - org.apache.maven.plugins - maven-jar-plugin - 3.3.0 - - - - demo.Fortune - true - - - - - - - - - - native - - - - org.graalvm.buildtools - native-maven-plugin - ${native.maven.plugin.version} - true - - - build-native - - compile-no-fork - - package - - - test-native - - test - - test - - - - - - - - - - - \ No newline at end of file diff --git a/native-image/native-build-tools/gradle-plugin/README.md b/native-image/native-build-tools/gradle-plugin/README.md new file mode 100644 index 000000000..22e840fcd --- /dev/null +++ b/native-image/native-build-tools/gradle-plugin/README.md @@ -0,0 +1,23 @@ +# Use Gradle to Build a Java Application from a Java Application + +The demo application simulates the traditional [fortune](https://en.wikipedia.org/wiki/Fortune_(Unix)) Unix program. +The data for the fortune phrases is provided by [YourFortune](https://github.com/your-fortune). + +The project uses the [Gradle plugin for GraalVM Native Image building](https://graalvm.github.io/native-build-tools/latest/gradle-plugin.html). + +## Run the Demo + +1. Run the application on JVM: + ```bash + ./gradlew run + ``` +2. Build a native executable: + ```bash + ./gradlew nativeRun + ``` + The `nativeRun` task compiles the application, invokes `nativeCompile`, and then runs the executable. +3. Re-run the application from the native executable: + ```bash + ./build/native/nativeCompile/fortune + ``` +Alternatively, you can execute `./run.sh` to build and run the application. \ No newline at end of file diff --git a/fortune-demo/fortune-gradle/fortune/build.gradle b/native-image/native-build-tools/gradle-plugin/build.gradle similarity index 93% rename from fortune-demo/fortune-gradle/fortune/build.gradle rename to native-image/native-build-tools/gradle-plugin/build.gradle index 373f9ab12..f049fa7e8 100644 --- a/fortune-demo/fortune-gradle/fortune/build.gradle +++ b/native-image/native-build-tools/gradle-plugin/build.gradle @@ -9,7 +9,7 @@ plugins { // Apply the application plugin to add support for building a CLI application in Java. id 'application' - id 'org.graalvm.buildtools.native' version '0.10.2' + id 'org.graalvm.buildtools.native' version '0.10.3' } repositories { @@ -36,6 +36,7 @@ graalvmNative { binaries { main { imageName.set('fortune') + buildArgs.add("-Ob") } } toolchainDetection = false diff --git a/fortune-demo/fortune-gradle/gradle/wrapper/gradle-wrapper.jar b/native-image/native-build-tools/gradle-plugin/gradle/wrapper/gradle-wrapper.jar similarity index 100% rename from fortune-demo/fortune-gradle/gradle/wrapper/gradle-wrapper.jar rename to native-image/native-build-tools/gradle-plugin/gradle/wrapper/gradle-wrapper.jar diff --git a/fortune-demo/fortune-gradle/gradle/wrapper/gradle-wrapper.properties b/native-image/native-build-tools/gradle-plugin/gradle/wrapper/gradle-wrapper.properties similarity index 100% rename from fortune-demo/fortune-gradle/gradle/wrapper/gradle-wrapper.properties rename to native-image/native-build-tools/gradle-plugin/gradle/wrapper/gradle-wrapper.properties diff --git a/fortune-demo/fortune-gradle/gradlew b/native-image/native-build-tools/gradle-plugin/gradlew similarity index 100% rename from fortune-demo/fortune-gradle/gradlew rename to native-image/native-build-tools/gradle-plugin/gradlew diff --git a/fortune-demo/fortune-gradle/gradlew.bat b/native-image/native-build-tools/gradle-plugin/gradlew.bat similarity index 100% rename from fortune-demo/fortune-gradle/gradlew.bat rename to native-image/native-build-tools/gradle-plugin/gradlew.bat diff --git a/native-image/native-build-tools/gradle-plugin/run.sh b/native-image/native-build-tools/gradle-plugin/run.sh new file mode 100755 index 000000000..ff6dc0a03 --- /dev/null +++ b/native-image/native-build-tools/gradle-plugin/run.sh @@ -0,0 +1,7 @@ +#!/usr/bin/env bash +set -ex + +# Run the application on the JVM +./gradlew clean run +# Build and run a native executable (`nativeRun` compiles the application, invokes `nativeCompile`, and then runs the executable) +./gradlew nativeRun \ No newline at end of file diff --git a/fortune-demo/fortune-gradle/settings.gradle b/native-image/native-build-tools/gradle-plugin/settings.gradle similarity index 100% rename from fortune-demo/fortune-gradle/settings.gradle rename to native-image/native-build-tools/gradle-plugin/settings.gradle diff --git a/fortune-demo/fortune-maven/src/main/java/demo/Fortune.java b/native-image/native-build-tools/gradle-plugin/src/main/java/demo/Fortune.java similarity index 100% rename from fortune-demo/fortune-maven/src/main/java/demo/Fortune.java rename to native-image/native-build-tools/gradle-plugin/src/main/java/demo/Fortune.java diff --git a/fortune-demo/fortune-gradle/fortune/src/main/resources/META-INF/native-image/resource-config.json b/native-image/native-build-tools/gradle-plugin/src/main/resources/META-INF/native-image/resource-config.json similarity index 100% rename from fortune-demo/fortune-gradle/fortune/src/main/resources/META-INF/native-image/resource-config.json rename to native-image/native-build-tools/gradle-plugin/src/main/resources/META-INF/native-image/resource-config.json diff --git a/fortune-demo/fortune-gradle/fortune/src/main/resources/fortunes.u8 b/native-image/native-build-tools/gradle-plugin/src/main/resources/fortunes.u8 similarity index 100% rename from fortune-demo/fortune-gradle/fortune/src/main/resources/fortunes.u8 rename to native-image/native-build-tools/gradle-plugin/src/main/resources/fortunes.u8 diff --git a/native-image/native-build-tools/maven-plugin/.mvn/wrapper/maven-wrapper.properties b/native-image/native-build-tools/maven-plugin/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 000000000..a6cd062b9 --- /dev/null +++ b/native-image/native-build-tools/maven-plugin/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.5/apache-maven-3.8.5-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/native-image/native-build-tools/maven-plugin/README.md b/native-image/native-build-tools/maven-plugin/README.md new file mode 100644 index 000000000..e3cfdec42 --- /dev/null +++ b/native-image/native-build-tools/maven-plugin/README.md @@ -0,0 +1,8 @@ +# Use Maven to Build a Java Application from a Java Application + +The demo application simulates the traditional [fortune](https://en.wikipedia.org/wiki/Fortune_(Unix)) Unix program. +The data for the fortune phrases is provided by [YourFortune](https://github.com/your-fortune). + +The project uses the [Maven plugin for GraalVM Native Image building](https://graalvm.github.io/native-build-tools/latest/maven-plugin.html). + +You can find the steps to run this demo in the [Optimize a Native Executable for File Size guide](https://www.graalvm.org/latest/reference-manual/native-image/guides/optimize-for-file-size/). \ No newline at end of file diff --git a/native-image/native-build-tools/maven-plugin/mvnw b/native-image/native-build-tools/maven-plugin/mvnw new file mode 100755 index 000000000..8d937f4c1 --- /dev/null +++ b/native-image/native-build-tools/maven-plugin/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/native-image/native-build-tools/maven-plugin/mvnw.cmd b/native-image/native-build-tools/maven-plugin/mvnw.cmd new file mode 100644 index 000000000..f80fbad3e --- /dev/null +++ b/native-image/native-build-tools/maven-plugin/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/native-image/native-build-tools/maven-plugin/pom.xml b/native-image/native-build-tools/maven-plugin/pom.xml new file mode 100644 index 000000000..3cd1b8a79 --- /dev/null +++ b/native-image/native-build-tools/maven-plugin/pom.xml @@ -0,0 +1,97 @@ + + + 4.0.0 + + demo + fortune + 1.0-SNAPSHOT + + + 21 + 21 + 0.10.3 + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.12.1 + + true + + + + org.apache.maven.plugins + maven-jar-plugin + 3.3.0 + + + + demo.Fortune + true + + + + + + + + + + native + + + + org.graalvm.buildtools + native-maven-plugin + ${native.maven.plugin.version} + true + + + build-native + + compile-no-fork + + package + + + + + + + + native-size-optimized + + + + org.graalvm.buildtools + native-maven-plugin + ${native.maven.plugin.version} + true + + + build-native + + compile-no-fork + + package + + + + fortune-optimized + + -Os + --emit build-report + + + + + + + + + \ No newline at end of file diff --git a/native-image/native-build-tools/maven-plugin/run.sh b/native-image/native-build-tools/maven-plugin/run.sh new file mode 100755 index 000000000..eb65f1c56 --- /dev/null +++ b/native-image/native-build-tools/maven-plugin/run.sh @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -ex + +./mvnw -Pnative package +./target/fortune +./mvnw -Pnative-size-optimized package +./target/fortune-optimized +du -h target/fortune* \ No newline at end of file diff --git a/fortune-demo/fortune-gradle/fortune/src/main/java/demo/Fortune.java b/native-image/native-build-tools/maven-plugin/src/main/java/demo/Fortune.java similarity index 61% rename from fortune-demo/fortune-gradle/fortune/src/main/java/demo/Fortune.java rename to native-image/native-build-tools/maven-plugin/src/main/java/demo/Fortune.java index 4aa559fdd..5ecabfbf2 100644 --- a/fortune-demo/fortune-gradle/fortune/src/main/java/demo/Fortune.java +++ b/native-image/native-build-tools/maven-plugin/src/main/java/demo/Fortune.java @@ -39,40 +39,40 @@ * SOFTWARE. */ - package demo; +package demo; - import java.io.BufferedReader; - import java.io.InputStreamReader; - import java.util.ArrayList; - import java.util.Random; - import java.util.Scanner; - - public class Fortune { - - private static final String SEPARATOR = "%"; - private static final Random RANDOM = new Random(); - private ArrayList fortunes = new ArrayList<>(); - - public Fortune(String path) { - // Scan the file into the array of fortunes - Scanner s = new Scanner(new BufferedReader(new InputStreamReader(this.getClass().getResourceAsStream(path)))); - s.useDelimiter(SEPARATOR); - while (s.hasNext()) { - fortunes.add(s.next()); - } - } - - private void printRandomFortune() throws InterruptedException { - int r = RANDOM.nextInt(fortunes.size()); //Pick a random number - String f = fortunes.get(r); //Use the random number to pick a random fortune - for (char c: f.toCharArray()) { // Print out the fortune - System.out.print(c); - Thread.sleep(100); - } - } - - public static void main(String[] args) throws InterruptedException { - Fortune fortune = new Fortune("/fortunes.u8"); - fortune.printRandomFortune(); - } - } \ No newline at end of file +import java.io.BufferedReader; +import java.io.InputStreamReader; +import java.util.ArrayList; +import java.util.Random; +import java.util.Scanner; + +public class Fortune { + + private static final String SEPARATOR = "%"; + private static final Random RANDOM = new Random(); + private final ArrayList fortunes = new ArrayList<>(); + + public Fortune(String path) { + // Scan the file into the array of fortunes + Scanner s = new Scanner(new BufferedReader(new InputStreamReader(this.getClass().getResourceAsStream(path)))); + s.useDelimiter(SEPARATOR); + while (s.hasNext()) { + fortunes.add(s.next()); + } + } + + private void printRandomFortune() throws InterruptedException { + int r = RANDOM.nextInt(fortunes.size()); //Pick a random number + String f = fortunes.get(r); //Use the random number to pick a random fortune + for (char c: f.toCharArray()) { // Print out the fortune + System.out.print(c); + Thread.sleep(100); + } + } + + public static void main(String[] args) throws InterruptedException { + Fortune fortune = new Fortune("/fortunes.u8"); + fortune.printRandomFortune(); + } +} \ No newline at end of file diff --git a/fortune-demo/fortune-maven/src/main/resources/META-INF/native-image/resource-config.json b/native-image/native-build-tools/maven-plugin/src/main/resources/META-INF/native-image/resource-config.json similarity index 100% rename from fortune-demo/fortune-maven/src/main/resources/META-INF/native-image/resource-config.json rename to native-image/native-build-tools/maven-plugin/src/main/resources/META-INF/native-image/resource-config.json diff --git a/fortune-demo/fortune-maven/src/main/resources/fortunes.u8 b/native-image/native-build-tools/maven-plugin/src/main/resources/fortunes.u8 similarity index 100% rename from fortune-demo/fortune-maven/src/main/resources/fortunes.u8 rename to native-image/native-build-tools/maven-plugin/src/main/resources/fortunes.u8