Build D for Android

From D Wiki
Revision as of 21:17, 1 November 2017 by Joakim (talk | contribs) (Add info on changes made to D for Android)
Jump to: navigation, search

These instructions show you how to build D command-line executables and OpenGL ES GUI apps for Android, either by using the Windows/linux compilers available here or a native Android compiler. There are separate steps for cross-compilation, ie building apps on a Windows or linux PC and running them on Android/ARM, versus native compilation, both building and running on your Android/ARM device itself.

Since you cannot install the Android SDK on Android, I end by showing how to package a GUI Android app, a zip file called an .apk, from scratch, by using the tools available in the Termux app for Android, a terminal emulator app and open-source package manager/repository for Android devices.

Prerequisites

Cross-compilation

  • A command shell on your host PC, where you'll run the ldc cross-compiler
    • Either a DOS command prompt or Powershell should work on Windows.
    • Any shell should work on linux, typical commands for the bash shell are shown.
  • Android native toolchain, the NDK and optionally the SDK
    • The SDK is necessary if you want to package a GUI app; the NDK is enough if you just want to build a command-line binary.
  • The ldc D compiler, either 1.4 or later
  • Common build tools
    • CMake and either Make or Ninja are required to build the runtime libraries for Android. There are instructions below on setting them up.
  • Android/ARM, whether a device or emulator, to run your D code
    • The SDK comes with an emulator. I use actual hardware, so that's what I'll discuss. Make sure it's a 32-bit ARM device, as 64-bit ARM is not supported yet.
    • If using a device, you need some way to transfer the app over. There are several ways to do this, here are a few I've tried:
  1. Install an ssh server app on your Android device and scp the app over. Alternately, set up an ssh server on your host PC, and use an ssh/scp client on Android to get the app. This is what I do, by using the OpenSSH client in Termux.
  2. Host the app in a web server and get it by using your Android browser or a downloader app.
  3. Setup the Android Debug Bridge (adb) on your device and use the SDK tools to push your files over.

Native compilation

  • Termux for Android, available in the official Play Store, APKMirror, or F-Droid
    • Check if it's a 32-bit ARM device by running "uname -m". If it returns "armv7l", you're good. If it says "aarch64," your 64-bit ARM device is not supported by ldc yet.

Setup

Once you're at a command prompt or have the Termux app installed, get the ldc compiler for Android and the NDK for cross-compilation, set some needed environment variables, and generate the runtime libraries for Android/ARM, which will be found in ldc-build-runtime.tmp/lib/.

Cross-compilation

Windows

Download CMake and the zip files for one of the Android NDKs for Windows, ldc 1.4, and either Make or Ninja (the following instructions assume Ninja). Make sure unzip is available to unpack all the build tools, then add them to your path, set the path of the NDK and its C cross-compiler, and run ldc-build-runtime. I show the commands for 64-bit Windows, should be similar for 32-bit, except the Ninja zip only comes with a 64-bit version. 

cd droid   # assuming all the zip files have been placed in a folder called droid

unzip cmake-3.9.2-win64-x64.zip
unzip ldc2-1.4.0-win64-msvc.zip
unzip android-ndk-r15c-windows-x86_64.zip
unzip ninja-win.zip

set PATH=%PATH%;C:\Users\you\droid\cmake-3.9.2-win64-x64\bin;C:\Users\you\droid\ldc2-1.4.0-win64-msvc\bin;C:\Users\you\droid

ldc2 --version   # run this to check that ldc is in your path

set CC=C:\Users\you\droid\android-ndk-r15c\toolchains\llvm\prebuilt\windows-x86_64\bin\clang

ldc-build-runtime --ninja --targetPreset=Android-arm

set NDK=C:\Users\you\droid\android-ndk-r15c

linux

Install needed packages, including optionally Ninja, as shown here for Ubuntu. You will need tar to unpack ldc and unzip for the NDK. Add ldc to your path and export the path of the NDK and its C cross-compiler, as shown here for bash, and run ldc-build-runtime. 

sudo apt-get install build-essential cmake curl ninja unzip

curl -L -O https://dl.google.com/android/repository/android-ndk-r15c-linux-x86_64.zip

unzip android-ndk-r15c-linux-x86_64.zip

curl -L -O https://github.com/ldc-developers/ldc/releases/download/v1.4.0/ldc2-1.4.0-linux-x86_64.tar.xz

tar xf ldc2-1.4.0-linux-x86_64.tar.xz
export PATH=$PATH:/path/to/your/ldc2-1.4.0-linux-x86_64/bin
ldc2 --version   # check that ldc is your path

export CC=/path/to/your/android-ndk-r15c/toolchains/llvm/prebuilt/linux-x86_64/bin/clang

ldc-build-runtime --targetPreset=Android-arm

