[转]Makefile使用总结

Makefile 是和 make 命令一起配合使用的.

很多大型项目的编译都是通过 Makefile 来组织的, 如果没有 Makefile, 那很多项目中各种库和代码之间的依赖关系不知会多复杂.

Makefile的组织流程的能力如此之强, 不仅可以用来编译项目, 还可以用来组织我们平时的一些日常操作. 这个需要大家发挥自己的想象力.

1.1 Makefile 主要的 5个部分 (显示规则, 隐晦规则, 变量定义, 文件指示, 注释)

Makefile基本格式如下:

target: prerequisitescommand......

其中&＃xff1a;

• target           :: 目标文件, 可以是 Object File, 也可以是可执行文件

• prerequisites :: 生成 target 所需要的文件或者目标

• command     :: make需要执行的命令 (任意的shell命令), Makefile中的命令必须以 Tab [\t] 开头

1. 显示规则 :: 说明如何生成一个或多个目标文件(包括 生成的文件, 文件的依赖文件, 生成的命令)

2. 隐晦规则 :: make的自动推导功能所执行的规则

3. 变量定义 :: Makefile中定义的变量

4. 文件指示 :: Makefile中引用其他Makefile; 指定Makefile中有效部分; 定义一个多行命令

5. 注释       :: Makefile只有行注释 "#", 如果要使用或者输出"#"字符, 需要进行转义 "\#"

1.2 GNU make 的工作方式

1. 读入主Makefile (主Makefile中可以引用其他Makefile)

2. 读入被include的其他Makefile

3. 初始化文件中的变量

4. 推导隐晦规则, 并分析所有规则

5. 为所有的目标文件创建依赖关系链

6. 根据依赖关系, 决定哪些目标要重新生成

7. 执行生成命令

2. Makefile 初级语法

2.1 Makefile 规则

注&＃xff1a; 语句太长的, 可以用 "\" 作为换行符

2.1.1 规则语法

规则主要有2部分: 依赖关系 和 生成目标的方法.

语法有以下2种:

target: prerequisitescommand...

或者

target: prerequisites; commandcommand...

2.1.2 规则中的通配符

• *     :: 表示任意一个或多个字符

• ?     :: 表示任意一个字符

• [...]  :: 表示列表中的一个。比如&＃xff0c;[abcd] 表示a,b,c,d中任意一个字符, [^abcd]表示除a,b,c,d以外的字符, [0-9]表示 0~9中任意一个数字

• ~    :: 表示用户的home目录

2.1.3 路径搜索

当一个Makefile中涉及到大量源文件时(这些源文件和Makefile极有可能不在同一个目录中),

这时, 最好将源文件的路径明确在Makefile中, 便于编译时查找. Makefile中有个特殊的变量 VPATH 就是完成这个功能的.

指定了 VPATH 之后, 如果当前目录中没有找到相应文件或依赖的文件, Makefile 回到 VPATH 指定的路径中再去查找..

VPATH 使用方法:

• vpath                   :: 当前目录中找不到文件时, 就从中搜索

• vpath   :: 符合格式的文件, 就从中搜索

• vpath                         :: 清除符合格式的文件搜索路径

• vpath                                           :: 清除所有已经设置好的文件路径

# 示例1 - 当前目录中找不到文件时, 按顺序从 src目录 ../parent-dir目录中查找文件
VPATH src:../parent-dir# 示例2 - .h结尾的文件都从 ./header 目录中查找
VPATH %.h ./header# 示例3 - 清除示例2中设置的规则
VPATH %.h# 示例4 - 清除所有VPATH的设置
VPATH

2.2 Makefile 中的变量

2.2.1 变量定义 ( &＃61; or :&＃61; )

OBJS &＃61; programA.o programB.o
OBJS-ADD &＃61; $(OBJS) programC.o
# 或者
OBJS :&＃61; programA.o programB.o
OBJS-ADD :&＃61; $(OBJS) programC.o

其中 &＃61; 和 :&＃61; 的区别在于&＃xff1a; :&＃61; 只能使用前面定义好的变量, &＃61; 可以使用后面定义的变量

测试 &＃61;

