Make 学习笔记

GNU Make

参考：Make 命令教程 | 阮一峰的网络日志

make 命令

make -n             # 非执行模式，只输出要执行的命令
make -C <dir>       # 在读取 Makefile 之前切换到指定的目录
make -f <makefile>  # 指定 Makefile

make -j$(nproc)     # 多线程编程
make -j1 V=s        # 单线程，输出编译过程信息。常用于 debug

Makefile

Makefile 格式

Makefile 文件由一系列规则（rules）构成。每条规则的形式如下。

<target>: [prerequisites]
	[commands]

上面第一行冒号前面的部分，叫做目标（target），冒号后面的部分叫做前置条件（prerequisites）；第二行必须由一个 tab 键起首，后面跟着命令（commands）。

目标是必需的，不可省略；前置条件和命令都是可选的，但是两者之中必须至少存在一个。

每条规则就明确两件事：构建目标的前置条件是什么，以及如何构建。

目标

一个目标（target）就构成一条规则。目标通常是文件名，指明 make 命令所要构建的对象。目标可以是一个文件名，也可以是多个文件名，之间用空格分隔。

c: a b           # 构建 c 需要 a 和 b 两个文件
	cat a b > c  # 用 cat 命令将 a 和 b 合并为 c

除了文件名，目标还可以是某个操作的名字，这称为伪目标（phony target）。

clean:
	rm *.o

上面代码的目标是 clean，它不是文件名，而是一个操作的名字，属于伪目标，作用是删除对象文件。

make clean

但是，如果当前目录中，正好有一个文件叫做 clean，那么这个命令不会执行。因为 make 发现 clean 文件已经存在，就认为没有必要重新构建了，就不会执行指定的 rm 命令。

为了避免这种情况，可以明确声明 clean 是伪目标（phony target），写法如下。

clean:
	rm *.o temp
.PHONY: clean

声明 clean 是伪目标之后，make 就不会去检查是否存在一个叫做 clean 的文件，而是每次运行都执行对应的命令。像 .PHONY 这样的内置目标名还有不少，可以查看 GNU Make 手册。

如果 make 命令运行时没有指定目标，默认会执行 Makefile 文件的第一个目标。

make  # 执行 Makefile 文件的第一个目标

常见伪目标：

  • all：构建整个项目。一般是默认目标。
  • install：安装构建产物。一般在 make all 之后执行。
  • clean：清除构建产物。
  • distclean：清除构建产物和中间产物。

前置条件

前置条件通常是一组文件名，之间用空格分隔。它指定了目标是否重新构建的判断标准：只要有一个前置文件不存在，或者有过更新（前置文件的 last-modification 时间戳比目标的时间戳新），目标就需要重新构建。

result: source
	cp source result

上面代码中，构建 result 的前置条件是 source 。如果当前目录中，source 已经存在，那么 make result 可以正常运行，否则必须再写一条规则，来生成 source 。

source:
	echo "this is the source" > source

上面代码中，source 后面没有前置条件，就意味着它跟其他文件都无关，只要这个文件还不存在，每次调用 make source，它都会生成。

make result
make result

上面连续执行两次 make result 命令。第一次执行会先新建 source，然后再新建 result。第二次执行，make 发现 source 没有变动（时间戳早于 result），就不会执行任何操作，result 也不会重新生成。

如果需要生成多个文件，往往采用下面的写法。

source: file1 file2 file3

上面代码中，source 是一个伪目标，只有三个前置文件，没有任何对应的命令。

make source

执行 make source 命令后，就会一次性生成 file1，file2，file3 三个文件。这比下面的写法要方便很多。

make file1
make file2
make file3

命令

命令（commands）表示如何更新目标文件，由一行或多行的 shell 命令组成。它是构建目标的具体指令，它的运行结果通常就是生成目标文件。

每行命令之前必须有一个 tab。

需要注意的是，每行命令在一个单独的 shell 中执行。这些 shell 之间没有继承关系。

var-lost:
	export foo=bar
	echo "foo=[$$foo]"

调用 shell 变量需要两个美元符号

make var-lost

上面代码执行后，取不到 foo 的值。因为两行命令在两个不同的进程执行。一个解决办法是将两行命令写在一行，中间用分号分隔。