export NDK=/path/to/your/android-ndk-r15c

Native compilation

Just install ldc from the Termux app, which will automatically pull in the clang compiler and a linker, as ldc tries to use the local C compiler for linking. 

apt install ldc

Build a command-line executable

Now that we have a D compiler and runtime libraries for Android, let's try building a small program, the classic Sieve of Eratosthenes single-core benchmark, which finds all prime numbers up to a number you choose.

Cross-compilation

# Load this link in your browser and download the file otherwise 
curl -L -O https://raw.githubusercontent.com/dlang/dmd/master/samples/sieve.d

# On linux
ldc2 -mtriple=armv7-none-linux-android -L-L/path/to/your/ldc-build-runtime.tmp/lib
-Xcc=--sysroot=$NDK/platforms/android-21/arch-arm -Xcc=-fuse-ld=bfd -Xcc=-gcc-toolchain
-Xcc=$NDK/toolchains/arm-linux-androideabi-4.9/prebuilt/linux-x86_64 -Xcc=-target
-Xcc=armv7-none-linux-androideabi -Xcc=-fpie -Xcc=-pie sieve.d

# On 64-bit Windows
ldc2 -mtriple=armv7-none-linux-android -L-LC:\Users\you\droid\ldc-build-runtime.tmp\lib
-Xcc=--sysroot=%NDK%\platforms\android-21\arch-arm -Xcc=-fuse-ld=bfd.exe -Xcc=-gcc-toolchain
-Xcc=%NDK%\toolchains\arm-linux-androideabi-4.9\prebuilt\windows-x86_64 -Xcc=-target
-Xcc=armv7-none-linux-androideabi -Xcc=-fpie -Xcc=-pie sieve.d

Copy this sieve program onto an Android device or emulator and set its permissions with the chmod command. Here's how I do it in Termux, with an ssh server running on the host PC with IP address 192.168.1.37: 

apt install openssh
cd
scp jo@192.168.1.37:sieve .
chmod 700 sieve

Native compilation

apt install curl

curl -L -O https://raw.githubusercontent.com/dlang/dmd/master/samples/sieve.d

ldc2 sieve.d

Run the sieve program

The sieve program will tell you how many prime numbers there are in the first n integers, a limit you can specify. Run this command to find how many primes there are in the first million integers: 

./sieve 1000000

If you built sieve successfully, it should return 

78498 primes

Build a sample OpenGL ES 1.0 GUI app ported to D

Clone my android repository or download its source in a zip file, which contains several headers and sample OpenGL apps from the NDK translated to D, and build the Native Activity app, which is written completely in D. As you'll see below, D code for an apk must be compiled to a shared library, which the Android runtime will call.

Cross-compilation

On linux, you can just clone my git repo: 

sudo apt-get install git

git clone https://github.com/joakim-noah/android.git

cd android/

Otherwise, simply get and unpack the zip file: 

curl -L -O https://github.com/joakim-noah/android/archive/official.zip

unzip official.zip
cd android-official/

After getting the source, go to the sample app, compile the D source, then link the objects into a shared library and place it in the directory that the SDK expects. 

cd samples/native-activity/

ldc2 -mtriple=armv7-none-linux-android -I../../ -c jni/main.d

ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../android/sensor.d

ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../android_native_app_glue.d

mkdir -p libs/armeabi-v7a/   # On Windows, mkdir libs\armeabi-v7a

# On linux
$CC -Wl,-soname,libnative-activity.so -shared --sysroot=$NDK/platforms/android-21/arch-arm
main.o sensor.o android_native_app_glue.o /path/to/your/ldc-build-runtime.tmp/lib/libphobos2-ldc.a
/path/to/your/ldc-build-runtime.tmp/lib/libdruntime-ldc.a -gcc-toolchain
$NDK/toolchains/arm-linux-androideabi-4.9/prebuilt/linux-x86_64 -fuse-ld=bfd -target
armv7-none-linux-androideabi -llog -landroid -lEGL -lGLESv1_CM
-o libs/armeabi-v7a/libnative-activity.so

# On 64-bit Windows
%CC% -Wl,-soname,libnative-activity.so -shared --sysroot=%NDK%\platforms\android-21\arch-arm
main.o sensor.o android_native_app_glue.o C:\Users\you\droid\ldc-build-runtime.tmp\lib\libphobos2-ldc.a
C:\Users\you\droid\ldc-build-runtime.tmp\lib\libdruntime-ldc.a -gcc-toolchain
%NDK%\toolchains\arm-linux-androideabi-4.9\prebuilt\windows-x86_64 -fuse-ld=bfd.exe -target
armv7-none-linux-androideabi -llog -landroid -lEGL -lGLESv1_CM
-o libs\armeabi-v7a\libnative-activity.so

