Makefile总结及通用模板使用

项目结构

./
├── a
│   ├── Makefile
│   ├── sub2.c
│   └── sub3.c
├── include
│   ├── sub2.h
│   ├── sub3.h
│   └── sub.h
├── main.c
├── Makefile
├── Makefile.build
└── sub.c

示例C代码

C代码只是作为示例，为了不影响阅读见附录

makefile文件

顶层目录下的Makefile

CROSS_COMPILE = 
AS		= $(CROSS_COMPILE)as
LD		= $(CROSS_COMPILE)ld
CC		= $(CROSS_COMPILE)gcc
CPP		= $(CC) -E
AR		= $(CROSS_COMPILE)ar
NM		= $(CROSS_COMPILE)nm

STRIP		= $(CROSS_COMPILE)strip
OBJCOPY		= $(CROSS_COMPILE)objcopy
OBJDUMP		= $(CROSS_COMPILE)objdump

export AS LD CC CPP AR NM
export STRIP OBJCOPY OBJDUMP

CFLAGS := -Wall -O2 -g
CFLAGS += -I $(shell pwd)/include

LDFLAGS := 

export CFLAGS LDFLAGS

TOPDIR := $(shell pwd)
export TOPDIR

TARGET := test


obj-y += main.o
obj-y += sub.o
obj-y += a/
# print:
# 	@echo $(TARGET)
# 	@echo $(shell find -name "*.o")
# 	@echo "obj-y="$(obj-y)
# 	@echo "TOPDIR="$(TOPDIR)
# TOPDIR=/home/book/Documents/makefile_learn/general_Makefile/example

# 执行make 会执行第一个 all 目标。all 分成两个依赖 start_recursive_build 和 $(TARGET)
all : start_recursive_build $(TARGET)
	@echo $(TARGET) has been built!

start_recursive_build:
	@echo "------------------start_recursive_build begin---------------------"
	make -C ./ -f $(TOPDIR)/Makefile.build
	@echo "------------------start_recursive_build end------------------------"

$(TARGET) : start_recursive_build
	@echo "-------------------------test begin---------------------------------"
	$(CC) -o $(TARGET) built-in.o $(LDFLAGS)
	@echo "-------------------------test end-----------------------------------"

clean:
	rm -f $(shell find -name "*.o")
	rm -f $(TARGET)

distclean:
	rm -f $(shell find -name "*.o")
	rm -f $(shell find -name "*.d")
	rm -f $(TARGET)

顶层目录下的Makefile.build

PHONY := __build
__build:

# 先清空
obj-y :=
subdir-y :=
EXTRA_CFLAGS :=
# 再包含 Makefile
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)

# 依赖于子目录a 依赖于built-in.o
__build : $(subdir-y) built-in.o
# 先去处理子目录a
# make -C 进入子目录a,使用顶层的makefile.build来处理这个子目录,即就是这个makefile.build。
#子目录中的makefile会对标志位，文件啥的进行赋值，然后执行%.o : %.c下面的规则。
$(subdir-y):
	@echo "--------------------subdir-y begin---------------------------"
	@echo "subdir-y="$(subdir-y)
	@echo "@="$@
	@echo "TOPDIR="$(TOPDIR)
	make -C $@ -f $(TOPDIR)/Makefile.build
	@echo "--------------------subdir-y end---------------------------"
#这一部分递归了好几次，第一次递归：在子目录a下生成a/built-in.o
# 这里subdir-y subdir_objs都为空 cur_objs=sub2.o sub3.o,即ld -r -o built-in.o sub2.o sub3.o obj-y= sub2.o sub3.o

# 第二次递归：ld -r -o built-in.o main.o sub.o a/built-in.o
built-in.o : $(subdir-y) $(cur_objs)
	@echo "--------------------built-in.o begin---------------------------"
	@echo "subdir-y="$(subdir-y)
	@echo "@="$@
	@echo "cur_objs="$(cur_objs)
	@echo "subdir_objs="$(subdir_objs)
	@echo "obj-y="$(obj-y)
	@echo "CFLAGS_sub3.o="$(CFLAGS_sub3.o)
	$(LD) -r -o $@ $(cur_objs) $(subdir_objs)
	@echo "--------------------built-in.o end---------------------------"
dep_file = .$@.d

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

子目录下的Makefile

