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 FF |
5 | This project contains scripts and patches to cross compile and package packages for |
6 | the [Termux](http://termux.com/) Android application. | |
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 | ||
16 | Initial setup | |
17 | ============= | |
bf13a244 | 18 | Building packages are for now only tested to work on Ubuntu 15.10. Perform the following |
1773070c FF |
19 | setup steps: |
20 | ||
21 | * Run `ubuntu-setup.sh` to install required packages and setup the `/data/` folder (see below). | |
22 | ||
23 | * Install the Android SDK at `$HOME/lib/android-sdk`. Override this by setting the environment | |
24 | variable `$ANDROID_HOME` to point at another location. | |
25 | ||
c30d3822 | 26 | * Install the Android NDK, version r11, at `$HOME/lib/android-ndk`. Override this by setting |
1773070c FF |
27 | the environment variable `$NDK` to point at another location. |
28 | ||
5e8045c9 AC |
29 | Alternatively a Dockerfile is provided which sets up a pristine image |
30 | suitable for building packages. To build the docker image, run the | |
31 | following command: | |
32 | ||
33 | docker build --rm=true -t termux . | |
34 | ||
35 | After build is successful, you can open an interactive prompt inside the | |
36 | container using: | |
37 | ||
38 | docker run --rm=true -ti termux /bin/bash | |
39 | ||
798619b9 | 40 | |
9ecaa95d FF |
41 | Building a package |
42 | ================== | |
798619b9 FF |
43 | In a non-rooted Android device an app such as Termux may not write to system locations, |
44 | which is why every package is installed inside the private file area of the Termux app: | |
3b8f4313 FF |
45 | |
46 | PREFIX=/data/data/com.termux/files/usr | |
798619b9 FF |
47 | |
48 | For simplicity while developing and building, the build scripts here assume that a /data | |
1773070c | 49 | folder is reserved for use on the host builder and install everything there. |
798619b9 | 50 | |
3b8f4313 FF |
51 | The basic flow is then to run "./build-package.sh $PKG", which: |
52 | * Sets up a patched stand-alone Android NDK toolchain | |
9ecaa95d FF |
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 | * Applies all patches in packages/$PKG/\*.patch | |
57 | ||
58 | * Builds the package and installs it to $PREFIX | |
59 | ||
1773070c FF |
60 | * Creates a dpkg package file for distribution. |
61 | ||
798619b9 FF |
62 | Reading and following build-package.sh is the best way to understand what's going on here. |
63 | ||
9ecaa95d FF |
64 | |
65 | Additional utilities | |
66 | ==================== | |
67 | * build-all.sh: used for building all packages in the correct order (using buildorder.py) | |
68 | ||
69 | * check-pie.sh: Used for verifying that all binaries are using PIE, which is required for Android 5+ | |
70 | ||
71 | * detect-hardlinks.sh: Used for finding if any packages uses hardlinks, which does not work on Android M | |
72 | ||
73 | * check-versions.sh: used for checking for package updates | |
74 | ||
75 | * clean-rebuild-all.sh: used for doing a clean rebuild of all packages (takes a couple of hours) | |
76 | ||
77 | * list-packages.sh: used for listing all packages with a one-line summary | |
798619b9 FF |
78 | |
79 | ||
80 | Resources about cross-compiling packages | |
81 | ======================================== | |
82 | * [Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/svn/index.html) | |
83 | ||
84 | * [Beyond Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/svn/) | |
85 | ||
86 | * [Cross-Compiled Linux From Scratch](http://cross-lfs.org/view/svn/x86_64-64/) | |
87 | ||
88 | * [OpenWrt](https://openwrt.org/), an embedded Linx distribution, contains [patches and build scripts](https://dev.openwrt.org/browser/packages) | |
89 | ||
90 | * 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. | |
91 | ||
92 | * [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). | |
93 | ||
94 | * [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. | |
95 | ||
96 | * [Kivy recipes](https://github.com/kivy/python-for-android/tree/master/recipes) contains recipes for building packages for Android. | |
97 | ||
98 | ||
99 | Common porting problems | |
100 | ======================= | |
101 | * The Android bionic libc does not have iconv and gettext/libintl functionality built in. A package from the NDK, libandroid-support, | |
102 | contains these and may be used by all packages. | |
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 | |
798619b9 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 | |
117 | CMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY | |
118 | for only searching there and don't fall back to build machines | |
119 | ||
120 | * Android is removing sys/timeb.h because it was removed in POSIX 2008, but ftime(3) can be replaced with gettimeofday(2) | |
121 | ||
122 | * mempcpy(3) is a GNU extension. We have added it to <string.h> provided TERMUX_EXPOSE_MEMPCPY is defined, | |
123 | so use something like CFLAGS+=" -DTERMUX_EXPOSE_MEMPCPY=1" for packages expecting that function to exist. | |
124 | ||
125 | ||
126 | dlopen() and RTLD_* flags | |
127 | ================================= | |
29db5b35 | 128 | <dlfcn.h> originally declares |
798619b9 | 129 | |
9ecaa95d FF |
130 | enum { RTLD_NOW=0, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=2, RTLD_NOLOAD=4}; // 32-bit |
131 | enum { RTLD_NOW=2, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=0x00100, RTLD_NOLOAD=4}; // 64-bit | |
798619b9 FF |
132 | |
133 | These differs from glibc ones in that | |
134 | ||
29db5b35 FF |
135 | 1. They are not preprocessor #define:s so cannot be checked for with `#ifdef RTLD_GLOBAL`. Termux patches this to |
136 | #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 | ||
141 | RPATH, LD_LIBRARY_PATH AND RUNPATH | |
142 | ================================== | |
143 | On desktop linux the linker searches for shared libraries in: | |
1ddf1728 | 144 | |
798619b9 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 | |
1ddf1728 FF |
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=$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 |
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 ... | |
798619b9 | 158 | These may come from version scripts in a Makefile such as: |
9ecaa95d FF |
159 | |
160 | -Wl,--version-script=$(top_srcdir)/proc/libprocps.sym | |
798619b9 | 161 | The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem. |