Gnu Make学习笔记1：基本用法

piaoxiang

学习任务：Gnu Make
学习资料：GNU Make 3.80（中文版，徐海兵译）、网络
学习目标：
    1、能够熟练编写中小规模project的Makefile
    2、能够读懂大规模project，比如Linux kernel的Makefile
    3、学习automake以实现自动化工程管理

2007-05-05

1、make是什么？Makefile又是什么？

    Gnu make是Linux环境下用来构建和管理工程的命令工具，然而单独的make命令是无法工作的，它需要一个Makefile文件。这个文件描述了整个工程的编译、连接规则，Makefile有自己的书写格式、命令、关键字。make读取Makefile，然后对这些规则解释执行，以完成工程管理。可以进行类比理解：shell是一个命令解释器，它可以读取shell脚本文件，在解释的同时执行（注意：这是解释器和编译器的不同之处）。同样，make类似一个命令解释器（但是不是命令解释器，只是类比而已），它可以读取Makefile文件，进行解释执行。因为shell脚本和Makefile都有自己独立的书写格式、命令等，所以需要分别理解，在变量引用等方面需要进行区分，不要混淆。从另一方面来看，Linux存在很多相通之处，就像一个生态环境。shell和Makefile可以结合使用，以更加通用。二者在正则表达式上很多地方相同。在学习中，采用对比研究的方法比较合适。

2、make的基本工作原理是什么？

    make是通过比较对应文件（规则的目标和依赖）的最后修改时间，来决定哪些文件需要更新、那些文件不需要更新。对需要更新的文件，make就执行数据库中所记录的相应命令（在make读取Makefile后会建立一个编译过程的描述数据库。此数据库中记录了所有各个文件之间的相互关系，以及它们的关系描述）来重建它，对于不需要重建的文件make什么也不做。
3、Makefile编写可读性的注意事项

    （1）在书写时，一个较长行可以使用反斜线（\）分解为多行，这样做可以使Makefile清晰、容易阅读。注意：反斜线之后不能有空格！
    （2）在实际工作中大家比较认同的方法是，使用一个变量“objects”、“OBJECTS”、“objs”、“OBJS”来作为所有的.o文件的列表的替代。在使用到这些文件列表的地方，使用此变量来代替。比如说定义了变量“OBJS”，那么就可以在需要的地方使用“$(OBJS)”来表示它。
    （3）书写规则建议的方式是：单目标，多依赖。就是说尽量做到一个规则中只存在一个目标文件，可有多个依赖文件。尽量避免多目标，单依赖的方式。这样后期维护也会非常方便，而且Makefile会更加清晰明了。

    （4）Makefile可以包含子Makefile，这样方便工程的模块化管理。这可以利用关键字include实现，和c语言对头文件的包含方式类似。include指示符告诉make暂停读取当前的Makefile，而转去读取include指定的一个或多个文件，完成以后再继续当前Makefile的读取。Makefile指示符include书写在独立的一行，其形式如下：
include FILENAMES
    FILENAMES是shell所支持的文件名（可以使用通配符）。指示符include所在的行可以以一个或者多个空格（make在处理时将忽略这些空格）开始，但是切记不能以【TAB】字符开始。
4、Makefile中如何创建多个可执行程序？

    Makefile中，如果在一个目录下如果需要创建多个可执行程序，我们可以将所有程序的重建规则在一个Makefile中描述。因为Makefile中第一个目标是“终极目标”，约定的做法是使用一个称为“all”的伪目标来作为终极目标，它的依赖文件就是那些需要创建的程序。


#sample multi-target
all: prog1 prog2 prog3
.PHONY: all
prog1: prog1.o utils.o
        $(CC) $(CFLAGS) $^ -o $@
prog2: prog2.o
        $(CC) $(CFLAGS) $^ -o $@
prog3: prog3.o sort.o utils.o
        $(CC) $(CFLAGS) $^ -o $@
    当需要单独更新某一个程序时，我们可以通过make的命令行选项来明确指定需要重建的程序。
5、Makefile中make clean的标准格式

    make存在一个内嵌隐含变量“RM”，它被定义为：“RM=rm -f”，因此在书写clean规则时的命令行可以使用$(RM)来代替rm，这样可以避免出现一个不必要的麻烦。这是推荐使用的做法。

    注意：目标clean仅仅代表一个动作的标识，这个标识可以作为make命令的参数。它没有任何依赖，Makefile中把这种没有任何依赖，只有执行动作的目标称为“伪目标”（phony targets）。你可以用make clean来执行清理工作。

