autotools 自动构建工程

阅读量

作为 UNIX/LINUX 背景下的开发人员或者运维人员，当然对 configure -> make -> make install 系列操作非常熟悉，但是可能对其实现方式不是那么熟悉，实际上，这叫 GNU构建系统，利用脚本和 make 程序在特定平台上构建软件。此次我们以开发者的视角来分析构建细节。

环境说明：
  • CentOS release 6.9 (Final)
  • autoconf 2.69 (包含 autoscan autoconf autoheader )
  • automake 1.11.1 (包含 aclocal automake)
  • make 3.81

configure / make / make install

开发人员或者运维人员经常使用 configure->make->make install 三部曲进行软件安装，然后好多人并不知道这个过程真正干了什么。

  • configure 脚本是由软件开发者维护并发布给用户使用的 shell脚本。这个脚本的作用就是检测系统环境和进行基本的配置，最终目的生成 Makefile 和 config.h

  • make 通过读取 Makefile 文件，开始构建软件

  • 而 make install 则负责将 软件或者可执行文件 安装至指定位置

详细请查看如下每部分详情….

项目结构

示例项目源码: autotoolsdemo

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[wettper@web-lovers autotoolsdemo]$ tree
.
├── AUTHORS
├── ChangeLog
├── docs
│   └── examples
├── include
│   ├── autotoolsdemo.h
│   ├── config.h
│   ├── thread.c
│   └── thread.h
├── NEWS
├── README.md
├── src
│   └── autotoolsdemo.c
├── tags
└── tests
    └── README.md
4 directories, 12 files

