Commit | Line | Data |
---|---|---|
4edf9992 FF |
1 | Termux packages |
2 | =============== | |
006983b2 | 3 | [![Join the chat at https://gitter.im/termux/termux](https://badges.gitter.im/termux/termux.svg)](https://gitter.im/termux/termux) |
5b9b57e3 | 4 | |
6dd45156 FF |
5 | This project contains scripts and patches to build packages for the |
6 | [Termux](https://termux.com/) Android application. | |
798619b9 | 7 | |
1a8d12c2 FF |
8 | License |
9 | ======= | |
a7dfa85f FF |
10 | The scripts and patches to build each package is licensed under the same license as |
11 | the actual package (so the patches and scripts to build bash are licensed under | |
12 | the same license as bash, while the patches and scripts to build python are licensed | |
6dd45156 | 13 | under the same license as python). |
88183689 | 14 | |
20730a0d | 15 | Build environment on Ubuntu 16.10 |
88183689 | 16 | ================================= |
711f6358 | 17 | Packages are built using Ubuntu 16.10. Perform the following steps to configure a Ubuntu 16.10 installation: |
1773070c | 18 | |
6dd45156 | 19 | - Run `scripts/setup-ubuntu.sh` to install required packages and setup the `/data/` folder. |
1773070c | 20 | |
6dd45156 | 21 | - Run `scripts/setup-android-sdk.sh` to install the Android SDK and NDK at `$HOME/lib/android-{sdk,ndk}`. |
1773070c | 22 | |
22dd00cb FF |
23 | There is also a [Vagrantfile](scripts/Vagrantfile) available for setting up an Ubuntu environment using a virtual machine on other operating systems. |
24 | ||
88183689 FF |
25 | Build environment using Docker |
26 | ============================== | |
20730a0d | 27 | On other Linux distributions than Ubuntu 16.10 (or on other platforms than Linux) the best course |
1a8d12c2 | 28 | of action is to setup a Docker container for building packages by executing: |
1773070c | 29 | |
711f6358 FF |
30 | ./scripts/run-docker.sh # On Linux and macOS. |
31 | .\scripts\run-docker.ps1 # On Windows. | |
1a8d12c2 | 32 | |
6dd45156 FF |
33 | This will setup a container (from an image created by [scripts/Dockerfile](scripts/Dockerfile)) |
34 | suitable for building packages. | |
5e8045c9 | 35 | |
6dd45156 FF |
36 | This source folder is mounted as the /root/termux-packages data volume, so changes are kept |
37 | in sync between the host and the container when trying things out before committing, and built | |
38 | deb files will be available on the host in the `debs/` directory just as when building on the host. | |
5e8045c9 | 39 | |
a0057943 FF |
40 | Build commands can be given to be executed in the docker container directly: |
41 | ||
42 | ./scripts/run-docker.sh ./build-package.sh libandroid-support | |
43 | ||
44 | will launch the docker container, execute the `./build-package.sh libandroid-support` | |
45 | command inside it and afterwards return you to the host prompt, with the newly built | |
46 | deb in `debs/` to try out. | |
5e8045c9 | 47 | |
9ecaa95d FF |
48 | Building a package |
49 | ================== | |
88183689 | 50 | The basic build operation is to run `./build-package.sh $PKG`, which: |
798619b9 | 51 | |
6dd45156 | 52 | 1. Sets up a patched stand-alone Android NDK toolchain if necessary. |
9ecaa95d | 53 | |
6dd45156 | 54 | 2. Reads `packages/$PKG/build.sh` to find out where to find the source code of the package and how to build it. |
a0057943 | 55 | |
6dd45156 | 56 | 3. Extracts the source in `$HOME/.termux-build/$PKG/src`. |
9ecaa95d | 57 | |
6dd45156 | 58 | 4. Applies all patches in packages/$PKG/\*.patch. |
9ecaa95d | 59 | |
6dd45156 | 60 | 5. Builds the package under `$HOME/.termux-build/$PKG/` (either in the build/ directory there or in the |
a0057943 FF |
61 | src/ directory if the package is specified to build in the src dir) and installs it to `$PREFIX`. |
62 | ||
6dd45156 | 63 | 6. Extracts modified files in `$PREFIX` into `$HOME/.termux-build/$PKG/massage` and massages the |
a0057943 | 64 | files there for distribution (removes some files, splits it up in sub-packages, modifies elf files). |
9ecaa95d | 65 | |
6dd45156 | 66 | 7. Creates a deb package file for distribution in `debs/`. |
1773070c | 67 | |
6dd45156 | 68 | Reading [build-package.sh](build-package.sh) is the best way to understand what is going on. |
798619b9 | 69 | |
9ecaa95d FF |
70 | Additional utilities |
71 | ==================== | |
88183689 | 72 | * build-all.sh: used for building all packages in the correct order (using buildorder.py). |
9ecaa95d | 73 | |
2fe052c8 | 74 | * clean.sh: used for doing a clean rebuild of all packages. |
9ecaa95d | 75 | |
88183689 | 76 | * scripts/check-pie.sh: Used for verifying that all binaries are using PIE, which is required for Android 5+. |
9ecaa95d | 77 | |
88183689 | 78 | * scripts/check-versions.sh: used for checking for package updates. |
9ecaa95d | 79 | |
88183689 | 80 | * scripts/list-packages.sh: used for listing all packages with a one-line summary. |
798619b9 FF |
81 | |
82 | ||
1a8d12c2 FF |
83 | Resources |
84 | ========= | |
85 | * [Android changes for NDK developers](https://android.googlesource.com/platform/bionic/+/master/android-changes-for-ndk-developers.md) | |
86 | ||
40dcead0 | 87 | * [Linux From Scratch](http://www.linuxfromscratch.org/lfs/view/stable/) |
798619b9 | 88 | |
88183689 | 89 | * [Beyond Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/stable/) |
798619b9 | 90 | |
88183689 | 91 | * [Cross-Compiled Linux From Scratch](http://www.clfs.org/view/CLFS-3.0.0-SYSVINIT/mips64-64/) |
798619b9 | 92 | |
88183689 | 93 | * [OpenWrt](https://openwrt.org/) as an embedded Linx distribution contains [patches and build scripts](https://dev.openwrt.org/browser/packages) |
798619b9 | 94 | |
88183689 | 95 | * 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`. |
798619b9 | 96 | |
88183689 | 97 | * [Kivy recipes](https://github.com/kivy/python-for-android/tree/master/pythonforandroid/recipes) contains recipes for building packages for Android. |
798619b9 FF |
98 | |
99 | ||
100 | Common porting problems | |
101 | ======================= | |
6dd45156 | 102 | * The Android bionic libc does not have iconv and gettext/libintl functionality built in. A package from the NDK, libandroid-support, contains these and may be used by all packages. |
798619b9 FF |
103 | |
104 | * "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 | |
105 | ||
106 | * rindex(3) is defined in <strings.h> but does not exist in NDK, but strrchr(3) from <string.h> is preferred anyway | |
107 | ||
108 | * <sys/termios.h> does not exist, but <termios.h> is the standard location. | |
109 | ||
110 | * <sys/fcntl.h> does not exist, but <fcntl.h> is the standard location. | |
111 | ||
3b8f4313 | 112 | * glob(3) system function (glob.h) - not in bionic, but use the `libandroid-glob` package |
798619b9 | 113 | |
88183689 FF |
114 | * [Cmake and cross compiling](http://www.cmake.org/Wiki/CMake_Cross_Compiling). |
115 | `CMAKE_FIND_ROOT_PATH=$TERMUX_PREFIX` to search there. | |
116 | `CMAKE_FIND_ROOT_PATH_MODE_LIBRARY=ONLY` and `CMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY` | |
798619b9 FF |
117 | for only searching there and don't fall back to build machines |
118 | ||
119 | * Android is removing sys/timeb.h because it was removed in POSIX 2008, but ftime(3) can be replaced with gettimeofday(2) | |
120 | ||
121 | * mempcpy(3) is a GNU extension. We have added it to <string.h> provided TERMUX_EXPOSE_MEMPCPY is defined, | |
122 | so use something like CFLAGS+=" -DTERMUX_EXPOSE_MEMPCPY=1" for packages expecting that function to exist. | |
123 | ||
7106823d VB |
124 | * Android uses a customized version of shared memory managemnt known as ashmem. libandroid-shmem wraps SYSV shared |
125 | memory calls to standard ashmem operations. Use it with `LDFLAGS+=" -landroid-shmem`. | |
126 | ||
67d2d615 FF |
127 | * SYSV semaphores (semget(2), semop(2) and others) aren't available. |
128 | Use unnamed POSIX semaphores instead (named semaphores are unimplemented). | |
c4804ab8 | 129 | |
798619b9 FF |
130 | dlopen() and RTLD_* flags |
131 | ================================= | |
29db5b35 | 132 | <dlfcn.h> originally declares |
798619b9 | 133 | |
9ecaa95d FF |
134 | enum { RTLD_NOW=0, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=2, RTLD_NOLOAD=4}; // 32-bit |
135 | enum { RTLD_NOW=2, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=0x00100, RTLD_NOLOAD=4}; // 64-bit | |
798619b9 FF |
136 | |
137 | These differs from glibc ones in that | |
138 | ||
88183689 | 139 | 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. |
798619b9 | 140 | 2. They differ in value from glibc ones, so cannot be hardcoded in files (DLFCN.py in python does this) |
29db5b35 | 141 | 3. They are missing some values (`RTLD_BINDING_MASK`, `RTLD_NOLOAD`, ...) |
798619b9 | 142 | |
88183689 FF |
143 | RPATH, RUNPATH AND LD\_LIBRARY\_PATH |
144 | ==================================== | |
798619b9 | 145 | On desktop linux the linker searches for shared libraries in: |
1ddf1728 | 146 | |
88183689 FF |
147 | 1. `RPATH` - a list of directories which is linked into the executable, supported on most UNIX systems. It is ignored if `RUNPATH` is present. |
148 | 2. `LD_LIBRARY_PATH` - an environment variable which holds a list of directories | |
149 | 3. `RUNPATH` - same as `RPATH`, but searched after `LD_LIBRARY_PATH`, supported only on most recent UNIX systems | |
1ddf1728 | 150 | |
1a8d12c2 | 151 | 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 (which the linker warns about) with --disable-rpath configure flags. NOTE: Starting from Android 7.0 RUNPATH (but not RPATH) is supported. |
798619b9 FF |
152 | |
153 | Warnings about unused DT entries | |
154 | ================================ | |
1a8d12c2 | 155 | Starting from 5.1 the Android linker warns about VERNEED (0x6FFFFFFE) and VERNEEDNUM (0x6FFFFFFF) ELF dynamic sections (WARNING: linker: $BINARY: unused DT entry: type 0x6ffffffe/0x6fffffff). These may come from version scripts (`-Wl,--version-script=`). The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem. NOTE: Starting from Android 6.0 symbol versioning is supported. |