开启Makefile大门

前言

在一个正式的软件项目中，由很多个.c和.h文件构成，此时如果直接在命令行进行编译，就会像这样：gcc a.c b.c c.c d.c e.c f.c g.c -o exe。每次编译都要输入一堆东西很麻烦，这个问题严重影响工作效率，怎么办？那就用Makefile来解决吧。

目录

正文

Makefile 简介

Makefile 是和 make 命令一起配合使用的.

很多大型项目的编译都是通过 Makefile 来组织的, 如果没有 Makefile, 那很多项目中各种库和代码之间的依赖关系不知会多复杂.

Makefile的组织流程的能力如此之强, 不仅可以用来编译项目, 还可以用来组织我们平时的一些日常操作. 这个需要大家发挥自己的想象力.

Makefile 的一些概念

规则主要有2部分: 依赖关系 和 生成目标的方法.

Makefile基本格式如下:

target ... : prerequisites ...
    command
    ...

或者

target ... : prerequisites ; command
    command
    ...

注： command太长, 可以用 “\” 作为换行符

其中，

• 目标(target)：目标顶格写，后面是冒号（冒号后面是依赖）。目标文件, 可以是 Object File, 也可以是可执行文件。
• 依赖（prerequisites）： 依赖是用来产生目标（target）的原材料。

• 命令（command）：命令前面一定是Tab，不能是定格，也不能说多个空格。命令就是要生成那个目标需要做的动作（任意的shell命令）。

  • 显示规则 :: 说明如何生成一个或多个目标文件(包括 生成的文件, 文件的依赖文件, 生成的命令)-
  • 隐晦规则 :: make的自动推导功能所执行的规则
  • 变量定义 :: Makefile中定义的变量
  • 文件指示 :: Makefile中引用其他Makefile; 指定Makefile中有效部分; 定义一个多行命令
  • 注释 :: Makefile只有行注释 “#”, 如果要使用或者输出”#”字符, 需要进行转义, “#”

Makefile 的基本工作原理

• 其一，当我们执行 make xx 的时候，Makefile会自动执行xx这个目标下面的命令语句。
• 其二，当我们make xx的时候，是否执行命令是取决于依赖的。依赖如果成立就会执行命令，否则不执行。
• 其三，我们直接执行make 和make 第一个目标 效果是一样的。（第一个目标其实就是默认目标）

GNU make 的工作方式

- 1.读入主Makefile (主Makefile中可以引用其他Makefile)
- 2.读入被include的其他Makefile
- 2.初始化文件中的变量
- 4.推导隐晦规则, 并分析所有规则
- 5.为所有的目标文件创建依赖关系链
- 6.根据依赖关系, 决定哪些目标要重新生成
- 7.执行生成命令

Makefile 的基本语法知识

Makefile 中定义和使用变量

变量定义 ( = or := )

OBJS = programA.o programB.o
OBJS-ADD = $(OBJS) programC.o
# 或者
OBJS := programA.o programB.o
OBJS-ADD := $(OBJS) programC.o

其中 = 和 := 的区别在于, := 只能使用前面定义好的变量, = 可以使用后面定义的变量

测试 =

# Makefile内容
OBJS2 = $(OBJS1) programC.o
OBJS1 = programA.o programB.o

all:
    @echo $(OBJS2)

# bash中执行 make, 可以看出虽然 OBJS1 是在 OBJS2 之后定义的, 但在 OBJS2中可以提前使用
$ make
programA.o programB.o programC.o

测试 :=

# Makefile内容
OBJS2 := $(OBJS1) programC.o
OBJS1 := programA.o programB.o

all:
    @echo $(OBJS2)

# bash中执行 make, 可以看出 OBJS2 中的 $(OBJS1) 为空
$ make
programC.o

变量替换

# Makefile内容
SRCS := programA.c programB.c programC.c
OBJS := $(SRCS:%.c=%.o)

all:
    @echo "SRCS: " $(SRCS)
    @echo "OBJS: " $(OBJS)

# bash中运行make
$ make
SRCS:  programA.c programB.c programC.c
OBJS:  programA.o programB.o programC.o

变量追加值 +=