.PHONY:clean
clean:
        $(RM) *.o $(TARGET)
6、小技巧

    （1）如果要执行的命令以字符“@”开始，则make在执行时这个命令就不会被回显。典型的用法是我们在使用echo命令时输出一些信息时，如：
@echo "starting"
    所以可以在书写Makefile时，使用@来控制命令的回显。
    （2）规则中，当目标需要被重建时，此规则定义的命令将会被执行，如果是多行命令，那么make就为每一行命令使用一个独立的子shell去执行。因此，多行命令之间的执行是相互独立的，相互之间不存在依赖。而在Makefile中书写在同一行的多个命令属于一个完整的shell命令行，所以需要注意：在一个规则的命令中，命令行cd改变目录并不会对其后的命令的执行产生影响。就是说其后的命令执行的工作目录不会是之前使用cd进入的那个目录。如果要实现这个目的，就不能把cd和其后的命令放在两行来书写。而应该把这两行命令写在一行上，用分号隔开。这样它们才是一个完整的shell命令行。如果希望把一个完整的shell命令行书写在多行上，需要使用反斜杠来对处于多行的命令进行连接，表示它们是一个完整的shell命令行。
    （3）make的递归调用
    在Makefile中使用“make”作为一个命令来执行本身或者其他makefile文件。递归调用在一个存在多级子目录的项目中非常有用。
subsystem:
cd subdir && $(MAKE)
等价于
subsystem:
$(MAKE) -C subdir
    意思是进入子目录，然后在子目录下面执行make。
    （4）make可以定制命令包
    在书写Makefile时，可能有多个规则会使用相同的一组命令，就像C语言程序中需要经常使用的函数printf。可以将一组命令进行类似c语言函数的封装，以后在需要的地方可以通过它的名字来对这一组命令中进行引用。这样就可以减少重复工作，提高了效率。在GNU make中，可以使用指示符define来完成这个功能，通常把define定义的一组命令成为一个命令包。定义一个命令包的语法以define开始，以endef结束。
define run-yacc
yacc $(firstword $^)
mv y.tab.c $@
endef
    这样，run-yacc就是这个命令包的名字。在define和endef之间的命令就是命令包的主体。需要说明的是，使用define定义的命令包中，命令体中变量和函数的引用不会展开。命令体中所有的内容包括$等都是变量run-yacc的定义，它和C语言中宏的使用方式一样。
使用：
foo.c:foo.y
$(run-yacc)
    （5）区分Makefile和shell中对变量应用的不同
    Makefile单字符的引用可以为$x $(x) ${x}三种形式。多字符的引用$(xx) ${xx}.
    而shell中变量的引用只有两种形式${xx} $xx.
    一般在书写Makefile时，各部分变量引用的格式建议如下：
（i）make变量（Makefile中定义的变量或者是make的环境变量）的引用使用$(VAR)的格式，无论VAR是单字符变量名还是多字符变量名。
（ii）出现在规则命令行中shell变量（一般为执行命令过程中的临时变量，它不属于Makefile变量，而是一个shell变量）引用使用shell的$tmp格式。
（iii）对出现在命令行中的make变量同样使用$(CMDVAR)格式来引用。
    （6）尽量采用直接展开式变量，而不要用递归展开式变量。

    （7）如果实现对一个之前没有定义过的变量进行赋值，可以使用?=。如果想对一个通用变量的值进行追加，使用+=。
7、思想

    作为一名优秀的程序员，在面对一个复杂问题时，应该是寻求一种尽可能简单、直接并且高效的处理方式来解决，而不是将一个简单问题在实现上复杂化。如果想在简单问题上突出自己使用某种语言的熟练程度，是一种非常愚蠢且不成熟的行为。

2007-05-10