目录：a/Makefile

# -D 即define 相当于在头文件中定义了宏：DEBUG
EXTRA_CFLAGS := -D DEBUG
# 单独给sub3.c 定义了宏：DEBUG_SUB3 只适用于sub3.o 并不适用sub2.o
CFLAGS_sub3.o := -D DEBUG_SUB3

obj-y += sub2.o 
obj-y += sub3.o

make输出结果

make -C ./ -f /home/book/Makefile_example/Makefile.build
make[1]: Entering directory '/home/book/Makefile_example'
--------------------subdir-y begin---------------------------
subdir-y= a
@=a
TOPDIR=/home/book/Makefile_example
make -C a -f /home/book/Makefile_example/Makefile.build
make[2]: Entering directory '/home/book/Makefile_example/a'
gcc -Wall -O2 -g -I /home/book/Makefile_example/include -D DEBUG  -Wp,-MD,.sub2.o.d -c -o sub2.o sub2.c
gcc -Wall -O2 -g -I /home/book/Makefile_example/include -D DEBUG -D DEBUG_SUB3 -Wp,-MD,.sub3.o.d -c -o sub3.o sub3.c
--------------------built-in.o begin---------------------------
subdir-y=
@=built-in.o
cur_objs=sub2.o sub3.o
subdir_objs=
obj-y= sub2.o sub3.o
CFLAGS_sub3.o=-D DEBUG_SUB3
ld -r -o built-in.o sub2.o sub3.o 
--------------------built-in.o end---------------------------
make[2]: Leaving directory '/home/book/Makefile_example/a'
--------------------subdir-y end---------------------------
gcc -Wall -O2 -g -I /home/book/Makefile_example/include   -Wp,-MD,.main.o.d -c -o main.o main.c
gcc -Wall -O2 -g -I /home/book/Makefile_example/include   -Wp,-MD,.sub.o.d -c -o sub.o sub.c
--------------------built-in.o begin---------------------------
subdir-y= a
@=built-in.o
cur_objs=main.o sub.o
subdir_objs=a/built-in.o
obj-y= main.o sub.o a/
CFLAGS_sub3.o=
ld -r -o built-in.o main.o sub.o a/built-in.o
--------------------built-in.o end---------------------------
make[1]: Leaving directory '/home/book/Makefile_example'
------------------start_recursive_build end------------------------
-------------------------test begin---------------------------------
gcc -o test built-in.o 
-------------------------test end-----------------------------------
test has been built!

分析过程

1.顶层目录执行make之后，先会执行第一个目标all ，all依赖于start_recursive_build和$(TARGET),$(TARGET)即最终生成的test。所以先会执行start_recursive_build这个目标下的规则来生成built-in.o，接着执行test这个目标下的规则，将生成的built-in.o文件链接生成test最终文件

2.最重要的是start_recursive_build begin这个目标如何在各个源代码目录下生成各自的built-in.o.

2.1执行make -C ./ -f $(TOPDIR)/Makefile.build命令，进入当前目录（还是当前目录，没变），使用顶层目录（还是当前目录）下的Makefile.build作为make执行的makefile文件。

2.1在Makefile.build文件中，首先是obj-y ,subdir-y，EXTRA_CFLAGS这些变量的清楚，然后再重新赋值。不再详细分析。主要看__build : $(subdir-y) built-in.o，在当前情况下subdir-y就是a，执行$(subdir-y):下的规则make -C $@ -f $(TOPDIR)/Makefile.build，进入a目录，使用顶层目录下的Makefile.build对a目录下的文件进行处理。因为a目录下的makefile做了一些变量的赋值操作，所以此时的obj-y= sub2.o sub3.o CFLAGS_sub3.o=-D DEBUG_SUB3。所以此时的%.o : %.c规则就展开成了这个样子