Finally, package the app as the SDK directs. I document the older Ant approach, which is deprecated, replace it with the Gradle command from a newer SDK. With Ant on linux, set the path to your SDK, then run these commands: 

export SDK=/path/to/your/android-sdk-linux
$SDK/tools/android update project -p . -s --target 1
ant debug

Transfer the resulting bin/NativeActivity-debug.apk to your Android device, again shown here by using scp from the Termux app. 

scp jo@192.168.1.37:android/samples/native-activity/bin/NativeActivity-debug.apk /sdcard/Download/

Native compilation

apt install git

git clone https://github.com/joakim-noah/android.git

cd android/samples/native-activity/

ldc2 -I../../ -c jni/main.d

ldc2 -I../../ -c ../../android/sensor.d

ldc2 -I../../ -c ../../android_native_app_glue.d

mkdir -p lib/armeabi-v7a/

$PREFIX/bin/clang -Wl,-soname,libnative-activity.so -shared main.o sensor.o
android_native_app_glue.o $PREFIX/lib/libphobos2-ldc.a $PREFIX/lib/libdruntime-ldc.a 
-target armv7-none-linux-androideabi -llog -landroid -lEGL -lGLESv1_CM
-o lib/armeabi-v7a/libnative-activity.so

Follow the instructions below to package this native shared library into an Android apk.

Install and run the sample GUI app

Go to Settings->Security on your Android device and allow installation of apps from unknown sources, ie from outside the Play Store, then go to /sdcard/Download in your file manager and choose the NativeActivity-debug apk to install it. Open the app after installing or go to your app folder and run the app named NativeActivity: it'll show a black screen initially, then flash a bunch of colors when the screen is touched.

Build a sample OpenGL ES 2.0 GUI app mostly written in D, with some Java

Cross-compilation

This app comes with a simple build script, which will build the D shared library for you, as long as the environment variables are set. 

cd samples/Teapot/

# On linux
export RTDIR=/path/to/your/ldc-build-runtime.tmp
./build-apk

# On 64-bit Windows
set RTDIR=C:\Users\you\droid\ldc-build-runtime.tmp
call build-apk.bat

Here are the contents of that script, so you can see what it's doing. The Windows version, build-apk.bat, only differs on the final link command, which I've pasted below. 

ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../ndk_helper/GLContext.d
ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../ndk_helper/JNIHelper.d
ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../ndk_helper/gestureDetector.d
ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../ndk_helper/perfMonitor.d
ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../ndk_helper/shader.d
ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../ndk_helper/tapCamera.d

ldc2 -mtriple=armv7-none-linux-android -I../../ -Ijni/ -Jjni/ -c jni/TeapotNativeActivity.d
ldc2 -mtriple=armv7-none-linux-android -I../../ -Jjni/ -c jni/TeapotRenderer.d
ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../android/sensor.d

ldc2 -mtriple=armv7-none-linux-android -I../../ -c ../../android_native_app_glue.d

# Link command on linux
$CC -Wl,-soname,libTeapotNativeActivity.so -shared
--sysroot=$NDK/platforms/android-21/arch-arm TeapotNativeActivity.o sensor.o
TeapotRenderer.o android_native_app_glue.o GLContext.o JNIHelper.o
gestureDetector.o perfMonitor.o shader.o tapCamera.o
$RTDIR/lib/libphobos2-ldc.a $RTDIR/lib/libdruntime-ldc.a -gcc-toolchain
$NDK/toolchains/arm-linux-androideabi-4.9/prebuilt/linux-x86_64 -fuse-ld=bfd
-target armv7-none-linux-androideabi -llog -landroid -lEGL -lGLESv2
-o libTeapotNativeActivity.so

# Link command on 64-bit Windows
%CC% -Wl,-soname,libTeapotNativeActivity.so -shared
--sysroot=%NDK%\platforms\android-21\arch-arm TeapotNativeActivity.o sensor.o
TeapotRenderer.o android_native_app_glue.o GLContext.o JNIHelper.o
gestureDetector.o perfMonitor.o shader.o tapCamera.o
%RTDIR%\lib\libphobos2-ldc.a %RTDIR%\lib\libdruntime-ldc.a -gcc-toolchain
%NDK%\toolchains\arm-linux-androideabi-4.9\prebuilt\windows-x86_64 -fuse-ld=bfd.exe
-target armv7-none-linux-androideabi -llog -landroid -lEGL -lGLESv2
-o libTeapotNativeActivity.so

Package this shared library into an apk by using the SDK, as you would normally, and try installing and running it on your device.

Native compilation

The steps are the same as above, except for a marginally different linker command, which is included in the build-apk script but commented out. However, this app requires compiling some Java code and the Java compilers in Termux aren't working at the moment, so I'll hold off on this for now.

Changes for Android

Now that you've seen some examples, here's a description of changes to D that have been made for Android.

