Commit | Line | Data |
---|---|---|
798619b9 FF |
1 | termux-packages |
2 | =============== | |
3 | This project contains scripts and patches to cross compile and package packages for | |
4 | the [Termux](http://termux.com/) Android application. | |
5 | ||
a7dfa85f FF |
6 | The scripts and patches to build each package is licensed under the same license as |
7 | the actual package (so the patches and scripts to build bash are licensed under | |
8 | the same license as bash, while the patches and scripts to build python are licensed | |
9 | under the same license as python, etc). | |
10 | ||
6dab2062 | 11 | NOTE: This is in a rough state - be prepared for some work and frustrations, and give |
1773070c FF |
12 | feedback if you find incorrect our outdated things! |
13 | ||
14 | Initial setup | |
15 | ============= | |
bf13a244 | 16 | Building packages are for now only tested to work on Ubuntu 15.10. Perform the following |
1773070c FF |
17 | setup steps: |
18 | ||
19 | * Run `ubuntu-setup.sh` to install required packages and setup the `/data/` folder (see below). | |
20 | ||
21 | * Install the Android SDK at `$HOME/lib/android-sdk`. Override this by setting the environment | |
22 | variable `$ANDROID_HOME` to point at another location. | |
23 | ||
24 | * Install the Android NDK, version r10e, at `$HOME/lib/android-ndk`. Override this by setting | |
25 | the environment variable `$NDK` to point at another location. | |
26 | ||
5e8045c9 AC |
27 | Alternatively a Dockerfile is provided which sets up a pristine image |
28 | suitable for building packages. To build the docker image, run the | |
29 | following command: | |
30 | ||
31 | docker build --rm=true -t termux . | |
32 | ||
33 | After build is successful, you can open an interactive prompt inside the | |
34 | container using: | |
35 | ||
36 | docker run --rm=true -ti termux /bin/bash | |
37 | ||
798619b9 | 38 | |
9ecaa95d FF |
39 | Building a package |
40 | ================== | |
798619b9 FF |
41 | In a non-rooted Android device an app such as Termux may not write to system locations, |
42 | which is why every package is installed inside the private file area of the Termux app: | |
3b8f4313 FF |
43 | |
44 | PREFIX=/data/data/com.termux/files/usr | |
798619b9 FF |
45 | |
46 | For simplicity while developing and building, the build scripts here assume that a /data | |
1773070c | 47 | folder is reserved for use on the host builder and install everything there. |
798619b9 | 48 | |
3b8f4313 FF |
49 | The basic flow is then to run "./build-package.sh $PKG", which: |
50 | * Sets up a patched stand-alone Android NDK toolchain | |
9ecaa95d FF |
51 | |
52 | * Reads packages/$PKG/build.sh to find out where to find the source code of the package and how to build it. | |
53 | ||
54 | * Applies all patches in packages/$PKG/\*.patch | |
55 | ||
56 | * Builds the package and installs it to $PREFIX | |
57 | ||
1773070c FF |
58 | * Creates a dpkg package file for distribution. |
59 | ||
798619b9 FF |
60 | Reading and following build-package.sh is the best way to understand what's going on here. |
61 | ||
9ecaa95d FF |
62 | |
63 | Additional utilities | |
64 | ==================== | |
65 | * build-all.sh: used for building all packages in the correct order (using buildorder.py) | |
66 | ||
67 | * check-pie.sh: Used for verifying that all binaries are using PIE, which is required for Android 5+ | |
68 | ||
69 | * detect-hardlinks.sh: Used for finding if any packages uses hardlinks, which does not work on Android M | |
70 | ||
71 | * check-versions.sh: used for checking for package updates | |
72 | ||
73 | * clean-rebuild-all.sh: used for doing a clean rebuild of all packages (takes a couple of hours) | |
74 | ||
75 | * list-packages.sh: used for listing all packages with a one-line summary | |
798619b9 FF |
76 | |
77 | ||
78 | Resources about cross-compiling packages | |
79 | ======================================== | |
80 | * [Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/svn/index.html) | |
81 | ||
82 | * [Beyond Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/svn/) | |
83 | ||
84 | * [Cross-Compiled Linux From Scratch](http://cross-lfs.org/view/svn/x86_64-64/) | |
85 | ||
86 | * [OpenWrt](https://openwrt.org/), an embedded Linx distribution, contains [patches and build scripts](https://dev.openwrt.org/browser/packages) | |
87 | ||
88 | * 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. | |
89 | ||
90 | * [CCTools](http://cctools.info/index.php?title=Main_Page) is an Android native IDE containing [patches for several programs](https://code.google.com/p/cctools/source/browse/#svn%2Ftrunk%2Fcctools-repo%2Fpatches) and [a bug tracker](https://code.google.com/p/cctools/issues/list). | |
91 | ||
92 | * [BotBrew](http://botbrew.com/) was a package manager for rooted devices with [sources on github](https://github.com/jyio/botbrew). Based on opkg and was transitioning to apt. | |
93 | ||
94 | * [Kivy recipes](https://github.com/kivy/python-for-android/tree/master/recipes) contains recipes for building packages for Android. | |
95 | ||
96 | ||
97 | Common porting problems | |
98 | ======================= | |
99 | * The Android bionic libc does not have iconv and gettext/libintl functionality built in. A package from the NDK, libandroid-support, | |
100 | contains these and may be used by all packages. | |
101 | ||
102 | * "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 | |
103 | ||
104 | * rindex(3) is defined in <strings.h> but does not exist in NDK, but strrchr(3) from <string.h> is preferred anyway | |
105 | ||
106 | * <sys/termios.h> does not exist, but <termios.h> is the standard location. | |
107 | ||
108 | * <sys/fcntl.h> does not exist, but <fcntl.h> is the standard location. | |
109 | ||
3b8f4313 | 110 | * glob(3) system function (glob.h) - not in bionic, but use the `libandroid-glob` package |
798619b9 | 111 | |
798619b9 FF |
112 | * cmake and cross compiling: http://www.cmake.org/Wiki/CMake_Cross_Compiling |
113 | CMAKE_FIND_ROOT_PATH=$TERMUX_PREFIX to search there. | |
114 | CMAKE_FIND_ROOT_PATH_MODE_LIBRARY=ONLY and | |
115 | CMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY | |
116 | for only searching there and don't fall back to build machines | |
117 | ||
118 | * Android is removing sys/timeb.h because it was removed in POSIX 2008, but ftime(3) can be replaced with gettimeofday(2) | |
119 | ||
120 | * mempcpy(3) is a GNU extension. We have added it to <string.h> provided TERMUX_EXPOSE_MEMPCPY is defined, | |
121 | so use something like CFLAGS+=" -DTERMUX_EXPOSE_MEMPCPY=1" for packages expecting that function to exist. | |
122 | ||
123 | ||
124 | dlopen() and RTLD_* flags | |
125 | ================================= | |
c2d4c0a9 | 126 | <dlfcn.h> declares |
798619b9 | 127 | |
9ecaa95d FF |
128 | enum { RTLD_NOW=0, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=2, RTLD_NOLOAD=4}; // 32-bit |
129 | enum { RTLD_NOW=2, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=0x00100, RTLD_NOLOAD=4}; // 64-bit | |
798619b9 FF |
130 | |
131 | These differs from glibc ones in that | |
132 | ||
133 | 1. They are not preprocessor #define:s so cannot be checked for with #ifdef RTLD_GLOBAL (dln.c in ruby does this) | |
134 | 2. They differ in value from glibc ones, so cannot be hardcoded in files (DLFCN.py in python does this) | |
135 | 3. They are missing some values (RTLD_BINDING_MASK, RTLD_NOLOAD, ...) | |
136 | ||
137 | ||
138 | RPATH, LD_LIBRARY_PATH AND RUNPATH | |
139 | ================================== | |
140 | On desktop linux the linker searches for shared libraries in: | |
1ddf1728 | 141 | |
798619b9 FF |
142 | 1. RPATH - a list of directories which is linked into the executable, supported on most UNIX systems. It is ignored if RUNPATH is present. |
143 | 2. LD_LIBRARY_PATH - an environment variable which holds a list of directories | |
1ddf1728 FF |
144 | 3. RUNPATH - same as RPATH, but searched after LD_LIBRARY_PATH, supported only on most recent UNIX systems |
145 | ||
146 | The Android linker (/system/bin/linker) does not support RPATH or RUNPATH, so we set LD_LIBRARY_PATH=$USR/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 |
147 | |
148 | ||
149 | Warnings about unused DT entries | |
150 | ================================ | |
151 | Starting from 5.1 the Android linker warns about VERNEED (0x6FFFFFFE) and VERNEEDNUM (0x6FFFFFFF) ELF dynamic sections: | |
9ecaa95d FF |
152 | |
153 | WARNING: linker: $BINARY: unused DT entry: type 0x6ffffffe arg ... | |
154 | WARNING: linker: $BINARY: unused DT entry: type 0x6fffffff arg ... | |
798619b9 | 155 | These may come from version scripts in a Makefile such as: |
9ecaa95d FF |
156 | |
157 | -Wl,--version-script=$(top_srcdir)/proc/libprocps.sym | |
798619b9 | 158 | The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem. |