这一章我们介绍韦东山老师写的通用Makefile的使用以及原理。
1. 通用Makefile相关文件
主要有三个文件,分别是Makefile Makefile.build 说明.txt 这三个文件的内容如下:
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 += xxx.o
obj-y += yyy/
all : start_recursive_build $(TARGET)
@echo $(TARGET) has been built!
start_recursive_build:
make -C ./ -f $(TOPDIR)/Makefile.build
$(TARGET) : built-in.o
$(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 : $(cur_objs) $(subdir_objs)
$(LD) -r -o $@ $^
dep_file = .$@.d
%.o : %.c
$(CC) $(CFLAGS) $(EXTRA_CFLAGS) $(CFLAGS_$@) -Wp,-MD,$(dep_file) -c -o $@ $<
.PHONY : $(PHONY)
说明.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使用方法
实验文件:
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);
}
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
}
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
}
sub.h
#define A 1
void sub_fun(void);
sub2.h
#define B 2
void sub2_fun(void);
sub3.h
#define C 3
void sub3_fun(void);
文件结构为:
- a文件夹: sub2.c sub3.c
- include文件夹:sub.h sub2.h sub3.h
- main.c
- sub.c
我们按照说明.txt文件进行编译
2.1 移动顶层Makefile以及创建子目录空白Makefile
- 首先需要将通用Makefile文件和Makefile.build移动至根目录,根目录下的Makefile称为顶层Makefile
- 在子目录(包含源文件的目录)下创建空白的Makefile
相关的目录结构如下图所示:
2.2 确定编译哪些源文件
修改顶层目录和各自目录Makefile的obj-y:
obj-y += xxx.o
obj-y += yyy/
这表示要编译当前目录下的xxx.c, 要编译当前目录下的yyy子目录
2.2.1 修改顶层Makefile
根目录下有main.c和sub.c 所以我们需要添加:
obj-y += main.o
obj-y += sub.o
还需要编译a目录下的sub2.c sub3.c文件,所以我们也需要添加a文件夹
obj-y += a/
a后必须要带上/, 这样系统才会认为是目录,不是文件。
顶层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/
all : start_recursive_build $(TARGET)
@echo $(TARGET) has been built!
start_recursive_build:
make -C ./ -f $(TOPDIR)/Makefile.build
$(TARGET) : built-in.o
$(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)
2.2.2 修改子目录Makefile
a目录下面有sub2.c sub3.c, 所以需要添加相关的.o文件(sub2.o, sub3.o)
子目录a下的Makefile代码:
obj-y += sub2.o
obj-y += sub3.o
2.3 确定编译选项和连接选项
修改顶层目录Makefile的CFLAGS,这是编译所有.c文件时都要用的编译选项;
修改顶层目录Makefile的LDFLAGS,这是链接最后的应用程序时的链接选项;LDFLAGS选项为指定库文件路径
我们将头文件都存放在include下了,所以需要设置CFLAGS选项,设置头文件存放路径。
CFLAGS += -I $(shell pwd)/include
$(shell pwd)表示当前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/
all : start_recursive_build $(TARGET)
@echo $(TARGET) has been built!
start_recursive_build:
make -C ./ -f $(TOPDIR)/Makefile.build
$(TARGET) : built-in.o
$(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)
2.4 确定使用哪个编译器
修改顶层目录Makefile的CROSS_COMPILE, 用来指定工具链的前缀(比如arm-linux-),如果使用系统的GCC,则该选项不用填写。这里我们使用GCC,故不需要指定。
2.5 确定应用程序的名字
修改顶层目录Makefile的TARGET, 这是用来指定编译出来的程序的名字,我们设置为test
2.6 编译和清除
在顶层根目录下执行"make"来编译,执行"make clean"来清除,执行"make distclean"来彻底清除。
2.7 运行和修改代码
运行:
修改sub3.h头文件中的C为4,再次运行:
2.8 设置EXTRA_CFLAGS和CFLAGS_xxx.o
通过修改子目录下的Makefile文件设置EXTRA_CFLAGS可以给当前目录下的所有文件(不含其下的子目录)设置额外的编译选项,比如设置程序中的相关宏定义。通过设置CFLAGS_xxx.o可以给当前目录下的xxx.c设置该文件的编译选项。
- “EXTRA_CFLAGS”, 它给当前目录下的所有文件(不含其下的子目录)设置额外的编译选项, 可以不设置
- “CFLAGS_xxx.o”, 它给当前目录下的xxx.c设置它自己的编译选项, 可以不设置
2.8.1 设置EXTRA_CFLAGS实验
由下图可知,sub2.c文件有DEBUG宏定义,如果定义了改宏,那么会打印相关的数据。
我们可以修改a目录下的Makefile文件加入EXTRA_CFLAGS设置,定义DEBUG宏,-D表示Define的意思
Makefile内容:
EXTRA_CFLAGS := -D DEBUG
obj-y += sub2.o
obj-y += sub3.o
下图为编译的图:
由图可知:编译sub2.c和sub3.c时加入了DEBUG选项。对于main.c没有加入DEBUG。
下图为运行图:
从图示可以看到,的确是有相关的打印。
2.8.2 设置CFLAGS_xxx.o实验
下图为sub3.c的源代码,从源代码可知,sub3.c单独定义了DEBUG_SUB3宏定义,我们可以通过设置在子目录下的Makefile文件中的CFLAGS_sub3.o的值来定义DEBUG_SUB3
a目录下的Makefile程序:
EXTRA_CFLAGS := -D DEBUG
CFLAGS_sub3.o := -D DEBUG_SUB3
obj-y += sub2.o
obj-y += sub3.o
编译:
由上图可知:只为sub3.c定义了DEBUG_SUB3宏,其他的源文件没有定义。
运行结果:
可知单独的调试信息出来了。