make-note
Makefile
在Linux环境下,常常使用
make程序自动化变异大型源码。
项目提供一个Makefile文件,make以此为基础进行程序的编译和链接。make并不限定为构建C/C++项目服务,还可以用于任何文件的组织与处理,但主要用于Unix/Linux环境的自动化开发。
GNU make
Makefile简单模板
1 | CC = gcc |
Makefile基础
在Linux环境下,输入make命令,程序在当前目录下查找一个名为Makefile的文件,然后,根据该文件定的规则,自动化的执行任意命令。
规则
Makefile文件由若干条规则(Rule)构成,每一条规则指出一个目标文件(Target),若干依赖文件(prerequisites),以及生成目标文件的命令。
规则如下:
1 | # 目标文件: 依赖文件1 依赖文件2 ... |
以上规则使用cat命令将文件a.txt b.txt合并写入m.txt
!注意:在Makefile的规则中,命令必须以Tab开头,不能是空格
Makefile定义了一系列规则,每个规则在满足依赖文件的前提下执行命令,就能创建一个目标文件。
make使用依赖文件的创建和修改时间来判断是否应该更新一个目标文件。
对于像以下情况依赖的Makefile编写
1 | x.txt: m.txt c.txt |
我们可以发现,在产生m.txt文件时依赖了m.txt c.txt两个文件,但是m.txt的生成依赖a.txt b.txt两个文件,
当依赖的是一个需要生成的文件,则需要先执行生成该依赖的规则。
伪目标
对于中间的生成文件,可以安全的进行删除。
可以使用clean规则进行中间生成产物的删除。
1 | clean: |
clean规则没有依赖文件,要执行clean,必须用命令make clean
在执行clean时,并没有创建一个名为clean的文件。若手动创建一个clean文件,该clean规则就不会执行。
若希望make不将clean视为文件,可以添加一个标识:
1 |
|
此时,clean不被视为一个文件,而是伪目标(Phony Target)。
大型项目通常会提供
cleaninstall等,约定俗成的目标名称。
一般并不需要用.PHONY标识clean等约定俗成的伪目标名称。
执行多条命令
一个规则可以有多条命令,如:
1 | cd: |
make cd可以执行以上定义的cd规则。
针对每条命令都是创建一个独立的shell环境,同时也不对执行目录进行改变。
可以将多条命令以;进行分隔。同时也可以在行后使用\将一行语句拆成多行。
1 | cd: |
还可以使用&&执行多条命令,在执行时,当某条命令失败,后续命令不会继续执行。
控制打印
默认情况下,make会打印出它执行的每一条命令。如果不想打印某一条命令,可以在命令前加上@,表示命令执行时,不打印该命令。
1 | no_output: |
控制错误
make在执行命令时,会检查每一条命令的返回值,如果返回错误(非0值),就会中断执行。
但是,有时候我们想忽略错误,继续执行命令,可以在需要忽略错误的命令前加上-:
1 | ignore_error: |
编写
Makefile就是编写一系列规则,来告诉make如何执行这些规则,最终生成我们期望的目标文件
编译C程序
C/C++程序的编译过程
main.cpp 源文件
| 预处理器
main.i 被预处理修改了的源文件
| 编译器
main.s 汇编程序
| 汇编器
main.o 可重定向的目标文件
| 链接器
main 可执行文件
以上过程可简化为以下处理步骤:
- 将每个
.c或.cpp文件编译为.o文件 - 将所有
.o文件链接为最终的可执行文件
使用隐式规则
在添加越来越多的.c .cpp .h .hpp文件时,就需要编写更多的规则来生成.o文件
由于make最初就是为了编译C程序而设计,为了免去重复创建编译.o文件的不ize,make内置了隐式规则(Implicit Rule),即,遇到一个.o文件时,若没有找到对应的规则,就自动应用一个隐式规则:
1 | xyz.o: xyz.c |
对于C程序员来说,使用隐式规则有一个潜在的问题,那就是无法跟踪.h文件的修改。
针对C C++ ASM Fortran等程序,
make内置了一系列隐式规则,可以通过官方手册进行查看。
使用变量
当我们在Makefile中重复写很多文件名时,会增加程序的复杂度,当需要改名时,费时费力。
在Makefile中可以使用变量来解决重复问题。
以一下Makefile为例:
1 | world: hello.o main.o |
在以上文件中world重复出现了3次,可以定义一个变量来进行替换。
1 | TARGET = world |
变量定义使用变量名=值或变量名:=值,通常变量名全大写。引用变量使用$(变量名)。
以上内容中,hello.o main.o列表也重复出现,可以使用变量进行替换:
1 | OBJS = hello.o main.o |
从编译过程可以看出:每个.o文件都是由对应的.c文件编译而成的,因此,可以让make先获取.c文件列表,再进行替换,得到.o文件列表。
1 | OBJS = $(patsubst %.c,%.o,$(wildcard * .c)) |
在以上的内容中,wildcard为列出当前目录下所有.c文件的函数,函数patsubst``进行模式替换。 这样,在每添加一个.c文件后,都不需要修改Makefile,变量OBJS`都会自动更新。
自动变量
在Makefile中,经常可以看到$@ $<这样的变量,这种变量被称为 自动变量(Automatic AVariable)
$@当前规则的目标名 在app: main.o规则中,$@就是app$<第一个依赖项名 在app: main.o util.o规则中,$<就是main.o$^所有依赖项列表 在app: main.o util.o规则中,$^就是main.o util.o
1 | # Makefile content |
在以上的Makefile文件中的自动变量的释义:
$@: main
$<: main.cpp
$^: main.cpp hello.o […]
例子
在 PPMStream 中的 makefile 构建文件
项目结构
1 | . |
构建文件
1 |
|
最佳实践建议
- 使用变量:避免硬编码路径和参数
- 目录分离:区分源码、构建和二进制目录
- 伪目标声明:标记不生成文件的目标
- 错误处理:在命令前添加-忽略错误
- 清晰的注释:解释复杂规则和变量
- 依赖管理:自动生成头文件依赖
- 分层Makefile:大型项目使用子目录Makefile
- 跨平台支持:处理不同OS的差异