var-kept:
	export foo=bar; echo "foo=[$$foo]"

另一个解决办法是在换行符前加反斜杠转义。

var-kept:
	export foo=bar; \
	echo "foo=[$$foo]"

最后一个方法是加上 .ONESHELL: 命令。

.ONESHELL:
var-kept:
	export foo=bar;
	echo "foo=[$$foo]"

注释

井号 # 在 Makefile 中表示注释。

# 这是注释
result.txt: source.txt
	# 这是注释
	cp source.txt result.txt  # 这也是注释

回声

正常情况下，make 会打印每条命令，然后再执行，这就叫做回声（echoing）。

test:
	# 这是测试

执行上面的规则，会得到下面的结果。

$ make test
# 这是测试

在命令的前面加上 @，就可以关闭回声。

test:
	@# 这是测试

现在再执行 make test，就不会有任何输出。

由于在构建过程中，需要了解当前在执行哪条命令，所以通常只在注释和纯显示的 echo 命令前面加上 @。

test:
	@# 这是测试
	@echo TODO

通配符

通配符（wildcard）用来指定一组符合条件的文件名。Makefile 的通配符与 bash 一致，主要有星号 *、问号 ? 和 [ ]。比如，*.o 表示所有后缀名为 .o 的文件。

clean:
	rm -f *.o

模式规则

make 命令允许对文件名进行类似正则运算的匹配，主要用到的匹配符是 %（匹配任意字符串）。比如，假定当前目录下有 f1.c 和 f2.c 两个源码文件，需要将它们编译为对应的对象文件。

%.o: %.c

等同于下面的写法。

f1.o: f1.c
f2.o: f2.c

使用匹配符 %，可以将大量同类型的文件，只用一条规则就完成构建。

模式替换

语法：

$(VAR:pattern=replacement)  # 将 VAR 中的 pattern 替换为 replacement

  • 将 SRC 中的 .c 替换为 .o：

    SRC = main.c utils.c lib.c
OBJ = $(SRC:.c=.o)

  • 将 SRC 中的 src/xxx.c 替换为 include/xxx.h：

    SRC = src/main.c src/utils.c src/lib.c
HEADER = $(SRC:src/%.c=include/%.h)

后缀规则

后缀规则用于定义如何从一种文件类型转换成另一种文件类型。

后缀规则通过一个点（.）后接一系列字符的形式来标识文件类型。如：

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

在这里，.c.o: 定义了从 .c 文件生成 .o 文件的规则。

值得注意的是，在新版的 make 中，后缀规则被视为过时的，推荐使用更灵活强大的模式规则。

变量和赋值符

Makefile 允许使用等号自定义变量。

txt = Hello World
test:
	@echo $(txt)

上面代码中，变量 txt 等于 Hello World。调用时，变量需要放在 $( ) 之中。

如果要调用 shell 变量，需要在美元符号前，再加一个美元符号（$$），这是因为 make 命令会对美元符号转义。

test:
	@echo $$HOME

有时，变量的值可能指向另一个变量。

v1 = $(v2)

上面代码中，变量 v1 的值是另一个变量 v2。这时会产生一个问题，v1 的值到底在定义时扩展（静态扩展），还是在运行时扩展（动态扩展）？如果 v2 的值是动态的，这两种扩展方式的结果可能会差异很大。

为了解决类似问题，Makefile 一共提供了四个赋值运算符（=、:=、?=、+=）：

# 在执行时扩展，允许递归扩展
VARIABLE = value

# 在定义时扩展
VARIABLE := value

# 只有在该变量为空时才设置值
VARIABLE ?= value

# 将值追加到变量的尾端
VARIABLE += value

更加具体的区别请参阅 What is the difference between the GNU Makefile variable assignments =, ?=, := and +=? | StackOverflow

内置变量

make 命令提供一系列内置变量，比如，$(CC) 指向当前使用的编译器（如 GCC），$(MAKE) 指向当前使用的 make 工具。这主要是为了跨平台的兼容性，详细的内置变量清单见 GNU Make 手册。

output:
	$(CC) -o output input.c

自动变量

