CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

12: Compiling software from source

Aim:
To learn about the common build systems available in Linux and to use them.

Introduction:
Open source software is distributed in source code form. In case of popular software
Linux distributions will often have the software packaged in their repositories. If the package is
not package is not in the repository the user has to compile the software from source. To do this
the user has to understand about the build system used in the project.
The GNU build system, also known as the Autotools, is a suite of programming tools
designed to assist in making source-code packages portable to many Unix-like systems. It can
be difficult to make a software program portable: the C compiler differs from system to system;
certain library functions are missing on some systems; header files may have different names.
One way to handle this is write conditional code, with code blocks selected by means of
preprocessor directives (#ifdef); but because of the wide variety of build environments this
approach quickly becomes unmanageable. The GNU build system is designed to address this
problem more manageably.
Tools included in the GNU build system
The GNU build system comprises the GNU utility programs Autoconf, Automake, and Libtool.
Other related tools frequently used with the GNU build system are GNUs make program, GNU
gettext, pkg-config, and the GNU Compiler Collection, also called GCC.
GNU Autoconf
Autoconf generates a configure script based on the contents of a configure.ac file which
characterizes a particular body of source code. The configure script, when run, scans the build
environment and generates a subordinate config.statusscript which, in turn, converts other input
files and most commonly Makefile.in into output files (Makefile) which are appropriate for that
build environment. Finally the make program uses Makefile to generate executable programs
from source code.
The complexity of the GNU build system reflects the variety of circumstances under which a
body of source code may be built.

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

If a source code file is changed then it suffices to re-run make which only recompiles that part of the body of the source code affected by the change.
If a .in file has changed then it suffices to re-run config.status and make.
If the body of source code is copied to another computer then it is suffices to rerun configure (which runs config.status) and make. (For this reason source code
using the GNU build system is normally distributed without the files thatconfigure
generates.)
If the body of source code is changed more fundamentally then configure.ac and
the .in files need to be changed and all subsequent steps also followed.
To process files, autoconf uses the GNU implementation of the m4 macro system.
Autoconf comes with several auxiliary programs such as Autoheader, which is used to help
manage C header files; Autoscan, which can create an initial input file for Autoconf; and
ifnames, which can list C pre-processor identifiers used in the program.

GNU Automake
Automake helps to create portable Makefiles, which are in turn processed with the make utility.
It takes its input as Makefile.am, and turns it into Makefile.in, which is used by the configure
script to generate the file Makefile output.
GNU Libtool
Libtool helps manage the creation of static and dynamic libraries on various Unix-like operating
systems. Libtool accomplishes this by abstracting the library-creation process, hiding
differences between various systems (e.g. GNU/Linuxsystems vs. Solaris).
Gnulib
Gnulib simplifies the process of making software that uses Autoconf and Automake portable to a
wide range of systems.
Make
In software development, make is a utility that automatically builds executable programs and
libraries from source code by reading files called makefiles which specify how to derive the
target program. Make can decide where to start through topological sorting. Though integrated
development environments and language-specific compiler features can also be used to
manage the build process in modern systems, make remains widely used, especially in Unix.
Make is typically used to build executable programs and libraries from source code. Generally
though, any process that involves transforming a dependency file to a target result (by executing
some number of arbitrary commands) is applicable to make. To cite an example, make could be
2

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

used to detect a change made to an image file (the dependency) and the target actions that
result might be to convert the file to some specific format, copy the result into a content
management system, and then send e-mail to a predefined set of users that the above actions
were performed.

Flow diagram of autoconf and automake

3

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

CMake
CMake is a unified, cross-platform, open-source build system that enables developers to build,
test and package software by specifying build parameters in simple, portable text files. It works
in a compiler-independent manner and the build process works in conjunction with native build
environments, such as make, Apple's Xcode and Microsoft Visual Studio. It also has minimal
dependencies, C++ only. CMake is open source software.
CMake can:
Create libraries
Generate wrappers
Compile source code
Build executables in arbitrary combinations

Apache Ant
Apache Ant is a software tool for automating software build processes. It is similar to Make but
is implemented using the Java language, requires the Java platform, and is best suited to
building Java projects.
The most immediately noticeable difference between Ant and Make is that Ant uses XML to
describe the build process and its dependencies, whereas Make uses Makefile format. By
default the XML file is named build.xml.
Ant is an Apache project. It is open source software, and is released under the Apache Software
License.

Description:
In this exercise students will learn how to use the GNU Autotools, Plain makefiles,
CMake and Ant build scripts. Students will write the build scripts for the various build tools
except for the Autotools where they will study an already existing project as a sample of how to
download and compile opensource software from the net.

Pre-requisites:
The computers need the development tools to be installed. Instructions for installing
them will be given along with each exercise.

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

Exercises:
Create a directory for all the programs in the exercise.
> mkdir build_systems
> cd build_systems

1. Make
We will be using a simple program written in C and write a makefile to compile the program.
> mkdir gnumake
> cd gnumake
> gedit squareroot.c

The Code:
// A simple program that computes the square root of a number
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
int main (int argc, char *argv[])
{
if (argc < 2)
{
fprintf(stdout,"Usage: %s number\n",argv[0]);
return 1;
}
double inputValue = atof(argv[1]);
double outputValue = sqrt(inputValue);
fprintf(stdout,"The square root of %g is %g\n",
inputValue, outputValue);
return 0;
}

Test it by compiling it once:

> gcc squareroot.c -o squareroot -lm
> ./sqaureroot 49
> The square root of 49 is 7

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

Now we write a simple makefile to compile the program.

> gedit Makefile
The Code:
# Commands start with TAB not spaces
CC
= gcc
CFLAGS
= -g
LDFLAGS
= -lm
all: squareroot
squareroot: squareroot.o
squareroot.o: squareroot.c
clean:
rm -f squareroot squareroot.o

Now we test the Makefile:

> make
make: Nothing to be done for `all'.
> make clean
rm -f squareroot squareroot.o
> make
gcc -g
-c -o squareroot.o squareroot.c
gcc -lm squareroot.o
-o squareroot
> ./squareroot 49
The square root of 49 is 7
>

2. CMake
We will now write a simple script for CMake to compile the previously written program.
First we install CMake

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

> yum install cmake

We create a new directory and copy the source code to it.

>
>
>
>

cd ..
mkdir cmake
cd cmake
cp ../gnumake/squareroot.c .

Now we create configuration files for CMake.

> gedit CMakeLists.txt
The Code:
cmake_minimum_required (VERSION 2.6)
project (squareroot)
add_executable(squareroot squareroot.c)
TARGET_LINK_LIBRARIES(squareroot m)

CMake is commonly use with out of source builds ie, we build the program in a directory
separate from the source. We use the generated makefile to compile the program.
> mkdir build
> cd build
> ls
> cmake ..
-- The C compiler identification is GNU
-- The CXX compiler identification is GNU
-- Check for working C compiler: /usr/bin/gcc
-- Check for working C compiler: /usr/bin/gcc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Configuring done
-- Generating done
-- Build files have been written to:
/home/<user>/projects/buildsystems/cmake/build
> ls
CMakeCache.txt CMakeFiles cmake_install.cmake Makefile

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

> make
Scanning dependencies of target squareroot
[100%] Building C object CMakeFiles/squareroot.dir/squareroot.c.o
Linking C executable squareroot
[100%] Built target squareroot
>ls
CMakeCache.txt CMakeFiles cmake_install.cmake Makefile squareroot
> ./squareroot 49
The square root of 49 is 7

Study the CMake generated Makefile.

3. Apache Ant
Apache ant uses java. So we need to install java.

> yum install java-1.6.0-openjdk-devel

> yum install ant

We need a new directory for the ant exercise.

>
>
>
>

cd ../../
mkdir ant
cd ant
mkdir -p src/hello

> gedit src/hello/HelloWorld.java

The Code:
package hello;
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World");
}
}

We now check to see if the code is working correctly

> mkdir -p build/classes
> javac -sourcepath src -d build/classes/ src/hello/HelloWorld.java

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

> java -cp build/classes hello.HelloWorld
Hello World
>

We now write the ant build script.

> gedit build.xml

The Code:
<project>
<target name="clean">
<delete dir="build"/>
</target>
<target name="compile">
<mkdir dir="build/classes"/>
<javac srcdir="src" destdir="build/classes"/>
</target>
<target name="jar">
<mkdir dir="build/jar"/>
<jar destfile="build/jar/HelloWorld.jar"
basedir="build/classes">
<manifest>
<attribute name="Main-Class" value="hello.HelloWorld"/>
</manifest>
</jar>
</target>
<target name="run">
<java jar="build/jar/HelloWorld.jar" fork="true"/>
</target>
</project>

Now the project can be compile and run using ant.

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

> ant clean
Buildfile: build.xml
clean:
[delete] Deleting
directory /home/<user>/projects/buildsystems/ant/build
BUILD SUCCESSFUL
Total time: 0 seconds
> ant compile jar run
Buildfile: build.xml
compile:
[mkdir] Created
dir: /home/<user>/projects/buildsystems/ant/build/classes
[javac] /home/<user>/projects/buildsystems/ant/build.xml:9:
warning: 'includeantruntime' was not set, defaulting to
build.sysclasspath=last; set to false for repeatable builds
[javac] Compiling 1 source file
to /home/<user>/projects/buildsystems/ant/build/classes
jar:
[mkdir] Created
dir: /home/<user>/projects/buildsystems/ant/build/jar
[jar] Building
jar: /home/<user>/projects/buildsystems/ant/build/jar/HelloWorld.jar
run:
[java] Hello World
BUILD SUCCESSFUL
Total time: 1 second

4. GNU Autotools
Now we will learn how to use autotools. We will be using a program designed specifically to
teach about using autotools -- GNU Hello. Copy the file hello-2.7.tar.gz to the buildsystems
project directory and uncompress it.
> cd ..
> ls

10

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

ant cmake gnumake hello-2.7.tar.gz
> tar -xzf hello-2.7.tar.gz
> cd hello-2.7
> ./configure
> make
> src/hello
Hello, world!
>

The program will now reside in the src directory. To install the program log in as root.
> su
> make install
> exit

Now the program can be run from anywhere.

> hello
Hello, world!
> hello --help
Usage: hello [OPTION]...
Print a friendly, customizable greeting.
-h, --help
-v, --version

display this help and exit

display version information and exit

-t, --traditional
-n, --next-generation
-g, --greeting=TEXT

use traditional greeting format

use next-generation greeting format
use TEXT as the greeting message

Report bugs to: bug-hello@gnu.org

GNU Hello home page: <http://www.gnu.org/software/hello/>
General help using GNU software: <http://www.gnu.org/gethelp/>

To uninstall the program:

> su
> make uninstall
> exit

Instead of using software downloaded as an archive for compilation, source code can also be
obtained from software repositories using version control systems like SVN. Build and
installation instructions will be found along with the source code which can be used to buil the
software.
11

CS2406-Lab Manual - NRCFOSS/AU-KBC Centre, Anna University Chennai

References:
1.
2.
3.
4.

http://sources.redhat.com/autobook/ -- Autotools book

http://www.gnu.org/software/make/manual -- GNU Make manual
http://www.cmake.org/cmake/help/cmake_tutorial.html -- CMake tutorial
http://ant.apache.org/manual/tutorial-HelloWorldWithAnt.html -- Apache Ant
tutorial

12