makefile

本文最后更新于:2021年12月6日 晚上

前言

这几天的实验让我觉得有必要学习一下makefile
参考博客:博客

会不会写makefile,从一个侧面说明了一个人是否具有完成大型工程的能力

makefile带来的好处是自动化编译

规则

1
2
3
4
target...:prerequisites...
command
...
...

target是一个object file,可以是一个执行文件,也可以是一个标签preerquisites是依赖的文件command是shell命令

prerequisites中如果有一个以上的文件比target文件要新的话,command所定义的命令就会被执行。

看看例子:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o

main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
cc -c kbd.c
command.o : command.c defs.h command.h
cc -c command.c
display.o : display.c defs.h buffer.h
cc -c display.c
insert.o : insert.c defs.h buffer.h
cc -c insert.c
search.o : search.c defs.h buffer.h
cc -c search.c
files.o : files.c defs.h buffer.h command.h
cc -c files.c
utils.o : utils.c defs.h
cc -c utils.c
clean :
rm edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o

其中,\是换行符,便于make阅读,最后的clean只是一个动作名字,清除生成的中间文件。在编写command时,此行一定要以tab开头,空格也不行。

上述make的工作方式

  1. make寻找名为makefile或者Makefile的文件
  2. 寻找第一个目标文件,上述例子edit为最终的目标文件
  3. 如果edit文件不存在,那么make会寻找edit后的.o文件,如果edit依赖的.o文件仍然不存在,那make就寻找目标文件是.o文件的文件。一直套娃下去
  4. 最终生成可执行文件

在找寻的过程中,如果出现错误,比如最后被依赖的文件找不到,那么make就会直接退出,并报错,而对于所定义的命令的错误,或是编译不成功,make根本不理。make只管文件的依赖性,即,如果在我找了依赖关系之后,冒号后面的文件还是不在,那么对不起,我就不工作啦

上述例子中的clean没有被edit直接/间接关联,则make不会自动执行。输入

1
make clean

才可以执行

变量

出于对makefile的易维护性的考虑,引入了变量的概念:

1
2
3
4
objects=main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)

末尾的clean变为:

1
2
clean:
rm edit $(objects)

自动推导

GNU的make可以自动推导文件的依赖关系以及命令,于是上述例子可以变为:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o

edit : $(objects)
cc -o edit $(objects)

main.o : defs.h
kbd.o : defs.h command.h
command.o : defs.h command.h
display.o : defs.h buffer.h
insert.o : defs.h buffer.h
search.o : defs.h buffer.h
files.o : defs.h buffer.h command.h
utils.o : defs.h

.PHONY : clean
clean :
rm edit $(objects)

极大减少了代码量

清空clean

1
2
3
.PHONY: clean
clean:
-rm edit $(objects)

.PHONY是一个伪目标,rm前的-告诉make也许某些文件会出现问题,但不要管,继续clean

makefile的文件系统

如果你不想使用makefile或者Makefile的文件名,可以用make -f file,file是你的文件名。
makefile中包含其他makefile的指令如同c++
一样:

1
-include foo.make a.mk b.mk c.mk e.mk f.mk

减号仍然表示不管怎样报错都继续执行下去,上面的命令可以采用部分正则规则简化:

1
-include foo,make *,mk $(bar)

工作方式

  1. 读入所有的Makefile。
  2. 读入被include的其它Makefile。
  3. 初始化文件中的变量。
  4. 推导隐晦规则,并分析所有规则。
  5. 为所有的目标文件创建依赖关系链。
  6. 根据依赖关系,决定哪些目标要重新生成。
  7. 执行生成命令。

书写规则

make支持三个通配符:

1
*,?,~

make可以在别的文件夹下寻找文件:

1
VPATH=src:../headers

如果make没有在当前文件夹下找到文件,就回去VPATH的路径下寻找文件,另一种方法是使用更为灵活的vpath:

1
2
3
4
5
6
vpath <pattern> <directories>
# 为符合模式的文件指定搜索目录
vpath <pattern>
# 清除符合模式的文件的搜索目录
vpath
# 清除所有已被设置好的文件搜索目录

pattern需要包含%,表示匹配0/若干字符,例如:

1
vpath %.h ../headers

make的伪目标特性可以一次生成多个可执行文件:

1
2
3
4
5
6
7
8
9
10
all : prog1 prog2 prog 3
.PHONY : all
prog1 : prog1.o utils.o
cc -o prog1 prog1.o utils.o

prog2 : prog2.o
cc -o prog2 prog2.o

prog3 : prog3.o sort.o utils.o
cc -o prog3 prog3.o sort.o utils.o

上述代码生成多个目标:prog1~3
makefile的静态模式可以自动寻找target,pattern,如:

1
2
3
4
5
6
objects = foo.o bar.o

all: $(objects)

$(objects): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@

上述例子等价于:

1
2
3
4
foo.o : foo.c
$(CC) -c $(CFLAGS) foo.c -o foo.o
bar.o : bar.c
$(CC) -c $(CFLAGS) bar.c -o bar.o

makefile可以自动生成.c文件对于头文件的依赖性,如:

1
cc -M main.c

等价于:

1
main.o : main.c defs.h

defs.h是main.c中包含的头文件

命令

1
@echo 正在编译xxx模块...

如果echo前没有@,那么会显示echo 正在编译xxx模块,加上@后则不会显示echo
如果你希望上一条命令作用于下一条命令,那么两个命令应该在同一行且用分号分隔:

1
cd /home/file;pwd

嵌套执行maek,可以这么做:

1
2
subsystem:
cd subdir && $(MAKE)

即执行subdir子目录下的makefile文件,上级的makefile变量可以传到下一级:

1
export <var>;

传递所有变量的话只需一个export,不需要任何变量名称

变量

变量可以使用变量:

1
2
3
4
5
foo=$(bar)
bar=$(ugh)
ugh=dsa
all:
echo $(foo)

显示为echo dsa
需要注意的是,如果有变量这样定义:

1
dir := /foo/bar    # directory to put the frobs in

那么dir的值是/foo/bar ,后面多了四个空格

1
foo ?= bar

如果foo先前没有被定义,那么foo等于bar,如果foo之前有过定义,那么这条语句什么也不做。

变量值的替换

1
2
foo :=a.o b.o c.o
bar :=$(foo:.o=.c)

第二行把foo中的.o全部换为.c
追加变量值:

1
2
objects = main.o foo.o bar.o utils.o
objects += another.o

条件

1
2
3
4
5
6
7
8
9
libs_for_gcc = -lgnu
normal_libs =

foo: $(objects)
ifeq ($(CC),gcc)
$(CC) -o foo $(objects) $(libs_for_gcc)
else
$(CC) -o foo $(objects) $(normal_libs)
endif

上述例子判断$(cc)是否是gcc

函数

subst

字符串替换,

1
$(subst ee,EE,feet on the street)

把feet on the street中的ee换成EE

patsubst

功能和subst一样,不过匹配的是模式,

1
$(patsubst %.c,%.o,x.c.c bar.c)

把字串 x.c.c bar.c 符合模式 %.c 的单词替换成 %.o ,返回结果是 x.c.o bar.o

strip

去掉开头和结尾的空格

1
$(strip a b c )

findstring

查找字符串

1
$(findstring a,a b c)

返回a,如果没有,则返回空

filter

过滤,返回符合模式pattern的字符串

1
2
3
sources := foo.c bar.c baz.s ugh.h
foo: $(sources)
cc $(filter %.c %.s,$(sources)) -o foo

filter-out

反过滤函数

sort

排序

word

取字符串的第n个单词,如 $(word 2, foo bar baz) 返回值是 bar 。

firstowrd

返回字符串的第一个单词

文件名操作函数暂略


本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!