# Makefile内容
SRCS := programA.c programB.c programC.c
SRCS += programD.c

all:
    @echo "SRCS: " $(SRCS)

# bash中运行make
$ make
SRCS:  programA.c programB.c programC.c programD.c

变量覆盖 override

作用是使 Makefile中定义的变量能够覆盖 make 命令参数中指定的变量

语法:

• override

目标变量

作用是使变量的作用域仅限于这个目标(target), 而不像之前例子中定义的变量, 对整个Makefile都有效.

语法:

Makefile 命令前缀

Makefile 中书写shell命令时可以加2种前缀 @ 和 -, 或者不用前缀.

3种格式的shell命令区别如下:

• 不用前缀 :: 输出执行的命令以及命令执行的结果, 出错的话停止执行
• 前缀 @ :: 只输出命令执行的结果, 出错的话停止执行
• 前缀 - :: 命令执行有错的话, 忽略错误, 继续执行

示例:
# Makefile 内容 (不用前缀)
all:
echo “没有前缀”
cat this_file_not_exist
echo “错误之后的命令” <– 这条命令不会被执行

# bash中执行 make
$ make
echo "没有前缀"             <-- 命令本身显示出来
没有前缀                    <-- 命令执行结果显示出来
cat this_file_not_exist
cat: this_file_not_exist: No such file or directory
make: *** [all] Error 1

###########################################################

# Makefile 内容 (前缀 @)
all:
    @echo "没有前缀"
    @cat this_file_not_exist
    @echo "错误之后的命令"       <-- 这条命令不会被执行

# bash中执行 make
$ make
没有前缀                         <-- 只有命令执行的结果, 不显示命令本身
cat: this_file_not_exist: No such file or directory
make: *** [all] Error 1

###########################################################

# Makefile 内容 (前缀 -)
all:
    -echo "没有前缀"
    -cat this_file_not_exist
    -echo "错误之后的命令"       <-- 这条命令会被执行

# bash中执行 make
$ make
echo "没有前缀"             <-- 命令本身显示出来
没有前缀                    <-- 命令执行结果显示出来
cat this_file_not_exist
cat: this_file_not_exist: No such file or directory
make: [all] Error 1 (ignored)
echo "错误之后的命令"       <-- 出错之后的命令也会显示
错误之后的命令              <-- 出错之后的命令也会执行

Makefile 的伪目标（.PHONY）

(1)伪目标意思是这个目标本身不代表一个文件，执行这个目标不是为了得到某个文件或东西，而是单纯为了执行这个目标下面的命令。

(2)伪目标一般都没有依赖，因为执行伪目标就是为了执行目标下面的命令。既然一定要执行命令了那就不必加依赖，因为不加依赖意思就是无条件执行。

(3)伪目标可以直接写，不影响使用；但是有时候为了明确声明这个目标是伪目标会在伪目标的前面用.PHONY来明确声明它是伪目标。

典型的伪目标是 Makefile 中用来清理编译过程中中间文件的 clean 伪目标, 一般格式如下:

.PHONY: clean   <-- 这句没有也行, 但是最好加上
clean:
    -rm -f *.o

引用其他的 Makefile

语法: include

查看C文件的依赖关系

写 Makefile 的时候, 需要确定每个目标的依赖关系.

GNU提供一个机制可以查看C代码文件依赖那些文件, 这样我们在写 Makefile 目标的时候就不用打开C源码来看其依赖那些文件了.

比如, 下面命令显示内核源码中 virt/kvm/kvm_main.c 中的依赖关系

$ cd virt/kvm/
$ gcc -MM kvm_main.c 
kvm_main.o: kvm_main.c iodev.h coalesced_mmio.h async_pf.h  <-- 这句就可以加到 Makefile 中作为编译 kvm_main.o 的依赖关系

make 退出码

Makefile的退出码有以下3种：

• 0 :: 表示成功执行
• 1 :: 表示make命令出现了错误
• 2 :: 使用了 “-q” 选项, 并且make使得一些目标不需要更新

指定 Makefile， 指定特定目标

默认执行 make 命令时, GNU make在当前目录下依次搜索下面3个文件 “GNUmakefile”, “makefile”, “Makefile”,

