Makefile简单使用
在linux系统中经常使用make命令来编译程序,而make命令执行的动作需要Makefike文件的依赖。下面我们来讲解一个最简单的Makefile文件。
hello: hello.c
gcc -o hello hello.c
clean:
rm -f hello
将上述 4 行存为 Makefile 文件(注意必须以 Tab 键缩进第 2、4 行,不能以空格键缩进),放入 01_hello目录下,并在目录下创建一个helloworld程序,命名为hello.c。然后直接执行 make 命令即可编译程序,执行“make clean”即可清除编译出来的结果。
执行make命令时,从第一行开始,会先判断hello是否存在,若不存在则执行gcc -o hello hello.c命令,若存在则判断hello和hello.c的时间,若hello.c比hello文件更加新(即编译过后更改过hello.c 文件),则执行make命令,否则不执行命令,即make 命令可以根据文件更新的时间戳来决定哪些文件需要重新编译,这使得可以避免编译已经编译过的、没有变化的程序,可以大大提高编译效率。
Makefile规则
一个简单的 Makefile 文件包含一系列的“规则”,其样式如下:
目标(target)…: 依赖(prerequiries)…
<tab>命令(command)
如果“依赖文件”比“目标文件”更加新,那么执行“命令”来重新生成“目标文件”。
命令被执行的 2 个条件:依赖文件比目标文件新,或是目标文件还没生成。
Makefile入门
下面我们将使用一个例子来进一步讲解makefile ,我们先创建main.c、sub.h、sub.c三个文件,具体代码如下。
main.c文件
#include <stdio.h>
extern void sub_fun(void);
int main(int argc, char* argv[])
{
printf("Main fun!\n");
sub_fun();
return 0;
}
sub.h文件
#define A 1
void sub_fun(void);
sub.c文件
#include <stdio.h>
#include "sub.h"
void sub_fun(void)
{
printf("Sub fun, A= %d!\n", A);
}
第一个makefile
test : main.c sub.c sub.h
gcc -o test main.c sub.c
执行make命令,第一行检测到未生成test这个目标文件,或者依赖文件时间戳比目标文件test新,则进行全部文件编译。简单粗暴,如果编译文件比较少,我们可以这样做,但是通常需要编译的文件都比较多,只改动一个文件的话,也需要把全部文件重新编译,所以效率低。
第二个makefile文件
test : main.o sub.o
gcc -o test main.o sub.o
main.o : main.c
gcc -c -o main.o main.c
sub.o : sub.c
gcc -c -o sub.o sub.c
clean:
rm *.o test -f
效率高,相似规则太多太啰嗦,不支持检测头文件:
为什么不检测头文件?我们执行make命令时,会生成test可执行文件,运行test文件输出结果如下:
Main fun!
Sub fun, A= 1!
我们修改 sub.h 的宏命令为#define A 2并使用 touch sub.c更改sub.c的时间戳,重新执行make命令并运行,发现结果A=1,这与宏命令不对应,所以不支持检测头文件。
第三个makefile文件
test : main.o sub.o
gcc -o test main.o sub.o
#模式规则:定义了将任意一个X.c文件转换为X.o文件
%.o : %.c
gcc -c -o $@ $<
sub.o : sub.h
clean:
rm *.o test -f
第4行是模式规则,看起来非常类似于正则规则,但在目标名称的前面多了一个 %号,同时可用来定义目标和依赖文件之间的关系。
"$@"表示目标文件 "$<"表示第一个依赖文件
效率高,精炼,支持检测头文件(但是需要手工添加头文件规则):检测头文件是加了sub.o : sub.h这条命令。因为这条命令并没有规则,所以会检测和它相同的目标文件(.o文件),并将他们的依赖文件合并在一起进行编译。即要生成sub.o文件时,相当于下面一条命令
sub.o : sub.c sub.h
gcc -c -o $@ $<
第四个makefile文件
” $^ ” 代表所有的依赖文件(components)
gcc -Wp,-MD,.abc.dep -c -o main.o main.c // 生成依赖文件 .abc.dep
下面是用到的两个函数的用法
A. $(foreach var,list,text)
简单地说,就是 for each var in list, change it to text。 对 list 中的每一个元素,取出来赋给 var,然后把 var 改为 text 所描述的形式。
例子:
objs := a.o b.o
dep_files := $(foreach f, $(objs), .$(f).d) // 最终 dep_files := .a.o.d .b.o.d
B. $(wildcard pattern)
pattern 所列出的文件是否存在,把存在的文件都列出来。
例子:
src_files := $( wildcard *.c) // 最终 src_files 中列出了当前目录下的所有.c 文件
objs := main.o sub.o
test : $(objs)
gcc -o test $^
# 需要判断是否存在依赖文件
# .main.o.d .sub.o.d
dep_files := $(foreach f, $(objs), .$(f).d) #对于所有的.o文件,定义它的依赖文件名
dep_files := $(wildcard $(dep_files)) #用来判断这依赖文件是否存在,存在的都列出来
# 把依赖文件包含进来
ifneq ($(dep_files),)#如果此变量不等于空,就包含进去
include $(dep_files)
endif
%.o : %.c
gcc -Wp,-MD,.$@.d -c -o $@ $<
clean:
rm *.o test -f
distclean:
rm $(dep_files) *.o test -f
我们发现不检测头文件出问题是在第二次或多次编译后才会出问题,我们在第一次编译时通过给 gcc添加-Wp,-MD,.abc.dep命令,可以生成隐含的依赖文件,我们查看.sub.o.d文件可以找到所依赖的头文件,如下图。使用$(foreach f, $(objs), .$(f).d)可以将所以此格式 .(依赖文件名).d 转换成字符串并赋值给dep_files,然后使用$(wildcard $(dep_files)) 判断依赖文件是否都存在,存在的都列出来。然后将依赖文件加入到include目录下
通用 Makefile 的使用
以上的Makefile文件都是针对于同一个目录下的,当有子目录需要编译时,就很难使用。因此,我介绍一个通用的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)
顶层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)
使用方法
本程序的Makefile分为3类:
- 顶层目录的Makefile
- 顶层目录的Makefile.build
- 各级子目录的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设置它自己的编译选项, 可以不设置
注意:
- "subdir/“中的斜杠”/"不可省略
- 顶层Makefile中的CFLAGS在编译任意一个.c文件时都会使用
- 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子目录
-
确定编译选项、链接选项
修改顶层目录Makefile的CFLAGS,这是编译所有.c文件时都要用的编译选项;
修改顶层目录Makefile的LDFLAGS,这是链接最后的应用程序时的链接选项;修改各自子目录下的Makefile:
“EXTRA_CFLAGS”, 它给当前目录下的所有文件(不含其下的子目录)设置额外的编译选项, 可以不设置
“CFLAGS_xxx.o”, 它给当前目录下的xxx.c设置它自己的编译选项, 可以不设置 -
使用哪个编译器?
修改顶层目录Makefile的CROSS_COMPILE, 用来指定工具链的前缀(比如arm-linux-) -
确定应用程序的名字:
修改顶层目录Makefile的TARGET, 这是用来指定编译出来的程序的名字 -
执行"make"来编译,执行"make clean"来清除,执行"make distclean"来彻底清除
使用示例
下面我将使用一个例子来讲解如何使用本方法,先创建如下图的结构文件,头文件全部放在include文件夹里,具体文件代码如下。
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.c文件
#define C 3
void sub3_fun(void);
第一步:先将Makefile和Makefile.build文件拷贝到顶层目录里去,在各自子目录创建一个空白的Makefile。
第二步:修改顶层和底层Makefile
因为需要编译顶层本层main.c、sub.c和a目录下的文件,做以下修改。
顶层makefile修改
obj-y += main.o
obj-y += sub.o
obj-y += a/
a目录下makefile修改
obj-y += sub2.o
obj-y += sub3.o
第三步:确定编译选项、链接选项
我们可以将头文件全部放在include目录下,使用下面命令完成编译操作。
CFLAGS := -Wall -O2 -g
CFLAGS += -I $(shell pwd)/include
第四步:使用哪个编译器?
CROSS_COMPILE = #可以修改此命令来选择编译器,使用gcc编译可以不指定
第五步:修改顶层目录Makefile的TARGET, 这是用来指定编译出来的程序的名字
第六步:执行"make"来编译,执行"make clean"来清除,执行"make distclean"来彻底清除
c文件里的宏命令也可以通过makefile的文件进行添加,此图是sub.3文件的截图。
我们可以在a文件夹下makefile文件添加这两行命令,来添加宏命令
EXTRA_CFLAGS := -D DEBUG #本目录全部c文件添加宏命令
CFLAGS_sub3.o := -D DEBUG_SUB3#仅sub3.o添加宏命令
更详细的资料和讲解视频,请看
链接:https://pan.baidu.com/s/1se_wBY6T4U-pfkxxc2WsTw
提取码:yul2