diff --git a/README.md b/README.md index 4502e67..39b1b13 100644 --- a/README.md +++ b/README.md @@ -419,6 +419,53 @@ end. ``` + + + +### ruapu with Java + + + + +
+ +Compile ruapu library and example + +```shell +./gradlew build +``` +Run example +```shell +java -cp \ + ./build/libs/ruapu-1.0-SNAPSHOT.jar \ + ./Example.java +``` + + + + +Use ruapu in Java + +```java +import ruapu.Ruapu; +import java.util.*; + +class Example { + public static void main(String args[]) { + Ruapu ruapu = new Ruapu(); + + System.out.println("avx: " + ruapu.supports("avx")); + // avx: 1 + System.out.println(Arrays.toString(ruapu.rua())); + // [mmx, sse, sse2, sse3, ssse3, sse41, sse42, avx, f16c, fma, avx2] + } +} + +``` + + + +
diff --git a/java/.gitignore b/java/.gitignore new file mode 100644 index 0000000..f35ca9e --- /dev/null +++ b/java/.gitignore @@ -0,0 +1,39 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store \ No newline at end of file diff --git a/java/CMakeLists.txt b/java/CMakeLists.txt new file mode 100644 index 0000000..26cd63c --- /dev/null +++ b/java/CMakeLists.txt @@ -0,0 +1,12 @@ +cmake_minimum_required(VERSION 2.8) +project(ruava) +set(CMAKE_BUILD_TYPE Release) + +option(BUILD_EXAMPLE OFF) + +find_package(JNI REQUIRED) + +add_library(ruapu_binding SHARED ruapu_binding.c) +target_include_directories(ruapu_binding PRIVATE ../ ${JNI_INCLUDE_DIRS}) +install(TARGETS ruapu_binding DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/install/ruapu) + diff --git a/java/Example.java b/java/Example.java new file mode 100644 index 0000000..be42726 --- /dev/null +++ b/java/Example.java @@ -0,0 +1,11 @@ +import ruapu.Ruapu; +import java.util.*; + +class Example { + public static void main(String args[]) { + Ruapu ruapu = new Ruapu(); + + System.out.println("avx: " + ruapu.supports("avx")); + System.out.println(Arrays.toString(ruapu.rua())); + } +} \ No newline at end of file diff --git a/java/build.bat b/java/build.bat new file mode 100644 index 0000000..5aca0ce --- /dev/null +++ b/java/build.bat @@ -0,0 +1,2 @@ +cmake -B build/cmake +cmake --build build/cmake --config Release --target install \ No newline at end of file diff --git a/java/build.gradle.kts b/java/build.gradle.kts new file mode 100644 index 0000000..af27b0b --- /dev/null +++ b/java/build.gradle.kts @@ -0,0 +1,49 @@ +plugins { + id("java") +} + +group = "ruapu" +version = "1.0-SNAPSHOT" + +repositories { + mavenCentral() +} + +dependencies { + testImplementation(platform("org.junit:junit-bom:5.9.1")) + testImplementation("org.junit.jupiter:junit-jupiter") +} + +tasks.test { + useJUnitPlatform() +} + +val host: String = System.getProperty("os.name")!! + +tasks.register("buildJNI") { + doLast { + val shell = when { + host.startsWith("Windows") -> "cmd" + else -> "bash" + } + val command = when { + host.startsWith("Windows") -> "/c" + else -> "-c" + } + val script = when { + host.startsWith("Windows") -> "build.bat" + else -> "./build.sh" + } + exec { + commandLine(shell, command, script) + } + } +} + +// copy cmake build library to java resources +tasks.jar { + dependsOn("buildJNI") + from("build/cmake/install/ruapu") { + include("*.dll", "*.so", "*.dylib") + } +} \ No newline at end of file diff --git a/java/build.sh b/java/build.sh new file mode 100755 index 0000000..34ff505 --- /dev/null +++ b/java/build.sh @@ -0,0 +1,2 @@ +cmake -B build/cmake +cmake --build build/cmake --config Release --target install diff --git a/java/gradle/wrapper/gradle-wrapper.jar b/java/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/java/gradle/wrapper/gradle-wrapper.jar differ diff --git a/java/gradle/wrapper/gradle-wrapper.properties b/java/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..add41d4 --- /dev/null +++ b/java/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Sat Mar 09 23:27:24 CST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/java/gradlew b/java/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/java/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original 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 POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${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 "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# 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 ;; #( + MSYS* | 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" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/java/gradlew.bat b/java/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/java/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/java/ruapu_binding.c b/java/ruapu_binding.c new file mode 100644 index 0000000..d119648 --- /dev/null +++ b/java/ruapu_binding.c @@ -0,0 +1,50 @@ +#include "ruapu_binding.h" +#include + +#define RUAPU_IMPLEMENTATION +#include "ruapu.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + + JNIEXPORT void JNICALL Java_ruapu_Ruapu_init(JNIEnv *env, jclass jcls) + { + ruapu_init(); + } + + JNIEXPORT jint JNICALL Java_ruapu_Ruapu_supports(JNIEnv *env, jclass jcls, jstring j_isa) + { + const char *isa = (*env)->GetStringUTFChars(env, j_isa, NULL); + int supported = ruapu_supports(isa); + (*env)->ReleaseStringUTFChars(env, j_isa, isa); + + return supported; + } + + JNIEXPORT jobjectArray JNICALL Java_ruapu_Ruapu_rua(JNIEnv *env, jclass jcls) + { + const char *const *supported = ruapu_rua(); + int size = 0U; + jclass jStringcls = (*env)->FindClass(env, "java/lang/String"); + while (*supported) + { + supported++; + size++; + } + + jobjectArray isa_array = (*env)->NewObjectArray(env, size, jStringcls, NULL); + int total_idx = 0; + supported = ruapu_rua(); + while (*supported) + { + jstring str_isa = (*env)->NewStringUTF(env, *supported++); + (*env)->SetObjectArrayElement(env, isa_array, total_idx++, str_isa); + } + return isa_array; + } + +#ifdef __cplusplus +} +#endif diff --git a/java/ruapu_binding.h b/java/ruapu_binding.h new file mode 100644 index 0000000..af117de --- /dev/null +++ b/java/ruapu_binding.h @@ -0,0 +1,16 @@ +#include + +#ifndef _Included_Ruapu +#define _Included_Ruapu +#ifdef __cplusplus +extern "C" { +#endif + +JNIEXPORT void JNICALL Java_ruapu_Ruapu_init(JNIEnv *env, jclass jcls); +JNIEXPORT jint JNICALL Java_ruapu_Ruapu_supports(JNIEnv *env, jclass jcls, jstring j_isa); +JNIEXPORT jobjectArray JNICALL Java_ruapu_Ruapu_rua(JNIEnv *env, jclass jcls); + +#ifdef __cplusplus +} +#endif +#endif // _Included_Ruapu diff --git a/java/settings.gradle.kts b/java/settings.gradle.kts new file mode 100644 index 0000000..b66aae4 --- /dev/null +++ b/java/settings.gradle.kts @@ -0,0 +1,2 @@ +rootProject.name = "ruapu" + diff --git a/java/src/main/java/ruapu/Ruapu.java b/java/src/main/java/ruapu/Ruapu.java new file mode 100644 index 0000000..367e48b --- /dev/null +++ b/java/src/main/java/ruapu/Ruapu.java @@ -0,0 +1,64 @@ +package ruapu; + +import java.io.*; + +public class Ruapu { + + public Ruapu() { + init(); + } + + public static native void init(); + + public static native int supports(String isa); + + public static native String[] rua(); + + static { + String libName = "ruapu_binding"; + String suffix = ""; + if (System.getProperty("os.name").startsWith("Windows")) { + suffix = ".dll"; + } else if (System.getProperty("os.name").startsWith("Mac")) { + suffix = ".dylib"; + } else { + libName = "libruapu_binding"; + suffix = ".so"; + } + // Extract library to temporary place + File temp = null; + try { + temp = File.createTempFile("ruapu_native_lib", suffix); + } catch (IOException e) { + throw new RuntimeException(e); + } + temp.deleteOnExit(); + InputStream is = Ruapu.class.getResourceAsStream("/" + libName + suffix); + if (is == null) { + throw new RuntimeException("Library " + libName + suffix + " not found in resources!"); + } + OutputStream os = null; + try { + os = new FileOutputStream(temp); + } catch (FileNotFoundException e) { + throw new RuntimeException(e); + } + byte[] buffer = new byte[512]; + int read = -1; + try { + while ((read = is.read(buffer)) != -1) { + os.write(buffer, 0, read); + } + } catch (IOException e) { + throw new RuntimeException(e); + } + try { + is.close(); + os.close(); + } catch (IOException e) { + throw new RuntimeException(e); + } + // load jni library from temporary file. + System.load(temp.getAbsolutePath()); + } +}