1、Gnu make如何执行？

    Gnu make的执行过程：

    （1）依次读取变量MAKEFILES定义的makefile文件列表。
    （2）读取工作目录下的makefile文件（按照命名的查找顺序：GNUmakefile、makefile、Makefile，首先找到那个就读那个）。
    （3）依次读取工作目录makefile使用指示符include包含的文件。
    （4）查找重建所有已读取的makefile文件的规则。
    （5）初始化变量值，并展开那些需要立即展开的变量和函数，然后根据预设条件执行分支。
    （6）根据“终极目标”和其他目标的依赖关系建立依赖关系链表。
    （7）执行除“终极目标”之外的所有目标的规则。
    （8）执行“终极目标”所在的规则。

    Gnu make读取Makefile：

    （1）读取所有Makefile文件，内建所有的变量、明确规则和隐含规则，并建立所有目标与依赖之间的依赖关系结构链表。（也就是建立了描述数据库）

    （2）根据第一阶段已经建立的依赖结构关系链表来决定那些关系需要更新，并使用相应的规则来重建目标。（通过描述数据库来分析执行）

    理解make执行的两个阶段对理解变量和函数如何展开很重要。在make执行的第一阶段如果变量和函数被展开，则称为“立即”展开，此时所有的变量和函数被展开在需要构建的结构链表的对应规则中（此规则在建立链表时需要使用）。其他的展开被称为“延后”的。这些变量和函数不会被立即展开，只有到后续某些规则需要或者第二阶段时才会展开。

    Gnu make执行一个规则：

    对于一个存在的规则（明确规则和隐含规则），首先，make程序将比较目标文件和所有的依赖文件的时间戳。如果目标的时间戳比所有依赖文件的时间戳更新，那么就什么也不做。否则，依赖文件中的某一个或者全部在上一次执行make后已经被修改过，规则所定义的重建目标的命令将会被执行。这是make工作的基础，也是其执行规则所定义命令的依据。

2、如何自动获取所有目标文件？

    在规则中，通配符会被自动展开，但是在变量定义和使用函数时，通配符不会被自动展开。如果Makefile中有这么一句：“objects=*.o”，那么变量objects的值就是“*.o”，而不是使用空格分开的所有.o文件列表。如果需要变量“objects”代表所有的.o文件，则需要使用函数wildcard来实现bjects=$(wildcar *.o)。函数wildcard的用法是：$(wildcard PATTERN...)。在Makefile中，它被展开为已经存在的、空格分割的、匹配此模式的所有文件列表。如果不存在符合此模式的文件，那么函数会忽略模式并返回空。

    在编写比较通用的Makefile文件时，如果目标文件比较多时，OBJS不容易书写了。这样就需要考虑一种比较通用的方法来完成自动获取。

举例如下：

（1）我编写的一个小工程，组织如下：

[armlinux@lqm testmake]$ tree
.
|-- Makefile
|-- README
|-- include
| `-- gc.h
`-- src
    |-- copy.c
    |-- getline.c
    `-- main.c
2 directories, 6 files

（2）这里可以使用Makefile的函数patsubst和wildcard来解决。具体方案如下：


[armlinux@lqm testmake]$ cat Makefile
# Common Makefile
#Desc: Practice to manage the project
# Compiler
CC := gcc
# Options
CFLAGS := -Wall -g -O2 -I./include
# Source code path
SRC_PATH := ./src
# Objects
OBJS := $(patsubst %.c, %.o, $(wildcard $(SRC_PATH)/*.c))
# Target
TARGET = test
$(TARGET): $(OBJS)
        $(CC) $(CFLAGS) $^ -o $@
        @echo "compile complete"
.PHONY:clean
clean:
        $(RM) $(OBJS) $(TARGET)
        @echo "OK"
（3）编译结果如下：
[armlinux@lqm testmake]$ make
gcc -Wall -g -O2 -I./include -c -o src/copy.o src/copy.c
gcc -Wall -g -O2 -I./include -c -o src/getline.o src/getline.c
gcc -Wall -g -O2 -I./include -c -o src/main.o src/main.c
gcc -Wall -g -O2 -I./include src/copy.o src/getline.o src/main.o -o test
compile complete
[armlinux@lqm testmake]$ make TARGET=copydata
gcc -Wall -g -O2 -I./include src/copy.o src/getline.o src/main.o -o copydata
compile complete
[armlinux@lqm testmake]$ ls
copydata include Makefile README src test
    如果要生成多种可执行文件，则可以把源文件分类存放在文件夹中，使用同样的语句就可以完成目标文件的获取。这样省去了手写的过程，虽然还是很简单，不太通用，不过比上一个版本要好一些了，继续完善。


本文来自ChinaUnix博客，如果查看原文请点：http://blog.chinaunix.net/u/21948/showart_292182.html