make 命令还提供一些自动变量（automatic variables），它们的值与当前规则有关。

  • $@：指代当前目标。比如，规则为 a b: c，那么 $@ 就指代 a b。

  • $<：指代第一个前置条件。比如，规则为 a: b c，那么 $< 就指代 b。

  • $(@D) 和 $(@F)：分别指代 $@ 的目录名和文件名。比如，$@ 是 src/input.c，那么 $(@D) 的值为 src，$(@F) 的值为 input.c。

  • $(<D) 和 $(<F)：分别指代 $< 的目录名和文件名。

  • $?：指代比目标更新的所有前置条件，以空格分隔。比如，规则为 t: p1 p2，其中 p2 的时间戳比 t 新，$?就指代 p2。

  • $^：指代所有前置条件，之间以空格分隔。比如，规则为 t: p1 p2，那么 $^ 就指代 p1 p2 。

  • $*：指代匹配符 % 匹配的部分， 比如 % 匹配 f1.txt 中的 f1，$* 就表示 f1。

所有的自动变量清单，请看 GNU Make 手册。下面是自动变量的一个例子。

dest/%.txt: src/%.txt
	@[ -d dest ] || mkdir dest
	cp $< $@

上面代码将 src 目录下的 txt 文件，拷贝到 dest 目录下。

判断和循环

条件判断

Makefile 使用 bash 语法，完成判断和循环。

ifeq ($(CC),gcc)
  libs=$(libs_for_gcc)
else
  libs=$(normal_libs)
endif

上面代码判断当前编译器是否为 gcc ，然后指定不同的库文件。

循环

LIST = one two three
all:
	for i in $(LIST); do \
		echo $$i; \
	done

# 等同于
all:
	for i in one two three; do \
		echo $i; \
	done

上面代码的运行结果：

one
two
three

函数

Makefile 还可以使用函数，格式如下。

$(function arguments)
# 或者
${function arguments}

Makefile 提供了许多内置函数可供调用，下面是几个常用的内置函数。

  • shell 函数

    shell 函数用来执行 shell 命令

    srcfiles := $(shell echo src/{00..99}.txt)

  • info 和 error

    info 和 error 函数用来将括号内的内容打印到终端

    $(info hello, make!)
$(error something went wrong!)

  • wildcard 函数

    wildcard 函数用来在 Makefile 中替换 bash 的通配符。

    srcfiles := $(wildcard src/*.txt)

  • subst 函数

    subst 函数用来文本替换，格式如下。

    $(subst from,to,text)

    下面的例子将字符串 feet on the street 替换成 fEEt on the strEEt。

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

    下面是一个稍微复杂的例子。

    comma := ,
empty :=
# space 变量用两个空变量作为标识符，当中是一个空格
space := $(empty) $(empty)
foo := a b c
bar := $(subst $(space),$(comma),$(foo))
# bar is now 'a,b,c'.

  • patsubst 函数

    patsubst 函数用于模式匹配的替换，格式如下。

    $(patsubst pattern,replacement,text)

    下面的例子将文件名 x.c.c bar.c，替换成 x.c.o bar.o。

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

  • 替换后缀名

    替换后缀名函数的写法是：变量名:后缀名替换规则。它实际上是 patsubst 函数的一种简写形式。

    min: $(OUTPUT:.js=.min.js)

    上面代码的意思是，将变量 OUTPUT 中的后缀名 .js 全部替换成 .min.js。

Makefile 实例

  • 执行多个目标

    .PHONY: cleanall cleanobj cleandiff

cleanall: cleanobj cleandiff
	rm program

cleanobj:
	rm *.o

cleandiff:
	rm *.diff

    上面代码可以调用不同目标，删除不同后缀名的文件，也可以调用一个目标（cleanall），删除所有指定类型的文件。

  • 编译 C 语言项目

    .PHONY: edit clean

edit: main.o kbd.o command.o display.o
	cc -o edit main.o kbd.o command.o display.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
	cc -c display.c

clean:
	rm edit main.o kbd.o command.o display.o

  • 版本检查

    NVCC_VERSION := $(shell nvcc --version | grep 11.8)
ifeq ($(NVCC_VERSION),)
	$(error "CUDA 11.8 is required")
endif

参见：如何用 Make 来构建 Node.js 项目 | 阮一峰的网络日志

posted @ 2024-06-06 02:18  Undefined443  阅读(39)  评论(0)    收藏  举报