5.11. Autoconf og automake

Makefiles er en stor hjælp til selv små projekter. Et problem der hurtigt opstår er at projektet begynder at udvide sig og blive mere og mere komplekst. Det får så din Makefile til at blive voldsomt stor, fyldt med fejl og uoverskuelig. Mange af de operationer der er i en Makefile, er trivielle gentagelser fra projekt til projekt. Når der skal ske det samme så mange gange, ville det være en fordel at indbygge dette i make eller lave noget udenom make der kan håndtere dette. Resultatet blev autoconf.

Formålet med autoconf er få oprettet en "make"-fil der passer til slutbrugerens linux-version og eventuelt med brugerens specielle ønsker. Hele autoconf-systemet er lidt af en rodebunke og ret komplekst. Der findes flere mindre gode instruktioner til autoconf, og dette er nok endnu et eksempel – vi forsøger alligevel.

Følgende programpakker skal være installeret inden man kan gå i gang: make, autoconf og automake.

For at gøre det hele så simpelt som muligt, laver vi det klassiske "Hello, world!" eksempel og bygger videre på dette. I et tomt underkatalog har vi så det lille simple program hello.c med følgende indhold.

/* Filnavn: hello.c */
#include <stdio.h>
int main(void)
{
  printf("Hello, world!\n");
  return 0;
}

For at komme i gang med selve autoconf mangler vi configure.ac (tidligere configure.in) og Makefile.am. Makefile.am er en fil til programmet automake, og den vil så oprette Makefile.in. Makefile.am er ofte en lille fil og ser således ud i en minimal udgave for et C-program.

## Filnavn: Makefile.am
AUTOMAKE_OPTIONS = foreign
bin_PROGRAMS = hello
hello_SOURCES = hello.c

Næste fil er configure.ac hvilket er en fil der kan gå hen og blive ret stor. I sin minimale udgave ser den således ud:

# Filnavn: configure.ac
AC_INIT(hello.c)
AM_INIT_AUTOMAKE( demo-hello, 1.0 )
AC_PROG_CC
AC_STDC_HEADERS
AC_OUTPUT(Makefile)

Med filerne hello.c, Makefile.am og configure.ac kan vi gå i gang med at oprette de filer vi senere skal have distribueret til brugeren.

aclocal.m4 er en samling af alle de shell-macroer som bruges i configure.ac. Filen aclocal.m4 dannes af programmet aclocal ved at aclocal skanner configure.ac for hvilke macroer der bliver brugt. Macroerne finder den i .m4-filer som dem i /usr/share/aclocal/ (Den kigger i nuværende bibliotek og /usr/share/aclocal/ automatisk, man kan angive yderligere biblioteker). aclocal skal køres hvis der anvendes nye makroer i configure.ac. Når man da kalder autoconf for at danne configure ud fra configure.ac, vil autoconf erstatte brug af macroer med koden fra aclocal.m4.

hven% aclocal

For at få oprettet Makefile.in – det er den der senere skal læses af configure – køres kommandoen automake -a.

hven% automake -a

Der manglede nogle filer til automake hvilket vi automatisk får med, med tilvalget "--add-missing" ("-a" på kort form).

hven% autoconf
hven% ./configure
hven% make

Ved oversættelse ses at der er brugt tilvalget "-g" til gcc, det betyder at der kommer fejlsøgningsdata med i programmet. Det kan slås fra ved at sætte CFLAGS i configure.ac til for eksempel "-O2". Dertil kommer at der er to oversætterdirektiver, PACKAGE og VERSION, med på kommandolinjen. Der kan komme flere direktiver, så det vil være smart hvis disse blev lagt i en fil for sig, så kommandolinjen ikke bliver for lang. Dette kan gøres ved at tilføje AM_CONFIG_HEADER(config.h) i configure.ac.

# Filnavn: configure.ac
AC_INIT(hello.c)
AM_INIT_AUTOMAKE( demo-hello, 1.0 )
AM_CONFIG_HEADER(config.h)
CFLAGS="-O2"
AC_PROG_CC
AC_STDC_HEADERS
AC_OUTPUT(Makefile)