主要文件的内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
/* config.h */
#ifndef CONFIG_H
#define CONFIG_H
#define MAXBUFLINE      20
//线程个数
#define THREAD_NUMS     10
extern int num;
#endif  /*CONFIG_H*/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/* thread.h */
#ifndef THREAD_H
#define THREAD_H
#ifndef HAVE_STDIO_H
#define HAVE_STDIO_H
#include <stdio.h>
#endif
#include "config.h"
void *thread_main(void *argv);
#endif  /*THREAD_H*/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/* autotoolsdemo.h */
#ifndef AUTOTOOLSDEMO_H
#define AUTOTOOLSDEMO_H
#ifndef HAVE_STDIO_H
#define HAVE_STDIO_H
#include <stdio.h>
#endif
#ifndef HAVE_STRING_H
#define HAVE_STRING_H
#include <string.h>
#endif
#ifndef HAVE_STDLIB_H
#define HAVE_STDLIB_H
#include <stdlib.h>
#endif
#ifndef HAVE_ERRNO_H
#define HAVE_ERRNO_H
#include <errno.h>
#endif
#ifndef HAVE_PTHREAD_H
#define HAVE_PTHREAD_H
#include <pthread.h>
#endif
#include "config.h"
#include "thread.h"
#endif  /*AUTOTOOLSDEMO_H*/
1
2
3
4
5
6
7
8
9
10
/* thread.c */
#include "thread.h"
int num = 0;
void *thread_main(void *argv)
{
    printf("this pthread num is: %d \n", num ++); 
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/* autotoolsdemo.c */
#include "autotoolsdemo.h"
int main ()
{
    int i;
    pthread_t threads[THREAD_NUMS];
    for (i = 0; i < THREAD_NUMS; i ++) {
        if (pthread_create(&threads[i], NULL, &thread_main, NULL) != 0) {
            fprintf(stderr, "create pthread error: %s \n", strerror(errno));
            exit(1);
        }
    }
    for (i = 0; i < THREAD_NUMS; i++) {
        pthread_join(threads[i], NULL);
    }
    return 0;
}

流程

简易流程

让我们开始

autoscan

1
[wettper@web-lovers autotoolsdemo]$ autoscan

将生成 configure.scan 和 autoscan.log，然后重命名 configure.scan 为 configure.ac。autoscan 会扫描源码，并生成一些通用的宏调用、输入的声明以及输出的声明。尽管autoscan十分方便，但是没人能够在构建之前，就把代码完全写好，因此 autoscan 通常用于初始化 configure.ac

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
AC_PREREQ([2.69])
AC_INIT([autotoolsdemo], [1.0], [contact@web-lovers.com])
AM_INIT_AUTOMAKE([autotoolsdemo], [1.0])
AC_CONFIG_SRCDIR([src/autotoolsdemo.c])
AC_CONFIG_HEADERS([config.h])
# Checks for programs.
AC_PROG_CC
AC_PROG_RANLIB
# Checks for libraries.
# Checks for header files.
AC_CHECK_HEADERS([stdio.h stdlib.h string.h errno.h])
# Checks for typedefs, structures, and compiler characteristics.
AC_CHECK_HEADER_STDBOOL
AC_TYPE_SIZE_T
# Checks for library functions.
AC_FUNC_MALLOC
AC_CHECK_FUNCS([memset strerror strstr])
AC_CONFIG_FILES([Makefile
                 include/Makefile
                 src/Makefile])
AC_OUTPUT

每个 configure.scan 文件都是以 AC_INIT开头，AC_OUTPUT 结束，布局如下

1
2
3
4
5
6
7
8
9
10
AC_INIT
    测试程序
    测试函数库
    测试头文件
    测试类型定义
    测试结构
    测试编译器特性
    测试库函数
    测试系统调用
AC_OUTPUT

其中以 AC_ 开头的类似函数调用一样的代码，实际是一些被称为“宏”的调用。这里的宏与C中的宏概念类似，会被替换展开。m4是一个经典的宏工具，autoconf 正是构建在m4之上，可以理解为 autoconf 预先实现了大量的，用于检测系统可移植性的宏，这些宏在展开后就是大量的shell脚本。所以编写 configure.ac 需要对这些宏熟练掌握，并且合理调用。有时，甚至可以自己实现自己的宏。

aclocal

1
[wettper@web-lovers autotoolsdemo]$ aclocal

configure.in 里面包含了一系列的宏命令，运行aclocal的目的是把工程需要的宏命令展开。aclocal.m4 就是configure.in中用到的宏定义。本步会生成aclocal.m4文件和autom4te.cache文件夹

autoconf

1
[wettper@web-lovers autotoolsdemo]$ autoconf

这个命令将 configure.ac 文件中的宏展开，生成 configure 脚本。这个过程可能要用到aclocal.m4中定义的宏

autoheader

1
[wettper@web-lovers autotoolsdemo]$ autoheader

生成配置头文件的模板config.h.in文件

编写Makefile.am

automake 工具会根据 configure.in 中的参量把 Makefile.am 转换成 Makefile.in 文件。最终通过 Makefile.in 生成 Makefile 文件，所以 Makefile.am 这个文件非常重要，分别在每个目录下建立 Makefile.am 配置文件

./Makefile.am

1
2
AUTOMAKE_OPTIONS = foreign
SUBDIRS = include src

./include/Makefile.am

1
2
3
4
AUTOMAKE_OPTIONS = foreign
INCLUDES = -I $(top_srcdir)/include/
noinst_LIBRARIES = libthread.a
libthread_a_SOURCES = config.h thread.h thread.c

./src/Makefile.am

1
2
3
4
5
6
AUTOMAKE_OPTIONS = foreign
INCLUDES = -I $(top_srcdir)/include/
bin_PROGRAMS = autotoolsdemo
autotoolsdemo_SOURCES = autotoolsdemo.c
autotoolsdemo_LDADD = $(top_srcdir)/include/libthread.a
LIBS= -l pthread

Makefile.am是一种比Makefile更高层次的规则。只需指定要生成什么目标，它由什么源文件生成，要安装到什么目录等构成。

  • AUTOMAKE_OPTIONS 软件等级，automake提供了3种软件等级：foreign、gnu、gnits，默认等级是gnu。此处使用的foreign表示只是检测必要的文件
  • SUBDIRS 先扫描子目录，多个目录用空格隔开
  • INCLUDES 指明include目录
  • noinst_LIBRARIES 生成静态库（.a）或者动态库(.so)的名称。库文件一般以lib.a或者lib.so来命名。而且 静态库使用中，需要对configure.ac中加入AC_PROG_RANLIB。静态库配置分为两个：
    • noinst_LIBRARIES：当运行make install的时候，库文件不会被安装到linux默认的/usr/local/lib目录下。
    • lib_LIBRARIES：当运行make intsall的时候，则会被安装到/usr/local/lib目录下。之前的例子：noinst_LIBRARIES=libthread.a
  • libthread_a_SOURCES c 的源文件，多个文件用空格分开
  • libthread_a_LDADD 加载所需的库文件
  • libthread_a_LDFLAGS 编译的时候的连接标识
  • bin_PROGRAMS 声明一个可执行文件目标
  • autotoolsdemo_SOURCES 指定这个目标所依赖的源代码文件
  • autotoolsdemo_LDADD 声明了可执行文件在连接时，需要依赖的Libtool库文件
  • LIBS 因为我们项目中用到了 pthread，这个是动态连接，在编译的时候会自动加上 -l pthread

automake

生成Makefiel.in和所需要的脚本，其中add-missing选项会让automake自动添加一些必须的脚本文件

1
2
3
4
[wettper@web-lovers autotoolsdemo]$ automake --add-missing
configure.ac:6: installing `./install-sh'
configure.ac:6: installing `./missing'
include/Makefile.am: installing `./depcomp'

./configure

configure 为 shell 脚本文件

1
2
[wettper@web-lovers wbench]$ file ./configure
./configure: POSIX shell script text executable

当 ./configure 运行的时候，将看到很多系统检查操作，不过检查的多少一般取决于软件的需求，即由 开发者决定。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
[wettper@web-lovers autotoolsdemo]$ ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking for style of include used by make... GNU
checking dependency style of gcc... gcc3
checking for ranlib... ranlib
checking how to run the C preprocessor... gcc -E
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for ANSI C header files... yes
checking for sys/types.h... yes
checking for sys/stat.h... yes
checking for stdlib.h... yes
checking for string.h... yes
checking for memory.h... yes
checking for strings.h... yes
checking for inttypes.h... yes
checking for stdint.h... yes
checking for unistd.h... yes
checking stdio.h usability... yes
checking stdio.h presence... yes
checking for stdio.h... yes
checking for stdlib.h... (cached) yes
checking for string.h... (cached) yes
checking errno.h usability... yes
checking errno.h presence... yes
checking for errno.h... yes
checking for stdbool.h that conforms to C99... yes
checking for _Bool... yes
checking for size_t... yes
checking for stdlib.h... (cached) yes
checking for GNU libc compatible malloc... yes
checking for memset... yes
checking for strerror... yes
checking for strstr... yes
configure: creating ./config.status
config.status: creating Makefile
config.status: creating include/Makefile
config.status: creating src/Makefile
config.status: creating config.h
config.status: executing depfiles commands

一般来说，configue 主要检查当前目标平台的 程序、库、头文件、函数 等的兼容性。这些检查结果将用于 config.h 和 Makefile 文件的生成，从而影响最后的编译

用户也可以通过 configure 配置参数来定制软件需要包含或不需要包含的组件、安装路径 等行为，这些参数分为 5组，可以通过执行 ./configure –help 查看，软件提供配置参数大致为：

  • 安装路径相关配置。最常见的是 –prefix。
  • 程序名配置。例如 –program-suffix 可用于为生成的程序添加后缀。
  • 跨平台编译。不太常用。
  • 动态库静态库选项。用于控制是否生成某种类型的库文件。
  • 程序组件选项。用于配置程序是否将某种功能编译到程序中，一般形如 –with-xxx。这可能是最常用的配置，而且由软件开发者来定义。

configure在执行过程中，除了生成Makefile外，还会生成的文件包括但不限于：

  • config.log 日志文件
  • config.cache 缓存，以提高下一次configure的速度，需通过-C来指定才会生成
  • config.status 实际调用编译工具构建软件的shell脚本

configure 经常会中途出错，这一般是由于当前平台不具有构建该软件所必需的依赖(库、函数、头文件、程序…)。此时，不要慌张，仔细查看输出，解决这些依赖

make

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
[wettper@web-lovers autotoolsdemo]$ make
make  all-recursive
make[1]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo'
Making all in include
make[2]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo/include'
gcc -DHAVE_CONFIG_H -I. -I.. -I ../include/    -g -O2 -MT thread.o -MD -MP -MF .deps/thread.Tpo -c -o thread.o thread.c
mv -f .deps/thread.Tpo .deps/thread.Po
rm -f libthread.a
ar cru libthread.a thread.o
ranlib libthread.a
make[2]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo/include'
Making all in src
make[2]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo/src'
gcc -DHAVE_CONFIG_H -I. -I.. -I ../include/    -g -O2 -MT autotoolsdemo.o -MD -MP -MF .deps/autotoolsdemo.Tpo -c -o autotoolsdemo.o autotoolsdemo.c
mv -f .deps/autotoolsdemo.Tpo .deps/autotoolsdemo.Po
gcc  -g -O2   -o autotoolsdemo autotoolsdemo.o ../include/libthread.a -l pthread
make[2]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo/src'
make[2]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo'
make[2]: Nothing to be done for `all-am'.
make[2]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo'
make[1]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo'

make install

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[wettper@web-lovers autotoolsdemo]$ sudo make install
Making install in include
make[1]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo/include'
make[2]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo/include'
make[2]: Nothing to be done for `install-exec-am'.
make[2]: Nothing to be done for `install-data-am'.
make[2]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo/include'
make[1]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo/include'
Making install in src
make[1]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo/src'
make[2]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo/src'
test -z "/usr/local/bin" || /bin/mkdir -p "/usr/local/bin"
  /usr/bin/install -c autotoolsdemo '/usr/local/bin'
make[2]: Nothing to be done for `install-data-am'.
make[2]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo/src'
make[1]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo/src'
make[1]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo'
make[2]: Entering directory `/var/www/c/experiment_demo/autotoolsdemo'
make[2]: Nothing to be done for `install-exec-am'.
make[2]: Nothing to be done for `install-data-am'.
make[2]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo'
make[1]: Leaving directory `/var/www/c/experiment_demo/autotoolsdemo'

默认安装至 /usr/local/bin/

1
2
3
4
5
6
7
8
9
10
11
12
13
[wettper@web-lovers autotoolsdemo]$ ll /usr/local/bin/autotoolsdemo
-rwxr-xr-x 1 root root 12281 Jan 22 10:57 /usr/local/bin/autotoolsdemo
[wettper@web-lovers autotoolsdemo]$ autotoolsdemo
this pthread num is: 0
this pthread num is: 1
this pthread num is: 2
this pthread num is: 3
this pthread num is: 4
this pthread num is: 5
this pthread num is: 6
this pthread num is: 7
this pthread num is: 8
this pthread num is: 9

如上所述即为 GUN构建系统的流程，类似使用较多的还有 cmake。但是更多的还是使用 IDE 进行构建。不过不可否认，作为 LINUX软件开发者，autotools 是不可避免的知识点。

本文作者： wettper
本文链接： http://www.web-lovers.com/c-autotools.html
版权声明： 本博客所有文章除特别声明外，均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处！

赏

谢谢你请我吃糖果

支付宝
微信

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

wettper <br /><br /> 现 离职状态 程序猿 <br /><br /> 叫醒我的不止阳光，还有梦想！<br /><br /> 喵喵、念念、健身、吉他！