# Makefile内容
OBJS2 &＃61; $(OBJS1) programC.o
OBJS1 &＃61; programA.o programB.oall:&＃64;echo $(OBJS2)# bash中执行 make, 可以看出虽然 OBJS1 是在 OBJS2 之后定义的, 但在 OBJS2中可以提前使用
$ makeprogramA.o programB.o programC.o

测试 :&＃61;

# Makefile内容
OBJS2 :&＃61; $(OBJS1) programC.o
OBJS1 :&＃61; programA.o programB.oall:&＃64;echo $(OBJS2)# bash中执行 make, 可以看出 OBJS2 中的 $(OBJS1) 为空
$ makeprogramC.o

2.2.2 变量替换

# Makefile内容
SRCS :&＃61; programA.c programB.c programC.c
OBJS :&＃61; $(SRCS:%.c&＃61;%.o)all:&＃64;echo "SRCS: " $(SRCS)&＃64;echo "OBJS: " $(OBJS)# bash中运行make
$ makeSRCS:  programA.c programB.c programC.c
OBJS:  programA.o programB.o programC.o

2.2.3 变量追加值 &＃43;&＃61;

# Makefile内容
SRCS :&＃61; programA.c programB.c programC.c
SRCS &＃43;&＃61; programD.call:&＃64;echo "SRCS: " $(SRCS)# bash中运行make
$ makeSRCS:  programA.c programB.c programC.c programD.c

2.2.4 变量覆盖 override

作用是使 Makefile中定义的变量能够覆盖 make 命令参数中指定的变量

语法:

• override &＃61;

• override :&＃61;

• override &＃43;&＃61;

下面通过一个例子体会 override 的作用&＃xff1a;

# Makefile内容 (没有用override)
SRCS :&＃61; programA.c programB.c programC.call:&＃64;echo "SRCS: " $(SRCS)# bash中运行make
$ make SRCS&＃61;nothing
SRCS:  nothing################################################## Makefile内容 (用override)
override SRCS :&＃61; programA.c programB.c programC.call:&＃64;echo "SRCS: " $(SRCS)# bash中运行make
$ make SRCS&＃61;nothing
SRCS:  programA.c programB.c programC.c

2.2.5 目标变量

作用是使变量的作用域仅限于这个目标(target), 而不像之前例子中定义的变量, 对整个Makefile都有效.

语法:

• ::

• :: override (override作用参见 变量覆盖的介绍)

 示例:

# Makefile 内容
SRCS :&＃61; programA.c programB.c programC.ctarget1: TARGET1-SRCS :&＃61; programD.c
target1:&＃64;echo "SRCS: " $(SRCS)&＃64;echo "SRCS: " $(TARGET1-SRCS)target2:&＃64;echo "SRCS: " $(SRCS)&＃64;echo "SRCS: " $(TARGET1-SRCS)# bash中执行make
$ make target1
SRCS:  programA.c programB.c programC.c
SRCS:  programD.c$ make target2     <-- target2中显示不了 $(TARGET1-SRCS)
SRCS:  programA.c programB.c programC.c
SRCS:

2.3 Makefile 命令前缀

Makefile 中书写shell命令时可以加2种前缀 &＃64; 和 -, 或者不用前缀.

3种格式的shell命令区别如下:

• 不用前缀 :: 输出执行的命令以及命令执行的结果, 出错的话停止执行

• 前缀 &＃64;   :: 只输出命令执行的结果, 出错的话停止执行

• 前缀 -     :: 命令执行有错的话, 忽略错误, 继续执行

 示例:

# Makefile 内容 (不用前缀)
all:    echo "没有前缀"cat this_file_not_exist    echo "错误之后的命令"       <-- 这条命令不会被执行# bash中执行 make$ makeecho "没有前缀"             <-- 命令本身显示出来
没有前缀                    <-- 命令执行结果显示出来cat this_file_not_existcat: this_file_not_exist: No such file or directorymake: *** [all] Error 1############################################################ Makefile 内容 (前缀 &＃64;)
all:&＃64;echo "没有前缀"&＃64;cat this_file_not_exist&＃64;echo "错误之后的命令"       <-- 这条命令不会被执行# bash中执行 make$ make没有前缀                         <-- 只有命令执行的结果, 不显示命令本身cat: this_file_not_exist: No such file or directorymake: *** [all] Error 1############################################################ Makefile 内容 (前缀 -)
all:    -echo "没有前缀"-cat this_file_not_exist    -echo "错误之后的命令"       <-- 这条命令会被执行# bash中执行 make$ makeecho "没有前缀"             <-- 命令本身显示出来
没有前缀                    <-- 命令执行结果显示出来cat this_file_not_existcat: this_file_not_exist: No such file or directorymake: [all] Error 1 (ignored)echo "错误之后的命令"       <-- 出错之后的命令也会显示
错误之后的命令              <-- 出错之后的命令也会执行