The Android environment doesn't support native Thread-Local Storage (TLS), which is integral to D, since all variables not explicitly marked shared/__gshared/immutable are thread-local by default in D. The Android D runtime supports emulated TLS instead, but this requires some changes to the source/build process:

  1. You must use the ld.bfd linker- see the use of -fuse-ld=bfd above- ld.gold won't do.
  2. You must have a D main function, even for a shared library. An empty D main can be put next to android_main, if you're using the default Android wrapper from my D android repo.
  3. The ELF object with the D main function must be passed to the linker first.

All the examples above follow these rules, which are in place to make sure TLS data is properly passed to the D garbage-collector.

If building a shared library and not a D command-line executable, you must also initialize and exit the D runtime by calling rt_init() and rt_term() before and after all D code is run, as has been done in the default Android wrapper (rt_init/rt_term are automatically inserted and run for an executable). Creating multiple D shared libraries is currently unsupported on Android, only a single D shared library that statically links against the D runtime will work.

Package an Android app from scratch on your Android device

Install aapt, the Android Asset Packaging Tool, and apksigner, a tool to create a hashed manifest and sign your apps. 

apt install aapt apksigner

I'll demonstrate with the NativeActivity app built above. 

cd samples/native-activity/
aapt package -M AndroidManifest.xml -S res -F NativeActivity-debug-unsigned.apk
aapt add NativeActivity-debug-unsigned.apk lib/armeabi-v7a/libnative-activity.so

This simple app only requires three files, AndroidManifest.xml, resources.arsc, and lib/armeabi-v7a/libnative-activity.so, which you can check with the following aapt command. 

aapt list NativeActivity-debug-unsigned.apk

Now let's generate a hashed manifest, just like a Java jar file, and sign the app. If you have your own Java Keystore already, just supply it to apksigner. If not, apksigner will generate a self-signed Keystore file, which we name debug.ks below, which is good enough to sign and install debug apps on your own Android device. 

apksigner debug.ks NativeActivity-debug-unsigned.apk NativeActivity-debug.apk

You should see three additional files in the apk, if you list its contents using the command above. At this point, you can install and run the signed app on your own device. If you modify the app, you'll need to build the manifest and sign it again: make sure you use the debug.ks you created before or Android won't allow you to reinstall the same app with a newly generated key, unless you first uninstall the app.

Sign your app using a certificate and OpenSSL

Unfortunately, apksigner only supports Java Keystore files for signing right now and I don't know how to build one from scratch, so if you don't have a keystore and want to release your app to an app store, you'll have to use OpenSSL to sign the app.

For a valid certificate for the final release, there's plenty of information online on how to generate one. I'll just show how to create a self-signed certificate for debugging purposes.

First, install the OpenSSL package in Termux. Then, this OpenSSL command will generate a self-signed debug certificate, apk.cert, and a 2048-bit RSA private key, key.pem, which isn't encrypted with a password. It will ask you for some signing info, for which I've shown what's used by the debug certificate in the Android SDK, but it doesn't matter what you enter, as it's ignored: 

apt install openssl-tool

openssl req -x509 -nodes -newkey rsa:2048 -keyout key.pem -out apk.cert

....................................+++
........................................................................................
.......................................................................+++
writing new private key to 'key.pem'
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [AU]:US
State or Province Name (full name) [Some-State]:.
Locality Name (eg, city) []:
Organization Name (eg, company) [Internet Widgits Pty Ltd]:Android
Organizational Unit Name (eg, section) []:
Common Name (e.g. server FQDN or YOUR name) []:Android Debug
Email Address []:

Now that we have a certificate- self-signed in this case, use your actual release certificate if you want to release the app- and private key, we use them to sign the app. Since the apk is just a zip file, unzip it into a directory and use OpenSSL to generate a new signature file, CERT.RSA, then update the apk with the new signature, and copy the apk to a public user directory from which you can install it: 

mkdir unpack
cd unpack/
unzip ../NativeActivity-debug.apk

cd META-INF/
openssl smime -sign -md sha1 -binary -noattr -in CERT.SF -out CERT.RSA -outform der -inkey ../../key.pem -signer ../../apk.cert

cd ..
aapt remove ../NativeActivity-debug.apk META-INF/CERT.RSA
aapt add ../NativeActivity-debug.apk META-INF/CERT.RSA

cd ..
cp NativeActivity-debug.apk /sdcard/Download/

The OpenSSL commands to generate a certificate and sign the apk were taken from this 2012 blog post, you can follow it further to see what the signature consists of and verify it for yourself. This 2013 blog post was critical for me to understand how apk signing works, I used to run all those commands by hand until the apksigner package was added to the Termux package repo late last year.

Retrieved from "https://wiki.dlang.org/?title=Build_D_for_Android&oldid=8660"