| commit | 02ad87f08395993ae417ce75bf8ce78a3bc23e0a | [log] [tgz] |
|---|---|---|
| author | Robbie Gemmell <robbie@apache.org> | Fri Sep 09 09:11:32 2022 +0100 |
| committer | Robbie Gemmell <robbie@apache.org> | Fri Sep 09 09:11:32 2022 +0100 |
| tree | fbafa54e0080b6465901fe0c31807b6d4bf1a5c2 | |
| parent | 3b4c38c75b2bf478bfbee53210b6735f3559c537 [diff] |
ARTEMIS-3966: simplify readme following recent updates
This is a simple tutorial about building and packaging the libartemis-native library. The libartemis-native is a thin layer library that interface with Linux' lib AIO library as part of the journaling feature of the broker when operating with AIO journal.
The lib AIO is a Linux-specific dependency, therefore having a relatively modern Linux operating system is assumed for the purpose of this documentation.
There are two ways to build the native libraries:
You can use either Docker or Podman to compile the native bits in a container created during the build phase before running the tests.
You can do this using the -Pdocker profile with maven:
$ mvn install -Pdocker
Or you can use the -Ppodman profile with maven:
$ mvn install -Ppodman
Alternatively, you can run the related scripts directly to execute the container native compilation only:
$ ./scripts/compile-using-docker.sh
or
$ ./scripts/compile-using-podman.sh
In order to build the package, make sure you install these packages:
For example, on Fedora Linux, compilation of the library requires the following specific packages:
Using a 64-bit Linux OS, it is possible to cross-compile the 32-bit version of the library. For this, the 32-bits version of the GNU C Library and lib AIO should be installed.
Once again using Fedora Linux as an example, it would mean that the following packages need to be installed:
You can use the ./scripts/compile-native.sh script. This script is using cross compilation towards 64 bits and 32 bits from a Linux environment.
Note you must first have the java compiler generate the .h header manually by running:
$ mvn generate-sources
Then call the script to compile the native libs:
$ ./scripts/compile-native.sh
Alternatively you can just use the bare-metal profile for maven which combines both of those steps in one operation before running the tests:
$ mvn install -Pbare-metal
The Lib AIO is the Linux' Kernel Asynchronous I/O Support Library. It is part of the kernel project. The library makes system calls on the kernel layer.
This is the project information:
Git Repository: git://git.kernel.org/pub/scm/libs/libaio/libaio.git Mailing List: linux-aio@kvack.org
From the project base directory, run:
docker build -f src/main/docker/Dockerfile-centos -t artemis-native-builder . && docker run -v $PWD/target/lib:/work/target/lib artemis-native-builder && sudo chown -Rv $USER:$GID target/lib
Example:
export JAVA_HOME=/usr/share/jdk11
Run mvn generate-sources to genrate the .h header file needed: $> mvn generate-sources
Call compile-native.sh. Bootstrap will call all the initial scripts you need $> ./compile-native.sh
if you are missing any dependencies, autoconf would tell you what you're missing.
The generated jar will include the ./lib/
Passing additional options to the compiler: cmake -DCMAKE_USER_C_FLAGS="-fomit-frame-pointer" -DCMAKE_VERBOSE_MAKEFILE=On .
Compiling with debug options: cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_VERBOSE_MAKEFILE=On .
Cross-compilation: cmake -DCMAKE_VERBOSE_MAKEFILE=On -DCMAKE_USER_C_FLAGS="-m32" -DARTEMIS_CROSS_COMPILE=On -DARTEMIS_CROSS_COMPILE_ROOT_PATH=/usr/lib .
Cross-compilation with debugging symbols: cmake -DCMAKE_VERBOSE_MAKEFILE=On -DCMAKE_USER_C_FLAGS="-m32" -DARTEMIS_CROSS_COMPILE=On -DARTEMIS_CROSS_COMPILE_ROOT_PATH=/usr/lib .
The User Manual, chapter 38 (Libaio Native Libraries) will provide more details about our native libraries on libaio.