2.4 伪目标

伪目标并不是一个"目标(target)", 不像真正的目标那样会生成一个目标文件.

典型的伪目标是 Makefile 中用来清理编译过程中中间文件的 clean 伪目标, 一般格式如下:

.PHONY: clean   <-- 这句没有也行, 但是最好加上
clean:    -rm -f *.o

2.5 引用其他的 Makefile

语法: include   (filename 可以包含通配符和路径)

示例:

# Makefile 内容
all:&＃64;echo "主 Makefile begin"&＃64;make other-all&＃64;echo "主 Makefile end"include ./other/Makefile# ./other/Makefile 内容
other-all:&＃64;echo "other makefile begin"&＃64;echo "other makefile end"# bash中执行 make$ ll
total 20K-rw-r--r-- 1 wangyubin wangyubin  125 Sep 23 16:13 Makefile-rw-r--r-- 1 wangyubin wangyubin  11K Sep 23 16:15 makefile.org   <-- 这个文件不用管
drwxr-xr-x 2 wangyubin wangyubin 4.0K Sep 23 16:11 other
$ ll other/total 4.0K-rw-r--r-- 1 wangyubin wangyubin 71 Sep 23 16:11 Makefile$ make主 Makefile beginmake[1]: Entering directory &＃96;/path/to/test/makefile&＃39;other makefile begin
other makefile endmake[1]: Leaving directory &＃96;/path/to/test/makefile&＃39;主 Makefile end

2.6 查看C文件的依赖关系

写 Makefile 的时候, 需要确定每个目标的依赖关系.

GNU提供一个机制可以查看C代码文件依赖那些文件, 这样我们在写 Makefile 目标的时候就不用打开C源码来看其依赖那些文件了.

比如, 下面命令显示内核源码中 virt/kvm/kvm_main.c 中的依赖关系

$ cd virt/kvm/$ gcc -MM kvm_main.c 
kvm_main.o: kvm_main.c iodev.h coalesced_mmio.h async_pf.h   <-- 这句就可以加到 Makefile 中作为编译 kvm_main.o 的依赖关系

2.7 make 退出码

Makefile的退出码有以下3种&＃xff1a;

• 0 :: 表示成功执行

• 1 :: 表示make命令出现了错误

• 2 :: 使用了 "-q" 选项, 并且make使得一些目标不需要更新

2.8 指定 Makefile&＃xff0c; 指定特定目标

默认执行 make 命令时, GNU make在当前目录下依次搜索下面3个文件 "GNUmakefile", "makefile", "Makefile",

找到对应文件之后, 就开始执行此文件中的第一个目标(target). 如果找不到这3个文件就报错.

 非默认情况下, 可以在 make 命令中指定特定的 Makefile 和特定的 目标.

示例&＃xff1a;

# Makefile文件名改为 MyMake, 内容
target1:&＃64;echo "target [1]  begin"&＃64;echo "target [1]  end"target2:&＃64;echo "target [2]  begin"&＃64;echo "target [2]  end"# bash 中执行 make$ lsMakefile
$ mv Makefile MyMake
$ lsMyMake
$ make                     <-- 找不到默认的 Makefilemake: *** No targets specified and no makefile found.  Stop.
$ make -f MyMake           <-- 指定特定的Makefile
target [1]  begin
target [1]  end
$ make -f MyMake target2   <-- 指定特定的目标(target)
target [2]  begin
target [2]  end

2.9 make 参数介绍

make 的参数有很多, 可以通过 make -h 去查看, 下面只介绍几个我认为比较有用的.

2.10 Makefile 隐含规则

这里只列一个和编译C相关的.

