通用Makefile的使用及解析

---

前言

欣赏一下韦东山老师写的通用 Makefile 源码，韦东山老师的“通用 Makefile” 是参考内核的 Makefile 编写出来的，这个通用的 Makefile 可以在工作中方便使用。

---

一、源码使用

1、工程预览

使用 tree 命令查看文件树形结构

example 目录下的文件为待添加 Makefile 的源码，Makefile_and_readme 目录下文件为通用 Makefile 的使用方法。

在工程里面添加 Makefile 可以参考 ./Makefile_and_readme/说明.txt

说明.txt

本程序的 Makefile 分为3类:
1. 顶层目录的 Makefile
2. 顶层目录的 Makefile.build
3. 各级子目录的 Makefile

一、各级子目录的 Makefile：
   它最简单，形式如下：

EXTRA_CFLAGS  := 
CFLAGS_file.o := 

obj-y += file.o
obj-y += subdir/
   
   "obj-y += file.o"  表示把当前目录下的 file.c 编进程序里，
   "obj-y += subdir/" 表示要进入 subdir 这个子目录下去寻找文件来编进程序里，是哪些文件由 subdir 目录下的 Makefile 决定。
   "EXTRA_CFLAGS",    它给当前目录下的所有文件(不含其下的子目录)设置额外的编译选项, 可以不设置
   "CFLAGS_xxx.o",    它给当前目录下的 xxx.c 设置它自己的编译选项, 可以不设置

注意: 
1. "subdir/"中的斜杠"/"不可省略
2. 顶层 Makefile 中的 CFLAGS 在编译任意一个 .c 文件时都会使用
3. CFLAGS  EXTRA_CFLAGS  CFLAGS_xxx.o 三者组成 xxx.c 的编译选项

二、顶层目录的 Makefile：
   它除了定义 obj-y 来指定根目录下要编进程序去的文件、子目录外，
   主要是定义工具链前缀 CROSS_COMPILE,
   定义编译参数 CFLAGS,
   定义链接参数 LDFLAGS,
   这些参数就是文件中用 export 导出的各变量。

三、顶层目录的 Makefile.build：
   这是最复杂的部分，它的功能就是把某个目录及它的所有子目录中、需要编进程序去的文件都编译出来，打包为 built-in.o
   详细的讲解请看视频。

四、怎么使用这套 Makefile：
1．把顶层 Makefile, Makefile.build 放入程序的顶层目录
   在各自子目录创建一个空白的 Makefile

2．确定编译哪些源文件
   修改顶层目录和各自子目录 Makefile 的 obj-y : 
    obj-y += xxx.o
	obj-y += yyy/
	这表示要编译当前目录下的 xxx.c, 要编译当前目录下的 yyy 子目录	

3. 确定编译选项、链接选项
   修改顶层目录 Makefile 的 CFLAGS，这是编译所有 .c 文件时都要用的编译选项;
   修改顶层目录 Makefile 的 LDFLAGS，这是链接最后的应用程序时的链接选项;
   
   修改各自子目录下的 Makefile：
   "EXTRA_CFLAGS",    它给当前目录下的所有文件(不含其下的子目录)设置额外的编译选项, 可以不设置
   "CFLAGS_xxx.o",    它给当前目录下的 xxx.c 设置它自己的编译选项, 可以不设置
   
4. 使用哪个编译器？
   修改顶层目录 Makefile 的 CROSS_COMPILE, 用来指定工具链的前缀(比如 arm-linux-)
   
5. 确定应用程序的名字：
   修改顶层目录 Makefile 的 TARGET, 这是用来指定编译出来的程序的名字

6. 执行"make"来编译，执行"make clean"来清除，执行"make distclean"来彻底清除

2、使用通用 Makefile 方法

