mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-26 23:01:04 +08:00
ff47aeb791
Solution: remove implementation. Frank Hartmann <soundart@gmx.net>, the author, rejected our request to relicense under MPL2, so we have to remove his copyrighted work. Tweetnacl is not security-supported and could not be used in production environments anyway, the supported backend is libsodium.
161 lines
4.1 KiB
Markdown
161 lines
4.1 KiB
Markdown
# Android Build
|
|
|
|
## Preamble
|
|
|
|
The last known NDK is automatically downloaded, if not specified otherwise.
|
|
|
|
As indicated in the main [README](../../README.md#supported-platforms-with-primary-CI), Android support is still DRAFT.
|
|
|
|
## Configuration
|
|
|
|
### Basics
|
|
|
|
Basically, LIBZMQ build for Android, relies on exported variables.
|
|
|
|
Provided build scripts can mainly be used like
|
|
|
|
export XXX=xxx
|
|
export YYY=yyy
|
|
...
|
|
cd <libzmq>/builds/android
|
|
./<build_script>
|
|
|
|
|
|
### Android NDK
|
|
|
|
LIBZMQ is tested against Android NDK versions r19 to r25.
|
|
|
|
By default, LIBZMQ uses NDK `android-ndk-r25`, but you can specify
|
|
a different one:
|
|
|
|
export NDK_VERSION=android-ndk-r23c
|
|
|
|
If you already have installed your favorite NDK somewhere, all you have to
|
|
do is to export and set NDK_VERSION and ANDROID_NDK_ROOT environment
|
|
variables, e.g:
|
|
|
|
export NDK_VERSION="android-ndk-r23b"
|
|
export ANDROID_NDK_ROOT=$HOME/${NDK_VERSION}
|
|
|
|
**Important:** ANDROID_NDK_ROOT must be an absolute path !
|
|
|
|
If you specify only NDK_VERSION, ANDROID_NDK_ROOT will be automatically set
|
|
to its default:
|
|
|
|
export ANDROID_NDK_ROOT=/tmp/${NDK_VERSION}
|
|
|
|
To specify the minimum SDK version set the environment variable below:
|
|
|
|
export MIN_SDK_VERSION=21 # Default value if unset
|
|
|
|
To specify the build directory set the environment variable below:
|
|
|
|
export ANDROID_BUILD_DIR=${HOME}/android_build
|
|
|
|
**Important:** ANDROID_BUILD_ROOT must be an absolute path !
|
|
|
|
### Android build folder
|
|
|
|
All Android libraries will be generated under:
|
|
|
|
${ANDROID_BUILD_DIR}/prefix/<arch>/lib
|
|
|
|
where <arch> is one of `arm`, `arm64`, `x86` or `x86_64`.
|
|
|
|
### Android build cleanup
|
|
|
|
Build and Dependency storage folders are automatically cleaned,
|
|
by ci_build.sh. This can be avoided with the help of
|
|
|
|
ANDROID_BUILD_DIR="no"
|
|
|
|
If you turn this to "no", make sure to clean what has to be, before
|
|
calling `build.sh` or `ci_build.sh`.
|
|
|
|
### Prebuilt Android libraries
|
|
|
|
Android prebuilt libraries have to be stored under
|
|
|
|
ANDROID_BUILD_DIR/prefix/<arch>/lib
|
|
|
|
Do not forget to disable [Android cleanup](#android-build-cleanup).
|
|
|
|
### Dependencies
|
|
|
|
By default, `build.sh` download dependencies under `/tmp/tmp-deps`.
|
|
|
|
You can specify another folder with the help of ANDROID_DEPENDENCIES_DIR:
|
|
|
|
ANDROID_DEPENDENCIES_DIR=${HOME}/my_dependencies
|
|
|
|
If you place your own dependency source trees there,
|
|
do not forget to disable [Android cleanup](#android-build-cleanup).
|
|
|
|
### Cryptographic configuration
|
|
|
|
The variable CURVE accepts 2 different values:
|
|
|
|
"" : LIBZMQ is built without any encryption support.
|
|
"libsodium" : LIBZMQ is built with LIBSODIUM encryption support (see below).
|
|
|
|
### Other configuration variables
|
|
|
|
You can also check configuration variables in `build.sh` itself, in its
|
|
"Configuration & tuning options" comment block.
|
|
|
|
## LIBSODIUM
|
|
|
|
LIBSODIUM is built along with LIBZMQ, when CURVE="libsodium".
|
|
|
|
- If you have your own clone of LIBSODIUM, set LIBSODIUM_ROOT to point to
|
|
its folder.
|
|
- If the variable LIBSODIUM_ROOT is not set, LIBZMQ will look for a folder
|
|
'libsodium' close to his own one.
|
|
- If no folder 'libsodium' exists, then LIBZMQ will clone LIBSODIUM from its
|
|
official STABLE branch.
|
|
|
|
## Build
|
|
|
|
See chapter [Configuration](#configuration) for configuration options and
|
|
other details.
|
|
|
|
Select your preferred parameters:
|
|
|
|
export XXX=xxx
|
|
export YYY=yyy
|
|
...
|
|
|
|
and run:
|
|
|
|
cd <libzmq>/builds/android
|
|
./build.sh [ arm | arm64 | x86 | x86_64 ]
|
|
|
|
Parameter selection and the calls to build.sh can be located in a
|
|
SHELL script, like in ci_build.sh.
|
|
|
|
## CI build
|
|
|
|
Basically, it will call `build.sh` once, for each Android target.
|
|
|
|
This script accepts the same configuration variables, but some are set
|
|
with different default values. For instance, the dependencies are not
|
|
downloaded or cloned in `/tmp/tmp-deps, but inside LIBZMQ clone.
|
|
|
|
It can be used in the same way as build.sh
|
|
|
|
export XXX=xxx
|
|
export YYY=yyy
|
|
cd <libzmq>/builds/android
|
|
./ci_build.sh
|
|
|
|
|
|
## Dockerfile
|
|
|
|
An example of Docker file is provided, for Ubuntu 22.04
|
|
|
|
Minimal changes are required to support Debian 9 to 11.
|
|
|
|
Minimal changes are required to support CentOS (7 only), Rocky Linux (8 & 9),
|
|
and many Fedora (22 to 37).
|
|
|