编译

基本概念

默认目标

Makefile当中的第一个目标会成为默认目标;
不指定参数的make命令会执行默认目标;
通常使用all的伪目标作为默认目标.

伪目标

当我们需要执行清理工作、运行测试等操作时, 我们不希望与实际文件名发生冲突, 此时就需要用到 伪目标.

语法

1
2
3

.PHONY: 目标名
目标名:
    命令

使用示例

# 情景：需要清理编译产生的 .o 文件和可执行文件
.PHONY: clean
clean:
    rm -f *.o program

# 情景：需要运行测试
.PHONY: test
test:
    ./run_tests.sh

# 使用方法：
# make clean  # 清理文件
# make test   # 运行测试

其中-f表示强制删除, 其他的参数如-r表示递归删除目录, -rf表示强制递归删除目录.

多重构建

我们还可以利用伪目标使得默认目标具有多个对象:

.PHONY: all debug release clean

# 默认目标包含常用的构建类型
all: debug release

# 调试版本
debug: main.c
    @echo "构建调试版本..."
    gcc -g main.c -o debug-program

# 发布版本
release: main.c
    @echo "构建发布版本..."
    gcc -O2 main.c -o release-program

clean:
    rm -f debug-program release-program

# 使用：
# make          # 构建调试版和发布版
# make debug    # 只构建调试版
# make release  # 只构建发布版
# make clean    # 清理

多目标

e.g:

1 2	bigoutput littleoutput : text.g generate text.g -$(subst output,,$@) > $@

解析

1 2	bigoutput littleoutput : text.g generate text.g -$(subst output,,$@) > $@

bigoutput littleoutput - 两个目标文件
text.g - 依赖文件
$(subst output,,$@) -变量展开：
- $@ 是自动变量，表示当前目标名
- subst 是替换函数，格式为 $(subst from,to,text)
- 此处将目标名中的 “output” 替换为空

当规则执行时：

对于 bigoutput 目标：
- $@ 展开为 bigoutput
- $(subst output,,$@) 结果为 big
- 最终命令变为：generate text.g -big > bigoutput
对于 littleoutput 目标：
- $@ 展开为 littleoutput
- $(subst output,,$@) 结果为 little
- 最终命令变为：generate text.g -little > littleoutput

因此, 上述的多目标规则等价于:

bigoutput : text.g
    generate text.g -big > bigoutput
littleoutput : text.g
    generate text.g -little > littleoutput

规则语法

多目标规则（Multiple Targets）是 Makefile 中的一个重要特性：

基本语法：

1 2	target1 target2 : prerequisites commands

特点：
- 多个目标共享相同的依赖关系
- 命令会对每个目标分别执行一次
- 可以使用 $@ 引用当前正在构建的目标
使用场景：
- 生成相似但略有不同的文件
- 多个目标需要类似的构建过程
- 减少重复代码

示例：

# 生成不同大小的图片
big.jpg small.jpg : original.jpg
    convert original.jpg -resize $* > $@

# 生成不同格式的文档
manual.pdf manual.html : manual.txt
    pandoc manual.txt -o $@

优势：
- 代码更简洁
- 易于维护
- 避免重复规则
- 更好的规则组织
注意事项：
- 命令对每个目标都会执行一次
- 需要合理使用自动变量（如 $@）来区分不同目标
- 确保命令对所有目标都适用

静态模式

好的，让我从这几个角度来介绍 Makefile 中的静态模式规则。

1. 引入背景

在 Makefile 中，当我们需要将多个源文件编译成对应的目标文件时，如果按照普通的规则写法，往往需要为每个文件都写一条规则：

foo.o : foo.c
    $(CC) -c $(CFLAGS) foo.c -o foo.o

bar.o : bar.c
    $(CC) -c $(CFLAGS) bar.c -o bar.o

test.o : test.c
    $(CC) -c $(CFLAGS) test.c -o test.o

这种写法存在明显问题：

规则重复，维护困难
当新增源文件时需要手动添加规则
代码冗长，不够优雅

虽然可以使用多目标规则，但在处理源文件和目标文件的对应关系时仍然不够灵活。这就是引入静态模式规则的原因。

2. 基本语法

静态模式规则的基本语法如下：

1 2	targets ...: target-pattern: prereq-pattern commands

其中：

targets: 要生成的目标文件列表
target-pattern: 目标的模式，通常包含 % 通配符
prereq-pattern: 依赖的模式，通常也包含 % 通配符
commands: 构建命令

% 在 target-pattern 中匹配的内容，会在 prereq-pattern 中作为相同的替换内容。

3. 综合示例

让我们通过几个逐渐复杂的例子来说明静态模式的使用：

基础示例：编译 C 文件

objects = foo.o bar.o test.o

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