Efter tilføjelse af AM_CONFIG_HEADER kan systemet drille lidt ved at komme med nogle sære fejlmeddelelser. Dette skyldes at der er nogle afhængigheder i aclocal.m4, så denne fil skal opdateres med kommandoen aclocal. For at få oprettet header-filen config.h.in køres autoheader. ./configure vil så oprette filen config.h som evt. kan tilføjes i hello.c. Dernæst kan ./configure køres igen, og der oprettes en Makefile.

hven% aclocal
hven% autoheader ; autoconf
hven% ./configure
hven% make clean ; make

Bemærk at der nu under oversættelse tilføjes -DHAVE_CONFIG_H på kommandolinjen. Vi kan nu teste i hello.c om der er en config.h og inkludere denne. Dernæst tjekker vi om PACKAGE og VERSION er defineret, og udskriver disse værdier. Tag et kig på config.h, og se hvad den indeholder.

/* Filnavn: hello.c */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdio.h>

int main(void)
{
#ifdef PACKAGE
#ifdef VERSION
  printf("Bygget med pakken: %s-%s\n\n", PACKAGE, VERSION);
#endif
#endif
  printf("Hello, world!\n");
  return 0;
}

Der er en del filer i et autoconf-system og som nybegynder kan det være noget svært at få et overblik. Listen herunder giver en beskrivelse af de mest almindelige filer.

I figuren herunder ses en skematisk tegning af de vigtigste filer i et autoconf system.

Du har nu fået oprettet de to mest basale filer Makefile.am og configure.ac som fint kan danne basis for et projekt. Lad os lige stoppe op og kikke på hvad der er oprettet af filer og hvorfor. Makefile.am er den mest overordnede fil og også den mest avancerede m.h.t. til brug af makroer. Heldigvis for forståelsen er der ikke så mange kommandoer i denne fil, de er bare ret avancerede. Makefile.am indeholder informationer om hvordan projektet overordnet ser ud. Hvilke er selve programmerne, hvor skal disse installeres, hvilke kildefiler kræver disse programmer osv. En Makefile.am skal oprettes i hvert underkatalog, så dem kan man nemt få nogle stykker af.

Den Makefile.am der ligger i roden af projektet, har kommandoen AUTOMAKE_OPTIONS som overordnet bestemmer hvilken type af projekt man køre. Et tilvalg man kan bruge til frie programmer er for eksempel gnu der er aktiveret som standard. Med gnu-tilvalget opretter automake en del ekstra filer såsom COPYING og INSTALL. Dertil forventer automake at der er oprettet fire ekstra filer (NEWS README AUTHORS ChangeLog). Den nye Makefile.am ser således ud:

## Filnavn: Makefile.am
AUTOMAKE_OPTIONS = gnu
bin_PROGRAMS = hello
hello_SOURCES = hello.c

Inden automake køres igen, skal vi lige have tilføjet de ekstra filer som en gnu-installation kræver, og så kan automake køres. En ny Makefile.in oprettes, og den indeholder ny oplysninger om flere filer der skal med i en distribution når man senere kører kommandoen make dist.

hven% touch NEWS README AUTHORS ChangeLog
hven% automake

Kommandoen bin_PROGRAMS er en noget mere avanceret makro der fortæller hvilke binære filer der skal oversættes, og hvor disse skal installeres. Flere programmer kan indeholdes i en pakke, og de skrives på samme linje med mellemrum imellem. bin betyder at programmerne installeres i det underkatalog der er defineret i variablen bindir. Slutbrugeren kan så senere under installation bestemme hvor binære filer skal installeres. Default vil programmer blive installeret i /usr/local/bin/, men for nogle programmer gælder at disse skal installeres i /bin/. Vi kan på forhånd selv bestemme bindir, hvilket vi kommer tilbage til. bin_PROGRAMS har en fætter der hedder sbin_PROGRAMS, og den har default /usr/local/sbin/.

hello_SOURCES er en noget speciel variable der fortæller hvilke kildefiler der anvendes til et enkelt program. automake tager hvert program der er listet i fx. bin_PROGRAMS og leder efter variablen ???_SOURCES. automake forventer altså at denne variabel er oprettet, og der kommer selvfølgelig en fejl hvis den ikke er.

configure.ac er filen der fortæller hvordan en opsætning skal foregå. Her kikkes der ikke på kildetekster etc., men alene på hvordan opsætningen skal forløbe for slutbrugeren. Til et projekt er der kun én configure.ac, og denne er placeret i roden af projektet.