找到对应文件之后, 就开始执行此文件中的第一个目标(target). 如果找不到这3个文件就报错.

非默认情况下, 可以在 make 命令中指定特定的 Makefile 和特定的 目标.

示例：
# Makefile文件名改为 MyMake, 内容
target1:
@echo “target [1] begin”
@echo “target [1] end”

target2:
    @echo "target [2]  begin"
    @echo "target [2]  end"

# bash 中执行 make
$ ls
Makefile
$ mv Makefile MyMake
$ ls
MyMake
$ make                     <-- 找不到默认的 Makefile
make: *** No targets specified and no makefile found.  Stop.
$ make -f MyMake           <-- 指定特定的Makefile
target [1]  begin
target [1]  end
$ make -f MyMake target2   <-- 指定特定的目标(target)
target [2]  begin
target [2]  end

make 参数介绍

make 的参数有很多, 可以通过 make -h 去查看, 下面只介绍几个我认为比较有用的.

参数                              含义

--debug[=<options>]             输出make的调试信息, options 可以是 a, b, v
-j --jobs                       同时运行的命令的个数, 也就是多线程执行 Makefile
-r --no-builtin-rules           禁止使用任何隐含规则
-R --no-builtin-variabes        禁止使用任何作用于变量上的隐含规则
-B --always-make                假设所有目标都有更新, 即强制重编译

Makefile 隐含规则

这里只列一个和编译C相关的.

编译C时，

隐含规则中的 命令变量 和 命令参数变量

命令变量, 书写Makefile可以直接写 shell时用这些变量.

下面只列出一些C相关的

变量  名含义
RM    rm -f
AR    ar
CC    cc
CXX   g++

示例:

下面只列出一些C相关的

变量名

含义

RM  rm -f
AR  ar
CC  cc
CXX g++

命令参数变量

变量名         含义
ARFLAGS     AR命令的参数
CFLAGS      C语言编译器的参数
CXXFLAGS    C++语言编译器的参数

示例: 下面以 CFLAGS 为例演示

# test.c 内容
#include <stdio.h>

int main(int argc, char *argv[])
{
    printf ("Hello Makefile\n");
    return 0;
}

# Makefile 内容
test: test.o
    $(CC) -o test test.o

# bash 中用 make 来测试
$ ll
total 24K
-rw-r--r-- 1 wangyubin wangyubin  69 Sep 23 17:31 Makefile
-rw-r--r-- 1 wangyubin wangyubin 14K Sep 23 19:51 makefile.org   <-- 请忽略这个文件
-rw-r--r-- 1 wangyubin wangyubin 392 Sep 23 17:31 test.c

$ make
cc    -c -o test.o test.c
cc -o test test.o               <-- 这个是自动推导的

$ rm -f test test.o

$ make CFLAGS=-Wall             <-- 命令中加的编译器参数自动追加入下面的编译中了
cc -Wall   -c -o test.o test.c
cc -o test test.o

自动变量

(1)为什么使用自动变量。在有些情况下文件集合中文件非常多，描述的时候很麻烦，所以我们Makefile就用一些特殊的符号来替代符合某种条件的文件集，这就形成了自动变量。

(2)自动变量的含义：预定义的特殊意义的符号。就类似于C语言编译器中预制的那些宏FILE一样。

(3)Makefile 中很多时候通过自动变量来简化书写, 各个自动变量的含义如下:

自动变量        含义

$@         目标集合
$%         当目标是函数库文件时, 表示其中的目标文件名
$<         第一个依赖目标. 如果依赖目标是多个, 逐个表示依赖目标
$?         比目标新的依赖目标的集合
$^         所有依赖目标的集合, 会去除重复的依赖目标
$+         所有依赖目标的集合, 不会去除重复的依赖目标
$*         这个是GNU make特有的, 其它的make不一定支持

Makefile 的文件名

Makefile的文件名合法的一般有2个：Makefile或者makefile，也可以是GNUMakefile.

Makefile 中引用其他Makefile（include指令）

