diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..eacac9a --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.idea +.gradle +build +*.so \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ba7b08..5d6f7b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ +- Add example project which generates a dynamic library using gccjit - Adjust generated sources path to match other JavaCPP presets - Add experimental build for Linux ppc64le ([pull #5](https://github.com/bytedeco/gcc/pull/5)) - Add environment for running aarch64, ppc64le, armhf builds ([pull #6](https://github.com/bytedeco/gcc/pull/6)) diff --git a/README.md b/README.md index f9bb4e8..1a3e567 100644 --- a/README.md +++ b/README.md @@ -31,5 +31,138 @@ from the rest of the JavaCPP Presets CI envs. This is a temporary solution and primarily a proof-of-concept. Please open an issue/discussion if you're in need of these architectures or if an architecture you need is not available. +## Sample Usage + +This is an example showing how to build and generate code via libgccjit and +outputting it into a dynamic library. +[/samples/code-generation/](samples/code-generation) + +> Sample showing how to call JIT-generated functions is work-in-progress. + +We can use Gradle to install the required dependencies and native binaries +built by JavaCPP. + +The `build.gradle` build file + +```groovy +plugins { + id("application") +} + +repositories { + mavenLocal() + mavenCentral() + maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } +} + +dependencies { + implementation("org.bytedeco:gcc-platform:10.2.0-1.5.5-SNAPSHOT") +} + +application { + mainClass = 'HelloWorld' +} +``` + +The `DylibGenerator.java` source file + +```java +import org.bytedeco.gcc.gccjit.*; +import org.bytedeco.javacpp.*; + +import static org.bytedeco.gcc.global.gccjit.*; + +public class DylibGenerator { + public static void main(String[] args) { + gcc_jit_context ctxt = gcc_jit_context_acquire(); + gcc_jit_context_set_bool_option(ctxt, GCC_JIT_BOOL_OPTION_DUMP_GENERATED_CODE, 1); + + create_code(ctxt); + + gcc_jit_context_compile_to_file(ctxt, GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY, "libhello.so"); + gcc_jit_context_release(ctxt); + } + + public static void create_code(gcc_jit_context ctxt) { + gcc_jit_type void_type = gcc_jit_context_get_type(ctxt, GCC_JIT_TYPE_VOID); + gcc_jit_type const_char_ptr_type = gcc_jit_context_get_type(ctxt, GCC_JIT_TYPE_CONST_CHAR_PTR); + gcc_jit_type int_type = gcc_jit_context_get_type(ctxt, GCC_JIT_TYPE_INT); + gcc_jit_param param_name = gcc_jit_context_new_param(ctxt, null, const_char_ptr_type, "name"); + gcc_jit_param[] func_params = { param_name }; + + PointerPointer func_params_ptr = new PointerPointer<>(func_params); + BytePointer func_name = new BytePointer("greet"); + gcc_jit_function greet_func = gcc_jit_context_new_function(ctxt, null, GCC_JIT_FUNCTION_EXPORTED, void_type, + func_name, func_params.length, func_params_ptr, 0); + + gcc_jit_param param_format = gcc_jit_context_new_param(ctxt, null, const_char_ptr_type, "format"); + gcc_jit_param[] printf_params = { param_format }; + + PointerPointer printf_params_ptr = new PointerPointer<>(printf_params); + BytePointer printf_name = new BytePointer("printf"); + gcc_jit_function printf_func = gcc_jit_context_new_function(ctxt, null, GCC_JIT_FUNCTION_IMPORTED, int_type, + printf_name, printf_params.length, printf_params_ptr, 0); + + gcc_jit_block block = gcc_jit_function_new_block(greet_func, "entry"); + BytePointer format = new BytePointer("hello %s\\n"); + gcc_jit_rvalue format_rvalue = gcc_jit_context_new_rvalue_from_ptr(ctxt, const_char_ptr_type, format); + gcc_jit_rvalue call = gcc_jit_context_new_call(ctxt, null, printf_func, 1, format_rvalue); + gcc_jit_block_add_eval(block, null, call); + + gcc_jit_block_end_with_void_return(block, null); + + func_name.deallocate(); + func_params_ptr.deallocate(); + printf_name.deallocate(); + printf_params_ptr.deallocate(); + format.deallocate(); + } +} +``` + +> The below explanation assumes a Linux environment. I tested this on Linux +> x86_64 + +The above program should output something similar to the following to the +terminal window on x86_64. Assembler output for other architectures will +obviously be different. + +```asm + .file "fake.c" + .text + .globl greet + .type greet, @function +greet: +.LFB0: + .cfi_startproc + pushq %rbp + .cfi_def_cfa_offset 16 + .cfi_offset 6, -16 + movq %rsp, %rbp + .cfi_def_cfa_register 6 + subq $16, %rsp + movq %rdi, -8(%rbp) +.L2: + movabsq $139992918400400, %rdi + call printf@PLT + leave + .cfi_def_cfa 7, 8 + ret + .cfi_endproc +.LFE0: + .size greet, .-greet + .ident "GCC: (GNU) 10.2.0" + .section .note.GNU-stack,"",@progbits +``` + +The `$139992918400400` operand to the movabsq instruction is expected as +it refers to our `"hello %s\n"` string we created. + +If we look in the directory we invoked the program in we should have a +`libhello.so` file which is dynamically linkable. Looking inside the shared +library file with `nm libhello.so | grep "greet"` we can see that the greet +function is indeed there. + [javacpp-presets]: https://github.com/bytedeco/javacpp-presets#readme -[libgccjit]: https://gcc.gnu.org/wiki/JIT \ No newline at end of file +[libgccjit]: https://gcc.gnu.org/wiki/JIT + diff --git a/build.gradle b/build.gradle index a6a6ca5..6689976 100644 --- a/build.gradle +++ b/build.gradle @@ -11,14 +11,15 @@ group = "org.bytedeco" version = "10.2.0-$javacppVersion" repositories { + mavenLocal() mavenCentral() maven { url "https://oss.sonatype.org/content/repositories/snapshots/" } } dependencies { api "org.bytedeco:javacpp:$javacppVersion" + javacppPlatform "org.bytedeco:javacpp-platform:$javacppVersion" javacppPlatform "org.bytedeco:gcc:$version:linux-x86_64" - javacppPlatform "org.bytedeco:gcc:$version:linux-ppc64le" testRuntimeOnly "org.bytedeco:javacpp:$javacppVersion:$javacppPlatform" testImplementation "junit:junit:4.13.1" diff --git a/build.sh b/build.sh index c906ff7..afda4b2 100644 --- a/build.sh +++ b/build.sh @@ -30,7 +30,7 @@ case $PLATFORM in --target=powerpc64le-linux-gnu \ --prefix=$GCC_INSTALL_PREFIX \ --enable-checking=release \ - --enable-languages=jit \ + --enable-languages=jit,c,c++ \ --enable-host-shared \ --disable-bootstrap \ --disable-multilib \ @@ -49,7 +49,7 @@ case $PLATFORM in ../gcc-$GCC_VERSION/configure \ --prefix=$GCC_INSTALL_PREFIX \ --enable-checking=release \ - --enable-languages=jit \ + --enable-languages=jit,c,c++ \ --enable-host-shared \ --disable-bootstrap \ --disable-multilib \ diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..be52383 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/samples/code-generation/build.gradle b/samples/code-generation/build.gradle new file mode 100644 index 0000000..b084d76 --- /dev/null +++ b/samples/code-generation/build.gradle @@ -0,0 +1,17 @@ +plugins { + id("application") +} + +repositories { + mavenLocal() + mavenCentral() + maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } +} + +dependencies { + implementation("org.bytedeco:gcc-platform:10.2.0-1.5.5-SNAPSHOT") +} + +application { + mainClass = 'DylibGenerator' +} \ No newline at end of file diff --git a/samples/code-generation/gradle/wrapper/gradle-wrapper.jar b/samples/code-generation/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c Binary files /dev/null and b/samples/code-generation/gradle/wrapper/gradle-wrapper.jar differ diff --git a/samples/code-generation/gradle/wrapper/gradle-wrapper.properties b/samples/code-generation/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..be52383 --- /dev/null +++ b/samples/code-generation/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/samples/code-generation/gradlew b/samples/code-generation/gradlew new file mode 100755 index 0000000..4f906e0 --- /dev/null +++ b/samples/code-generation/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed 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 +# +# https://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. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +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 + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/samples/code-generation/gradlew.bat b/samples/code-generation/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/samples/code-generation/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/samples/code-generation/settings.gradle b/samples/code-generation/settings.gradle new file mode 100644 index 0000000..f11be3d --- /dev/null +++ b/samples/code-generation/settings.gradle @@ -0,0 +1 @@ +rootProject.name = "gcc-sample-code-generator" \ No newline at end of file diff --git a/samples/code-generation/src/main/java/DylibGenerator.java b/samples/code-generation/src/main/java/DylibGenerator.java new file mode 100644 index 0000000..5d13754 --- /dev/null +++ b/samples/code-generation/src/main/java/DylibGenerator.java @@ -0,0 +1,51 @@ +import org.bytedeco.gcc.gccjit.*; +import org.bytedeco.javacpp.*; + +import static org.bytedeco.gcc.global.gccjit.*; + +public class DylibGenerator { + public static void main(String[] args) { + gcc_jit_context ctxt = gcc_jit_context_acquire(); + gcc_jit_context_set_bool_option(ctxt, GCC_JIT_BOOL_OPTION_DUMP_GENERATED_CODE, 1); + + create_code(ctxt); + + gcc_jit_context_compile_to_file(ctxt, GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY, "libhello.so"); + gcc_jit_context_release(ctxt); + } + + public static void create_code(gcc_jit_context ctxt) { + gcc_jit_type void_type = gcc_jit_context_get_type(ctxt, GCC_JIT_TYPE_VOID); + gcc_jit_type const_char_ptr_type = gcc_jit_context_get_type(ctxt, GCC_JIT_TYPE_CONST_CHAR_PTR); + gcc_jit_type int_type = gcc_jit_context_get_type(ctxt, GCC_JIT_TYPE_INT); + gcc_jit_param param_name = gcc_jit_context_new_param(ctxt, null, const_char_ptr_type, "name"); + gcc_jit_param[] func_params = { param_name }; + + PointerPointer func_params_ptr = new PointerPointer<>(func_params); + BytePointer func_name = new BytePointer("greet"); + gcc_jit_function greet_func = gcc_jit_context_new_function(ctxt, null, GCC_JIT_FUNCTION_EXPORTED, void_type, + func_name, func_params.length, func_params_ptr, 0); + + gcc_jit_param param_format = gcc_jit_context_new_param(ctxt, null, const_char_ptr_type, "format"); + gcc_jit_param[] printf_params = { param_format }; + + PointerPointer printf_params_ptr = new PointerPointer<>(printf_params); + BytePointer printf_name = new BytePointer("printf"); + gcc_jit_function printf_func = gcc_jit_context_new_function(ctxt, null, GCC_JIT_FUNCTION_IMPORTED, int_type, + printf_name, printf_params.length, printf_params_ptr, 0); + + gcc_jit_block block = gcc_jit_function_new_block(greet_func, "entry"); + BytePointer format = new BytePointer("hello %s\\n"); + gcc_jit_rvalue format_rvalue = gcc_jit_context_new_rvalue_from_ptr(ctxt, const_char_ptr_type, format); + gcc_jit_rvalue call = gcc_jit_context_new_call(ctxt, null, printf_func, 1, format_rvalue); + gcc_jit_block_add_eval(block, null, call); + + gcc_jit_block_end_with_void_return(block, null); + + func_name.deallocate(); + func_params_ptr.deallocate(); + printf_name.deallocate(); + printf_params_ptr.deallocate(); + format.deallocate(); + } +} \ No newline at end of file