| 1 | Termux packages |
| 2 | =============== |
| 3 | [![Join the chat at https://gitter.im/termux/termux](https://badges.gitter.im/termux/termux.svg)](https://gitter.im/termux/termux) |
| 4 | |
| 5 | This project contains scripts and patches to cross compile and package packages for |
| 6 | the [Termux](https://termux.com/) Android application. |
| 7 | |
| 8 | The scripts and patches to build each package is licensed under the same license as |
| 9 | the actual package (so the patches and scripts to build bash are licensed under |
| 10 | the same license as bash, while the patches and scripts to build python are licensed |
| 11 | under the same license as python, etc). |
| 12 | |
| 13 | NOTE: This is in a rough state - be prepared for some work and frustrations, and give |
| 14 | feedback if you find incorrect our outdated things! |
| 15 | |
| 16 | |
| 17 | Build environment on Ubuntu 16.04 |
| 18 | ================================= |
| 19 | Packages are normally built using Ubuntu 16.04. Most packages should build also under |
| 20 | other Linux distributions (or even on OS X), but those environments will need manual setup |
| 21 | adapted from the below setup for Ubuntu: |
| 22 | |
| 23 | * Run `scripts/setup-ubuntu.sh` to install required packages and setup the `/data/` folder. |
| 24 | |
| 25 | * Run `scripts/setup-android-sdk.sh` to install the Android SDK and NDK at `$HOME/lib/android-{sdk,ndk}`. |
| 26 | |
| 27 | |
| 28 | Build environment using Docker |
| 29 | ============================== |
| 30 | A Docker container configured for building images can be downloaded and run with: |
| 31 | |
| 32 | ./scripts/run-docker.sh |
| 33 | |
| 34 | This will set you up with a interactive prompt in a container, where this source folder |
| 35 | is mounted as the /root/termux-packages data volume, so changes are kept in sync between |
| 36 | the host and the container when trying things out before committing, and built deb files |
| 37 | will be available on the host in the `debs/` directory just as when building on the host. |
| 38 | |
| 39 | Build commands can be given to be executed in the docker container directly: |
| 40 | |
| 41 | ./scripts/run-docker.sh ./build-package.sh libandroid-support |
| 42 | |
| 43 | will launch the docker container, execute the `./build-package.sh libandroid-support` |
| 44 | command inside it and afterwards return you to the host prompt, with the newly built |
| 45 | deb in `debs/` to try out. |
| 46 | |
| 47 | |
| 48 | Building a package |
| 49 | ================== |
| 50 | The basic build operation is to run `./build-package.sh $PKG`, which: |
| 51 | |
| 52 | * Sets up a patched stand-alone Android NDK toolchain if necessary. |
| 53 | |
| 54 | * Reads `packages/$PKG/build.sh` to find out where to find the source code of the package and how to build it. |
| 55 | |
| 56 | * Extracts the source in `$HOME/.termux-build/$PKG/src`. |
| 57 | |
| 58 | * Applies all patches in packages/$PKG/\*.patch. |
| 59 | |
| 60 | * Builds the package under `$HOME/.termux-build/$PKG/` (either in the build/ directory there or in the |
| 61 | src/ directory if the package is specified to build in the src dir) and installs it to `$PREFIX`. |
| 62 | |
| 63 | * Extracts modified files in `$PREFIX` into `$HOME/.termux-build/$PKG/massage` and massages the |
| 64 | files there for distribution (removes some files, splits it up in sub-packages, modifies elf files). |
| 65 | |
| 66 | * Creates a deb package file for distribution in `debs/`. |
| 67 | |
| 68 | Reading `build-package.sh` is the best way to understand what is going on. |
| 69 | |
| 70 | |
| 71 | Additional utilities |
| 72 | ==================== |
| 73 | * build-all.sh: used for building all packages in the correct order (using buildorder.py). |
| 74 | |
| 75 | * clean-rebuild-all.sh: used for doing a clean rebuild of all packages. |
| 76 | |
| 77 | * scripts/check-pie.sh: Used for verifying that all binaries are using PIE, which is required for Android 5+. |
| 78 | |
| 79 | * scripts/detect-hardlinks.sh: Used for finding if any packages uses hardlinks, which does not work on Android M. |
| 80 | |
| 81 | * scripts/check-versions.sh: used for checking for package updates. |
| 82 | |
| 83 | * scripts/list-packages.sh: used for listing all packages with a one-line summary. |
| 84 | |
| 85 | |
| 86 | Resources about cross-compiling packages |
| 87 | ======================================== |
| 88 | * [Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/svn/index.html) |
| 89 | |
| 90 | * [Beyond Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/stable/) |
| 91 | |
| 92 | * [Cross-Compiled Linux From Scratch](http://www.clfs.org/view/CLFS-3.0.0-SYSVINIT/mips64-64/) |
| 93 | |
| 94 | * [OpenWrt](https://openwrt.org/) as an embedded Linx distribution contains [patches and build scripts](https://dev.openwrt.org/browser/packages) |
| 95 | |
| 96 | * http://dan.drown.org/android contains [patches for cross-compiling to Android](http://dan.drown.org/android/src/) as well as [work notes](http://dan.drown.org/android/worknotes.html), including a modified dynamic linker to avoid messing with `LD_LIBRARY_PATH`. |
| 97 | |
| 98 | * [Kivy recipes](https://github.com/kivy/python-for-android/tree/master/pythonforandroid/recipes) contains recipes for building packages for Android. |
| 99 | |
| 100 | |
| 101 | Common porting problems |
| 102 | ======================= |
| 103 | * The Android bionic libc does not have iconv and gettext/libintl functionality built in. A package from the NDK, libandroid-support, |
| 104 | contains these and may be used by all packages. |
| 105 | |
| 106 | * "error: z: no archive symbol table (run ranlib)" usually means that the build machines libz is used instead of the one for cross compilation, due to the builder library -L path being setup incorrectly |
| 107 | |
| 108 | * rindex(3) is defined in <strings.h> but does not exist in NDK, but strrchr(3) from <string.h> is preferred anyway |
| 109 | |
| 110 | * <sys/termios.h> does not exist, but <termios.h> is the standard location. |
| 111 | |
| 112 | * <sys/fcntl.h> does not exist, but <fcntl.h> is the standard location. |
| 113 | |
| 114 | * glob(3) system function (glob.h) - not in bionic, but use the `libandroid-glob` package |
| 115 | |
| 116 | * [Cmake and cross compiling](http://www.cmake.org/Wiki/CMake_Cross_Compiling). |
| 117 | `CMAKE_FIND_ROOT_PATH=$TERMUX_PREFIX` to search there. |
| 118 | `CMAKE_FIND_ROOT_PATH_MODE_LIBRARY=ONLY` and `CMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY` |
| 119 | for only searching there and don't fall back to build machines |
| 120 | |
| 121 | * Android is removing sys/timeb.h because it was removed in POSIX 2008, but ftime(3) can be replaced with gettimeofday(2) |
| 122 | |
| 123 | * mempcpy(3) is a GNU extension. We have added it to <string.h> provided TERMUX_EXPOSE_MEMPCPY is defined, |
| 124 | so use something like CFLAGS+=" -DTERMUX_EXPOSE_MEMPCPY=1" for packages expecting that function to exist. |
| 125 | |
| 126 | |
| 127 | dlopen() and RTLD_* flags |
| 128 | ================================= |
| 129 | <dlfcn.h> originally declares |
| 130 | |
| 131 | enum { RTLD_NOW=0, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=2, RTLD_NOLOAD=4}; // 32-bit |
| 132 | enum { RTLD_NOW=2, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=0x00100, RTLD_NOLOAD=4}; // 64-bit |
| 133 | |
| 134 | These differs from glibc ones in that |
| 135 | |
| 136 | 1. They are not preprocessor #define:s so cannot be checked for with `#ifdef RTLD_GLOBAL`. Termux patches this to #define values for compatibility with several packages. |
| 137 | 2. They differ in value from glibc ones, so cannot be hardcoded in files (DLFCN.py in python does this) |
| 138 | 3. They are missing some values (`RTLD_BINDING_MASK`, `RTLD_NOLOAD`, ...) |
| 139 | |
| 140 | |
| 141 | RPATH, RUNPATH AND LD\_LIBRARY\_PATH |
| 142 | ==================================== |
| 143 | On desktop linux the linker searches for shared libraries in: |
| 144 | |
| 145 | 1. `RPATH` - a list of directories which is linked into the executable, supported on most UNIX systems. It is ignored if `RUNPATH` is present. |
| 146 | 2. `LD_LIBRARY_PATH` - an environment variable which holds a list of directories |
| 147 | 3. `RUNPATH` - same as `RPATH`, but searched after `LD_LIBRARY_PATH`, supported only on most recent UNIX systems |
| 148 | |
| 149 | The Android linker (/system/bin/linker) does not support `RPATH` or `RUNPATH`, so we set `LD_LIBRARY_PATH=$PREFIX/lib` and try to avoid building useless rpath entries with --disable-rpath configure flags. Another option to avoid depending on `LD_LIBRARY_PATH` would be supplying a custom linker - this is not done due to the overhead of maintaining a custom linker. |
| 150 | |
| 151 | |
| 152 | Warnings about unused DT entries |
| 153 | ================================ |
| 154 | Starting from 5.1 the Android linker warns about VERNEED (0x6FFFFFFE) and VERNEEDNUM (0x6FFFFFFF) ELF dynamic sections: |
| 155 | |
| 156 | WARNING: linker: $BINARY: unused DT entry: type 0x6ffffffe arg ... |
| 157 | WARNING: linker: $BINARY: unused DT entry: type 0x6fffffff arg ... |
| 158 | |
| 159 | These may come from version scripts in a Makefile such as: |
| 160 | |
| 161 | -Wl,--version-script=$(top_srcdir)/proc/libprocps.sym |
| 162 | |
| 163 | The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem. |