1 2	%.o : %.c $(CC) $(CFLAGS) $(EXTRA_CFLAGS) $(CF

展开为：

1
2

gcc -Wall -O2 -g -I /home/book/Makefile_example/include -D DEBUG  -Wp,-MD,.sub2.o.d -c -o sub2.o sub2.c
gcc -Wall -O2 -g -I /home/book/Makefile_example/include -D DEBUG -D DEBUG_SUB3 -Wp,-MD,.sub3.o.d -c -o sub3.o sub3.c

这样就生成了sub2.o和sub3.o.但是此时还没完，因为我们的目标是在子目录下生成a/built-in.o

2.2在子目录a中当然也会执行到built-in.o : $(subdir-y) $(cur_objs),此时subdir-y为空，因为a下面没有子目录了。而cur_objs=sub2.o sub3.o。此时通过规则$(LD) -r -o $@ $(cur_objs) $(subdir_objs)来将sub2.o sub3.o链接成a/built-in.o。这个命令展开实际为：

1	ld -r -o built-in.o sub2.o sub3.o

此时就完成了我们的任务：生成:a/built-in.o.

所以我们也可看到make输出：离开a文件夹

1	make[2]: Leaving directory '/home/book/Makefile_example/a'

3.回到主目录之后，继续使用makefile.build来处理顶层文件夹的源文件。比如将main.c sub.c文件转换成.o.d文件（当然在a目录下也做了这个工作）。接下来的工作就是生成顶层目录下的built-in.o文件。注意此时make已经切换到了顶层目录。此时subdir-y=a,cur_objs=main.o sub.o subdir_objs=a/built-in.o。此时通过规则$(LD) -r -o $@ $(cur_objs) $(subdir_objs)来将main.o sub.o a/built-in.o链接成顶层目录下的built-in.o

这个命令展开实际为

1	ld -r -o built-in.o main.o sub.o a/built-in.o

3.1至此，built-in.o的生成工作就大功告成了，此时可以看到make离开文件夹（不知道离开了没，我感觉没有），start_recursive_build endend.

1	make[1]: Leaving directory '/home/book/Makefile_example'

4.现在顶层目录的built-in.o已经有了，顶层目录下的built-in.o汇聚了所有子目录的.o信息以及main.o的信息。只需要通过gcc -o test built-in.o 即可生成我们的最终目标test

5.最终start_recursive_build和$(TARGET)都有了，打印输出：

1	test has been built!

Makefile零碎知识点

目标冒号后面没有依赖项的情况

对于只有目标而没有依赖项的情况，说明该目标不依赖任何文件或者目标，直接执行后面的命令。这种情况一般用于伪目标。

常见的伪目标有：clean install help

清理操作
1
2
clean:
rm -f *.o
安装操作
1
2
3
4
5
install: modules_install
$(MAKE) -C $(KERNELDIR) M=$(shell pwd) $@

modules_install:
$(MAKE) -C $(KERNELDIR) M=$(shell pwd) $@
install 目标依赖于 modules_install，但这里我们关注的是 modules_install 自身。modules_install 没有依赖项，直接执行命令进入内核源码目录并安装模块

其执行逻辑大概就是make判断当前目标是否比依赖新，结果没有发现目标文件，当然不可能比依赖新，就执行后面的语句。但是当Makefile目录下如果有clean文件时候，再执行make时候就会提示make: clean is up to date.。如果想避免这种情况，就需要使用 .PHONY : clean告诉make clean是个伪目标，不管有没有clean这个文件。

为什么使用无依赖项的目标？

伪目标：用于触发特定操作而非生成文件。例如，clean、install、help 等目标通常不生成实际文件，而是执行清理、安装或显示帮助信息等操作。
简化逻辑：某些操作不需要依赖其他文件或目标，直接执行命令即可。例如，清理操作只需要删除特定文件，而不需要等待其他文件生成。
灵活性：允许开发者定义任意数量的伪目标，方便扩展和维护 Makefile。

多个目标共享同一组命令

1 2	modules modules_install help clean: $(MAKE) -C $(KERNELDIR) M=$(shell pwd) $@

当调用这些目标中的任何一个时，都会执行相同的命令，即进入内核源码目录并根据目标名称执行相应的操作。

默认执行第一个目标

如果有多个伪目标，默认情况下使用make命令指挥执行第一个目标。例如一个完整的Makefile内容如下(测试用例)，默认是执行第一个目标help，可以使用make clean执行clean目标。

help:
	@echo "Available targets:"
	@echo "  all       - Build the module"
	@echo "  install   - Install the module"
	@echo "  clean     - Clean up build files"
clean:
	rm -f *.o

1	make -C <directory> [target]

-C <directory>：表示进入指定的目录 <directory>，然后在该目录中执行Make命令

[target]：可选参数，表示要执行的目标。如果没有指定目标，则默认执行Makefile中的第一个目标。

操作示例1：执行命令make -C test，输出为。这个案例的Makefile内容就是上文只包含help和clean的那个。

book@100ask:~/Documents/makefile_learn$ make -C test
make: Entering directory '/home/book/Documents/makefile_learn/test'
Available targets:
  all       - Build the module
  install   - Install the module
  clean     - Clean up build files
make: Leaving directory '/home/book/Documents/makefile_learn/test'

操作示例2：执行命令make -C test clean

book@100ask:~/Documents/makefile_learn$ make -C test clean 
make: Entering directory '/home/book/Documents/makefile_learn/test'
rm -f *.o
make: Leaving directory '/home/book/Documents/makefile_learn/test'

1	make -C <directory> -f <makefile>

-C <directory>：表示进入指定的目录 <directory>，然后在该目录中执行Make命令。
-f <makefile>：指定要使用的Makefile文件为 <makefile>。默认情况下，make 会查找名为 Makefile 或 makefile 的文件，但使用 -f 可以明确指定其他文件。

1	make -C ./ -f $(TOPDIR)/Makefile.build

-C ./：表示进入当前目录（. 表示当前目录）。这通常用于确保在特定的工作目录中执行Make操作。
-f $(TOPDIR)/Makefile.build：指定使用位于 $(TOPDIR) 目录下的 Makefile.build 文件作为Makefile。$(TOPDIR) 是一个变量，通常定义为项目的顶层目录路径。

附录：

示例C代码

main.c

#include <stdio.h>

extern void sub_fun(void);
extern void sub2_fun(void);
void sub3_fun(void);

int main(int argc, char* argv[])
{
    printf("Main fun!\n");
    sub_fun();
    sub2_fun();
    sub3_fun();
    return 0;
}

sub.c

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

void sub_fun(void)
{
    printf("Sub fun,  A = %d!\n", A);   
}

a/sub2.c

#include <stdio.h>
#include <sub2.h>

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

a/sub3.c

#include <stdio.h>
#include <sub3.h>

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

}