有时候Makefile总体比较复杂，因此分成好几个Makefile来写。然后在主Makefile中引用其他的，用include指令来引用。引用的效果也是原地展开，和C语言中的头文件包含非常相似。

Makefile 中的注释用

Makefile中注释使用#，和shell一样。

命令前面的@用来静默执行

(1)在makefile的命令行中前面的@表示静默执行。
(2)Makefile中默认情况下在执行一行命令前会先把这行命令给打印出来，然后再执行这行命令。
(3)如果你不想看到命令本身，只想看到命令执行就静默执行即可。

Makefile 中几种变量赋值运算符

(1)= 最简单的赋值

(2):= 一般也是赋值
以上这两个大部分情况下效果是一样的，但是有时候不一样。

用=赋值的变量，在被解析时他的值取决于最后一次赋值时的值，所以你看变量引用的值时不能只往前面看，还要往后面看。
用:=来赋值的，则是就地直接解析，只用往前看即可。

(3)?= 如果变量前面并没有赋值过则执行这条赋值，如果前面已经赋值过了则本行被忽略。（实验可以看出：所谓的没有赋值过其实就是这个变量没有被定义过）

(4)+= 用来给一个已经赋值的变量接续赋值，意思就是把这次的值加到原来的值的后面，有点类似于strcat。（在shell makefile等文件中，可以认为所有变量都是字符串，+=就相当于给字符串stcat接续内容）（注意一个细节，+=续接的内容和原来的内容之间会自动加一个空格隔开）

**注意：**Makefile中并不要求赋值运算符两边一定要有空格或者无空格，这一点比shell的格式要求要松一些。

Makefile 的环境变量

(1)makefile中用export导出的就是环境变量。一般情况下要求环境变量名用大写，普通变量名用小写。

(2)环境变量和普通变量不同，可以这样理解：环境变量类似于整个工程中所有Makefile之间可以共享的全局变量，而普通变量只是当前本Makefile中使用的局部变量。所以要注意：定义了一个环境变量会影响到工程中别的Makefile文件，因此要小心。

(3)Makefile中可能有一些环境变量可能是makefile本身自己定义的内部的环境变量或者是当前的执行环境提供的环境变量（譬如我们在make执行时给makefile传参。make CC=arm-linux-gcc，其实就是给当前Makefile传了一个环境变量CC，值是arm-linux-gcc。我们在make时给makefile传的环境变量值优先级最高的，可以覆盖makefile中的赋值）。这就好像C语言中编译器预定义的宏_LINE_ _FUNCTION_等一样。

Makefile 中使用通配符

(1) *       若干个任意字符
(2) ?       1个任意字符
(3) []      将[]中的字符依次去和外面的结合匹配

还有个%，也是通配符，表示任意多个字符，和*很相似，但是%一般只用于规则描述中，又叫做规则通配符。

Makefile 高级语法

嵌套Makefile

在 Makefile 初级语法中已经提到过引用其它 Makefile的方法. 这里有另一种写法, 并且可以向引用的其它 Makefile 传递参数.

示例: (不传递参数, 只是调用子文件夹 other 中的Makefile)
# Makefile 内容
all:
@echo “主 Makefile begin”
@cd ./other && make
@echo “主 Makefile end”

# ./other/Makefile 内容
other-all:
    @echo "other makefile begin"
    @echo "other makefile end"

# bash中执行 make
$ ll
total 28K
-rw-r--r-- 1 wangyubin wangyubin  104 Sep 23 20:43 Makefile
-rw-r--r-- 1 wangyubin wangyubin  17K Sep 23 20:44 makefile.org   <-- 这个文件不用管
drwxr-xr-x 2 wangyubin wangyubin 4.0K Sep 23 20:42 other
$ ll other/
total 4.0K
-rw-r--r-- 1 wangyubin wangyubin 71 Sep 23 16:11 Makefile

$ make
主 Makefile begin
make[1]: Entering directory `/path/to/test/makefile/other'
other makefile begin
other makefile end
make[1]: Leaving directory `/path/to/test/makefile/other'
主 Makefile end.

示例: (用export传递参数)

# Makefile 内容
export VALUE1 := export.c    <-- 用了 export, 此变量能够传递到 ./other/Makefile 中
VALUE2 := no-export.c        <-- 此变量不能传递到 ./other/Makefile 中

