JOCL - Java Bindings for OpenCL - http://jocl.org
JOCL is available in Maven Central under the following coordinates:
<dependency> <groupId>org.jocl</groupId> <artifactId>jocl</artifactId> <version>2.0.1</version> </dependency>
In order to build JOCL, create a local working directory, e.g.
C:\JOCLRoot, and clone the required repositories into this
git clone https://github.com/gpu/JOCL.git git clone https://github.com/gpu/JOCLCommon.git
Building the native libraries
The native libraries of JOCL can be built with CMake and any compatible target compiler (e.g. Visual Studio or GCC):
- Set the directory containing the sources of the
- Set the directory for the build files: e.g.
- Press "Configure" (and select the appropriate compiler)
- Press "Generate"
C:\JOCLRoot\JOCL.build will contain the build files, e.g. the
GCC makefiles or the Visual Studio project files. Compiling the project
with these makefiles will place the binaries into a
subdirectory of the project, e.g. into
Building and packaging the external native library dependencies
JOCL itself does not have external dependencies, except for the run-time dependency to the OpenCL implementation. If you only want to compile JOCL, then you can skip this section.
This section only refers to libraries like JOCLBLAS and JOCLBlast, which require installations of external libraries (clBLAS and CLBlast, respectively). The following JOCLBlast and CLBlast, but the same process applies to all other external dependencies.
Compiling and installing CLBlast (as described in its documentation) will
result in directories that contain the header files and the native libraries.
In order to build JOCLBlast, the paths to these header directories and
library files have to be entered in the CMake GUI, as the values of the
After this information has been entered, the JOCLBlast library may be
compiled as described above, under Building the native libraries.
The resulting native JOCLBlast library will be placed into
nativeLibraries directory of the project, for example, into
This library is dynamically linked against the actual CLBlast library.
In order to be able to load this library, the CLBlast library must
be in a specific subdirectory of the
The name of this subdirectory is determined by the operating system and
architecture that the library is compiled for. The general pattern here is
OS here refers to the operating system, and will usually be
ARCHITECTURE refers to the processor architecture
of the target system, and will usually be
x86 (for 32 bit system) or
x86_64 (for 64 bit systems).
For example, on 64 bit Windows, the
clblast.dll will have to be placed
into the directory
There, it will be picked up by the Maven and integrated into the JAR, as described in the next section.
Building the Java libraries
The actual Java libraries can be built with
Apache Maven. After the native libraries
have been built as described above, change into the
mvn clean install
This will compile the Java libraries, run the unit tests, assemble the
classes (together with the native libraries), sources and JavaDocs into
JAR files, and finally place all libraries into the
Building for Android
Compiling native code for Android is a bit of a pain, so we use android-cmake
to make our lives a bit easier. We first begin by installing the android-cmake
toolchain file into our cmake modules path. On Linux, this is likely
cd /usr/share/cmake-3.2/Modules sudo wget https://github.com/taka-no-me/android-cmake/raw/master/android.toolchain.cmake
Next, we want to configure the build for our particular Android target.
cd JOCL mkdir build cd build cmake -DCMAKE_TOOLCHAIN_FILE=android.toolchain \ -DANDROID_ABI=armeabi-v7a \ -DANDROID_NATIVE_API_LEVEL=21 \ -DCMAKE_BUILD_TYPE=Release \ ..
This should be enough to get you started. For more advanced configuration, refer to the android-cmake documentation.
Finally, when building the final .jar file, we would like to avoid running the local tests, as the Android native libraries won't run on your local machine.
mvn clean install -DskipTests
Building on a virtual machine
Note: This section has to be updated. See issue 23.
Preparing to build JOCL using Vagrant:
Install VirtualBox (tested with version 5.2.10)
Install Vagrant (tested with version 2.0.1)
Install the vagrant Virtual Box Guest additions plugin with
vagrant plugin install vagrant-vbguest
Building JOCL using Vagrant:
Copy the Vagrantfile into a working directory and execute
The provisioning script will install all required packages, clone the latest state of JOCL from GitHub, build the native library using CMake and gcc, and the JARs using Maven.
The resulting JAR files will be placed in the working directory.
In order to remove the machine that has been created for building JOCL, execute