Makefile学习笔记

Makefile作为软件开发中用于自动化编译的工具，它定义了一系列的规则来指定哪些文件需要先编译，哪些文件需要后编译，哪些文件需要重新编译等。Makefile的使用极大地提高了软件开发的效率。下面作为笔者学习的简单记录：

1. Makefile基本结构

Makefile文件包含了一系列的“规则”，每个规则的基本结构如下：

目标(target)…: 依赖(prerequisites)… 
    命令(command)

目标(target)：通常是要生成的文件的名称，也可以是执行的动作名称，如“clean”。
依赖(prerequisites)：生成目标所需要的文件或中间过程生成的目标。
命令(command)：通过执行命令对依赖操作生成目标。命令前必须是一个Tab字符，不能是空格。

例子：

test:test.cc
    g++ -o $@ $^
.PHONY:clean
clean:
    rm -f test

备注：

  • 在Linux中 .cpp 等价于 .cc 等价于 .cxx。
  • g++是一个编译C++语法的编译器，gcc是一个编译C语法的编译器。
  • 使用make后，形成可执行文件test。
  • 使用make clean后删除可执行文件test。

2. Makefile的工作原理

  1. 检查依赖： 在生成目标之前，make会检查规则中的依赖是否存在。如果不存在，则寻找是否有规则用来生成该依赖文件。
  2. 检查更新： 如果依赖存在，make会检查依赖的时间戳是否比目标的时间戳新。如果依赖的时间戳更新，则执行命令更新目标。
  3. 执行命令： 如果目标需要更新，则按照规则中的命令执行操作。

3. Makefile的常用命令和选项

make命令

功能： 默认执行Makefile文件中的第一个目标。

例子：

Makefile:
test1:test1.cc
    g++ -o test1 test1.cc
test2:test2.cc
    g++ -o test2 test2.cc

执行后只会执行 g++ -o test1 test1.cc 而不会执行 g++ -o test2 test2.cc。如果你想同时执行两个，后面会讲。

make clean

功能：通常用于清除编译过程中产生的中间文件和最终生成的目标文件。

make -f file

功能：指定Makefile文件的名称，不使用默认的Makefile、makefile或GNUmakefile。

例子：

假设你有一个名为 alt_makefile 的 Makefile 文件，你可以通过以下命令来使用它：

make -f alt_makefile

使用 -f 选项时，make 不会查找当前目录下的 Makefile、makefile 或 GNUmakefile 文件，除非你显式地通过 -f 指定它们。你可以指定多个 -f 选项来包含多个 Makefile 文件。make 会按照指定的顺序读取这些文件，并合并它们的规则。如果多个文件中定义了相同的规则，后面的文件会覆盖前面的文件中的定义。在一些复杂的项目中，可能会有多个 Makefile 文件，分别用于不同的构建目标或环境。使用 -f 选项可以灵活地选择使用哪个 Makefile 文件。

make -C dir

功能：在读取Makefile之前改变工作目录至 dir 目录。

例子：

project/ 
├── Makefile 
└── src/ 
    ├── Makefile 
    └── ... (源文件)

你可以在项目的根目录（project）下运行以下命令来执行 src 目录中的 Makefile：

make -C src

make -n

功能：只打印要执行的命令但不执行。

make -s

功能：执行命令但不显示执行的命令。

4. Makefile中的变量：$(变量名) $@，$<，$^

Makefile中可以使用变量来简化规则的编写。变量可以在Makefile的任何地方定义和使用，引用变量时需要用 $(变量名) 的形式。

赋值：= 和 :=

使用 = 进行赋值时，Makefile 会进行延迟展开（lazy evaluation 或 recursive expansion）。这意味着变量的值不会立即确定，而是在每次变量被引用时根据变量的当前值重新计算。

使用 := 进行赋值时，Makefile 会进行直接展开（immediate evaluation 或 simple expansion）。这意味着变量的值在赋值时立即确定，并且之后不会改变（除非使用其他机制，如 override 指令）。

$(变量名)

自定义变量：如G=g++，定义了一个变量G，其值为g++。

例子：

G=g++
test:test.cc
    $(G) -o test test.cc

等价于：

test:test.cc
    g++ -o test test.cc

$@，$<，$^

自动变量：如$@表示规则中的目标，$<表示第一个依赖文件，$^表示所有的依赖文件。

例子1：

test:test.cc
    g++ -o $@ $^

等价于：

test:test.cc
    g++ -o test test.cc

例子2：

test:test1.o test2.o test3.o
    g++ -o $@ $^

等价于：

test:test1.o test2.o test3.o
    g++ -o test test1.o test2.o test3.o

例子3：

test:test.cc
    g++ -o $@ $<

等价于：

test:test.cc
    g++ -o test test.cc

5. %的使用

模式规则允许使用%通配符来匹配文件名，从而可以为一组文件定义相同的编译规则。例如：

CC=gcc
%.o: %.c  	
    $(CC) -c $< -o $@

这条规则表示对于所有的.c文件，都使用$(CC) -c命令编译成对应的.o文件。

6. .PHONY的使用

伪目标（phony target）是那些不真正生成文件的目标，如“clean”。为了避免与同名文件冲突，可以使用.PHONY声明伪目标：

清理例子
Makefile代码：
.PHONY: clean
clean:
    rm -f $(shell find -name "*.o")

.PHONY: clean：这一行声明了clean是一个伪目标。这意味着，无论何时你运行make clean，make都会执行clean目标下的命令，而不会去检查名为clean的文件是否存在或是否是最新的。这对于那些不生成文件的命令（如清理命令）特别有用。

7. Makefile的常用函数wildcard 和 patsubst

Makefile中提供了许多内置函数，如wildcard、patsubst等，用于对文件名进行匹配、替换等操作。

wildcard

$(wildcard pattern)：查找当前目录下所有符合模式pattern的文件。

例如：

SRC=$(wildcard *.cc)

查找当前目录下所有.cc后缀的文件赋值给SRC。例如当前目录有main.cc test.cc，那么SRC=main.cc test.cc

注意：wildcard只能查找当前目录的文件，如果想要找的文件在当前目录的一个目录中，那么它是找不到的，此时应该使用：

SOURCES := $(shell find src -name "*.cc")

patsubst

$(patsubst pattern,replacement,text)：将text中符合pattern的部分替换为replacement。

例如：

# 定义一个变量，包含了一些文件名  
FILES = foo.c bar.c baz.h  
# 使用patsubst将.c文件扩展名替换为.o  
OBJECTS = $(patsubst %.c,%.o,$(FILES))

8. 常用的Makefile的示例

一个test.cc文件形成对应的test可执行文件

test:test.cc
    g++ -o $@ $^

.PHONY:clean
clean:
    rm -f test

效果：

  • 输入make形成可执行文件test。
  • 输入make clean删除可执行文件test。

多个.cc文件形成对应的可执行文件（以两个为例）

all:test1 test2
test1:test1.cc
    g++ -o test1 test1.cc
test2:test2.cc
    g++ -o test2 test2.cc
 
clean:
    rm -f test1 test2
 
.PHONY: all clean

备注：.PHONY: all clean写在哪都行。

Ref:

  • [1]. 跟我一起写Makefile-陈皓