all:
    @echo "主 Makefile begin"
    @cd ./other && make
    @echo "主 Makefile end"


# ./other/Makefile 内容
other-all:
    @echo "other makefile begin"
    @echo "VALUE1: " $(VALUE1)
    @echo "VALUE2: " $(VALUE2)
    @echo "other makefile end"

# bash中执行 make
$ make
主 Makefile begin
make[1]: Entering directory `/path/to/test/makefile/other'
other makefile begin
VALUE1:  export.c        <-- VALUE1 传递成功
VALUE2:                  <-- VALUE2 传递失败
other makefile end
make[1]: Leaving directory `/path/to/test/makefile/other'
主 Makefile end

补充: export 语法格式如下:

• export variable = value
• export variable := value
• export variable += value

定义命令包

命令包有点像是个函数, 将连续的相同的命令合成一条, 减少 Makefile 中的代码量, 便于以后维护.

语法:

define <command-name>
command
...
endef

示例:

# Makefile 内容
define run-hello-makefile
@echo -n "Hello"
@echo " Makefile!"
@echo "这里可以执行多条 Shell 命令!"
endef

all:
    $(run-hello-makefile)


# bash 中运行make
$ make
Hello Makefile!
这里可以执行多条 Shell 命令!

条件判断

条件判断的关键字主要有 ifeq ifneq ifdef ifndef

语法:

<conditional-directive>
<text-if-true>
endif

# 或者
<conditional-directive>
<text-if-true>
else
<text-if-false>
endif

示例: ifeq的例子, ifneq和ifeq的使用方法类似, 就是取反

# Makefile 内容
all:
ifeq ("aa", "bb")
    @echo "equal"
else
    @echo "not equal"
endif

# bash 中执行 make
$ make
not equal

Makefile 中的函数

Makefile 中自带了一些函数, 利用这些函数可以简化 Makefile 的编写.

函数调用语法如下:

$(<function> <arguments>)
# 或者
${<function> <arguments>}

字符串函数

字符串替换函数: $(subst ,,)

功能: 把字符串

文件名函数

取目录函数: $(dir

foreach函数

语法:

$(foreach

if

这里的if是个函数, 和前面的条件判断不一样, 前面的条件判断属于Makefile的关键字

语法:

$(if

call - 创建新的参数化函数

语法:

$(call

origin - 判断变量的来源函数

语法:

$(origin

shell函数

语法:

$(shell

make 控制函数

产生一个致命错误: $(error

Makefile中一些GNU约定俗成的伪目标

如果有过在Linux上, 从源码安装软件的经历的话, 就会对 make clean, make install 比较熟悉.

像 clean, install 这些伪目标, 广为人知, 不用解释就大家知道是什么意思了.

下面列举一些常用的伪目标, 如果在自己项目的Makefile合理使用这些伪目标的话, 可以让我们自己的Makefile看起来更专业, 呵呵 :)

伪目标                     含义
all                 所有目标的目标，其功能一般是编译所有的目标
clean               删除所有被make创建的文件
install             安装已编译好的程序，其实就是把目标可执行文件拷贝到指定的目录中去
print               列出改变过的源文件
tar                 把源程序打包备份. 也就是一个tar文件
dist                创建一个压缩文件, 一般是把tar文件压成Z文件. 或是gz文件
TAGS                更新所有的目标, 以备完整地重编译使用
check 或 test        一般用来测试makefile的流程

进一步学习Makefile的资料

关于Makefile还有一些比较经典的教程，参考《跟我一起学Makefile》。

Makefile的作用和意义

• (1)工程项目中c文件太多管理不方便，因此用Makefile来做项目管理，方便编译链接过程。
• (2)uboot和linux kernel本质上都是C语言的项目，都由很多个文件组成，因此都需要通过Makefile来管理。所以要分析uboot必须对Makefile有所了解。

结语

写这篇博客一是对于《朱老师嵌入式流程核心课程》中的Makefile的一个总结，其次在网上找了一些资料，配合写出了这篇比较完整Makefile总结博客。