Makefile从入门到上手

Gnep@97

发布于 2023-08-15 15:23:34

40600

代码可运行

文章被收录于专栏：Gnep's_Technology_BlogGnep's_Technology_Blog

运行总次数：0

代码可运行

前言

makefile 关系到了整个工程的编译规则。一个工程中的源文件不计其数，并且按类型、功能、模块分别放在若干个目录中，makefile 定义了一系列的规则来指定，哪些文件需要先编译，哪些文件需要后编译，哪些文件需要重新编译，甚至于进行更复杂的功能操作，因为 makefile 就像一个 Shell 脚本一样，其中也可以执行操作系统的命令。

本文记录了 Makefile 的使用。

一、Makefile 介绍

Makefile 是一个名为 GNU-Make 软件所需要的脚本文件，该脚本文件可以指导 Make 软件控制 arm-gcc 等工具链去编译工程文件最终得到可执行文件，几乎所有的 Linux 发行版都内置了 GNU-Make 软件，VScode 等多种 IDE 也内置了 Make 程序。说白了，Makefile 就是用来管理项目的。

你见到的 xxx.mk 文件或者 Makefile 都统称为 Makefile 脚本文件。

命名只能为 makefile 或者是 Makefile，因为只有这两种命名方式才能被 make 命令识别。

二、示例源码

这里放出供下面 Makefile 基础规则中用来测试的源码。

1、hello.c

#include <stdio.h>
#include "head.h"

int main(int argc, char *argv[])
{
    int a = 10; int b = 5;

    printf("%d+%d=%d\n", a, b, add(a, b));
    printf("%d-%d=%d\n", a, b, sub(a, b));
    printf("%d/%d=%d\n", a, b, div(a, b));
    printf("%dx%d=%d\n", a, b, mul(a, b));

	return 0;
}

2、add.c

int add(int a, int b)
{
	return a+b;
}

3、sub.c

int sub(int a, int b)
{
	return a-b;
}

4、mul.c

int mul(int a, int b)
{
	return a*b;
}

5、div.c

int div(int a, int b)
{
	return a/b;
}

6、head.h

#ifndef _HEAD_H_
#define _HEAD_H_

int add(int , int );
int sub(int , int );
int div(int , int );
int mul(int , int );

#endif

三、Makefile 基础规则

想要掌握 makefile，首先需要了解两个概念，⼀个是目标（target），另⼀个就是依赖（dependency）。目标就是指要干什么，或说运行 make 后生成什么，而依赖是告诉 make 如何去做以实现目标。在 Makefile 中，目标和依赖是通过规则（rule）来表达的。

makefile 的依赖是从上至下的，换句话说就是目标文件是第一句里的目标，如果不满足执行依赖，就会继续向下执行。如果满足了生成目标的依赖，就不会再继续向下执行了。make 会自动寻找规则里需要的材料文件，执行规则下面的行为生成规则中的目标。

Makefile 三要素：

工作原理：

1、一个规则

1个规则

目标：依赖条件
（一个 tab 缩进）命令

①、目标的时间必须晚于依赖条件的时间，否则，更新目标。 ②、依赖条件如果不存在，找寻新的规则去产生依赖条件。

下面来一步一步升级 makefile

利用上述代码实现第一个版本的 Makefile

Makefile 第一版

a.out : hello.c add.c sub.c mul.c div.c
	gcc hello.c add.c sub.c mul.c div.c -o a.out -I ./

执行 make ：

此时，修改 add.c 为下面

add.c

int add(int a, int b)
{
	return a+b+1;
}

此时，再使用 make，发现了问题

可以看到，只修改 add.c，但是编译的时候，其他.c 文件也重新编译了，这不太科学。明明只改了一个，全部都重新编译了。

于是将 makefile 改写如下：

Makefile 第二版

a.out : hello.o add.o sub.o mul.o div.o
	gcc hello.o add.o sub.o mul.o div.o -o a.out 

hello.o : hello.c
	gcc -c hello.c -o hello.o -I ./

add.o : add.c
	gcc -c add.c -o add.o

