X-Git-Url: https://git.distorted.org.uk/~mdw/termux-packages/blobdiff_plain/a9abb520559ae5681d5fb7d5575670593b5df792..0b4923cdcf8545d12f2135ff28a19d030afc70ec:/README.md diff --git a/README.md b/README.md index 3c536fc8..971d589c 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,80 @@ -termux-packages +Termux packages =============== +[![Join the chat at https://gitter.im/termux/termux](https://badges.gitter.im/termux/termux.svg)](https://gitter.im/termux/termux) + This project contains scripts and patches to cross compile and package packages for the [Termux](http://termux.com/) Android application. +The scripts and patches to build each package is licensed under the same license as +the actual package (so the patches and scripts to build bash are licensed under +the same license as bash, while the patches and scripts to build python are licensed +under the same license as python, etc). + +NOTE: This is in a rough state - be prepared for some work and frustrations, and give +feedback if you find incorrect our outdated things! + +Initial setup +============= +Building packages are for now only tested to work on Ubuntu 15.10. Perform the following +setup steps: + +* Run `ubuntu-setup.sh` to install required packages and setup the `/data/` folder (see below). + +* Install the Android SDK at `$HOME/lib/android-sdk`. Override this by setting the environment +variable `$ANDROID_HOME` to point at another location. + +* Install the Android NDK, version r11, at `$HOME/lib/android-ndk`. Override this by setting +the environment variable `$NDK` to point at another location. + +Alternatively a Dockerfile is provided which sets up a pristine image +suitable for building packages. To build the docker image, run the +following command: -Overview -======== + docker build --rm=true -t termux . + +After build is successful, you can open an interactive prompt inside the +container using: + + docker run --rm=true -ti termux /bin/bash + + +Building a package +================== In a non-rooted Android device an app such as Termux may not write to system locations, which is why every package is installed inside the private file area of the Termux app: - PREFIX=/data/data/com.termux/files/usr + + PREFIX=/data/data/com.termux/files/usr For simplicity while developing and building, the build scripts here assume that a /data -folder is reserved for use on the host builder, which requires setup: - sudo mkdir /data - sudo chown $USER /data - -The basic flow is then to run "./build-package.sh $PKG", which - - Sets up a patched stand-alone Android NDK toolchain - - Reads packages/$PKG/build.sh to find out where to find the source code of the - package and how to build it. - - Applies all patches in packages/$PKG/\*.patch - - Builds the package and installs it to $PREFIX - - Packages the package in one or more .dpkg files for distribution +folder is reserved for use on the host builder and install everything there. + +The basic flow is then to run "./build-package.sh $PKG", which: +* Sets up a patched stand-alone Android NDK toolchain + +* Reads packages/$PKG/build.sh to find out where to find the source code of the package and how to build it. + +* Applies all patches in packages/$PKG/\*.patch + +* Builds the package and installs it to $PREFIX + +* Creates a dpkg package file for distribution. + Reading and following build-package.sh is the best way to understand what's going on here. -Additional utilities are contained here: - - build-all.sh, used for building all packages in the correct order (using buildorder.py) - - check-pie.sh, used for verifying that all binaries are using PIE, which is required for Android 5+ - - check-versions.sh, used for checking for package updates - - clean-rebuild-all.sh, used for doing a clean rebuild of all packages (takes a couple of hours) - - list-packages.sh, used for listing all packages with a one-line summary + +Additional utilities +==================== +* build-all.sh: used for building all packages in the correct order (using buildorder.py) + +* check-pie.sh: Used for verifying that all binaries are using PIE, which is required for Android 5+ + +* detect-hardlinks.sh: Used for finding if any packages uses hardlinks, which does not work on Android M + +* check-versions.sh: used for checking for package updates + +* clean-rebuild-all.sh: used for doing a clean rebuild of all packages (takes a couple of hours) + +* list-packages.sh: used for listing all packages with a one-line summary Resources about cross-compiling packages @@ -64,12 +109,7 @@ contains these and may be used by all packages. * <sys/fcntl.h> does not exist, but <fcntl.h> is the standard location. -* glob(3) system function (glob.h) - not in bionic, but use the libglob package - -* undefined reference to 'rpl_malloc' and/or 'rpl_realloc': These functions are added by some autoconf setups - when it fails to detect 0-safe malloc and realloc during cross-compilating. Avoided by defining - "ac_cv_func_malloc_0_nonnull=yes ac_cv_func_realloc_0_nonnull=yes". - See http://wiki.buici.com/xwiki/bin/view/Programing+C+and+C%2B%2B/Autoconf+and+RPL_MALLOC +* glob(3) system function (glob.h) - not in bionic, but use the `libandroid-glob` package * cmake and cross compiling: http://www.cmake.org/Wiki/CMake_Cross_Compiling CMAKE_FIND_ROOT_PATH=$TERMUX_PREFIX to search there. @@ -85,64 +125,37 @@ contains these and may be used by all packages. dlopen() and RTLD_* flags ================================= -<dlfn.h> declares +<dlfcn.h> originally declares -> enum { RTLD_NOW = 2, RTLD_LAZY = 1, RTLD_LOCAL = 0, RTLD_GLOBAL = 0x00100, RTLD_NOLOAD = 4}; // 64 bit -> enum { RTLD_NOW = 0, RTLD_LAZY = 1, RTLD_LOCAL = 0, RTLD_GLOBAL = 2, RTLD_NOLOAD = 4}; // 32 bit + enum { RTLD_NOW=0, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=2, RTLD_NOLOAD=4}; // 32-bit + enum { RTLD_NOW=2, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=0x00100, RTLD_NOLOAD=4}; // 64-bit These differs from glibc ones in that -1. They are not preprocessor #define:s so cannot be checked for with #ifdef RTLD_GLOBAL (dln.c in ruby does this) +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. 2. They differ in value from glibc ones, so cannot be hardcoded in files (DLFCN.py in python does this) -3. They are missing some values (RTLD_BINDING_MASK, RTLD_NOLOAD, ...) +3. They are missing some values (`RTLD_BINDING_MASK`, `RTLD_NOLOAD`, ...) RPATH, LD_LIBRARY_PATH AND RUNPATH ================================== On desktop linux the linker searches for shared libraries in: + 1. RPATH - a list of directories which is linked into the executable, supported on most UNIX systems. It is ignored if RUNPATH is present. 2. LD_LIBRARY_PATH - an environment variable which holds a list of directories -3. RUNPATH - same as RPATH, but searched after LD_LIBRARY_PATH, supported only on most recent UNIX systems, e.g. on most current Linux systems -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. +3. RUNPATH - same as RPATH, but searched after LD_LIBRARY_PATH, supported only on most recent UNIX systems + +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. Warnings about unused DT entries ================================ 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 arg ... - WARNING: linker: $BINARY: unused DT entry: type 0x6fffffff arg ... -These may come from version scripts in a Makefile such as: - -Wl,--version-script=$(top_srcdir)/proc/libprocps.sym -The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem. -Obtaining shell access on an emulator -===================================== -First install and start sshd on device: - apt install openssh - sshd -The follow the below steps: - # Find out the linux user for the package to use in the chown command later: - adb shell dumpsys package com.termux | grep userId= - # Push your public ssh key: - adb push $HOME/.ssh/id_dsa.pub /data/data/com.termux/files/home/.ssh/authorized_keys - # Use the linux user for the package, 10053 below, to set ownerhip and permissions: - adb shell chown -R 10053 /data/data/com.termux/files/home/.ssh/ - adb shell chmod -R 0700 /data/data/com.termux/files/home/.ssh/ - # Forward port 8022 to the emulator: - adb forward tcp:8022 tcp:8022 - # Finally connect with ssh: - ssh -p 8022 localhost - -Bootstrapping -============= -To get files on device one option is: - udpsvd -vE 0.0.0.0 8069 tftpd -c . # Run on device. -c arg to allow file uploading - printf "mode binary\nput out.md\nquit" | tftp 192.168.0.12 8069 # on computer -Another is with ftp: - tcpsvd -vE 0.0.0.0 8021 ftpd -w . # Run on device. -w arg to allow file uploading - printf "put tmp.c\nquit" | ftp -n 192.168.0.12 8021 # Run on computer. -n arg to use anonymous login -NOTE: The ftpd and tftpd programs has been patched to run without chroot. This means that the directory - serving is only the starting point and clients may cd out of if the access the whole system! + WARNING: linker: $BINARY: unused DT entry: type 0x6ffffffe arg ... + WARNING: linker: $BINARY: unused DT entry: type 0x6fffffff arg ... +These may come from version scripts in a Makefile such as: + -Wl,--version-script=$(top_srcdir)/proc/libprocps.sym +The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem.