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 | ============================== | |
30 | A Docker container configured for building images can be downloaded an 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 | |
36 | the host and the container when trying things out before committing. | |
5e8045c9 | 37 | |
88183689 FF |
38 | The build output folder is mounted to $HOME/termux, so deb files can be found in |
39 | $HOME/termux/_deb on the host for trying them out on a device or emulator. | |
5e8045c9 | 40 | |
798619b9 | 41 | |
9ecaa95d FF |
42 | Building a package |
43 | ================== | |
88183689 | 44 | The basic build operation is to run `./build-package.sh $PKG`, which: |
798619b9 | 45 | |
3c323c69 | 46 | * Sets up a patched stand-alone Android NDK toolchain if necessary. |
9ecaa95d | 47 | |
88183689 | 48 | * Reads `packages/$PKG/build.s`h to find out where to find the source code of the package and how to build it. |
9ecaa95d | 49 | |
3c323c69 | 50 | * Applies all patches in packages/$PKG/\*.patch. |
9ecaa95d | 51 | |
3c323c69 | 52 | * Builds the package and installs it to `$PREFIX`. |
9ecaa95d | 53 | |
3c323c69 | 54 | * Creates a dpkg package file for distribution in `$HOME/termux/_deb`. |
1773070c | 55 | |
88183689 | 56 | Reading `build-package.sh` is the best way to understand what is going on. |
798619b9 | 57 | |
9ecaa95d FF |
58 | |
59 | Additional utilities | |
60 | ==================== | |
88183689 | 61 | * build-all.sh: used for building all packages in the correct order (using buildorder.py). |
9ecaa95d | 62 | |
88183689 | 63 | * clean-rebuild-all.sh: used for doing a clean rebuild of all packages. |
9ecaa95d | 64 | |
88183689 | 65 | * scripts/check-pie.sh: Used for verifying that all binaries are using PIE, which is required for Android 5+. |
9ecaa95d | 66 | |
88183689 | 67 | * scripts/detect-hardlinks.sh: Used for finding if any packages uses hardlinks, which does not work on Android M. |
9ecaa95d | 68 | |
88183689 | 69 | * scripts/check-versions.sh: used for checking for package updates. |
9ecaa95d | 70 | |
88183689 | 71 | * scripts/list-packages.sh: used for listing all packages with a one-line summary. |
798619b9 FF |
72 | |
73 | ||
74 | Resources about cross-compiling packages | |
75 | ======================================== | |
76 | * [Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/svn/index.html) | |
77 | ||
88183689 | 78 | * [Beyond Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/stable/) |
798619b9 | 79 | |
88183689 | 80 | * [Cross-Compiled Linux From Scratch](http://www.clfs.org/view/CLFS-3.0.0-SYSVINIT/mips64-64/) |
798619b9 | 81 | |
88183689 | 82 | * [OpenWrt](https://openwrt.org/) as an embedded Linx distribution contains [patches and build scripts](https://dev.openwrt.org/browser/packages) |
798619b9 | 83 | |
88183689 | 84 | * 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 | 85 | |
88183689 | 86 | * [Kivy recipes](https://github.com/kivy/python-for-android/tree/master/pythonforandroid/recipes) contains recipes for building packages for Android. |
798619b9 FF |
87 | |
88 | ||
89 | Common porting problems | |
90 | ======================= | |
91 | * The Android bionic libc does not have iconv and gettext/libintl functionality built in. A package from the NDK, libandroid-support, | |
92 | contains these and may be used by all packages. | |
93 | ||
94 | * "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 | |
95 | ||
96 | * rindex(3) is defined in <strings.h> but does not exist in NDK, but strrchr(3) from <string.h> is preferred anyway | |
97 | ||
98 | * <sys/termios.h> does not exist, but <termios.h> is the standard location. | |
99 | ||
100 | * <sys/fcntl.h> does not exist, but <fcntl.h> is the standard location. | |
101 | ||
3b8f4313 | 102 | * glob(3) system function (glob.h) - not in bionic, but use the `libandroid-glob` package |
798619b9 | 103 | |
88183689 FF |
104 | * [Cmake and cross compiling](http://www.cmake.org/Wiki/CMake_Cross_Compiling). |
105 | `CMAKE_FIND_ROOT_PATH=$TERMUX_PREFIX` to search there. | |
106 | `CMAKE_FIND_ROOT_PATH_MODE_LIBRARY=ONLY` and `CMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY` | |
798619b9 FF |
107 | for only searching there and don't fall back to build machines |
108 | ||
109 | * Android is removing sys/timeb.h because it was removed in POSIX 2008, but ftime(3) can be replaced with gettimeofday(2) | |
110 | ||
111 | * mempcpy(3) is a GNU extension. We have added it to <string.h> provided TERMUX_EXPOSE_MEMPCPY is defined, | |
112 | so use something like CFLAGS+=" -DTERMUX_EXPOSE_MEMPCPY=1" for packages expecting that function to exist. | |
113 | ||
114 | ||
115 | dlopen() and RTLD_* flags | |
116 | ================================= | |
29db5b35 | 117 | <dlfcn.h> originally declares |
798619b9 | 118 | |
9ecaa95d FF |
119 | enum { RTLD_NOW=0, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=2, RTLD_NOLOAD=4}; // 32-bit |
120 | enum { RTLD_NOW=2, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=0x00100, RTLD_NOLOAD=4}; // 64-bit | |
798619b9 FF |
121 | |
122 | These differs from glibc ones in that | |
123 | ||
88183689 | 124 | 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 | 125 | 2. They differ in value from glibc ones, so cannot be hardcoded in files (DLFCN.py in python does this) |
29db5b35 | 126 | 3. They are missing some values (`RTLD_BINDING_MASK`, `RTLD_NOLOAD`, ...) |
798619b9 FF |
127 | |
128 | ||
88183689 FF |
129 | RPATH, RUNPATH AND LD\_LIBRARY\_PATH |
130 | ==================================== | |
798619b9 | 131 | On desktop linux the linker searches for shared libraries in: |
1ddf1728 | 132 | |
88183689 FF |
133 | 1. `RPATH` - a list of directories which is linked into the executable, supported on most UNIX systems. It is ignored if `RUNPATH` is present. |
134 | 2. `LD_LIBRARY_PATH` - an environment variable which holds a list of directories | |
135 | 3. `RUNPATH` - same as `RPATH`, but searched after `LD_LIBRARY_PATH`, supported only on most recent UNIX systems | |
1ddf1728 | 136 | |
88183689 | 137 | 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 |
138 | |
139 | ||
140 | Warnings about unused DT entries | |
141 | ================================ | |
142 | Starting from 5.1 the Android linker warns about VERNEED (0x6FFFFFFE) and VERNEEDNUM (0x6FFFFFFF) ELF dynamic sections: | |
9ecaa95d FF |
143 | |
144 | WARNING: linker: $BINARY: unused DT entry: type 0x6ffffffe arg ... | |
145 | WARNING: linker: $BINARY: unused DT entry: type 0x6fffffff arg ... | |
88183689 | 146 | |
798619b9 | 147 | These may come from version scripts in a Makefile such as: |
9ecaa95d FF |
148 | |
149 | -Wl,--version-script=$(top_srcdir)/proc/libprocps.sym | |
88183689 | 150 | |
798619b9 | 151 | The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem. |