sub.o : sub.c
	gcc -c sub.c -o sub.o

mul.o : mul.c
	gcc -c mul.c -o mul.o

div.o : div.c
	gcc -c div.c -o div.o

执行 make 指令如下：

此时，再将 add.c 改为最开始的代码：

add.c

int add(int a, int b)
{
	return a+b;
}

执行 make 指令如下：

可以看到，只重新编译了修改过的 add.c 和最终目标

makefile 检测原理：修改文件后，文件的修改时间发生变化，会出现目标文件的时间早于作为依赖材料的时间，出现这种情况的文件会重新编译。修改 add.c 后， add.o 的时间就早于 add.c ， a.out 的时间也早于 add.o 的时间了，于是重新编译这俩文件了。

关于 makefile 指定目标问题，先修改 makefile 如下：

Makefile 第三版

hello.o : hello.c
	gcc -c hello.c -o hello.o -I ./

add.o : add.c
	gcc -c add.c -o add.o

sub.o : sub.c
	gcc -c sub.c -o sub.o

mul.o : mul.c
	gcc -c mul.c -o mul.o

div.o : div.c
	gcc -c div.c -o div.o

a.out : hello.o add.o sub.o mul.o div.o
	gcc hello.o add.o sub.o mul.o div.o -o a.out

只是将 a.out 放在了文件末尾执行 make，如下：

这是因为， makefile 默认第一个目标文件为终极目标，生成就跑路，这时候可以用 ALL 来指定终极目标。

ALL：指定 makefile 的终极目标。

指定目标的 makefile 如下：

Makefile 第四版

ALL : a.out

hello.o : hello.c
	gcc -c hello.c -o hello.o -I ./

add.o : add.c
	gcc -c add.c -o add.o

sub.o : sub.c
	gcc -c sub.c -o sub.o

mul.o : mul.c
	gcc -c mul.c -o mul.o

div.o : div.c
	gcc -c div.c -o div.o

a.out : hello.o add.o sub.o mul.o div.o
	gcc hello.o add.o sub.o mul.o div.o -o a.out

执行：

2、两个函数和 clean

①、2 个函数：

找到当前目录下所有后缀为 .c 的文件，赋值给 src

