Project

General

Profile

Cross-compiling NDN projects for home routers » History » Version 11

Mathias Gibbens, 10/29/2015 11:40 AM
Reference #3303

1 1 Mathias Gibbens
Cross-compiling NDN projects for home routers
2
=============================================
3
4
Contents
5
--------
6
7
*  [Introduction](#Introduction)
8
*  [Setting up the build host](#Setting-up-the-build-host)
9
*  [OpenWRT source and toolchain](#OpenWRT-source-and-toolchain)
10
*  [DD-WRT source and toolchain](#DD-WRT-source-and-toolchain)
11
*  [Compiling ndn-cxx](#Compiling-ndn-cxx)
12
*  [Using the ndn-cxx library with other NDN projects](#Using-the-ndn-cxx-library-with-other-NDN-projects)
13
*  [Concluding remarks](#Concluding-remarks)
14
15
Introduction
16
------------
17
18 5 Mathias Gibbens
This page describes how to cross compile NDN projects to run on wireless home routers that are supported by various open source firmwares, such as [OpenWRT](https://openwrt.org/) and [DD-WRT](http://dd-wrt.com/). Currently, it is easier to use OpenWRT. Building NDN projects to run on a router is a fairly straight forward process, but it is assumed that you are familiar with basic software development in a Linux environment, have some familiarity with cross compiling in general, and aren't afraid to get your hands dirty! There are also a couple considerations that need to be addressed when targeting smaller/embedded devices, especially concerning the limited flash storage typically available on routers.
19 1 Mathias Gibbens
20
The process of setting up the build host and actually compiling the NDN project will be the same regardless of the hardware/firmware you wish to target. Follow the corresponding section that matches your firmware to get the proper cross compile environment.
21
22
Setting up the build host
23
-------------------------
24
25 9 Mathias Gibbens
Steps in this guide were tested on a system running Debian 8 (jessie). Distribution specific commands, like installing packages, may have to be modified to suit your setup, but on the whole this guide should be applicable to any modern Linux system. All commands should be run as a normal user -- never as root!
26 1 Mathias Gibbens
27
Make sure you have the needed packages on the host system to compile the cross compile toolchain, libraries, and resulting firmware:
28
29 2 Mathias Gibbens
    sudo apt-get install build-essential subversion git-core libncurses5-dev zlib1g-dev gawk unzip pkg-config
30 1 Mathias Gibbens
31 2 Mathias Gibbens
Finally, before we actually begin the compilation process, be aware that the paths given below which reference a specific build target (like "mipsel\_mips32_uClibc-0.9.33.2") very well could be different for you. Be sure to make the appropriate adjustments to match your setup.
32 1 Mathias Gibbens
33
OpenWRT source and toolchain
34
----------------------------
35
36 2 Mathias Gibbens
Begin by fetching the current code for OpenWRT. Additional instructions are available on that project's wiki: [OpenWrt Buildroot - Installation](http://wiki.openwrt.org/doc/howto/buildroot.exigence). This guide assumes you checked out the source to your home directory.
37 1 Mathias Gibbens
38
    git clone git://git.openwrt.org/openwrt.git
39
    cd ~/openwrt/
40 4 Mathias Gibbens
41
You will need to edit the feed configuration file `feeds.conf.default` to re-enable the "oldpackages" repository. Simply find that line, and remove the leading `#`. Once done, the line should look like `src-git oldpackages http://git.openwrt.org/packages.git`. Now, fetch the current feed information and populate the package choices for the next step.
42
43 1 Mathias Gibbens
    ./scripts/feeds update -a
44
    ./scripts/feeds install -a
45
46
We need to fetch the current feed information, as that is where we get the boost, libcrypto++, and libsqlite3 libraries to run in OpenWRT.
47
48
Now, run the configuration interface and adjust the settings as you need to match your device, etc.
49
50
    cd ~/openwrt/
51
    make menuconfig
52
53 10 Mathias Gibbens
**IMPORTANT** As of June 2015, the OpenWRT project has [switched to a new C library](https://lists.openwrt.org/pipermail/openwrt-devel/2015-June/033702.html) called musl. If you are running OpenWRT 15.05 (Chaos Calmer) or earlier, you must change the C library that the toolchain will use back to uClib, otherwise your cross compiled code _will not run_ on the router. If you are running a development version of OpenWRT compiled from code after June 16, 2015, it will use the musl C library and you do not have to change anything.
54
55
Follow these options in the menuconfig to change the C library. (Note that you will have to first enable the options before actually selecting them.)
56
57
    Advanced configuration options (for developers) --->
58
        Toolchain Options --->
59
            C Library implementation (use musl) --->
60
                Use uClib
61
62 2 Mathias Gibbens
Additionally, make sure the following libraries are selected so we can compile the NDN software. (Additional libraries might be required for projects that go beyond ndn-cxx, like `libpcap` for [NFD](http://redmine.named-data.net/projects/NFD).)
63 1 Mathias Gibbens
64
    Libraries --->
65
        database --->
66
            libsqlite3
67 5 Mathias Gibbens
        boost --->
68
            Boost test package
69 10 Mathias Gibbens
            Boost atomic library
70 5 Mathias Gibbens
            Boost chrono library
71
            Boost date_time library
72
            Boost filesystem library
73 1 Mathias Gibbens
            Boost iostreams library
74 5 Mathias Gibbens
            Boost program_options library
75 6 Mathias Gibbens
            Boost random library
76 1 Mathias Gibbens
            Boost regex library
77 5 Mathias Gibbens
            Boost system library
78 6 Mathias Gibbens
            Boost thread library
79 1 Mathias Gibbens
        libcryptoxx
80
81
After you have the configuration to your liking, we need to compile the toolchain and libraries. This will take a while.
82
83
    make
84
85
Once the OpenWRT cross compile environment is compiled, we need to create two temporary symlinks so the later `./waf configure` stage will properly detect `libcrypto++`: (Again, remember that the target part of the path names may be different for you.)
86
87
    ln -s ~/openwrt/staging_dir/target-mipsel_mips32_uClibc-0.9.33.2/usr/include/crypto++ ~/openwrt/staging_dir/target-mipsel_mips32_uClibc-0.9.33.2/usr/include/cryptopp
88
    ln -s ~/openwrt/staging_dir/target-mipsel_mips32_uClibc-0.9.33.2/usr/lib/libcrypto++.so ~/openwrt/staging_dir/target-mipsel_mips32_uClibc-0.9.33.2/usr/lib/libcryptopp.so
89
90
Now the cross compile environment is ready for you to use. Proceed to [Compiling ndn-cxx](#Compiling-ndn-cxx).
91
92
DD-WRT source and toolchain
93 3 Mathias Gibbens
---------------------------
94
95
Configuring DD-WRT is a little more complicated than OpenWRT's setup. Begin by fetching the current code for DD-WRT. Additional instructions are available on that project's wiki: [Development - DD-WRT Wiki](http://www.dd-wrt.com/wiki/index.php/Development#Building_DD-WRT_from_Source). This guide assumes you checked out the source to your home directory.
96
97
    svn co svn://svn.dd-wrt.com/DD-WRT
98
    cd ~/DD-WRT/
99
100 5 Mathias Gibbens
Next, download the current cross compile toolchain for DD-WRT (note that the link on DD-WRT's wiki is broken, this is the correct one):
101 1 Mathias Gibbens
102 5 Mathias Gibbens
    wget ftp://ftp.dd-wrt.com/toolchains/toolchains.tar.gz
103 1 Mathias Gibbens
104 5 Mathias Gibbens
**FIXME** Need to complete this section. As of early 2015, it is easier to use the OpenWRT build system. I was able to cross-compile ndn-cxx and NFD using OpenWRT's system and then run the binaries on a DD-WRT flashed router. YMMV.
105 3 Mathias Gibbens
106
Now the cross compile environment is ready for you to use. Proceed to [Compiling ndn-cxx](#Compiling-ndn-cxx).
107 1 Mathias Gibbens
108
Compiling ndn-cxx
109
-----------------
110
111 2 Mathias Gibbens
In this section we will compile the [ndn-cxx](http://redmine.named-data.net/projects/ndn-cxx) library. Other NDN projects should compile in a similar manner.
112 1 Mathias Gibbens
113 2 Mathias Gibbens
As mentioned in the introduction, compiling for an embedded device can present issues not normally encountered. Chief among these for us is the very limited disk space to copy files to on the router. Normal compilation of a NDN project will by default produce binaries that include debug symbols. This can add an order of magnitude to the resulting binary size (101MB vs 15MB total), making it infeasible to run on a router. Therefore we will overwrite the default compiler flags with the `CXXFLAGS` variable. Additionally, the compilation process produces a statically linked library which is several megabytes in size. Unless it is specifically needed, there's no reason to copy it to the router where it will just waste space.
114 1 Mathias Gibbens
115 9 Mathias Gibbens
Begin by fetching the current release of ndn-cxx, 0.3.4 as of this writing:
116 1 Mathias Gibbens
117
    cd
118 9 Mathias Gibbens
    wget https://github.com/named-data/ndn-cxx/archive/ndn-cxx-0.3.4.tar.gz
119
    tar xf ndn-cxx-0.3.4.tar.gz
120
    cd ndn-cxx-ndn-cxx-0.3.4/
121 1 Mathias Gibbens
122 11 Mathias Gibbens
**IMPORTANT** If you are using the uClib C library, there is a [known issue](http://redmine.named-data.net/issues/3303) that will cause compilation to fail. This is fixed in the upcoming 0.4 release of the library.
123
124 1 Mathias Gibbens
Now, set the needed environment variables so the configuration and compilation process use the cross compile environment we have setup.
125
126 2 Mathias Gibbens
**FIXME** this is currently specific to OpenWRT
127 1 Mathias Gibbens
128
    export TOOLCHAIN_PATH=$HOME/openwrt/staging_dir/toolchain-mipsel_mips32_gcc-4.8-linaro_uClibc-0.9.33.2/bin
129
    export CROSSCOMPILE_PATH=$HOME/openwrt/staging_dir/target-mipsel_mips32_uClibc-0.9.33.2/usr
130
    export CXX=$TOOLCHAIN_PATH/mipsel-openwrt-linux-uclibc-g++
131
    export AR=$TOOLCHAIN_PATH/mipsel-openwrt-linux-uclibc-ar
132
    export CXXFLAGS="-O2"
133
    export CFLAGS="-I$CROSSCOMPILE_PATH/include"
134
    export LDFLAGS="-L$CROSSCOMPILE_PATH/lib -lz"
135
136
Finally, configure and build the library. We will install the resulting binaries and source files into a folder within our home directory so we don't accidentally contaminate our host system with non-native binaries.
137
138 6 Mathias Gibbens
    ./waf configure --prefix=/usr --sysconfdir=/etc --with-cryptopp=$CROSSCOMPILE_PATH --with-sqlite3=$CROSSCOMPILE_PATH --boost-includes=$CROSSCOMPILE_PATH/include --boost-libs=$CROSSCOMPILE_PATH/lib
139 1 Mathias Gibbens
    
140
    ./waf
141
    
142
    DESTDIR=$HOME/ndn-cxx-crosscompile ./waf install
143
144
You can now find the cross compiled binaries in `~/ndn-cxx-crosscompile`.
145
146
Using the ndn-cxx library with other NDN projects
147
-------------------------------------------------
148
149 2 Mathias Gibbens
Well, now that you've got the library cross compiled, you'll likely want to use it! Because it is both cross compiled as well as installed locally in your home directory, whatever project wants to use it will have to be told where to look. As a simple example, this section will show cross compiling [NFD](http://redmine.named-data.net/projects/NFD).
150 1 Mathias Gibbens
151 5 Mathias Gibbens
NFD requires the `libpcap` library, so make sure you've selected it when compiling your firmware and cross compile environment. (If you haven't, go back and do so, then rerun `make`. The second time should be much faster, as only the parts affected by configuration changes will have to be compiled.)
152 2 Mathias Gibbens
153 9 Mathias Gibbens
Similar to ndn-cxx, we will get the current release of NFD, 0.3.4 as of this writing:
154 5 Mathias Gibbens
155
    cd
156 9 Mathias Gibbens
    wget https://github.com/named-data/NFD/archive/NFD-0.3.4.tar.gz
157
    tar xf NFD-0.3.4.tar.gz
158
    cd NFD-NFD-0.3.4/
159 7 Mathias Gibbens
160 2 Mathias Gibbens
If the environment variables from the previous section aren't still set, reset them before proceeding.
161
162
NDN projects that use ndn-cxx assume they can get the necessary include directories and linking information via pkg-config. Because ndn-cxx isn't in the standard search path, we need to add it:
163
164
    export PKG_CONFIG_PATH=$HOME/ndn-cxx-crosscompile/usr/lib/pkgconfig:$PKG_CONFIG_PATH
165 1 Mathias Gibbens
166 6 Mathias Gibbens
Additionally, we need to tweak the configuration file for ndn-cxx so it includes the correct directories, since when the pkg-config file was generated, it assumed final installation based off the supplied `--prefix` option. Edit `~/ndn-cxx-crosscompile/usr/lib/pkgconfig/libndn-cxx.pc` and append the lib and include paths (the last arguments below) to the last two lines to (make sure to change the username part of the paths!):
167 2 Mathias Gibbens
168 6 Mathias Gibbens
    Libs: -L${libdir} [...snip...] -L/home/USER/ndn-cxx-crosscompile/usr/lib
169
    Cflags: -I${includedir} [...snip...] -I/home/USER/ndn-cxx-crosscompile/usr/include
170 2 Mathias Gibbens
171
Now, configure and compile NFD:
172
173 6 Mathias Gibbens
    ./waf configure --prefix=/usr --sysconfdir=/etc --with-libpcap=$CROSSCOMPILE_PATH --boost-includes=$CROSSCOMPILE_PATH/include --boost-libs=$CROSSCOMPILE_PATH/lib --without-websocket
174 2 Mathias Gibbens
    
175
    ./waf
176
    
177
    DESTDIR=$HOME/NFD-crosscompile ./waf install
178
179
Like before, the cross compiled binaries will be in `~/NFD-crosscompile`.
180
181
182 1 Mathias Gibbens
Concluding remarks
183
------------------
184 2 Mathias Gibbens
185
Hopefully this walk through has been helpful to you in your quest to cross compile a NDN project.
186
187 5 Mathias Gibbens
I have chosen not to talk about actually copying the resulting binaries to the router, as there are many ways to do so: package managers, tarballs, by hand, etc. There are plenty of better tutorials online that are easy to find if you need pointers doing this.