Makefile
Makefile简介
make命令执行时,需要一个makefile文件,以告诉make命令需要怎么样的去编译和链接程序。
eg:一个工程有8个c文件,和3个头文件,我们要写一个makefile来告诉make命令如何编译和链接这几个文件。规则是:
- 如果这个工程没有编译过,那么我们的所有c文件都要编译并被链接。
- 如果这个工程的某几个c文件被修改,那么我们只编译被修改的c文件,并链接目标程序。
- 如果这个工程的头文件被改变了,那么我们需要编译引用了这几个头文件的c文件,并链接目标程序。
只要我们的makefile写得够好,所有的这一切,只用一个make命令就可以完成,make命令会自动智能地根据当前的文件修改的情况来确定哪些文件需要重编译,从而自动编译所需要的文件和链接目标程序。
Makefile三要素
目标、依赖、命令
Makefile简单示例
#.PHONY:可以指定伪目标
.PHONY:targetb
targeta:targetb targetc
echo "targeta"
targetb:
echo "targetb"
targetc
echo "targetc"
实验结果
当创建一个targetb目标文件后,会有以下提示
所以存在以下问题:如果在当前工作目录下存在文件 targetb,由于这个规则没有任何依赖文件,所以目标被认为是最新的而不去执行规则所定义的命令,因此命令“ echo “targetb” "将不会被执行。
为了解决这个问题,我们需要将目标 “targetb“ 声明为伪目标。将一个目标声明为伪目标的方法是将它作为特殊目标 .PHONY 的依赖。这样目标“targetb” 就被声明为一个伪目标,无论在当前目录下是否存在targetb这个文件,都可以执行targetb命令。而且,当一个目标被声明为伪目标后,make 在执行此规则时不会去试图去查找隐含规则来创建它。这样也提高了 make 的执行效率,同时也不用担心由于目标和文件名重名而使我们的期望失败。(详细资料:Makefile中文手册->4.6节,Makefile伪目标)
声明为伪目标后,targetb命令就可以执行了
引入Makefile管理项目
创建一个 mp3.c 和 main.c 文件,如下
/*mp3.c*/
#include<stdio.h>
void play()
{printf("play music!\r\n");}
void stop()
{printf("stop music!\r\n");}
/*main.c*/
#include<stdio.h>
int main()
{
play();
stop();
return 0;
}
一、不引入Makefile进行编译并执行
二、编写Makefile
#mp3程序依赖main.o和mp3.o,执行gcc main.o mp3.o -o mp3命令
mp3:main.o mp3.o
gcc main.o mp3.o -o mp3
#main.o和mp3.o依赖main.c和mp3.c
main.o:main.c
mp3.o:mp3.c
#main.o的目标:执行gcc -c main.c -o main.o命令
main.o:
gcc -c main.c -o main.o
#mp3.o的目标:执行gcc -c mp3.c -o mp3.o
mp3.o:
gcc -c mp3.c -o mp3.o
#声明伪指令clean,指令目标为:rm mp3,即删除mp3程序
.PHONY:clean
clean:
rm mp3
三、引入Makefile进行编译并执行
make生成main.o和mp3.o以及可执行程序mp3
不同情况下编译时,执行的命令的区别
一、当我们第一次编译的时候
1. gcc -c main.c -o main.o
2. gcc -c mp3.c -o mp3.o
3. gcc main.o mp3.o -o mp3
二、若我们编译完删除程序文件,并再次编译的时候
gcc main.o mp3.o -o mp3
三、当我们修改其中一个.c文件后,再次编译的时候
#例如修改main.c#
1. gcc -c main.c -o main.o
2. gcc main.o mp3.o -o mp3
以上程序中,mp3应用程序依赖的是main.o和mp3.o,也就是说,当我们只修改main.c文件中的内容后,在重新编译的时候,由于mp3.c文件没有修改,就不会重新参与编译,这样就节约了编译花费的时间。
Makefile的变量
系统变量
.PHONY:all
all:
#系统变量:一般用来指代编译器
echo "$(CC)"
#系统变量:一般用来指代汇编器
echo "$(AS)"
#系统变量:一般用来指make工具
echo "$(MAKE)"
打印出三个系统变量的值
自定义变量
- =,延迟赋值
- :=,立即赋值
- ?=,空赋值,只有当变量为空的时候,赋值才有效。
- +=,追加赋值,
自动化变量
- $<,第一个依赖文件
- $^,全部的依赖文件
- $@,目标
利用变量优化Makefile
#类似于宏定义
CC=gcc #用CC变量指代gcc编译器
TARGET=mp3 #用TARGET指代目标
OBJS=main.o mp3.o #用OBJS指代依赖文件
$(TARGET):$(OBJS) #这里等于: mp3:main.o mp3.o
$(CC) $^ -o $@ #这里等于: gcc main.o mp3.o -o mp3
main.o:main.c
mp3.o:mp3.c
main.o:
$(CC) -c main.c -o main.o
mp3.o:
$(CC) -c mp3.c -o mp3.o
.PHONY:clean
clean:
rm mp3
Makefile的模式匹配
%
匹配任意多个非空字符,效果如下
shell: *通配符
模式匹配的机制
在模式规则中,目标文件是一个带有模式字符“%”的文件,使用模式来匹配目标文件。文件名中的模式字符“%”可以匹配任何非空字符串,除模式字符以外的部分要求一致。
例如:
“%.c”匹配所有以“.c”结尾的文件(匹配的文件名长度最少为3个字母)。
“s%.c”匹配所有第一个字母为“s”,而且必须以“.c”结尾的文件,文件名长度最小为5个字符(模式字符“%”至少匹配一个字符)。
模式规则中依赖文件也可以不包含模式字符“%”。当依赖文件名中不包含模式字符“%”时,其含义是所有符合目标模式的目标文件都依赖于一个指定的文件(例如:%.o : debug.h,表示所有的.o文件都依赖于头文件“debug.h”)。
对于多目标模式规则来说,所有规则的目标共同拥有依赖文件和规则的命令行,当文件符合多个目标模式中的任何一个时,规则定义的命令就有可能将会执行;因为多个目标共同拥有规则的命令行,因此一次命令执行之后,规则不会再去检查是否需要重建符合其它模式的目标。(详细资料:Makefile中文手册->10.5节,模式规则)
利用模式匹配优化Makefile
CC=gcc
TARGET=mp3
OBJS=main.o mp3.o
$(TARGET):$(OBJS)
$(CC) $^ -o $@
#main.o:main.c
# $(CC) -c main.c -o main.o
#mp3.o:mp3.c
# $(CC) -c mp3.c -o mp3.o
#“%.o”匹配所有以“.o”结尾的文件,“%.c”匹配所有以“.c”结尾的文件。前面定义了OBJS有两个.o文件,所以按顺序匹配。
#等于执行了上面被注释的内容。
%.o:%.c
$(CC) -c $< -o $@
#由于默认规则.o 文件默认使用 .c 文件来进行编译的。所以上面两行也可以不用写
.PHONY:clean
clean:
rm mp3
默认规则
.o 文件默认使用 .c 文件来进行编译的。
Makefile条件分支
ifeq (var1,var2)
...
else
...
endif
ifneq (var1,var2)
...
else
...
endif
例程:
ARCH ?= x86 #判断ARCH是否等于x86
ifeq ($(ARCH),x86) #如果是,则用gcc编译,在Ubuntu上可执行
CC=gcc
else #如果不是,则用arm-linux-gnueabihf-gcc编译,在Linux上可执行
CC=arm-linux-gnueabihf-gcc
endif
TARGET=mp3
OBJS=main.o mp3.o
$(TARGET):$(OBJS)
$(CC) $^ -o $@
%.o:%.c
$(CC) -c $< -o $@
.PHONY:clean
clean:
sudo rm mp3 *.o
利用arm-linux-gnueabihf-gcc进行编译和利用gcc-x86进行编译之间的区别:
Makefile常用函数
模式替换函数
$(patsubst PATTERN,REPLACEMENT,TEXT)
函数名称:模式替换函数—patsubst。
函数功能:搜索“TEXT”中以空格分开的单词,将符合模式“PATTERN”替换为“REPLACEMENT”。参数“PATTERN”中可以使用模式通符“%”来代表一个单词中的若干字符。如果参数“REPLACEMENT”中也包含一个“%”,那么“REPLACEMENT”中的“%”将是“PATTERN”中的那个“%”所代表的字符串。在“PATTERN”和“REPLACEMENT”中,只有第一个“%”被作为模式字符来处理,之后出现的不再作模式字符(作为一个字符)。在参数中如果需要将第一个出现的“%”作为字符本身而不作为模式字符时,可使用反斜杠“\”进行转义处理(转义处理的机制和使用静态模式的转义一致,具体可参考 5.12.1 静态模式规则的语法一小节)。
返回值:替换后的新字符串。
函数说明:参数“TEXT”单词之间的多个空格在处理时被合并为一个空格,并忽略前导和结尾空格
示例:
$(patsubst %.c,%.o,x.c.c bar.c)
把字串“x.c.c bar.c”中以.c 结尾的单词替换成以.o 结尾的字符。函数的返回结果是“x.c.o bar.o“
.PHONY:all
all:
echo "$(patsubst %.c,%.o,x.c.c bar.c star.c)"
结果:将bar.c和star.c替换为bar.o和star.o,x.c.o表示把 .c 转换为 .o
取文件名函数
$(notdir NAMES…)
函数名称:取文件名函数——notdir。
函数功能:从文件名序列“NAMES…”中取出非目录部分。目录部分是指最后一个斜线(“/”)(包括斜线)之前的部分。删除所有文件名中的目录部分,只保留非目录部分。
返回值:文件名序列“NAMES…”中每一个文件的非目录部分。
函数说明:如果“NAMES…”中存在不包含斜线的文件名,则不改变这个文件名。以反斜线结尾的文件名,是用空串代替,因此当当“NAMES…”中存在多个这样的文件名时,返回结果中分割各个文件名的空格数目将不确定!这是此函数的一个缺陷。
示例:
$(notdir src/foo.c hacks)
返回值为:“foo.c hacks”。
.PHONY:all
all:
echo "$(notdir src/foo.c hackS)"
结果:返回文件中非目录的部分,src/作为目录不返回
获取匹配模式文件名函数
$(wildcard PATTERN)
函数名称:获取匹配模式文件名函数—wildcard
函数功能:列出当前目录下所有符合模式“PATTERN”格式的文件名。
返回值:空格分割的、存在当前目录下的所有符合模式“PATTERN”的文件名。
函数说明:“PATTERN”使用shell可识别的通配符,包括“?”(单字符)、“*”(多字符)等。可参考 4.4 文件名中使用通配符一节。
示例:
$(wildcard *.c)
返回值为当前目录下所有.c 源文件列表
.PHONY:all
all:
echo "$(wildcard *.c)"
结果:返回 mp3.c 和 main.c
foreach 函数
函数“foreach”不同于其它函数。它是一个循环函数。类似于 Linux 的 shell 中的for 语句。
“foreach”函数的语法:
$(foreach VAR,LIST,TEXT)
**函数功能:**这个函数的工作过程是这样的:如果需要(存在变量或者函数的引用),首先展开变量“VAR”和“LIST”的引用;而表式“TEXT”中的变量引用不展开。执行时把“LIST”中使用空格分割的单词依次取出赋值给变量“VAR”,然后执行“TEXT”表达式。重复直到“LIST”的最后一个单词(为空时结束)。“TEXT”中的变量或者函数引用在执行时才被展开,因此如果在“TEXT”中存在对“VAR”的引用,那么“VAR”的值在每一次展开式将会到的不同的值。
**返回值:**空格分割的多次表达式“TEXT”的计算的结果。
我们来看一个例子,定义变量“files”,它的值为四个目录(变量“dirs”代表的 a、 b、c、d 四个目录)下的文件列表:
dirs := a b c d
files := ( f o r e a c h d i r , (foreach dir, (foreachdir,(dirs),$(wildcard $(dir)/*))
例子中,“TEXT”的表达式为“$(wildcard ( d i r ) ) ” 。 表 达 式 第 一 次 执 行 时 将 展 开 为 “ (dir))”。表达式第一次执行时将展开为“ (dir))”。表达式第一次执行时将展开为“(wildcard a)”;第二次执行时将展开为“ ( w i l d c a r d b ) ” ; 第 三 次 展 开 为 “ (wildcard b)”;第三次展开为“ (wildcardb)”;第三次展开为“(wildcard c)”;….;以此类推。所以此函数所实现的功能就和一下语句等价:
files := $(wildcard a/* b/* c/* d/*)
当函数的“TEXT”表达式过于复杂时,我们可以通过定义一个中间变量,此变量代表表达式的一部分。并在函数的“TEXT”中引用这个变量。上边的例子也可以这样来实现:
find_files = $(wildcard $(dir)/*)
dirs := a b c d
files := ( f o r e a c h d i r , (foreach dir, (foreachdir,(dirs),$(find_files))
在这里我们定义了一个变量(也可以称之为表达式),需要注意,在这里定义的是“递归展开”时的变量“find_files”。保证了定义时变量中的引用不展开,而是在表达式被函数处理时才展开(如果这里使用直接展开式的定义将是无效的表达式)。可参考 6.2 两种变量定义节。
**函数说明:**函数中参数“VAR”是一个局部的临时变量,它只在“foreach”函数的上下文中有效,它的定义不会影响其它部分定义的同名“VAR”变量的值。在函数的执行过程中它是一个“直接展开”式变量。
示例:
.PHONY:all
dirs := a b c d
files := $(foreach dir,$(dirs),$(wildcard $(dir)/*))
all:
echo "$(files)"
结果:打印出a和b文件夹下的所有文件
利用函数进一步规范项目
#判断编译器
ARCH ?= x86
ifeq ($(ARCH),x86)
CC=gcc
else
CC=arm-linux-gnueabihf-gcc
endif
#编译目标
TARGET=mp3
#编译文件存放目录
BUILD_DIR=build
#源文件存放目录
SRC_DIR=module1 module2
#遍历源文件,获取匹配模式文件名
SOURCES=$(foreach dir,$(SRC_DIR),$(wildcard $(dir)/*.c))
#把.c文件修改为.o文件,即进行模式替换,
#具体过程:先取出SOURCES中的.c文件的文件名,然后修改为.o文件
OBJS=$(patsubst %.c,$(BUILD_DIR)/%.o,$(notdir $(SOURCES)))
#定义VPATH能够让make在当前目录找不到的情况下,到所指定的目录中去找寻文件
VPATH=$(SRC_DIR)
#生成的.o文件存放在编译文件存放目录(BUILD_DIR)
$(BUILD_DIR)/$(TARGET):$(OBJS)
$(CC) $^ -o $@
#生成的可执行文件存放在编译文件存放目录(BUILD_DIR),加管道,如果没有该目录就创建一个
$(BUILD_DIR)/%.o:%.c | creat_build
$(CC) -c $< -o $@
.PHONY:clean create_build
#清理build目录
clean:
sudo rm -r $(BUILD_DIR)
#创建build目录
creat_build:
sudo mkdir -p $(BUILD_DIR)
Makefile解决头文件依赖
步骤:
-
写一个头文件,并把头文件添加到编译器的头文件路径中。
-
实时检查头文件的更新情况,一旦头文件发生变化,应该要重新编译所有相关文件。
ARCH ?= x86
ifeq ($(ARCH),x86)
CC=gcc
else
CC=arm-linux-gnueabihf-gcc
endif
TARGET=mp3
BUILD_DIR=build
SRC_DIR=module1 module2
INC_DIR=include
CFLAGS=$(patsubst %,-I%,$(INC_DIR))
#遍历头文件,获取匹配模式文件名
INCLUDES=$(foreach dir,$(INC_DIR),$(wildcard $(dir)/*.h))
#遍历源文件,获取匹配模式文件名
SOURCES=$(foreach dir,$(SRC_DIR),$(wildcard $(dir)/*.c))
#把.c文件修改为.o文件,即进行模式替换,
#具体过程:先取出SOURCES中的.c文件的文件名,然后修改为.o文件
OBJS=$(patsubst %.c,$(BUILD_DIR)/%.o,$(notdir $(SOURCES)))
#定义VPATH能够让make在当前目录找不到的情况下,到所指定的目录中去找寻文件
VPATH=$(SRC_DIR)
#生成的.o文件存放在编译文件存放目录(BUILD_DIR)
$(BUILD_DIR)/$(TARGET):$(OBJS)
$(CC) $^ -o $@
#生成的可执行文件存放在编译文件存放目录(BUILD_DIR),加管道,如果没有该目录就创建一个
#并添加头文件依赖,当头文件有修改的话则会重新参与编译
$(BUILD_DIR)/%.o:%.c $(INCLUDES) | creat_build
$(CC) -c $< -o $@ $(CFLAGS)
.PHONY:clean create_build
#清理build目录
clean:
sudo rm -r $(BUILD_DIR)
#创建build目录
creat_build:
sudo mkdir -p $(BUILD_DIR)
此时整个工程的目录结构