src = $(wildcard ./*.c) # 匹配当前工作目录下的所有.c 文件。将文件名组成列表，赋值给变量 src。 src = add.c sub.c mul.c div1.c

把 src 变量所有后缀为 .c 的文件替换成 .o

obj = $(patsubst %.c, %.o, $(src)) # 将参数 3 中，包含参数 1 的部分，替换为参数 2。 obj = add.o sub.o mul.c div1.o

用这两个函数修改 makefile 如下：

Makefile 第五版

src = $(wildcard *.c) # hello.c add.c sub.c mul.c  div.c

obj = $(patsubst %.c, %.o, $(src)) # hello.o add.o sub.o mul.o div.o

ALL : a.out

hello.o : hello.c
	gcc -c hello.c -o hello.o -I ./

add.o : add.c
	gcc -c add.c -o add.o

sub.o : sub.c
	gcc -c sub.c -o sub.o

mul.o : mul.c
	gcc -c mul.c -o mul.o

div.o : div.c
	gcc -c div.c -o div.o

a.out : $(obj)
	gcc $(obj) -o a.out

执行 make 指令，如下所示：

②、clean

-rm -rf $(obj) a.out # “-” ：作用是，删除不存在文件时，不报错。顺序执行结束。

每次要删除 .o 文件，很恶心，于是改写 makefile 如下：加了 clean 部分

Makefile 第六版

src = $(wildcard *.c) # hello.c add.c sub.c mul.c  div.c

obj = $(patsubst %.c, %.o, $(src)) # hello.o add.o sub.o mul.o div.o

ALL : a.out

hello.o : hello.c
	gcc -c hello.c -o hello.o -I ./

add.o : add.c
	gcc -c add.c -o add.o

sub.o : sub.c
	gcc -c sub.c -o sub.o

mul.o : mul.c
	gcc -c mul.c -o mul.o

div.o : div.c
	gcc -c div.c -o div.o

a.out : $(obj)
	gcc $(obj) -o a.out 

clean :
	-rm -rf $(obj) a.out

rm 前面的 - ，代表出错依然执行。比如，待删除文件集合是 5 个，已经手动删除了 1 个，就只剩下 4 个，然而删除命令里面还是 5 个的集合，就会有删除不存在文件的问题，不加这 - ，就会报错，告诉你有一个文件找不到。加了-就不会因为这个报错。

执行 make

由于没有文件变动， a.out 的时间戳晚于所有依赖文件，这里 make 就没干活

于是，执行时加新指令，先模拟执行 clean 部分：

确定没有问题，执行

3、三个自动变量和模式规则

①、三个自动变量

$@	# 在规则的命令中，表示规则中的目标。

$^	# 在规则的命令中，表示所有依赖条件。组成一个列表，以空格隔开，如果这个列表中有重复项，则去重

$<	# 在规则的命令中，表示第一个依赖条件。如果将该变量应用在模式规则中，它可将依赖条件列表中的依赖依次取出，套用模式规则。

用自动变量修改 makefile，如下：

Makefile 第七版

src = $(wildcard *.c) # hello.c add.c sub.c mul.c  div.c

obj = $(patsubst %.c, %.o, $(src)) # hello.o add.o sub.o mul.o div.o

ALL : a.out

hello.o : hello.c
	gcc -c $< -o $@ -I ./

add.o : add.c
	gcc -c $< -o $@

sub.o : sub.c
	gcc -c $< -o $@

mul.o : mul.c
	gcc -c $< -o $@

div.o : div.c
	gcc -c $< -o $@

a.out : $(obj)
	gcc $^ -o $@

clean :
	-rm -rf $(obj) a.out

sub， add 这些指令中使用 < 和

②、模式规则

<1>、模式规则

%.o : %.c
	gcc -c $< -o %@

修改 makefile，如下：

Makefile 第八版

src = $(wildcard *.c) # hello.c add.c sub.c mul.c  div.c

obj = $(patsubst %.c, %.o, $(src)) # hello.o add.o sub.o mul.o div.o

ALL : a.out

%.o : %.c
	gcc -c $< -o $@

a.out : $(obj)
	gcc $^ -o $@

clean :
	-rm -rf $(obj) a.out

执行 make，如下：

这时，增加一个 square 函数，并添加 square.c 文件如下：

square.c

int suqare(int a)
{
    return a*a;
}

head.h 做如下修改： head.h

#ifndef _HEAD_H_
#define _HEAD_H_

int add(int , int );
int sub(int , int );
int div(int , int );
int mul(int , int );
int square(int );

#endif

hello.c 做如下修改： hello.c

#include <stdio.h>
#include "head.h"

int main(int argc, char *argv[])
{
    int a = 10; int b = 5;

    printf("%d+%d=%d\n", a, b, add(a, b));
    printf("%d-%d=%d\n", a, b, sub(a, b));
    printf("%d/%d=%d\n", a, b, div(a, b));
    printf("%dx%d=%d\n", a, b, mul(a, b));
    printf("%d*%d=%d\n", a, a, mul(a, a));

	return 0;
}

直接执行 make：

增加函数的时候，不用改 makefile，只需要增加.c 文件，改一下源码，就行。很强势。

<2>、静态模式规则

继续优化 makefile，使用静态模式规则，就是指定模式规则给谁用，这里指定模式规则给 obj 用，以后文件多了，文件集合会有很多个，就需要指定哪个文件集合用什么规则

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

修改后 makefile 如下：

Makefile 第八版

src = $(wildcard *.c) # hello.c add.c sub.c mul.c  div.c

obj = $(patsubst %.c, %.o, $(src)) # hello.o add.o sub.o mul.o div.o

ALL : a.out

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

a.out : $(obj)
	gcc $^ -o $@

clean :
	-rm -rf $(obj) a.out

运行如下：

4、伪目标

.PHONY: clean ALL

再来一个扩展，当前文件夹下有 ALL 文件或者 clean 文件时，会导致 makefile 瘫痪，如下所示， make clean 没有工作

用伪目标来解决，添加一行 .PHONY: clean ALL

makefile 如下所示：

Makefile 第九版

src = $(wildcard *.c) # hello.c add.c sub.c mul.c  div.c

obj = $(patsubst %.c, %.o, $(src)) # hello.o add.o sub.o mul.o div.o

ALL : a.out

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

a.out : $(obj)
	gcc $^ -o $@

clean :
	-rm -rf $(obj) a.out

.PHONY : clean ALL

再来执行 make clean，就不会受到干扰了

5、编译时的参数

还有一个扩展就是，编译时的参数， -g，-Wall 这些，可以放在 makefile 里面修改后 makefile 如下：

Makefile 第十版

src = $(wildcard *.c) # hello.c add.c sub.c mul.c  div.c

obj = $(patsubst %.c, %.o, $(src)) # hello.o add.o sub.o mul.o div.o

myArgs = -Wall -g

ALL : a.out

$(obj) : %.o : %.c
	gcc -c $< -o $@ $(myArgs)

a.out : $(obj)
	gcc $^ -o $@ $(myArgs)

clean :
	-rm -rf $(obj) a.out

.PHONY : clean ALL

执行 make，如下：

6、make 的参数

参数：

-n：模拟执行 make、 make clean 命令。
-f：指定文件执行 make 命令。 xxxx.mk

如果 makefile 的名字变化一下，比如，叫 m6 用 m6 执行 makefile， make -f m6 用 m6 执行 clean make -f m6 clean

四、工程源码优化

将上述 .c 文件都放到 src 目录中，.h 文件都放在 inc 目录中，所生成的 .o 文件产物都放在 obj 目录中

使用 tree 命令查看树形结构拓扑

修改 makefile 如下，主要是注意 % 的匹配理解，只匹配文件名，目录位置要手动添加

Makefile 第十一版

src = $(wildcard ./src/*.c) # ./src/hello.c ./src/add.c ...

obj = $(patsubst ./src/%.c, ./obj/%.o, $(src)) # ./obj/hello.o ./obj/add.o ...

inc_path = ./inc

myArgs = -Wall -g

ALL : a.out

$(obj) : ./obj/%.o : ./src/%.c
	gcc -c $< -o $@ $(myArgs) -I $(inc_path)

a.out : $(obj)
	gcc $^ -o $@ $(myArgs)

clean :
	-rm -rf $(obj) a.out

.PHONY : clean ALL

执行 make 和 make clean，效果如下

如果 makefile 的名字变化一下，比如，叫 m6

用 m6 执行 makefile， make -f m6 用 m6 执行 clean make -f m6 clean

五、Makefile 语法

1、两种变量

在 Makefile 中有两种变量，一种称为即时变量（简单变量），另一种称为延时变量

即时变量（简单变量）
- A := xxx # A 的值即刻确定，在定义时即确定
延时变量
- B = xxx # B 的值使用到时才确定

编写下面一个 Makefile

A := abc
B = 123

all :
	@echo $(A)
	@echo $(B)

执行 make

从上面我们看不出即时变量和延时变量的差别，我们再对 Makefile 进行如下修改：

A := $(C)
B = $(C)
C = abc

all :
	@echo A = $(A)
	@echo B = $(B)

执行 make

可以看到 A 的值为空，B 的值为 abc，因为 A 为即时变量，在定义时即确定，所以为空

修改 Makefile 将 C 的赋值放在最后：

A := $(C)
B = $(C)
#C = abc

all :
	@echo A = $(A)
	@echo B = $(B)

C = abc

执行 make，可以发现结果并不受影响

因为当我们执行 make 的时候，会把 Makefile 整个文件读进来进行分析，然后解析里面的变量，所以变量 C 的赋值放在哪里并不受影响

2、赋值方法

:=		# 即时变量
= 		# 延时变量
?= 		# 延时变量，如果是第 1 次定义才起效，如果在前面该变量已定义则忽略这句
+= 		# 附加，他是即时变量还是延时变量取决于前面的定义

①、+=（附加）使用案例

如下 Makefile

A := $(C)
B = $(C)
C = 123

all :
	@echo A = $(A)
	@echo B = $(B)

C += abc

执行 make

②、?= 使用案例

修改 Makefile 如下：

A := $(C)
B = $(C)
C = 123

D = 777
D ?= 888

all :
	@echo A = $(A)
	@echo B = $(B)
	@echo D = $(D)

C += abc

执行 make

六、Makefile 函数

函数调用，很像变量的使用，也是以 $ 来标识的，其语法如下：

$(<function> <arguments>)

或是:

${<function> <arguments>}

这里，就是函数名，make支持的函数不多。为函数的参数，参数间以逗号 , 分隔，而函数名和参数之间以“空格”分隔。函数调用以 $ 开头，以圆括号或花括号把函数名和参数括起。

1、foreach 函数

foreach 函数和别的函数非常的不一样。因为这个函数是用来做循环用的，Makefile 中的 foreach 函数几乎是仿照于 Unix 标准 Shell（/bin/sh）中的 for 语句，或是 C-Shell（/bin/csh）中的 foreach 语句而构建的。它的语法是：

$(foreach <var>,<list>,<text>)

这个函数的意思是，把参数 <list> 中的单词逐一取出放到参数 <var> 所指定的变量中，然后再执行 <text> 所包含的表达式。每一次 <text> 会返回一个字符串，循环过程中， <text> 的所返回的每个字符串会以空格分隔，最后当整个循环结束时， <text> 所返回的每个字符串所组成的整个字符串（以空格分隔）将会是 foreach 函数的返回值。

所以， <var> 最好是一个变量名， <list> 可以是一个表达式，而 <text> 中一般会使用 <var> 这个参数来依次枚举 <list> 中的单词。举个例子：如下 Makefile

names := a b c d

files := $(foreach n,$(names),$(n).o)

ALL:
	@echo $(files)

执行 make 上面的例子中， (name) 中的单词会被挨个取出，并存到变量 n 中， (n).o 每次根据 (n) 计算出一个值，这些值以空格分隔，最后作为foreach函数的返回，所以， (files) 的值是 a.o b.o c.o d.o 。

注意，foreach中的 <var> 参数是一个临时的局部变量，foreach函数执行完后，参数 <var> 的变量将不在作用，其作用域只在 foreach 函数当中。

2、filter 和 filter-out 函数

$(filter <pattern...>,<text>)

名称：过滤函数
功能：以 <pattern> 模式过滤 <text> 字符串中的单词，保留符合模式 <pattern> 的单词。可以有多个模式。
返回：返回符合模式 <pattern> 的字串。

$(filter-out <pattern...>,<text>)

名称：反过滤函数
功能：以 <pattern> 模式过滤 <text> 字符串中的单词，去除符合模式 <pattern> 的单词。可以有多个模式。
返回：返回不符合模式 <pattern> 的字串。

示例 Makefile 如下：

C = a b b d/

D = $(filter %/, $(C))
E = $(filter-out %/, $(C))

ALL:
	@echo D = $(D)
	@echo E = $(E)

执行 make

3、patsubst

$(patsubst <pattern>,<replacement>,<text>)

名称：模式字符串替换函数。
功能：查找 <text> 中的单词（单词以“空格”、“Tab”或“回车”“换行”分隔）是否符合模式 <pattern> ，如果匹配的话，则以 <replacement> 替换。这里， <pattern> 可以包括通配符 % ，表示任意长度的字串。如果 <replacement> 中也包含 % ，那么， <replacement> 中的这个 % 将是 <pattern> 中的那个 % 所代表的字串。（可以用 \ 来转义，以 % 来表示真实含义的 % 字符）
返回：函数返回被替换过后的字符串。
示例：$(patsubst %.c,%.o,x.c.c bar.c)，把字串 x.c.c bar.c 符合模式 %.c 的单词替换成 %.o ，返回结果是 x.c.o bar.o

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2023-08-14，如有侵权请联系 cloudcommunity@tencent.com 删除

makefile