复杂示例：多种源文件处理

# 定义源文件和目标文件
cpp_sources := $(wildcard *.cpp)
c_sources := $(wildcard *.c)
cpp_objects := $(cpp_sources:.cpp=.o)
c_objects := $(c_sources:.c=.o)
all_objects := $(cpp_objects) $(c_objects)

# C++ 源文件的编译规则
$(cpp_objects): %.o: %.cpp
    $(CXX) -c $(CXXFLAGS) $< -o $@

# C 源文件的编译规则
$(c_objects): %.o: %.c
    $(CC) -c $(CFLAGS) $< -o $@

# 生成可执行文件
program: $(all_objects)
    $(CXX) $^ -o $@

$(cpp_sources:.cpp=.o)是一种模式替换, 会将cpp_sources中的所有.cpp文件替换为.o文件;
- 即$(varname:pattern1=pattern2) 会将varname中的所有pattern1替换为pattern2;

更复杂的示例：多目录处理

# 目录结构
SRCDIR = src
OBJDIR = obj

# 源文件和目标文件
SOURCES = $(wildcard $(SRCDIR)/*.c)
OBJECTS = $(SOURCES:$(SRCDIR)/%.c=$(OBJDIR)/%.o)

# 确保目标目录存在
$(OBJDIR):
    mkdir -p $@

# 静态模式规则
$(OBJECTS): $(OBJDIR)/%.o: $(SRCDIR)/%.c | $(OBJDIR)
    $(CC) -c $(CFLAGS) $< -o $@

# 最终目标
program: $(OBJECTS)
    $(CC) $^ -o $@

todo

这个复杂示例展现了 Makefile 在处理现代项目时的多个高级特性。在文件组织方面，示例实现了跨目录的文件处理能力，通过将源文件和目标文件分别组织在不同的目录（如 src 和 obj）中，体现了项目结构的清晰性和模块化。Makefile 能够智能地在这些目录间进行文件操作，保持项目的整洁有序。

在目录管理方面，示例引入了自动创建目标目录的机制。通过使用条件依赖（用 | 分隔符标识），确保在编译过程开始前目标目录已经存在。这种方式优雅地解决了目录创建的时序问题，避免了因目录不存在而导致的编译失败。特别是当多个目标文件同时需要某个目录时，条件依赖能够确保目录创建操作只执行一次，提高了构建效率。

在文件名处理方面，示例展示了复杂的文件名转换技巧。通过巧妙运用 Make 的模式替换功能，实现了从源文件到目标文件的路径和扩展名转换。例如，将 src/main.c 转换为 obj/main.o，这种转换不仅处理了文件扩展名的变化，还同时处理了目录路径的变化。这种灵活的文件名处理机制，使得 Makefile 能够适应更复杂的项目结构和构建需求，同时保持了规则的简洁性和可维护性。

基本规则

target ... : prerequisites ...
    recipe
    ...
    ...

target: 目标文件 | 可执行文件 | 标签;
prerequisites: 依赖文件 | target;
recipe: 对应target所需的命令(以Tap缩进开头).

执行recipe命令的条件:

prerequisites中存在文件的日期早于target的日期;
target的文件不存在.

使用变量

# 定义变量: 类似于C的宏定义
objects = main.o display.o

# 使用变量
edit: $(objects)
    cc -o edit $(objects)

必须使用Tab缩进;
采取$(variable)的形式引用变量, 将会展开为变量的值;
cc -o edit 声明采用C语言编译器同时指定输出文件名为edit.

Make的自动推导

自动推导规则

文件关联：
- 当make看到.o文件时，会自动将对应的.c文件加入依赖关系
- 例如：发现whatever.o时，会自动关联whatever.c作为依赖文件
命令推导：
- 自动推导编译命令，如cc -c whatever.c
- 无需在每个.o文件后都手动写编译命令

示例结构

依赖关系：

# 自动推导之前
main.o : main.c defs.h
    cc -c main.c

# 自动推导下的简化书写
main.o : defs.h

清理目标：

1
2
3

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

.PHONY表示clean是伪目标文件;
这种自动推导方式大大简化了Makefile的编写;
clean总是放在文件的末尾.

make命令在默认情况下会在当前目录下依次寻找文件名为GNUmakefile,makefile,Makefile的文件.

推荐使用Makefile作为文件名;
也可以使用-f或者-file参数来指定特定的Makefile文件.

1	make -f Make.Linux

include命令

1 2	# 使用include命令可以将其他Makefile包含进来 include <file-name>

include命令前可以存在空字符, 但是不能为Tab缩进;
include与文件之间可以存在多个空格.

直接指定文件

# 最基本的include用法是直接指定文件名
include config.mk
include ./build/rules.mk

# 同时包含多个文件
include config.mk rules.mk tests.mk

使用通配符 *

# * 匹配任意字符串
include *.mk              # 包含当前目录下所有.mk文件
include src/*.mk         # 包含src目录下的所有.mk文件
include **/build/*.mk    # 包含任意子目录中build目录下的所有.mk文件

我们同样可以在变量中使用通配符 *:

# 使用时展开
objects = *.o

# 定义时展开(除非重新赋值, 否则保持定义时的展开状态)
objects := $(wildcard *.o)

e.g:

1	$(patsubst %.c,%.o,$(wildcard *.c))

patsubst是一个函数, 用于模式替换;
语法为patsubst <pattern>,<replacement>,<text>;
此处表示利用通配符, 将所有的.c文件名称替换为.o文件.

使用单字符通配符

# ? 匹配单个字符
include test?.mk         # 匹配test1.mk, testA.mk等
include rule_?.mk        # 匹配rule_1.mk, rule_2.mk等
include config???.mk     # 匹配config后带三个字符的.mk文件

使用目录路径

# 可以指定不同的目录路径
include ./configs/*.mk    # 当前目录下的configs子目录
include ../shared/*.mk    # 上级目录的shared子目录
include /usr/local/include/make/*.mk  # 绝对路径

使用字符集[]

# [] 用于匹配字符集中的任意一个字符
include make[123].mk     # 匹配make1.mk, make2.mk, make3.mk
include test[a-z].mk     # 匹配testa.mk到testz.mk
include config[0-9].mk   # 匹配config0.mk到config9.mk

错误处理

# 默认情况下，如果include的文件不存在，make会报错

# 使用-include或sinclude可以忽略文件不存在的错误
-include optional.mk     # 如果文件不存在，继续执行不报错
sinclude optional.mk     # 与-include完全相同

# 多个可选文件
-include config/*.mk     # 如果config目录下有任何.mk文件不存在，继续执行

组合使用示例

# 可以组合使用多种模式
include config.mk \
        rules/*.mk \
        test[0-9].mk \
        ./build/**/*.mk

# 使用变量
INCLUDE_DIR = ./includes
include $(INCLUDE_DIR)/*.mk

# 条件包含
ifdef CUSTOM_RULES
    include $(CUSTOM_RULES)
endif

make的工作方式

读取所有的Makefile;
读取include涉及的Makefile文件;
初始化文件当中的变量;
推导隐式规则并分析所有规则;
为目标文件创建依赖关系链;
根据依赖关系, 决定需要重新生成的文件;
执行生成命令.

文件搜寻

VPATH

默认情况下, make会在当前目录和所有子目录下寻找依赖文件和目标文件.
为了能够在较大工程中扩大make的搜索范围, 我们可以通过特殊变量VPATH来指定搜索路径.

1	VPATH = src:../headers

不同的目录之间由:分隔, 上述定义指定了额外的src以及../headers目录;
当前目录的优先级最高, 在当前目录下无法找到相关文件时将会从指定的目录中从左到右继续寻找.

vpath

上述的VPATH指定了全局文件的搜索路径, 而vpath允许为不同类型的文件指定不同的搜索路径.

语法

# 1. 为指定模式的文件设置搜索路径
vpath pattern directory1:directory2

# 2. 清除指定模式的搜索路径
vpath pattern

# 3. 清除所有已设置的 vpath
vpath

特点

可以为不同类型的文件指定不同的搜索路径;
支持使用 % 通配符匹配文件名;
可以有多条 vpath 指令, 且针对相同模式的命令将会起到附加而非覆盖的作用.

e.g.

# 定义编译器
CC = gcc

vpath %.h include
vpath %.c src
vpath %.o build
vpath %.a lib

program: main.o utils.o
    $(CC) -o program main.o utils.o -L. -lmylib

main.o: main.c project.h
    $(CC) -c main.c

utils.o: utils.c utils.h
    $(CC) -c utils.c

vpath的指令必须都写在Makefile当中, 在Make解析Makefile文件时被处理, 例如:

# 如果需要清理 .o 文件的搜索路径并重新设置
clean-paths:
	# 清除 .o 文件的搜索路径
	vpath %.o
	# 设置新的搜索路径
	vpath %.o new/build

# 如果需要完全重置所有搜索路径
reset-paths:
	# 清除所有 vpath 设置
	vpath
	# 重新设置所需的搜索路径
	vpath %.h include
	vpath %.c src
	vpath %.o build

在终端中对应的指令:

1
2
3

$ make              # 使用默认搜索路径编译
$ make clean-paths  # 执行搜索路径清理和重设
$ make reset-paths  # 重置所有搜索路径

优先级: 当前目录 > vpath > VPATH.