include/sub.h

1 2	#define A 1 void sub_fun(void);

include/sub2.h

1 2	#define B 2 void sub2_fun(void);

include/sub3.h

1 2	#define B 2 void sub2_fun(void);

Makefile模板

顶层Makefile

# 如果给pc机编译则不需要设置，如果给arm板编译则需要设置
# arm-buildroot-linux-gnueabihf-
CROSS_COMPILE = 
AS		= $(CROSS_COMPILE)as
LD		= $(CROSS_COMPILE)ld
CC		= $(CROSS_COMPILE)gcc
CPP		= $(CC) -E
AR		= $(CROSS_COMPILE)ar
NM		= $(CROSS_COMPILE)nm

STRIP		= $(CROSS_COMPILE)strip
OBJCOPY		= $(CROSS_COMPILE)objcopy
OBJDUMP		= $(CROSS_COMPILE)objdump

export AS LD CC CPP AR NM
export STRIP OBJCOPY OBJDUMP

CFLAGS := -Wall -O2 -g
# 以后所有的.c文件都会去 当前目录下的include目录下查找头文件，给所有的.c文件都要用到这个属性
CFLAGS += -I $(shell pwd)/include
# 链接选项 可以指定库在哪里，需要链接哪些库 LDFLAGS := -L dir -l libname
LDFLAGS := 

export CFLAGS LDFLAGS

TOPDIR := $(shell pwd)
export TOPDIR

TARGET := test


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


all : start_recursive_build $(TARGET)
	@echo $(TARGET) has been built!

start_recursive_build:
	make -C ./ -f $(TOPDIR)/Makefile.build

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

clean:
	rm -f $(shell find -name "*.o")
	rm -f $(TARGET)

distclean:
	rm -f $(shell find -name "*.o")
	rm -f $(shell find -name "*.d")
	rm -f $(TARGET)

顶层目录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)

子目录Makefile

一般是指定源文件和编译选项

# EXTRA_CFLAGS := -D DEBUG
# CFLAGS_sub3.o := -D DEBUG_SUB3

obj-y += sub2.o 
obj-y += sub3.o

使用说明

本程序的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"来彻底清除

参考

韦东山《通用Makefile的使用》