下面按照上述 ./Makefile_and_readme/说明.txt 讲解一下如何给 example 添加 Makefile
步骤如下：
①、将 Makefile_and_readme 目录下的 Makefile 和 Makefile.build 文件拷贝到 example 的顶层目录

 cp Makefile Makefile.build ../example/

②、在 example 子目录 a 中创建一个空白的 Makefile

 touch Makefile

③、确定要编译哪些源文件，按照需求修改 Makefile
<1>、编译顶层目录的 main.c sub.c 以及 a 目录中的文件
修改 ./general_Makefile/Makefile

注意：这里目录 a 必须不能忘了 /
<2>、编译顶层 a 目录中的 sub2.c sub3.c 文件
修改 ./general_Makefile/example

因此，这样从顶层目录的 Makefile 一路往下查看，你要编译 main.o sub.o 还有 a 目录下的文件，再从 a 目录下的 Makefile 里面又知道了你要编译 sub2.o sub3.o，这样就可以遍历所有的目录，把所有要编译的程序都给找出来
④、确定编译选项、链接选项
<1>、编译选项
顶层目录下面有一个变量叫做 CFLAGS，这是编译所有的 c 文件时都要用的编译选项。

我们把所有的头文件都放在了 include 目录下面了，因此我们编译源文件时都要去这个目录下查找头文件，我们可以修改顶层目录下的 Makefile，指定这么一个CFLAGS 选项

CFLAGS += -I $(shell pwd)/include	# 指定当前目录下的 include 目录

这样做以后所有的 .c 文件都会去这个目录下面来查找他们的头文件

<2>、链接选项
同样道理，还有 LDFLAGS，源文件都编译成 .o 文件后姚链接起来，你可以来指定链接选项，比如说你可以指定库在哪里，以及指定使用哪个一个库

LDFLAGS := -L 库路径 -l库名称

我们的程序里用不着指定

⑤、指定编译器
指定是给 PC 机编译还是 arm 板编译，可以修改 CROSS_COMPILE 交叉编译器的前缀
例如下面给 arm 板子编译：

CROSS_COMPILE = arm-linux-

我们这里赋值为空，默认使用 PC 机编译

不同的板子这个前缀不一样
⑥、确定应用程序的名字
我们指定应用程序的名字为 test

二、源码编译

1、编译

进入到 example 目录，执行 make，可以看到编译生成了 test 文件

再执行 make，可以看到不会执行任何事了

执行 test，可以看到结果

修改 include 目录下面的 sub3.h，把宏定义 C 的值改成 4

再次执行 make，它只会去编译所涉及的 sub3.c，其他文件并没有重新编译

执行 test

2、EXTRA_CFLAGS 和 CFLAGS_xxx.o

我们还可以给各个子目录下面的 makefile 里面添加 “EXTRA_CFLAGS” “CFLAGS_xxx.o” 这两个变量

"EXTRA_CFLAGS",    它给当前目录下的所有文件(不含其下的子目录)设置额外的编译选项, 可以不设置
"CFLAGS_xxx.o",    它给当前目录下的xxx.c设置它自己的编译选项, 可以不设置

首先查看 sub2.c 源码

#include 
#include 

