gdb-static-cross/README.md

142 lines
10 KiB
Markdown
Raw Normal View History

2017-05-16 00:36:04 +08:00
## Build scripts and toolchain helpers and how to build a cross-compile and statically link gdbserver
2017-05-04 07:37:28 +08:00
2017-05-16 00:32:02 +08:00
First things first, I apologize for the poor documentation but I did not intend to write any. Hopefully it's better than nothing
2017-05-06 03:07:31 +08:00
2017-05-16 00:32:02 +08:00
### What this repository is NOT
2017-05-04 07:37:28 +08:00
2017-05-16 00:32:02 +08:00
This repository is not a toolchain or a toolchain builder
2017-05-16 00:32:02 +08:00
### What this repository *kind of* is
2017-05-16 00:32:02 +08:00
A HOWTO on building a statically linked gdbserver without much hacking
2017-05-04 07:37:28 +08:00
2017-05-16 00:32:02 +08:00
### What this repository IS when fully utilized
2017-05-04 07:50:14 +08:00
2017-05-26 00:17:28 +08:00
This repository is for when you don't want something as heavy as crosstool-ng or buildroot. You just need to cross-compile and statically link a few binaries, for example gdbserver, and you have musl/uClibc/glibc toolchain to work from already built. This focuses on gdb-7.12, but you can use these scripts in one form or another when building just about anything, though you will need to modify them from time to time to suit your needs. While they function out of the box for my needs, it is best you think of them as living documentation / reference material for a simpleish task that can be confusing for first-timers, and slow for veterans
2017-05-04 07:50:14 +08:00
2017-05-26 00:17:28 +08:00
* [activate-openwrt-toolchain.env](https://github.com/mzpqnxow/gdb-static-cross/blob/master/activate-script-helpers/activate-openwrt-toolchain.env) - place file in prebuilt OpenWRT toolchain root, source it for productivity, etc.
* [activate-musl-toolchain.env](https://github.com/mzpqnxow/gdb-static-cross/blob/master/activate-script-helpers/activate-musl-toolchain.env) - place file in musl-cross-make toolchain root, source it for productivity, etc.
* [gdbserver-7.12-static-build.sh](https://github.com/mzpqnxow/gdb-static-cross/blob/master/gdbserver-7.12-static-build.sh) - shell script to build a static gdb-7.12 gdbserver using a cross-compile toolchain. Should be executed from gdb-7.12-/gdb/gdbserver/ which is extracted from the [gdbserver-7.12.tar.gz](https://ftp.gnu.org/gnu/gdb/gdb-7.12.1.tar.gz) tarball from GNU distribution sites or from this repository
2017-05-04 07:50:14 +08:00
2017-05-16 00:34:32 +08:00
*Note that you can use the `--disable-build-with-cxx` option when configuring gdb-7.12/gdb/gdbserver in some cases to make your life easier*
2017-05-16 00:32:02 +08:00
### ATTENTION!
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
***If you just want to download a statically linked gdbserver for a specific MIPS(EL) or ARM platform, check the [prebuilt](https://github.com/mzpqnxow/gdb-static-cross/tree/master/prebuilt/) directory***
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
I tried to compile builds as portable as possible (i.e. emulating FP in software) and got a lot out of use of what was produced in real life situations, so you should find them somewhat reliable on Linux based embedded devices
2017-05-04 07:50:14 +08:00
2017-05-16 00:32:02 +08:00
### If you want to build things other than gdbserver
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
Some open source projects have no real build system, and many have very strange custom build systems that don't use the "standard" `./configure && make && make install` style build system . You can check out [embedded-toolkt](https://github.com/mzpqnxow/embedded-toolkit) and look in the [src](https://github.com/mzpqnxow/embedded-toolkit/tree/master/src) directory for examples of using these scripts before building various tools such as *gawk*, *gdbserver*, *tcpdump*, *libpcap*, *lsof*, *etc* which have some unique build systems, especially lsof... WTF lsof? Also, if you have a toolchain without wchar, use mawk instead of gawk. The mawk source and patches to build mawk are also included in [src](https://github.com/mzpqnxow/embedded-toolkit/tree/master/src/mawk). You can also use this for simple `gcc bah.c -o bah` operations or `gcc bah.s -o bah`
2017-05-04 07:37:28 +08:00
2017-05-16 00:32:02 +08:00
## OpenWrt: Use `source activate-openwrt-toolchain.env` with a pre-built OpenWrt Toolchain
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
To use `activate-openwrt-toolchain.env` with a pre-built **OpenWrt Toolchain** you can follow these simple steps. First browse to [https://downloads.openwrt.org/snapshots/trunk/](https://downloads.openwrt.org/snapshots/trunk/) to find the toolchain you want to use. You can use `gcc -v` to determine if the options are right for your CPU
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
To use this script, assume you have a directory called /toolchains/ and that this is where you will keep the toolchains, one subdirectory per toolchain. To get a new toolchain up in such a way to use active-openwrt-toolchain, grab a file like [OpenWrt-Toolchain-brcm63xx-generic_gcc-5.3.0_musl-1.1.16.Linux-x86_64.tar.bz2](https://downloads.openwrt.org/snapshots/trunk/brcm63xx/generic/OpenWrt-Toolchain-brcm63xx-generic_gcc-5.3.0_musl-1.1.16.Linux-x86_64.tar.bz2)
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
### Build using OpenWRT and these scripts, step by step for the impatient cut and paste enthusiasts
2017-05-04 07:37:28 +08:00
```
$ cd ~/ && git clone https://github.com/mzpqnxow/gdb-7.12-crossbuilder
$ cd gdb-7.12-crossbuilder
$ wget https://.../OpenWrt-Toolchain-brcm63xx-generic_gcc-5.3.0_musl-1.1.16.Linux-x86_64.tar.bz2
$ tar -xvjf OpenWrt-Toolchain-brcm63xx-generic_gcc-5.3.0_musl-1.1.16.Linux-x86_64.tar.bz2
$ cd OpenWrt-Toolchain-brcm63xx-generic_gcc-5.3.0_musl-1.1.16.Linux-x86_64/
$ TOOLCHAIN=$(echo toolchain-*)
$ mv "$TOOLCHAIN" /openwrt-toolchains/
$ cp ~/gdb-7.12-crossbuilder/activate-openwrt-toolchain.env /openwrt-toolchains/$TOOLCHAIN/activate
$ source /openwrt-toolchains/$TOOLCHAIN/activate
```
2017-05-16 00:32:02 +08:00
## MUSL via [musl-cross-make](https://github.com/richfelker/musl-cross-make/): Use `source activate-musl-toolchain.env` with an installed toolchain built by musl-cross-make
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
Using [musl-cross-make](https://github.com/richfelker/musl-cross-make/) is a great experience and kudos to [@richfelker](https://github.com/richfelker) for making it available. I recommend you try it, even just for testing a sample i486 toolchain, useful for building statically linked libraries for common desktop/server platforms. If you do try it, all you need to do is edit the musl-cross-make config.mak file to specify the architecture and any other flags as well as installation path and then use make -j and make install. That's it. You're done. The activate-musl-toolchain file provided here is for you to place in the root of the installed toolchain to use as a convenience to "activate" the toolchain in your environment for use with *weird* build systems, or for software with no build system at all. You use it by simply `source`ing it in your active shell. Sorry, there is no deactivate. Just start a new shell to restore your environment. Here's an example
2017-05-04 07:37:28 +08:00
```
$ export TOOLCHAIN_DEST=/musl-cross-make-toolchains/toolchain-mips_mips32_musl/
$ cd ~/
2017-05-16 00:32:02 +08:00
$ git clone https://github.com/richfelker/musl-cross-make
2017-05-04 07:37:28 +08:00
$ cd musl-cross-make
$ vi config.mak
... assume you're installing to $TOOLCHAIN_DEST ...
$ make -j && make install
$ cd ~/
$ git clone https://github.com/mzpqnxow/gdb-7.12-crossbuilder
$ cd gdb-7.12-crossbuilder
$ cp activate-musl-toolchain.env $TOOLCHAIN_DEST/activate
$ source $TOOLCHAIN_DEST/activate
$ wget https://ftp.gnu.org/gnu/gdb/gdb-7.12.tar.xz
$ tar -xvf gdb-7.12.tar.xz
$ cp gdbserver-7.12-static-build.sh gdb-7.12/gdb/gdbserver
$ cd gdb-7.12/gdb/gdbserver
$ ./gdbserver-7.12-static-build.sh
$ file gdbserver
gdbserver: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), statically linked, not stripped
```
2017-05-16 00:32:02 +08:00
### Capabilities provided by the shell source scripts
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
Look at the end of each .env file. You will see some variables exported, hopefully intuitively named. Those variables can now be accessed in your shell while building software with your toolchain with no need to adjust paths or locate static libraries. Tools like gcc, ar, as, ld, g++, etc. will also now be in your path and there will be a `cross_configure` alias in the shell to simplify using software packages that utilize `./configure` build systems, just replace `./configure` with `cross_configure`. This is a very simple alias that just includes the `--host` and `--prefix` options set, it's not magic.
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
#### Sample environment variables set after activating an OpenWrt toolchain
2017-05-04 07:37:28 +08:00
2017-05-16 00:41:25 +08:00
```
DL_STATIC=/opt/openwrt/armel-gnu-eabi5-sysv/lib/libdl.a
2017-05-04 07:37:28 +08:00
C_STATIC=/opt/openwrt/armel-gnu-eabi5-sysv/lib/libc.a
STDCXX_STATIC=/opt/openwrt/armel-gnu-eabi5-sysv/lib/libstdc++.a
UTIL_STATIC=/opt/openwrt/armel-gnu-eabi5-sysv/lib/libutil.a
PTHREAD_STATIC=/opt/openwrt/armel-gnu-eabi5-sysv/lib/libpthread.a
GCCEH_STATIC=/opt/openwrt/armel-gnu-eabi5-sysv/lib/gcc/arm-openwrt-linux-muslgnueabi/5.3.0/libgcc_eh.a
STAGING_DIR=/opt/openwrt/armel-gnu-eabi5-sysv
TOOLCHAIN_ROOT=/opt/openwrt/armel-gnu-eabi5-sysv
TOOLCHAIN_BIN=/opt/openwrt/armel-gnu-eabi5-sysv/bin
TOOLCHAIN_TARGET=arm-openwrt-linux-muslgnueabi
2017-05-16 00:41:25 +08:00
SYSTEM_ROOT=/opt/openwrt/armel-gnu-eabi5-sysv
```
2017-05-04 07:37:28 +08:00
2017-05-26 00:17:28 +08:00
#### Sample alias that you will find in your environment
2017-05-04 07:37:28 +08:00
2017-05-16 00:41:25 +08:00
`alias cross_configure='./configure --host=arm-openwrt-linux-muslgnueabi --prefix=/opt/openwrt/armel-gnu-eabi5-sysv'`
2017-05-16 00:32:02 +08:00
2017-05-26 00:17:28 +08:00
### Doing a plain old build of gdbserver for the same host and target (i.e. no special toolchain, 'native' build)
2017-05-16 00:32:02 +08:00
2017-05-26 00:17:28 +08:00
*This is not something you will be doing often as with gdbserver you will almost always be using a non-native toolchain. However, I wanted to include an example of how it can be cleanly done in a standard build environment. It assumes glibc, which is not really a good target for building non-trivial statically executables. With a minimal amount of effort you can build a musl toolchain for x86_64 or i486*
2017-05-16 00:32:02 +08:00
#### Find static libraries you will need to link gdbserver with
You will need to make sure you have libstdc++.a and libgcc_eh.a on your system. If you don't know what you're doing, you can just use find. Try using the following:
2017-05-04 07:37:28 +08:00
```
2017-05-16 00:32:02 +08:00
$ find /l* /u* -name libgcc_eh.a
... choose the appropriate one if you have a multilib system ..
$ export LIBGCC=/usr/lib/gcc/x86_64-linux-gnu/4.9/libgcc_eh.a
$ find /l* /u* -name libstdc++.a
... choose the appropriate one if you have a multilib system ..
$ export LIBCXX=/usr/lib/gcc/x86_64-linux-gnu/4.9/libstdc++.a
$ export CC=gcc-4.9
... set this if you have multiple versions of gcc on your system ...
2017-05-04 07:37:28 +08:00
```
2017-05-16 00:32:02 +08:00
#### Perform the build
```
$ wget https://ftp.gnu.org/gnu/gdb/gdb-7.12.tar.xz
$ tar -xvf gdb-7.12.tar.xz
$ cd gdb-7.12/gdb/gdbserver
$ sed -i -e 's/srv_linux_thread_db=yes//' configure.srv
2017-05-26 00:17:28 +08:00
... optionally apply architecture specific patches, not required for x86 or x86_64 though
2017-05-16 00:32:02 +08:00
$ ./configure --prefix=/opt/gdbserver-7.12-static CXXFLAGS='-fPIC -static'
$ make -j gdbserver GDBSERVER_LIBS="$LIBGCC $LIBCXX"
```
2017-05-16 00:42:53 +08:00
You should now have a statically compiled GDB 7.12 gdbserver for your native OS. Read on for the cross-compile stuff, which is a little more involved but still pretty simple.
2017-05-26 00:17:28 +08:00
*NOTE: You really should use uClibc or musl for your libc, not glibc, because of libnss which requires dynamic library loading via libdl*
2017-05-16 00:32:02 +08:00
2017-05-04 07:37:28 +08:00
## License
2017-05-16 00:32:02 +08:00
* The shell scripts and source files here are is released under the terms of GPLv2 by copyright@mzpqnxow.com
* Please see LICENSE or LICENSE.md for more information on GPLv2
* Third party software is included with license information intact