Embedded Linux Labs
Embedded Linux Labs
Embedded Linux Labs
Practical Labs
https://bootlin.com
Training setup
Download files and directories used in practical labs
Lab data are now available in an embedded-linux-labs directory in your home directory. This
directory contains directories and files used in the various practical labs. It will also be used as
working space, in particular to keep generated files separate when needed.
You are now ready to start the real practical labs!
More guidelines
Can be useful throughout any of the labs
• Read instructions and tips carefully. Lots of people make mistakes or waste time because
they missed an explanation or a guideline.
• Always read error messages carefully, in particular the first one which is issued. Some
people stumble on very simple errors just because they specified a wrong file path and
didn’t pay enough attention to the corresponding error message.
• Never stay stuck with a strange problem more than 5 minutes. Show your problem to
your colleagues or to the instructor.
• You should only use the root user for operations that require super-user privileges, such
as: mounting a file system, loading a kernel module, changing file ownership, configuring
the network. Most regular tasks (such as downloading, extracting sources, compiling...)
can be done as a regular user.
• If you ran commands from a root shell by mistake, your regular user may no longer be
able to handle the corresponding generated files. In this case, use the chown -R command
to give the new files back to your regular user.
Example: chown -R myuser.myuser linux/
Setup
Go to the $HOME/embedded-linux-labs/toolchain directory.
Getting Crosstool-ng
Let’s download the sources of Crosstool-ng, through its git source repository, and switch to a
commit that we have tested:
git clone https://github.com/crosstool-ng/crosstool-ng.git
cd crosstool-ng/
git checkout eb65ba65
Installing Crosstool-ng
We can either install Crosstool-ng globally on the system, or keep it locally in its download
directory. We’ll choose the latter solution. As documented at http://crosstool-ng.github.
io/docs/install/#hackers-way, do:
./bootstrap
./configure --enable-local
make
Then you can get Crosstool-ng help by running
./ct-ng help
Crosstool-ng comes with a set of ready-made configuration files for various typical setups:
Crosstool-ng calls them samples. They can be listed by using ./ct-ng list-samples.
We will start with the arm-cortexa5-linux-uclibcgnueabihf sample. It can be loaded by
issuing:
./ct-ng arm-cortexa5-linux-uclibcgnueabihf
Then, to refine the configuration, let’s run the menuconfig interface:
./ct-ng menuconfig
In Path and misc options:
• Change Maximum log level to see to DEBUG so that we can have more details on what
happened during the build in case something went wrong.
In Toolchain options:
• Set Tuple's vendor string to training.
• Set Tuple's alias to arm-linux. This way, we will be able to use the compiler as arm-
linux-gcc instead of arm-training-linux-uclibcgnueabihf-gcc, which is much longer
to type.
In C-library:
• Enable IPv6 support. That’s because of Buildroot (which we will use later), which doesn’t
accept to use toolchains without IPv6 support.
In Debug facilities, disable every option. Some of these options will be useful in a real
toolchain, but in our labs, we will do debugging work with another toolchain anyway. Hence,
not compiling debugging features here will reduce toolchain building time.
Explore the different other available options by traveling through the menus and looking at the
help for some of the options. Don’t hesitate to ask your trainer for details on the available
options. However, remember that we tested the labs with the configuration described above.
You might waste time with unexpected issues if you customize the toolchain configuration.
Known issues
It is frequent that Crosstool-ng aborts because it can’t find a source archive on the Internet,
when such an archive has moved or has been replaced by more recent versions. New Crosstool-ng
versions ship with updated URLs, but in the meantime, you need work-arounds.
If this happens to you, what you can do is look for the source archive by yourself on the Internet,
and copy such an archive to the src directory in your home directory. Note that even source
archives compressed in a different way (for example, ending with .gz instead of .bz2) will be
fine too. Then, all you have to do is run ./ct-ng build again, and it will use the source archive
that you downloaded.
Cleaning up
Do this only if you have limited storage space. In case you made a mistake in the toolchain
configuration, you may need to run Crosstool-ng again. Keeping generated files would save a
significant amount of time.
To save about 7 GB of storage space, do a ./ct-ng clean in the Crosstool-NG source direc-
tory. This will remove the source code of the different toolchain components, as well as all the
generated files that are now useless since the toolchain has been installed in $HOME/x-tools.
Bootloader - U-Boot
Objectives: Set up serial communication, compile and install the
U-Boot bootloader, use basic U-Boot commands, set up TFTP com-
munication with the development workstation.
As the bootloader is the first piece of software executed by a hardware platform, the installation
procedure of the bootloader is very specific to the hardware platform. There are usually two
cases:
• The processor offers nothing to ease the installation of the bootloader, in which case the
JTAG has to be used to initialize flash storage and write the bootloader code to flash.
Detailed knowledge of the hardware is of course required to perform these operations.
• The processor offers a monitor, implemented in ROM, and through which access to the
memories is made easier.
The Xplained board, which uses the SAMA5D3 SoCs, falls into the second category. The
monitor integrated in the ROM reads the MMC/SD card to search for a valid bootloader before
looking at the internal NAND flash for a bootloader. In case nothing is available, it will operate
in a fallback mode, that will allow to use an external tool to reflash some bootloader through
USB. Therefore, either by using an MMC/SD card or that fallback mode, we can start up a
SAMA5D3-based board without having anything installed on it.
We’re going to use that fallback mode, and its associated tool, sam-ba.
wget https://ww1.microchip.com/downloads/en/DeviceDoc/sam-ba_2.15.zip
unzip sam-ba_2.15.zip
Plug the USB-to-serial cable on the Xplained board. The blue end of the cable is going to GND
on J23, red on RXD and green on TXD. When plugged in your computer, a serial port should
appear, /dev/ttyUSB0.
1 In case this website is down, you can also find this tool on https://bootlin.com/labs/tools/.
You can also see this device appear by looking at the output of dmesg.
To communicate with the board through the serial port, install a serial communication program,
such as picocom:
You also need to make your user belong to the dialout group to be allowed to write to the serial
console:
Important: for the group change to be effective, in Ubuntu 18.04, you have to completely reboot
the system 2 . A workaround is to run newgrp dialout, but it is not global. You have to run it
in each terminal.
You can now power-up the board by connecting the micro-USB cable to the board, and to your
PC at the other end. If a system was previously installed on the board, you should be able to
interact with it through the serial line.
AT91Bootstrap Setup
The boot process is done in two steps with the ROM monitor trying to execute a first piece of
software, called AT91Bootstrap, from its internal SRAM, that will initialize the DRAM, load
U-Boot that will in turn load Linux and execute it.
As far as bootloaders are concerned, the layout of the NAND flash will look like:
2 As explained on https://askubuntu.com/questions/1045993/after-adding-a-group-logoutlogin-is-not-
enough-in-18-04/.
• Offset 0x0 for the first stage bootloader is dictated by the hardware: the ROM code of the
SAMA5D3 looks for a bootloader at offset 0x0 in the NAND flash.
• Offset 0x40000 for the second stage bootloader is decided by the first stage bootloader.
This can be changed by changing the AT91Bootstrap configuration.
• Offset 0xc0000 of the U-Boot environment is decided by U-Boot. This can be changed by
modifying the U-Boot configuration.
The first item to compile is AT91Bootstrap that you can fetch from Microchip’s GitHub account:
git clone https://github.com/linux4sam/at91bootstrap.git
cd at91bootstrap
git checkout v3.8.9
Then, we first need to configure the build system for our setup. We’re going to need a few pieces
of information for this:
• Which board you want to run AT91Bootstrap on
• Which device should AT91Bootstrap will be stored on
• What component you want AT91Boostrap to load
You can get the list of the supported boards by listing the board directory. You’ll see that in
each of these folders, we have a bunch of defconfig files, that are the supported combinations.
In our case, using the Atmel SAMA5D3 Xplained board, we will load U-Boot, from NAND flash
on (nf in the defconfig file names).
After finding the right defconfig file, load it using make <defconfig_filename> (just the file
name, without the directory part).
In recent versions of AT91Bootstrap, you can now run make menuconfig to explore options
available in this program.
The next thing to do is to specify the cross-compiler prefix (the part before gcc in the cross-
compiler executable name):
export CROSS_COMPILE=arm-linux-
Last but not least, install the python package that the Makefile for AT91Bootstrap will try to
invoke.
U-Boot setup
Download U-Boot:
wget ftp://ftp.denx.de/pub/u-boot/u-boot-2017.09.tar.bz2
More recent versions may also work, but we have not tested them.
Extract the source archive and get an understanding of U-Boot’s configuration and compilation
steps by reading the README file, and specifically the Building the Software section.
Basically, you need to:
• Set the CROSS_COMPILE environment variable;
• Run make <NAME>_defconfig, where the list of available configurations can be found in
the configs/ directory. There are two flavors of the Xplained configuration: one to run
from the SD card (sama5d3_xplained_mmc) and one to run from the NAND flash (sama5d3_
xplained_nandflash). Since we’re going to boot on the NAND, use the latter.
• Now that you have a valid initial configuration, you can now run make menuconfig to
further edit your bootloader features.
• In recent versions of U-Boot and for some boards, you will need to have the Device Tree
compiler:
sudo apt install device-tree-compiler
• Finally, run make, which should build U-Boot.
3 You can speed up the compiling by using the -jX option with make, where X is the number of parallel jobs
used for compiling. Twice the number of CPU cores is a good value.
4 ECC means Error Correcting Code. If we don’t have the same ECC scheme as the one RomBOOT expects,
Shrinking U-Boot
Look at the size of the u-boot.bin binary. According to the above flash layout, the U-Boot
binary is supposed to fit between flash offset 0x40000 and offset 0xc0000, corresponding to a
maximum size of 524288 bytes. Is u-boot.bin bigger than this maximum?
The first offset is what AT91Bootstrap expects (though it can be changed in AT91Bootstrap’s
configuration). The second one, corresponding to where U-Boot stores its environment settings,
is board dependent but apparently cannot be changed through make menuconfig.
To avoid recompiling AT91Bootstrap, we propose to compile U-Boot with less features, to make
its binary small. That’s probably something you will do too during real-life projects.
So, in U-Boot sources, run make menuconfig, look for and disable the below options:5 .
• ext4 options
• nfs options
• USB options
• SPL options
• XIMG support
• FIT (Flattened Image Tree) support
• CMD_ELF option
• dhcp command support
• Regular expression support (REGEX)
• loadb support
• CMD_MII option
Now, recompile U-Boot and check that u-boot.bin is smaller than our maximum size.
Flashing U-Boot
Now, in sam-ba, in the Send File Name field, set the path to the u-boot.bin that was just
compiled, and set the address to 0x40000. Click on the Send File button.
You can now exit sam-ba.
Testing U-Boot
Reset the board and check that it boots your new bootloaders. You can verify this by checking
the build dates:
AT91Bootstrap 3.8.9 (Mon Oct 30 2017 16:09:08 (UTC+0100))
CPU: SAMA5D36
Crystal frequency: 12 MHz
CPU clock : 528 MHz
Master clock : 132 MHz
DRAM: 256 MiB
NAND: 256 MiB
MMC: Atmel mci: 0, Atmel mci: 1
*** Warning - bad CRC, using default environment
In: serial@ffffee00
Out: serial@ffffee00
Err: serial@ffffee00
Net:
Error: ethernet@f0028000 address not set.
No ethernet found.
Hit any key to stop autoboot: 0
Interrupt the countdown to enter the U-Boot shell:
=>
In U-Boot, type the help command, and explore the few commands available.
Now, configure the network on the board in U-Boot by setting the ipaddr and serverip envi-
ronment variables:
setenv ipaddr 192.168.0.100
setenv serverip 192.168.0.1
The first time you use your board, you also need to set the MAC address in U-boot:
setenv ethaddr 12:34:56:ab:cd:ef
In case the board was previously configured in a different way, we also turn off automatic booting
after commands that can be used to copy a kernel to RAM:
setenv autostart no
To make these settings permanent, save the environment:
saveenv
Now reset your board7 .
You can then test the TFTP connection. First, put a small text file in the directory exported
through TFTP on your development workstation. Then, from U-Boot, do:
tftp 0x22000000 textfile.txt
The tftp command should have downloaded the textfile.txt file from your development
workstation into the board’s memory at location 0x220000008 .
You can verify that the download was successful by dumping the contents of the memory:
md 0x22000000
We will see in the next labs how to use U-Boot to download, flash and boot a kernel.
Rescue binaries
If you have trouble generating binaries that work properly, or later make a mistake that causes
you to loose your bootloader binaries, you will find working versions under data/ in the current
lab directory.
7 Resetting your board is needed to make your ethaddr permanent, for obscure reasons. If you don’t, U-boot
Kernel sources
Objective: Learn how to get the kernel sources and patch them.
Setup
Create the $HOME/embedded-linux-labs/kernel directory and go into it.
Apply patches
Download the patch files corresponding to the latest 4.19 stable release: a first patch to move
from 4.18 to 4.19 and if one exists, a second patch to move from 4.19 to 4.19.x.
Without uncompressing them to a separate file, apply the patches to the Linux source directory.
View one of the patch files with vi or gvim (if you prefer a graphical editor), to understand the
information carried by such a file. How are described added or removed files?
Rename the linux-4.18 directory to linux-4.19.<x>.
Kernel - Cross-compiling
Objective: Learn how to cross-compile a kernel for an ARM target
platform.
Setup
Go to the $HOME/embedded-linux-labs/kernel directory.
Target system
We are going to cross-compile and boot a Linux kernel for the Microchip SAMA5D3 Xplained
board.
Kernel sources
We will re-use the kernel sources downloaded and patched in the previous lab.
Once found, use this target to configure the kernel with the ready-made configuration.
Don’t hesitate to visualize the new settings by running make xconfig afterwards!
In the kernel configuration, as an experiment, change the kernel compression from Gzip to XZ.
This compression algorithm is far more efficient than Gzip, in terms of compression ratio, at the
expense of a higher decompression time.
Cross compiling
At this stage, you need to install the libssl-dev package to compile the kernel.
You’re now ready to cross-compile your kernel. Simply run:
make
and wait a while for the kernel to compile. Don’t forget to use make -j<n> if you have multiple
cores on your machine!
Look at the end of the kernel build output to see which file contains the kernel image. You can
also see the Device Tree .dtb files which got compiled. Find which .dtb file corresponds to your
board.
Copy the linux kernel image and DTB files to the TFTP server home directory.
So, let’s start by erasing the corresponding 128 KiB of NAND flash for the DTB:
nand erase 0x140000 0x20000
(NAND offset) (size)
Then, let’s erase the 5 MiB of NAND flash for the kernel image:
nand erase 0x160000 0x500000
Then, copy the DTB and kernel binaries from TFTP into memory, using the same addresses as
before.
Then, flash the DTB and kernel binaries:
nand write 0x22000000 0x140000 0x20000
(RAM addr) (NAND offset) (size)
nand write 0x21000000 0x160000 0x500000
Power your board off and on, to clear RAM contents. We should now be able to load the DTB
and kernel image from NAND and boot with:
nand read 0x22000000 0x140000 0x20000
(RAM addr) (offset) (size)
nand read 0x21000000 0x160000 0x500000
bootz 0x21000000 - 0x22000000
Write a U-Boot script that automates the DTB + kernel download and flashing procedure.
You are now ready to modify bootcmd to boot the board from flash. But first, save the settings
for booting from tftp:
setenv bootcmdtftp ${bootcmd}
This will be useful to switch back to tftp booting mode later in the labs.
Finally, using editenv bootcmd, adjust bootcmd so that the Xplained board starts using the
kernel in flash.
Now, reset the board to check that it boots in the same way from NAND flash. Check that this
is really your own version of the kernel that’s running9
9 Look at the kernel log. You will find the kernel version number as well as the date when it was compiled.
That’s very useful to check that you’re not loading an older version of the kernel instead of the one that you’ve
just compiled.
Lab implementation
While (s)he develops a root filesystem for a device, a developer needs to make frequent changes
to the filesystem contents, like modifying scripts or adding newly compiled programs.
It isn’t practical at all to reflash the root filesystem on the target every time a change is made.
Fortunately, it is possible to set up networking between the development workstation and the
target. Then, workstation files can be accessed by the target through the network, using NFS.
Unless you test a boot sequence, you no longer need to reboot the target to test the impact of
script or application updates.
Setup
Go to the $HOME/embedded-linux-labs/tinysystem/ directory.
Kernel configuration
We will re-use the kernel sources from our previous lab, in $HOME/embedded-linux-labs/kernel/.
In the kernel configuration built in the previous lab, verify that you have all options needed for
booting the system using a root filesystem mounted over NFS, and if necessary, enable them
and rebuild your kernel.
Now, the kernel should complain for the last time, saying that it can’t find an init application:
Kernel panic - not syncing: No working init found. Try passing init= option to kernel.
See Linux Documentation/init.txt for guidance.
Obviously, our root filesystem being mostly empty, there isn’t such an application yet. In the
next paragraph, you will add Busybox to your root filesystem and finally make it usable.
Virtual filesystems
Run the ps command. You can see that it complains that the /proc directory does not exist.
The ps command and other process-related commands use the proc virtual filesystem to get
their information from the kernel.
From the Linux command line in the target, create the proc, sys and etc directories in your
root filesystem.
Now mount the proc virtual filesystem. Now that /proc is available, test again the ps command.
Note that you can also now halt your target in a clean way with the halt command, thanks to
proc being mounted11 .
Then, create a /etc/inittab file and a /etc/init.d/rcS startup script declared in /etc/
inittab. In this startup script, mount the /proc and /sys filesystems.
Any issue after doing this?
Goals
After doing the A tiny embedded system lab, we are going to copy the filesystem contents to the
SD card. The filesystem will be split into several partitions, and your sama5d3 X-plained board
will be booted with this SD card, without using NFS anymore.
Setup
Throughout this lab, we will continue to use the root filesystem we have created in the $HOME/
embedded-linux-labs/tinysystem/nfsroot directory, which we will progressively adapt to use
block filesystems.
The device file name may be different (such as /dev/sdb if the card reader is connected to a
USB bus (either inside your PC or using a USB card reader).
In the following instructions, we will assume that your SD card is seen as /dev/mmcblk0 by your
PC workstation.
Type the mount command to check your currently mounted partitions. If SD partitions are
mounted, unmount them:
$ sudo umount /dev/mmcblk0*
Then, clear possible SD card contents remaining from previous training sessions (only the first
megabytes matter):
$ sudo dd if=/dev/zero of=/dev/mmcblk0 bs=1M count=256
Now, let’s use the cfdisk command to create the partitions that we are going to use:
$ sudo cfdisk /dev/mmcblk0
If cfdisk asks you to Select a label type, choose dos. This corresponds to traditional par-
titions tables that DOS/Windows would understand. gpt partition tables are needed for disks
bigger than 2 TB.
In the cfdisk interface, delete existing partitions, then create three primary partitions, starting
from the beginning, with the following properties:
• One partition, 64MB big, with the FAT16 partition type.
• One partition, 8 MB big14 , that will be used for the root filesystem. Due to the geometry
of the device, the partition might be larger than 8 MB, but it does not matter. Keep the
Linux type for the partition.
• One partition, that fills the rest of the SD card, that will be used for the data filesystem.
Here also, keep the Linux type for the partition.
Press Write when you are done.
To make sure that partition definitions are reloaded on your workstation, remove the SD card
and insert it again.
with the 8 GB SD cards that we use in our labs, 8 MB will be the smallest partition that cfdisk will allow you
to create.
You now need to adjust the bootcmd of U-Boot so that it loads the kernel and DTB from the
SD card instead of loading them from the NAND.
In U-boot, you can load a file from a FAT filesystem using a command like
fatload mmc 0:1 0x21000000 filename
Which will load the file named filename from the first partition of the device handled by the
first MMC controller to the system memory at the address 0x21000000.
Going further
At this point our board still uses the bootloaders (at91bootstrap and U-Boot) stored in the
NAND flash. Let’s try to have everything on our SD card. The ROM code can load the first
stage bootloader from an MMC or SD card, from a file named boot.bin located in the first FAT
partition. U-Boot will be stored as u-boot.bin.
For this you will need to recompile at91bootstrap (you’ll need to switch to version 3.8.12) to
support booting from an SD card. Then recompile U-Boot after reconfiguring it with its MMC
configuration (we previously used the configuration for running from NAND flash).
Setup
Stay in $HOME/embedded-linux-labs/tinysystem. Install the mtd-utils package, which will be
useful to create UBIFS and UBI images.
Goals
Instead of using an external SD card as in the previous lab, we will make our system use its
internal flash storage.
We will create an MTD partition to be attached to the UBI layer (the partitions previously used
to store the kernel image and the DTB should be merged with this UBI partition).
The kernel and DTB images will be stored in two separate static (read-only) UBI volumes.
The root filesystem will be a UBI volume storing a UBIFS filesystem mounted read-only, the web
server upload data will be stored in another UBI volume storing a UBIFS filesystem mounted
read/write. These volumes will be dynamic volumes and will be 16 MiB large.
Which gives the following layout:
Recompile your kernel if needed. We will update your kernel image on flash in the next section.
When flashing the UBI image, use the trimffs version of the command nand write16 .
Going further
Using squashfs for the root filesystem
Root filesystems are often a sensitive part of your system, and you don’t want it to be corrupted,
hence some people decide to use a read-only file system for their rootfs and use another file system
to store their auxiliary data.
squashfs is one of these read-only file systems. However, squashfs expects to be mounted on a
block device.
Use the ubiblk layer to emulate a read-only block device on top of a static UBI volume to mount
a squashfs filesystem as the root filesystem:
• First create a squashfs image with your rootfs contents
• Then create a new static volume to store your squashfs and update it with your squashfs
image
• Enable and setup the ubiblk layer
• Boot on your new rootfs
Atomic update
UBI also provides an atomic update feature, which is particularly useful if you need to safely
upgrade sensitive parts of your system (kernel, DTB or rootfs).
Duplicate the kernel volume and create a U-Boot script to fallback on the second kernel volume
if the first one is corrupted:
16 The command nand write.trimffs skips the blank sectors instead of writing them. It is needed because the
algorithm used by the hardware ECC for the SAMA5D3 SoC generates a checksum with bytes different from
0xFF if the page is blank. Linux only checks the page, and if it is blank it doesn’t erase it, but as the OOB is not
blank it leads to ECC errors. More generally it is not recommended writing more than one time on a page and
its OOB even if the page is blank.
To illustrate how to use existing libraries and applications, we will extend the small root filesys-
tem built in the A tiny embedded system lab to add the ALSA libraries and tools and an audio
playback application using these libraries.
We’ll see that manually re-using existing libraries is quite tedious, so that more automated
procedures are necessary to make it easier. However, learning how to perform these operations
manually will significantly help you when you face issues with more automated tools.
Recompile your kernel with audio support. The options we want are: CONFIG_SOUND, CONFIG_SND,
CONFIG_SND_USB and CONFIG_SND_USB_AUDIO.
At this stage, the easiest solution to update your kernel is probably to get back to copying it
to RAM from tftp. Anyway, we will have to modify U-Boot environment variables, as we are
going to switch back to NFS booting anyway.
Make sure that your board still boots with this new kernel.
We’re going to integrate the alsa-utils and ogg123 executables. As most software components,
they in turn depend on other libraries, and these dependencies are different depending on the
configuration chosen for them. In our case, the dependency chain for alsa-utils is quite simple,
it only depends on the alsa-lib library.
The dependencies are a bit more complex for ogg123. It is part of vorbis-tools, that depend
on libao and libvorbis. libao in turn depends on alsa-lib, and libvorbis on libogg.
libao, alsa-utils and alsa-lib are here to abstract the use of ALSA, one of the Audio Subsys-
tems supported in Linux. vorbis-tools, libvorbis and libogg are used to handle the audio
files encoded using the Ogg codec, which is quite common.
Of course, all these libraries rely on the C library, which is not mentioned here, because it is
already part of the root filesystem built in the A tiny embedded system lab. You might wonder
how to figure out this dependency tree by yourself. Basically, there are several ways, that can
be combined:
• Read the help message of the configure script (by running ./configure --help).
To configure, compile and install all the components of our system, we’re going to start from
the bottom of the tree with alsa-lib, then continue with alsa-utils, libao, libogg, and libvorbis, to
finally compile vorbis-tools.
Preparation
For our cross-compilation work, we will need two separate spaces:
• A staging space in which we will directly install all the packages: non-stripped versions
of the libraries, headers, documentation and other files needed for the compilation. This
staging space can be quite big, but will not be used on our target, only for compiling
libraries or applications;
• A target space, in which we will only copy the required files from the staging space: binaries
and libraries, after stripping, configuration files needed at runtime, etc. This target space
will take a lot less space than the staging space, and it will contain only the files that are
really needed to make the system work on the target.
To sum up, the staging space will contain everything that’s needed for compilation, while the
target space will contain only what’s needed for execution.
For the target, we need a basic system with BusyBox and initialization scripts. We will re-use
the system built in the A tiny embedded system lab, so copy this system in the target directory:
cp -a $HOME/embedded-linux-labs/tinysystem/nfsroot/* target/
Note that for this lab, a lot of typing will be required. To save time typing, we advise you to
copy and paste commands from the electronic version of these instructions.
Testing
Make sure the target/ directory is exported by your NFS server to your board by modifying
/etc/exports and restarting your NFS server.
Make your board boot from this new directory through NFS.
alsa-lib
alsa-lib is a library supposed to handle the interaction with the ALSA subsystem. It is available
at http://alsa-project.org. Download version 1.1.6, and extract it in $HOME/embedded-linux-
labs/thirdparty/.
By looking at the configure script, we see that it has been generated by autoconf (the header
contains a sentence like Generated by GNU Autoconf 2.69). Most of the time, autoconf comes
with automake, that generates Makefiles from Makefile.am files. So alsa-lib uses a rather com-
mon build system. Let’s try to configure and build it:
./configure
make
You can see that the files are getting compiled with gcc, which generates code for x86 and not
for the target platform. This is obviously not what we want, so we clean-up the object and tell
the configure script to use the ARM cross-compiler:
make clean
CC=arm-linux-gcc ./configure
Of course, the arm-linux-gcc cross-compiler must be in your PATH prior to running the configure
script. The CC environment variable is the classical name for specifying the compiler to use.
Quickly, you should get an error saying:
checking whether we are cross compiling... configure: error: in `.../thirdparty/alsa-lib-1.1.6':
configure: error: cannot run C compiled programs.
If you meant to cross compile, use `--host'.
See `config.log' for more details
If you look at the config.log file, you can see that the configure script compiles a binary with
the cross-compiler and then tries to run it on the development workstation. This is a rather
usual thing to do for a configure script, and that’s why it tests so early that it’s actually doable,
and bails out if not.
Obviously, it cannot work in our case, and the scripts exits. The job of the configure script
is to test the configuration of the system. To do so, it tries to compile and run a few sample
applications to test if this library is available, if this compiler option is supported, etc. But in
our case, running the test examples is definitely not possible.
We need to tell the configure script that we are cross-compiling, and this can be done using
the --build and --host options, as described in the help of the configure script:
System types:
--build=BUILD configure for building on BUILD [guessed]
--host=HOST cross-compile to build programs to run on HOST [BUILD]
The --build option allows to specify on which system the package is built, while the --host
option allows to specify on which system the package will run. By default, the value of the
--build option is guessed and the value of --host is the same as the value of the --build
option. The value is guessed using the ./config.guess script, which on your system should
For this library, this option may not change anything to the resulting binaries, but for safety, it
is always recommended to make sure that the prefix matches where your library will be running
on the target system.
Do not confuse the prefix (where the application or library will be running on the target system)
from the location where the application or library will be installed on your host while building
the root filesystem.
The prefix corresponds to the path in the target system and never on the host. So, one
should never pass a prefix like $HOME/embedded-linux-labs/thirdparty/target/usr, otherwise
at runtime, the application or library may look for files inside this directory on the target
system, which obviously doesn’t exist! By default, most build systems will install the application
or library in the given prefix (/usr or /usr/local), but with most build systems (including
autotools), the installation prefix can be overridden, and be different from the configuration
prefix.
1. Create the target/usr/lib directory, it will contain the stripped version of the library
2. Copy the dynamic version of the library. Only libasound.so.2 and libasound.so.2.0.0
are needed, since libasound.so.2 is the SONAME of the library and libasound.so.2.0.0
is the real binary:
• cp -a staging/usr/lib/libasound.so.2* target/usr/lib
• arm-linux-strip target/usr/lib/libasound.so.2.0.0
Alsa-utils
Download alsa-utils from the ALSA offical webpage. We tested the lab with version 1.1.6.
Once uncompressed, we quickly discover that the alsa-utils build system is based on the autotools,
so we will work once again with a regular configure script.
As we’ve seen previously, we will have to provide the prefix and host options and the CC variable:
CC=arm-linux-gcc ./configure --host=arm-linux --prefix=/usr
Now, we should quiclky get an error in the execution of the configure script:
checking for libasound headers version >= 1.0.27... not present.
configure: error: Sufficiently new version of libasound not found.
Again, we can check in config.log what the configure script is trying to do:
configure:7146: checking for libasound headers version >= 1.0.27
configure:7208: arm-linux-gcc -c -g -O2 conftest.c >&5
conftest.c:12:10: fatal error: alsa/asoundlib.h: No such file or directory
Of course, since alsa-utils uses alsa-lib, it includes its header file! So we need to tell the C
compiler where the headers can be found: there are not in the default directory /usr/include/,
but in the /usr/include directory of our staging space. The help text of the configure script
says:
CPPFLAGS C/C++/Objective C preprocessor flags,
e.g. -I<include dir> if you have headers
in a nonstandard directory <include dir>
Let’s use it:
CPPFLAGS=-I$HOME/embedded-linux-labs/thirdparty/staging/usr/include \
CC=arm-linux-gcc \
./configure --host=arm-linux --prefix=/usr
Now, it should stop a bit later, this time with the error:
checking for libasound headers version >= 1.0.27... found.
checking for snd_ctl_open in -lasound... no
configure: error: No linkable libasound was found.
The configure script tries to compile an application against libasound (as can be seen from
the -lasound option): alsa-utils uses alsa-lib, so the configure script wants to make sure this
library is already installed. Unfortunately, the ld linker doesn’t find it. So, let’s tell the linker
where to look for libraries using the -L option followed by the directory where our libraries
are (in staging/usr/lib). This -L option can be passed to the linker by using the LDFLAGS at
configure time, as told by the help text of the configure script:
LDFLAGS linker flags, e.g. -L<lib dir> if you have
libraries in a nonstandard directory <lib dir>
Let’s use this LDFLAGS variable:
LDFLAGS=-L$HOME/embedded-linux-labs/thirdparty/staging/usr/lib \
CPPFLAGS=-I$HOME/embedded-linux-labs/thirdparty/staging/usr/include \
CC=arm-linux-gcc \
./configure --host=arm-linux --prefix=/usr
Once again, it should fail a bit further down the tests, this time complaining about a missing
curses helper header. curses or ncurses is a graphical framework to design UIs in the terminal.
This is only used by alsamixer, one of the tools provided by alsa-utils, that we are not going to
use. Hence, we can just disable the build of alsamixer.
Of course, if we wanted it, we would have had to build ncurses first, just like we built alsa-lib.
We will also need to disable support for xmlto that generates the documentation.
LDFLAGS=-L$HOME/embedded-linux-labs/thirdparty/staging/usr/lib \
CPPFLAGS=-I$HOME/embedded-linux-labs/thirdparty/staging/usr/include \
CC=arm-linux-gcc \
./configure --host=arm-linux --prefix=/usr \
--disable-alsamixer --disable-xmlto
Then, run the compilation with make. Hopefully, it works!
Let’s now begin the installation process. Before really installing in the staging directory, let’s
install in a dummy directory, to see what’s going to be installed (this dummy directory will not
be used afterwards, it is only to verify what will be installed before polluting the staging space):
make DESTDIR=/tmp/alsa-utils/ install
The DESTDIR variable can be used with all Makefiles based on automake. It allows to override
the installation directory: instead of being installed in the configuration prefix directory, the
files will be installed in DESTDIR/configuration-prefix.
Now, let’s see what has been installed in /tmp/alsa-utils/ (run tree /tmp/alsa-utils):
./lib/udev/rules.d/90-alsa-restore.rules
./usr/bin/aseqnet
./usr/bin/aseqdump
./usr/bin/arecordmidi
./usr/bin/aplaymidi
./usr/bin/aconnect
./usr/bin/alsaloop
./usr/bin/speaker-test
./usr/bin/iecset
./usr/bin/aplay
./usr/bin/amidi
./usr/bin/amixer
./usr/bin/alsaucm
./usr/sbin/alsaconf
./usr/sbin/alsactl
./usr/share/sounds/alsa/Side_Left.wav
./usr/share/sounds/alsa/Rear_Left.wav
./usr/share/sounds/alsa/Noise.wav
./usr/share/sounds/alsa/Front_Right.wav
./usr/share/sounds/alsa/Front_Center.wav
./usr/share/sounds/alsa/Side_Right.wav
./usr/share/sounds/alsa/Rear_Right.wav
./usr/share/sounds/alsa/Rear_Center.wav
./usr/share/sounds/alsa/Front_Left.wav
./usr/share/locale/ru/LC_MESSAGES/alsaconf.mo
./usr/share/locale/ja/LC_MESSAGES/alsaconf.mo
./usr/share/locale/ja/LC_MESSAGES/alsa-utils.mo
./usr/share/locale/fr/LC_MESSAGES/alsa-utils.mo
./usr/share/locale/de/LC_MESSAGES/alsa-utils.mo
./usr/share/man/fr/man8/alsaconf.8
./usr/share/man/man8/alsaconf.8
./usr/share/man/man1/aseqnet.1
./usr/share/man/man1/aseqdump.1
./usr/share/man/man1/arecordmidi.1
./usr/share/man/man1/aplaymidi.1
./usr/share/man/man1/aconnect.1
./usr/share/man/man1/alsaloop.1
./usr/share/man/man1/speaker-test.1
./usr/share/man/man1/iecset.1
./usr/share/man/man1/aplay.1
./usr/share/man/man1/amidi.1
./usr/share/man/man1/amixer.1
./usr/share/man/man1/alsactl.1
./usr/share/alsa/speaker-test/sample_map.csv
./usr/share/alsa/init/ca0106
./usr/share/alsa/init/hda
./usr/share/alsa/init/test
./usr/share/alsa/init/info
./usr/share/alsa/init/help
./usr/share/alsa/init/default
./usr/share/alsa/init/00main
So, we have:
• The manual pages in /usr/share/man/, explaining how to use the various tools
Then, let’s install only the necessary files in the target space, manually:
cd ..
cp -a staging/usr/bin/a* staging/usr/bin/speaker-test target/usr/bin/
cp -a staging/usr/sbin/alsa* target/usr/sbin
arm-linux-strip target/usr/bin/a*
arm-linux-strip target/usr/bin/speaker-test
arm-linux-strip target/usr/sbin/alsactl
mkdir -p target/usr/share/alsa/pcm
cp -a staging/usr/share/alsa/alsa.conf* target/usr/share/alsa/
cp -a staging/usr/share/alsa/cards target/usr/share/alsa/
cp -a staging/usr/share/alsa/pcm/default.conf target/usr/share/alsa/pcm/
Now test that all is working fine by running the speaker-test util on your board, with the
headset provided by your instructor plugged in. You may need to add the missing libraries from
the toolchain install directory.
Caution: don’t copy the dmix.conf file. speaker-test will tell you that it cannot find this file,
but it won’t work if you copy this file from the staging area.
The sound you get will be mainly noise (as what you would get by running speaker-test on
your PCs). At least, sound output is showing some signs of life! It will get much better when
we play samples with ogg123.
libogg
Now, let’s work on libogg. Download the 1.3.3 version from http://xiph.org and extract it.
Configuring libogg is very similar to the configuration of the previous libraries:
CC=arm-linux-gcc ./configure --host=arm-linux --prefix=/usr
Of course, compile the library:
make
Installation to the staging space can be done using the classical DESTDIR mechanism:
make DESTDIR=$HOME/embedded-linux-labs/thirdparty/staging/ install
And finally, only install manually in the target space the files needed at runtime:
cd ..
cp -a staging/usr/lib/libogg.so.0* target/usr/lib/
arm-linux-strip target/usr/lib/libogg.so.0.8.3
Done with libogg!
libvorbis
Libvorbis is the next step. Grab the 1.3.6 version from http://xiph.org and uncompress it.
Once again, the libvorbis build system is a nice example of what can be done with a good usage
of the autotools. Cross-compiling libvorbis is very easy, and almost identical to what we’ve seen
with alsa-utils. First, the configure step:
CC=arm-linux-gcc \
./configure --host=arm-linux --prefix=/usr
It will fail with:
configure: error: Ogg >= 1.0 required !
By running ./configure --help, you will find the --with-ogg-libraries and --with-ogg-
includes options. Use these:
CC=arm-linux-gcc ./configure --host=arm-linux --prefix=/usr \
--with-ogg-includes=$HOME/embedded-linux-labs/thirdparty/staging/usr/include \
--with-ogg-libraries=$HOME/embedded-linux-labs/thirdparty/staging/usr/lib
Then, compile the library:
make
libao
Now, let’s work on libao. Download the 1.2.0 version from http://xiph.org and extract it.
Configuring libao is once again fairly easy, and similar to every sane autotools based build
system:
LDFLAGS=-L$HOME/embedded-linux-labs/thirdparty/staging/usr/lib \
CPPFLAGS=-I$HOME/embedded-linux-labs/thirdparty/staging/usr/include \
CC=arm-linux-gcc ./configure --host=arm-linux \
--prefix=/usr
Of course, compile the library:
make
Installation to the staging space can be done using the classical DESTDIR mechanism:
make DESTDIR=$HOME/embedded-linux-labs/thirdparty/staging/ install
And finally, install manually the only needed files at runtime in the target space:
cd ..
cp -a staging/usr/lib/libao.so.4* target/usr/lib/
arm-linux-strip target/usr/lib/libao.so.4.1.0
We will also need the alsa plugin that is loaded dynamically by libao at startup:
mkdir -p target/usr/lib/ao/plugins-4/
cp -a staging/usr/lib/ao/plugins-4/libalsa.so target/usr/lib/ao/plugins-4/
Done with libao!
vorbis-tools
Finally, thanks to all the libraries we compiled previously, all the dependencies are ready. We
can now build the vorbis tools themselves. Download the 1.4.0 version from the official website,
at http://xiph.org/. As usual, extract the tarball.
Before starting the configuration, let’s have a look at the available options by running ./
configure --help. Many options are available. We see that we can, in addition to the usual
autotools configuration options:
• Enable/Disable the various tools that are going to be built: ogg123, oggdec, oggenc, etc.
• Enable or disable support for various other codecs: FLAC, Speex, etc.
• Enable or disable the use of various libraries that can optionally be used by the vorbis
tools
So, let’s begin with our usual configure line:
LDFLAGS=-L$HOME/embedded-linux-labs/thirdparty/staging/usr/lib \
CPPFLAGS=-I$HOME/embedded-linux-labs/thirdparty/staging/usr/include \
CC=arm-linux-gcc \
./configure --host=arm-linux --prefix=/usr
At the end, you should see the following warning:
configure: WARNING: Prerequisites for ogg123 not met, ogg123 will be skipped.
Please ensure that you have POSIX threads, libao, and (optionally) libcurl
libraries and headers present if you would like to build ogg123.
Which is unfortunate, since we precisely want ogg123.
If you look back at the script output, you should see that at some point that it tests for libao
and fails to find it:
checking for AO... no
configure: WARNING: libao too old; >= 1.0.0 required
If you look into the config.log file now, you should find something like:
configure:22343: checking for AO
configure:22351: $PKG_CONFIG --exists --print-errors "ao >= 1.0.0"
Package ao was not found in the pkg-config search path.
Perhaps you should add the directory containing `ao.pc'
to the PKG_CONFIG_PATH environment variable
No package 'ao' found
In this case, the configure script uses the pkg-config system to get the configuration parameters
to link the library against libao. By default, pkg-config looks in /usr/lib/pkgconfig/ for .pc
files, and because the libao-dev package is probably not installed in your system the configure
script will not find libao library that we just compiled.
It would have been worse if we had the package installed, because it would have detected and
used our host package to compile libao, which, since we’re cross-compiling, is a pretty bad thing
to do.
This is one of the biggest issue with cross-compilation: mixing host and target libraries, because
build systems have a tendency to look for libraries in the default paths.
So, now, we must tell pkg-config to look inside the /usr/lib/pkgconfig/ directory of our staging
space. This is done through the PKG_CONFIG_LIBDIR environment variable, as explained in the
manual page of pkg-config.
Moreover, the .pc files contain references to paths. For example, in $HOME/embedded-linux-
labs/thirdparty/staging/usr/lib/pkgconfig/ao.pc, we can see:
prefix=/usr
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include
[...]
Libs: -L${libdir} -lao
Cflags: -I${includedir}
So we must tell pkg-config that these paths are not absolute, but relative to our staging space.
This can be done using the PKG_CONFIG_SYSROOT_DIR environment variable.
Then, let’s run the configuration of the vorbis-tools again, passing the PKG_CONFIG_LIBDIR and
PKG_CONFIG_SYSROOT_DIR environment variables:
LDFLAGS=-L$HOME/embedded-linux-labs/thirdparty/staging/usr/lib \
CPPFLAGS=-I$HOME/embedded-linux-labs/thirdparty/staging/usr/include \
PKG_CONFIG_LIBDIR=$HOME/embedded-linux-labs/thirdparty/staging/usr/lib/pkgconfig \
PKG_CONFIG_SYSROOT_DIR=$HOME/embedded-linux-labs/thirdparty/staging \
CC=arm-linux-gcc \
./configure --host=arm-linux --prefix=/usr
Now, the configure script should end properly, we can now start the compilation:
make
It should fail with the following cryptic message:
make[2]: Entering directory '/home/tux/embedded-linux-labs/thirdparty/vorbis-tools-1.4.0/ogg123'
if arm-linux-gcc -DSYSCONFDIR=\"/usr/etc\" -DLOCALEDIR=\"/usr/share/locale\" -DHAVE_CONFIG_H -I. -I. -I.. -I/usr/include -I../
then mv -f ".deps/audio.Tpo" ".deps/audio.Po"; else rm -f ".deps/audio.Tpo"; exit 1; fi
In file included from audio.c:22:
/usr/include/stdio.h:27:10: fatal error: bits/libc-header-start.h: No such file or directory
You can notice that /usr/include is added to the include paths. Again, this is not what we
want because it contains includes for the host, not the target. It is coming from the autodetected
value for CURL_CFLAGS.
Add the --without-curl option to the configure invocation, restart the compilation.
The compilation may then fail with an error related to libm. While the code uses the function
from this library, the generated Makefile doesn’t give the right command line argument in order
to link against the libm.
If you look at the configure help, you can see
LIBS libraries to pass to the linker, e.g. -l<library>
And this is exactly what we are supposed to use to add new linker flags.
Add this to the configure command line to get
LDFLAGS=-L$HOME/embedded-linux-labs/thirdparty/staging/usr/lib \
CPPFLAGS=-I$HOME/embedded-linux-labs/thirdparty/staging/usr/include \
PKG_CONFIG_LIBDIR=$HOME/embedded-linux-labs/thirdparty/staging/usr/lib/pkgconfig \
PKG_CONFIG_SYSROOT_DIR=$HOME/embedded-linux-labs/thirdparty/staging \
LIBS=-lm \
CC=arm-linux-gcc \
./configure --host=arm-linux --prefix=/usr --without-curl
Finally, it builds!
Now, install the vorbis-tools to the staging space using:
make DESTDIR=$HOME/embedded-linux-labs/thirdparty/staging/ install
And then install them in the target space:
cd ..
cp -a staging/usr/bin/ogg* target/usr/bin
arm-linux-strip target/usr/bin/ogg*
You can now test that everything works! Run ogg123 on the sample file found in thirdparty/
data.
There should still be one missing C library object. Copy it, and you should get: +
ERROR: Failed to load plugin /usr/lib/ao/plugins-4/libalsa.so => dlopen() failed
=== Could not load default driver and no driver specified in config file. Exiting.
This error message is unfortunately not sufficient to figure out what’s going wrong. It’s a good
opportunity to use the strace utility to get more details about what’s going on. To do so, you
can used the one built by Crosstool-ng inside the toolchain target/usr/bin directory.
You can now run ogg123 through strace:
strace ogg123 /sample.ogg
You can see that the command fails to open the ld-uClibc.so.1 file:
open("/lib/ld-uClibc.so.1", O_RDONLY) = -1 ENOENT (No such file or directory)
open("/lib/ld-uClibc.so.1", O_RDONLY) = -1 ENOENT (No such file or directory)
open("/usr/lib/ld-uClibc.so.1", O_RDONLY) = -1 ENOENT (No such file or directory)
open("/usr/X11R6/lib/ld-uClibc.so.1", O_RDONLY) = -1 ENOENT (No such file or directory)
open("/home/tux/embedded-linux-labs/thirdparty/staging/usr/lib/ld-uClibc.so.1", O_RDONLY) = -1 ENOENT (No
write(2, "ERROR: Failed to load plugin ", 29ERROR: Failed to load plugin ) = 29
write(2, "/usr/lib/ao/plugins-4/libalsa.so", 32/usr/lib/ao/plugins-4/libalsa.so) = 32
write(2, " => dlopen() failed\n", 20 => dlopen() failed
Now, look for ld-uClibc.so.1 in the toolchain. You can see that both ld-uClibc.so.1 and
ld-uClibc.so.0 are symbolic links to the same file. So, create the missing link under target/lib
and run ogg123 again.
Everything should work fine now. Enjoy the sound sample!
To finish this lab completely, and to be consistent with what we’ve done before, let’s strip the
libraries in target/lib:
arm-linux-strip target/lib/*
Setup
Create the $HOME/embedded-linux-labs/buildroot directory and go into it.
Configure Buildroot
In our case, we would like to:
Exit the menuconfig interface. Your configuration has now been saved to the .config file.
Going further
• Add dropbear (SSH server and client) to the list of packages built by Buildroot and log to
your target system using an ssh client on your development workstation. Hint: you will
have to set a non-empty password for the root account on your target for this to work.
• Add a new package in Buildroot for the GNU Gtypist game. Read the Buildroot documen-
tation to see how to add a new package. Finally, add this package to your target system,
compile it and run it. The newest versions require a library that is not fully supported by
Buildroot, so you’d better stick with the latest version in the 2.8 series.
• Flash the new system on the flash of the board
– First, in buildroot, select the UBIFS filesystem image type.
– You’ll also need to provide buildroot some information on the underlying device
that will store the filesystem. In our case, the logical eraseblock size is 124KiB, the
minimum I/O unit size is 2048 and the Maximum logical eraseblock (LEB) count is
133.
– Then, once the image has been generated, update your rootfs volume.
Application development
Objective: Compile and run your own ncurses application on the
target.
Setup
Go to the $HOME/embedded-linux-labs/appdev directory.
17 Again, output/host/usr/bin has a special pkg-config that automatically knows where to look, so it already
knows the right paths to find .pc files and their sysroot.
Setup
Go to the $HOME/embedded-linux-labs/debugging directory. Create an nfsroot directory.
Debugging setup
Because of issues in gdb and ltrace in the uClibc version that we are using in our toolchain, we
will use a different toolchain in this lab, based on glibc.
As glibc has more complete features that lighter libraries, it looks like a good idea to do your
application debugging work with a glibc toolchain first, and then switch to lighter libraries once
your application and software stack is production ready.
Extract the Buildroot 2019.02 sources into the current directory.
Then, in the menuconfig interface, configure the target architecture as done previously but
configure the toolchain and target packages differently:
• In Toolchain:
– Toolchain type: External toolchain
– Toolchain: Custom Toolchain
– Toolchain origin: Toolchain to be downloaded and installed
– Toolchain URL: https://toolchains.bootlin.com/downloads/releases/toolchains/
armv7-eabihf/tarballs/armv7-eabihf--glibc--bleeding-edge-2018.07-3.tar.bz2
You can easily choose such a toolchain on https://toolchains.bootlin.com by se-
lecting the architecture, the C library and the compiler version you need. While you
can try with other versions, the above toolchain is known to make this lab work.
– External toolchain gcc version: 8.x
– External toolchain kernel headers series: 4.14.x
– External toochain C library: glibc/eglibc
– Select Toolchain has SSP support?
– Select Toolchain has RPC support?
– Select Toolchain has C++ support?
– Select Copy gdb server to the Target
• Target packages
– Debugging, profiling and benchmark
∗ Select ltrace
∗ Select strace
Now, build your root filesystem.
Go back to the $HOME/embedded-linux-labs/debugging directory and extract the buildroot-
2019.02/output/images/rootfs.tar archive in the nfsroot directory.
Add this directory to the /etc/exports file and restart nfs-kernel-server.
Boot your ARM board over NFS on this new filesystem, using the same kernel as before.
Using strace
Now, go to the $HOME/embedded-linux-labs/debugging directory.
strace allows to trace all the system calls made by a process: opening, reading and writing files,
starting other processes, accessing time, etc. When something goes wrong in your application,
strace is an invaluable tool to see what it actually does, even when you don’t have the source
code.
Update the PATH:
export PATH=$HOME/embedded-linux-labs/debugging/buildroot-2019.02/output/host/bin:$PATH
With your cross-compiling toolchain compile the data/vista-emulator.c program, strip it with
arm-linux-strip, and copy the resulting binary to the /root directory of the root filesystem.
Back to target system, try to run the /root/vista-emulator program. It should hang indefi-
nitely!
Interrupt this program by hitting [Ctrl] [C].
Now, running this program again through the strace command and understand why it hangs.
You can guess it without reading the source code!
Now add what the program was waiting for, and now see your program proceed to another bug,
failing with a segmentation fault.
Using ltrace
Now run the program through ltrace.
Now you should see what the program does: it tries to consume as much system memory as it
can!
Also run the program through ltrace -c, to see what function call statistics this utility can
provide.
It’s also interesting to run the program again with strace. You will see that memory allocations
translate into mmap() system calls. That’s how you can recognize them when you’re using strace.
Using gdbserver
We are now going to use gdbserver to understand why the program segfaults.
Compile vista-emulator.c again with the -g option to include debugging symbols. This time,
just keep it on your workstation, as you already have the version without debugging symbols
on your target.
Then, on the target side, run vista-emulator under gdbserver. gdbserver will listen on a TCP
port for a connection from gdb, and will control the execution of vista-emulator according to
the gdb commands:
gdbserver localhost:2345 vista-emulator
On the host side, run arm-linux-gdb (also found in your toolchain):
arm-linux-gdb vista-emulator
You can also start the debugger through the ddd interface:
ddd --debugger arm-linux-gdb vista-emulator
gdb starts and loads the debugging information from the vista-emulator binary that has been
compiled with -g.
Then, we need to tell where to find our libraries, since they are not present in the default /lib
and /usr/lib directories on your workstation. This is done by setting the gdb sysroot variable
(on one line):
(gdb) set sysroot /home/<user>/embedded-linux-labs/debugging/
buildroot-2019.02/output/staging
Of course, replace <user> by your actual user name.
And tell gdb to connect to the remote system:
(gdb) target remote <target-ip-address>:2345
Then, use gdb as usual to set breakpoints, look at the source code, run the application step by
step, etc. Graphical versions of gdb, such as ddd can also be used in the same way. In our case,
we’ll just start the program and wait for it to hit the segmentation fault:
(gdb) continue
You could then ask for a backtrace to see where this happened:
(gdb) backtrace
This will tell you that the segmentation fault occurred in a function of the C library, called by
our program. This should help you in finding the bug in our application.
What to remember
During this lab, we learned that...
• It’s easy to study the behavior of programs and diagnose issues without even having the
source code, thanks to strace.
• You can leave a small gdbserver program (about 300 KB) on your target that allows to
debug target applications, using a standard gdb debugger on the development host.
• It is fine to strip applications and binaries on the target machine, as long as the programs
and libraries with debugging symbols are available on the development host.
Setup
Go to the $HOME/embedded-linux-labs/realtime/ directory.
Install the netcat package.
Root filesystem
Create an nfsroot directory.
To compare real-time latency between standard Linux and Xenomai, we are going to need a
root filesystem and a build environment that supports Xenomai.
Let’s build this with Buildroot.
Download and extract the Buildroot 2016.02 sources. As the latest version of Xenomai doesn’t
seem to work on the Xplained board (yet), we need an older version of Buildroot that will build
Xenomai 2.6.
Configure Buildroot with the following settings, using the / command in make menuconfig to
find parameters by their name:
• In Target:
– Target architecture: ARM (little endian)
– Target Architecture Variant: cortex-A5
• In Toolchain:
– Toolchain type: External toolchain
– Toolchain: Sourcery CodeBench ARM 2014.05
• In System configuration:
• In Target packages:
– Enable Show packages that are also provided by busybox. We need this to build
the standard netcat command, not provided in the default BusyBox configuration.
– In Debugging, profiling and benchmark, enable rt-tests. This will be a few ap-
plications to test real-time latency.
∗ Make sure that POSIX skin library and Native skin library18 are enabled.
As you are using a 64 bit distribution, Buildroot should also ask you to install 32 bit compatibility
packages to be able to execute the Sourcery CodeBench external toolchain:
At the end of the build job, extract the output/images/rootfs.tar archive in the nfsroot
directory.
The last thing to do is to add a few files that we will need in our tests:
cp data/* nfsroot/root
Then go to http://kernel.org and download the exact version corresponding to the patch you
downloaded. At the time of this writing, this version was 4.13.10.
Configure your kernel for your Xplained board, and then make sure that the below settings
are disabled: CONFIG_PROVE_LOCKING, CONFIG_DEBUG_LOCK_ALLOC, CONFIG_DEBUG_MUTEXES and
CONFIG_DEBUG_SPINLOCK.
Also, for the moment, disable the CONFIG_HIGH_RES_TIMERS option which impact we want to
measure.
Boot the Xplained board by mounting the root filesystem that you built. As usual, login as
root, there is no password.
18 Needed by the Xenomai testsuite.
Have a look at the rttest.c source file available in root/ in the nfsroot/ directory. See how it
shows the resolution of the CLOCK_MONOTONIC clock.
Now compile this program:
arm-none-linux-gnueabi-gcc -o rttest rttest.c -lrt
Execute the program on the board. Is the clock resolution good or bad? Compare it to the
timer tick of your system, as defined by CONFIG_HZ.
Copy the results in a file, in order to be able to compare them with further results.
Obviously, this resolution will not provide accurate sleep times, and this is because our kernel
doesn’t use high-resolution timers. So let’s add back the CONFIG_HIGH_RES_TIMERS option in the
kernel configuration.
Recompile your kernel, boot your Xplained with the new version, and check the new resolution.
Better, isn’t it?
Repeat the tests and compare the results again. You should see a massive improvement in the
maximum latency.