编译C时&＃xff0c;.o 的目标会自动推导为 .c

# Makefile 中
main : main.o    gcc -o main main.o#会自动变为:
main : main.o    gcc -o main main.omain.o: main.c    <-- main.o 这个目标是隐含生成的    gcc -c main.c

2.11 隐含规则中的 命令变量 和 命令参数变量

2.11.1 命令变量, 书写Makefile可以直接写 shell时用这些变量.

下面只列出一些C相关的

示例:

# Makefile 内容
all:&＃64;echo $(RM)&＃64;echo $(AR)&＃64;echo $(CC)&＃64;echo $(CXX)# bash 中执行make, 显示各个变量的值
$ makerm -farccg&＃43;&＃43;

2.11.2 命令参数变量

 示例: 下面以 CFLAGS 为例演示

# test.c 内容
#include int main(int argc, char *argv[])
{printf ("Hello Makefile\n");return 0;
}# Makefile 内容
test: test.o$(CC) -o test test.o# bash 中用 make 来测试
$ ll
total 24K-rw-r--r-- 1 wangyubin wangyubin  69 Sep 23 17:31 Makefile-rw-r--r-- 1 wangyubin wangyubin 14K Sep 23 19:51 makefile.org   <-- 请忽略这个文件-rw-r--r-- 1 wangyubin wangyubin 392 Sep 23 17:31 test.c$ makecc    -c -o test.o test.ccc -o test test.o               <-- 这个是自动推导的$ rm -f test test.o$ make CFLAGS&＃61;-Wall             <-- 命令中加的编译器参数自动追加入下面的编译中了cc -Wall   -c -o test.o test.ccc -o test test.o

2.12 自动变量

Makefile 中很多时候通过自动变量来简化书写, 各个自动变量的含义如下:

3. Makefile 高级语法

3.1 嵌套Makefile

在 Makefile 初级语法中已经提到过引用其它 Makefile的方法. 这里有另一种写法, 并且可以向引用的其它 Makefile 传递参数.

示例: (不传递参数, 只是调用子文件夹 other 中的Makefile)

# Makefile 内容
all:&＃64;echo "主 Makefile begin"&＃64;cd ./other && make&＃64;echo "主 Makefile end"# ./other/Makefile 内容
other-all:&＃64;echo "other makefile begin"&＃64;echo "other makefile end"# bash中执行 make$ ll
total 28K-rw-r--r-- 1 wangyubin wangyubin  104 Sep 23 20:43 Makefile-rw-r--r-- 1 wangyubin wangyubin  17K Sep 23 20:44 makefile.org   <-- 这个文件不用管
drwxr-xr-x 2 wangyubin wangyubin 4.0K Sep 23 20:42 other
$ ll other/total 4.0K-rw-r--r-- 1 wangyubin wangyubin 71 Sep 23 16:11 Makefile$ make主 Makefile beginmake[1]: Entering directory &＃96;/path/to/test/makefile/other&＃39;other makefile begin
other makefile endmake[1]: Leaving directory &＃96;/path/to/test/makefile/other&＃39;主 Makefile end

 示例: (用export传递参数)

# Makefile 内容
export VALUE1 :&＃61; export.c    <-- 用了 export, 此变量能够传递到 ./other/Makefile 中
VALUE2 :&＃61; no-export.c        <-- 此变量不能传递到 ./other/Makefile 中all:&＃64;echo "主 Makefile begin"&＃64;cd ./other && make&＃64;echo "主 Makefile end"# ./other/Makefile 内容
other-all:&＃64;echo "other makefile begin"&＃64;echo "VALUE1: " $(VALUE1)&＃64;echo "VALUE2: " $(VALUE2)&＃64;echo "other makefile end"# bash中执行 make$ make主 Makefile beginmake[1]: Entering directory &＃96;/path/to/test/makefile/other&＃39;other makefile begin
VALUE1:  export.c        <-- VALUE1 传递成功
VALUE2:                  <-- VALUE2 传递失败
other makefile endmake[1]: Leaving directory &＃96;/path/to/test/makefile/other&＃39;主 Makefile end

*补充* export 语法格式如下:

• export variable &＃61; value

• export variable :&＃61; value

• export variable &＃43;&＃61; value

3.2 定义命令包