void sub2_fun(void)
{
    printf("Sub2 fun, B = %d!\n", B);   
#ifdef DEBUG
	printf("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
#endif
}

再查看 sub3.c

#include 
#include 

void sub3_fun(void)
{
    printf("Sub3 fun, C = %d!\n", C);
	
#ifdef DEBUG
		printf("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
#endif

#ifdef DEBUG_SUB3
		printf("It is only debug info for sub3.\n");
#endif

}

可以看到 sub2.c 和 sub3.c 都含有 DEBUG 编译宏，如果定义了这个宏，就会打印对应的信息，那么我们可以通过 Makefile 里面传入这个宏

修改 a 目录下的 Makefile

EXTRA_CFLAGS := -D Debug	# -D 就是 define 的意思

使用这个编译选项来编译 c 文件时，他就相当于在头文件里面定义了这个宏一样

先执行 make clean，再执行 make 查看效果

可以看到编译 sub2.c 和 sub3.c 时，传入了 -D 的编译选项， -I 选项是都有的，编译 main.c 和 sub.c 时没有 -D 选项

执行 test 文件，可以看到打印出了这些调试信息

源码 sub3.c 里面有个 DEBUG_SUB3 的编译开关，我们也可以给这个 sub3.c 单独指定这个编译选项
修改 a 目录下面的 Makefile，增加下面一句：

CFLAGS_sub3.o := -D DEBUG_SUB3

先执行 make clean，再执行 make

可以看到只有 sub3.c 用到了 DEBUG_SUB3 的编译选项
执行 test 文件，可以看到相应的调试信息

三、通用 Makefile 的解析

查看 example 目录下的文件树结构

1、Makefile.build 文件

Makefile.build

PHONY := __build
__build:


obj-y :=
subdir-y :=
EXTRA_CFLAGS :=

include Makefile

# obj-y := a.o b.o c/ d/
# $(filter %/, $(obj-y))   : c/ d/
# __subdir-y  : c d
# subdir-y    : c d
__subdir-y	:= $(patsubst %/,%,$(filter %/, $(obj-y)))
subdir-y	+= $(__subdir-y)

# c/built-in.o d/built-in.o
subdir_objs := $(foreach f,$(subdir-y),$(f)/built-in.o)

# a.o b.o
cur_objs := $(filter-out %/, $(obj-y))
dep_files := $(foreach f,$(cur_objs),.$(f).d)
dep_files := $(wildcard $(dep_files))

ifneq ($(dep_files),)
  include $(dep_files)
endif


PHONY += $(subdir-y)


__build : $(subdir-y) built-in.o

$(subdir-y):
	make -C $@ -f $(TOPDIR)/Makefile.build

built-in.o : $(subdir-y) $(cur_objs)
	$(LD) -r -o $@ $(cur_objs) $(subdir_objs)

dep_file = .$@.d

%.o : %.c
	$(CC) $(CFLAGS) $(EXTRA_CFLAGS) $(CFLAGS_$@) -Wp,-MD,$(dep_file) -c -o $@ $<
	
.PHONY : $(PHONY)

2、通用 Makefile 的设计思想：

每一个目录下面都有一个名为 Makefile 的文件，在 Makefile 里面指定了哪些文件，哪些目录要编译进程序里，我们使用顶层 Makefile.build 将这些文件编进程序里。

①、在 Makefile 文件中确定要编译的文件、目录，比如：

obj-y += main.o
obj-y += a/

“Makefile” 文件总是被 “Makefile.build” 包含的。

②、Makefile.build 中设置编译规则，有 3 条编译规则：
A. 怎么编译子目录？ 进入子目录编译：

$(subdir-y):
	make -C $@ -f $(TOPDIR)/Makefile.build	# 进入子目录并使用顶层目录里面的 Makefile.build 来编译这个子目录，这个 Makefile.build 会包含子目录里面的 Makefile，从子目录的 Makefile 就知道了要编译哪些文件

B. 怎么编译当前目录中的文件？

%.o : %.c
	$(CC) $(CFLAGS) $(EXTRA_CFLAGS) $(CFLAGS_$@) -Wp,-MD,$(dep_file) -c -o $@ $<

C. 当前目录下的 .o 和子目录下的 built-in.o 要打包起来：

built-in.o : $(cur_objs) $(subdir_objs)
	$(LD) -r -o $@ $^

③、顶层 Makefile 中把顶层目录的 built-in.o 链接成 APP：

$(TARGET) : built-in.o
	$(CC) $(LDFLAGS) -o $(TARGET) built-in.o

3、情景演绎

四、资源自取

https://download.csdn.net/download/qq_41839588/88222517

---

我的qq：2442391036，欢迎交流！

---