Der kan komme mange underlige fejl undervejs, hvilket kan afhjælpes ved at køre de forskellige programmer igen. For alle programmer gælder at det ikke skader at køre dem igen, og det tager heller ikke ret lang tid at gøre det. Så går noget galt, så kør denne stribe programmer igen:

hven% aclocal; automake -a; autoheader; autoconf; ./configure

Læs mere: http://sources.redhat.com/automake/automake.html, http://sources.redhat.com/autoconf/autoconf_toc.html, http://www.andamooka.org/reader.pl?section=autobook og "info automake" lokalt på dit system. Se også autoconf-filerne fra distribution fileutils.

./Makefile.am
./configure.ac
man/Makefile.am
man/hello.1
src/Makefile.am
src/hello.c

AUTOMAKE_OPTIONS = foreign
SUBDIRS = man src

AC_INIT(src/hello.c)
AM_INIT_AUTOMAKE( katalog-hello, 1.0 )
AC_PROG_CC
AC_STDC_HEADERS
AC_OUTPUT(Makefile man/Makefile src/Makefile)

man_MANS = hello.1
man_aux = $(man_MANS:.1=.x)
EXTRA_DIST = $(man_MANS)

.TH HELLO 1 "1 August 2001" "Hello" "Friheden til at programmere"
.SH NAME
hello \- en hilsen
.SH SYNOPSIS
hello
.SH DESCRIPTION
.B hello
skriver "Hello, world!" til standard out.
.SH USAGE
hello
.SH COPYRIGHT
Copyright \(co 2001 Friheden til at programmere.
.SH SEE ALSO
goodbye(1)

bin_PROGRAMS = hello
hello_SOURCES = hello.c

#include <stdio.h>
int main(void)
{
  printf("Hello, world!\n");
  return 0;
}

hven% aclocal; automake -a; autoconf
hven% ./configure
hven% make

## Filnavn: Makefile.am
AUTOMAKE_OPTIONS = foreign
bin_PROGRAMS = ceks2
ceks2_SOURCES = ceks2.c cfkt.c

# Filnavn: configure.ac
AC_INIT(ceks2.c)
AM_INIT_AUTOMAKE( demo-ceks , 1.0 )
AC_PROG_CC
AC_STDC_HEADERS
AC_OUTPUT(Makefile)

hven% automake -a
hven% aclocal
hven% autoconf
hven% ./configure
hven% make
hven% make install
hven% make uninstall
hven% make dist # o.s.v...

## Filnavn: Makefile.am
...
bin_SCRIPTS = hello.pl hello.sh
sbin_SCRIPTS = minbackup.sh
sysconfdir_DATA = hello.conf
htmldir = /var/www/html/hello
html_DATA = index.html
...

hven% ./configure --bindir=/bin

hven% ./configure --help | grep DIR

# Filnavn: configure.ac
...
htmldir=/var/www/html/hello
AC_MSG_CHECKING(htmldir)
AC_ARG_WITH(htmldir,
[  --with-htmldir=DIR      Where to put html/php files],
[ case "$withval" in
  yes|no)
  ;;
  * )
    htmldir="$withval"
    ;;
  esac])
AC_SUBST(htmldir)
AC_MSG_RESULT(${htmldir})
...

hven% ./configure --help
hven% ./configure --htmldir=/home/www
hven% make -n install | more

# Filnavn: configure.ac
...
AC_CHECK_FUNCS(printf)
...

# Filnavn: configure.ac
...
CONFDATO=`date "+%Y-%m-%d %H:%M:%S"`
AC_DEFINE_UNQUOTED(CONFDATO,"$CONFDATO",[Dato for kørsel af ./configure])
...

hven% autoheader ; autoconf ; ./configure
hven% cat config.h

/* Filnavn: hello.c */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdio.h>

int main(void)
{
#ifdef CONFDATO
  printf("./configure er kørt d.: %s\n", CONFDATO );
#endif
  printf("Hello, world!\n");
  return 0;
}

# Filnavn: configure.ac
AC_INIT(hello.c++)
AM_INIT_AUTOMAKE( demo-hello, 1.0 )
AC_PROG_CXX
AC_OUTPUT(Makefile)