命令包有点像是个函数, 将连续的相同的命令合成一条, 减少 Makefile 中的代码量, 便于以后维护.

语法:

define command
...
endef

 示例:

# Makefile 内容
define run-hello-makefile
&＃64;echo -n "Hello"&＃64;echo " Makefile!"&＃64;echo "这里可以执行多条 Shell 命令!"endefall:$(run-hello-makefile)# bash 中运行make
$ makeHello Makefile!这里可以执行多条 Shell 命令!

3.3 条件判断

条件判断的关键字主要有 ifeq ifneq ifdef ifndef

语法:


endif# 或者
elseendif

 示例: ifeq的例子, ifneq和ifeq的使用方法类似, 就是取反

# Makefile 内容
all:
ifeq ("aa", "bb")&＃64;echo "equal"else&＃64;echo "not equal"endif# bash 中执行 make$ makenot equal

 示例: ifdef的例子, ifndef和ifdef的使用方法类似, 就是取反

# Makefile 内容
SRCS :&＃61; program.call:
ifdef SRCS&＃64;echo $(SRCS)else&＃64;echo "no SRCS"endif# bash 中执行 make$ makeprogram.c

3.4 Makefile 中的函数

Makefile 中自带了一些函数, 利用这些函数可以简化 Makefile 的编写.

函数调用语法如下:

$( )
# 或者
${ }

• 是函数名

• 是函数参数

3.4.1 字符串函数

字符串替换函数: $(subst ,,)

功能: 把字符串 中的 替换为

返回: 替换过的字符串

# Makefile 内容
all:&＃64;echo $(subst t,e,maktfilt)  <-- 将t替换为e# bash 中执行 make$ makemakefile

模式字符串替换函数: $(patsubst ,,)

功能: 查找中的单词(单词以"空格", "tab", "换行"来分割) 是否符合 , 符合的话, 用 替代.

返回: 替换过的字符串

# Makefile 内容
all:&＃64;echo $(patsubst %.c,%.o,programA.c programB.c)# bash 中执行 make$ makeprogramA.o programB.o

去空格函数: $(strip )

功能: 去掉 字符串中开头和结尾的空字符

返回: 被去掉空格的字符串值

# Makefile 内容
VAL :&＃61; "       aa  bb  cc "all:&＃64;echo "去除空格前: " $(VAL)&＃64;echo "去除空格后: " $(strip $(VAL))# bash 中执行 make$ make去除空格前:         aa  bb  cc 去除空格后:   aa bb cc

查找字符串函数: $(findstring ,)

功能: 在字符串 中查找 字符串

返回: 如果找到, 返回 字符串,  否则返回空字符串

# Makefile 内容
VAL :&＃61; "       aa  bb  cc "all:&＃64;echo $(findstring aa,$(VAL))&＃64;echo $(findstring ab,$(VAL))# bash 中执行 make$ makeaa

过滤函数: $(filter ,)

功能: 以 模式过滤字符串 , *保留* 符合模式 的单词, 可以有多个模式

返回: 符合模式 的字符串

# Makefile 内容
all:&＃64;echo $(filter %.o %.a,program.c program.o program.a)# bash 中执行 make$ makeprogram.o program.a

反过滤函数: $(filter-out ,)

功能: 以 模式过滤字符串 , *去除* 符合模式 的单词, 可以有多个模式

返回: 不符合模式 的字符串

# Makefile 内容
all:&＃64;echo $(filter-out %.o %.a,program.c program.o program.a)# bash 中执行 make$ makeprogram.c

排序函数: $(sort )

功能: 给字符串 中的单词排序 (升序)

返回: 排序后的字符串

# Makefile 内容
all:&＃64;echo $(sort bac abc acb cab)# bash 中执行 make$ makeabc acb bac cab

取单词函数: $(word ,)

功能: 取字符串 中的 第个单词 (n从1开始)

返回: 中的第个单词, 如果 比 中单词个数要大, 则返回空字符串

# Makefile 内容
all:&＃64;echo $(word 1,aa bb cc dd)&＃64;echo $(word 5,aa bb cc dd)&＃64;echo $(word 4,aa bb cc dd)# bash 中执行 make$ makeaadd

取单词串函数: $(wordlist ,,)