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 | |
798619b9 | 5 | This project contains scripts and patches to cross compile and package packages for |
88183689 | 6 | the [Termux](https://termux.com/) Android application. |
798619b9 | 7 | |
a7dfa85f FF |
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 | ||
6dab2062 | 13 | NOTE: This is in a rough state - be prepared for some work and frustrations, and give |
1773070c FF |
14 | feedback if you find incorrect our outdated things! |
15 | ||
88183689 FF |
16 | |
17 | Build environment on Ubuntu 16.04 | |
18 | ================================= | |
3c323c69 FF |
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: | |
1773070c | 22 | |
88183689 FF |
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}`. | |
1773070c | 26 | |
1773070c | 27 | |
88183689 FF |
28 | Build environment using Docker |
29 | ============================== | |
a0057943 | 30 | A Docker container configured for building images can be downloaded and run with: |
1773070c | 31 | |
88183689 | 32 | ./scripts/run-docker.sh |
5e8045c9 | 33 | |
88183689 FF |
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 | |
a0057943 FF |
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. | |
5e8045c9 | 38 | |
a0057943 FF |
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. | |
5e8045c9 | 46 | |
798619b9 | 47 | |
9ecaa95d FF |
48 | Building a package |
49 | ================== | |
88183689 | 50 | The basic build operation is to run `./build-package.sh $PKG`, which: |
798619b9 | 51 | |
3c323c69 | 52 | * Sets up a patched stand-alone Android NDK toolchain if necessary. |
9ecaa95d | 53 | |
a0057943 FF |
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`. | |
9ecaa95d | 57 | |
3c323c69 | 58 | * Applies all patches in packages/$PKG/\*.patch. |
9ecaa95d | 59 | |
a0057943 FF |
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). | |
9ecaa95d | 65 | |
a0057943 | 66 | * Creates a deb package file for distribution in `debs/`. |
1773070c | 67 | |
88183689 | 68 | Reading `build-package.sh` is the best way to understand what is going on. |
798619b9 | 69 | |
9ecaa95d FF |
70 | |
71 | Additional utilities | |
72 | ==================== | |
88183689 | 73 | * build-all.sh: used for building all packages in the correct order (using buildorder.py). |
9ecaa95d | 74 | |
88183689 | 75 | * clean-rebuild-all.sh: used for doing a clean rebuild of all packages. |
9ecaa95d | 76 | |
88183689 | 77 | * scripts/check-pie.sh: Used for verifying that all binaries are using PIE, which is required for Android 5+. |
9ecaa95d | 78 | |
88183689 | 79 | * scripts/detect-hardlinks.sh: Used for finding if any packages uses hardlinks, which does not work on Android M. |
9ecaa95d | 80 | |
88183689 | 81 | * scripts/check-versions.sh: used for checking for package updates. |
9ecaa95d | 82 | |
88183689 | 83 | * scripts/list-packages.sh: used for listing all packages with a one-line summary. |
798619b9 FF |
84 | |
85 | ||
86 | Resources about cross-compiling packages | |
87 | ======================================== | |
88 | * [Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/svn/index.html) | |
89 | ||
88183689 | 90 | * [Beyond Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/stable/) |
798619b9 | 91 | |
88183689 | 92 | * [Cross-Compiled Linux From Scratch](http://www.clfs.org/view/CLFS-3.0.0-SYSVINIT/mips64-64/) |
798619b9 | 93 | |
88183689 | 94 | * [OpenWrt](https://openwrt.org/) as an embedded Linx distribution contains [patches and build scripts](https://dev.openwrt.org/browser/packages) |
798619b9 | 95 | |
88183689 | 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`. |
798619b9 | 97 | |
88183689 | 98 | * [Kivy recipes](https://github.com/kivy/python-for-android/tree/master/pythonforandroid/recipes) contains recipes for building packages for Android. |
798619b9 FF |
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 | ||
3b8f4313 | 114 | * glob(3) system function (glob.h) - not in bionic, but use the `libandroid-glob` package |
798619b9 | 115 | |
88183689 FF |
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` | |
798619b9 FF |
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 | ================================= | |
29db5b35 | 129 | <dlfcn.h> originally declares |
798619b9 | 130 | |
9ecaa95d FF |
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 | |
798619b9 FF |
133 | |
134 | These differs from glibc ones in that | |
135 | ||
88183689 | 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. |
798619b9 | 137 | 2. They differ in value from glibc ones, so cannot be hardcoded in files (DLFCN.py in python does this) |
29db5b35 | 138 | 3. They are missing some values (`RTLD_BINDING_MASK`, `RTLD_NOLOAD`, ...) |
798619b9 FF |
139 | |
140 | ||
88183689 FF |
141 | RPATH, RUNPATH AND LD\_LIBRARY\_PATH |
142 | ==================================== | |
798619b9 | 143 | On desktop linux the linker searches for shared libraries in: |
1ddf1728 | 144 | |
88183689 FF |
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 | |
1ddf1728 | 148 | |
88183689 | 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. |
798619b9 FF |
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: | |
9ecaa95d FF |
155 | |
156 | WARNING: linker: $BINARY: unused DT entry: type 0x6ffffffe arg ... | |
157 | WARNING: linker: $BINARY: unused DT entry: type 0x6fffffff arg ... | |
88183689 | 158 | |
798619b9 | 159 | These may come from version scripts in a Makefile such as: |
9ecaa95d FF |
160 | |
161 | -Wl,--version-script=$(top_srcdir)/proc/libprocps.sym | |
88183689 | 162 | |
798619b9 | 163 | The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem. |