Makefile入门

Posted 2020-09-29 Edver

1.Makefile概述：

　　什么是makefile？或许很多Winodws的程序员都不知道这个东西，因为那些Windows的IDE都为你做了这个工作，但我觉得要作一个好的和professional的程序员，makefile还是要懂。这就好像现在有这么多的html的编辑器，但如果你想成为一个专业人士，你还是要了解HTML的标识的含义。特别在Unix下的软件编译，你就不能不自己写makefile了，会不会写makefile，从一个侧面说明了一个人是否具备完成大型工程的能力。

　　因为，makefile关系到了整个工程的编译规则。一个工程中的源文件不计数，其按类型、功能、模块分别放在若干个目录中，makefile定义了一系列的规则来指定，哪些文件需要先编译，哪些文件需要后编译，哪些文件需要重新编译，甚至于进行更复杂的功能操作，因为makefile就像一个Shell脚本一样，其中也可以执行操作系统的命令。

　　makefile带来的好处就是——“自动化编译”，一旦写好，只需要一个make命令，整个工程完全自动编译，极大的提高了软件开发的效率。make是一个命令工具，是一个解释makefile中指令的命令工具，一般来说，大多数的IDE都有这个命令，比如：Delphi的make，Visual C++的nmake，Linux下GNU的make。可见，makefile都成为了一种在工程方面的编译方法。

　　在这篇文档中，将以C/C++的源码作为我们基础，所以必然涉及一些关于C/C++的编译的知识，相关于这方面的内容，还请各位查看相关的编译器的文档。这里所默认的编译器是UNIX下的GCC和CC。

2.Makefile规则(显示规则, 隐晦规则, 变量定义, 文件指示, 注释)

 　　Makefile基本编写格式：

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

　　target：　　　　目标文件，可以是Object File，也可以是执行文件。还可以是一个标签（Label）

　　prerequisites：　要生成那个target所依赖的文件或是目标。

　　command：　　　也就是make需要执行的命令。（任意的Shell命令）

　　这是一个文件的依赖关系，也就是说，target这一个或多个的目标文件依赖于prerequisites中的文件，其生成规则定义在command中。说白一点就是说，prerequisites中如果有一个以上的文件比target文件要新的话，command所定义的命令就会被执行。这就是Makefile的规则。也就是Makefile中最核心的内容。

　　编写规则说明：

1. 显示规则 :: 说明如何生成一个或多个目标文件(包括 生成的文件, 文件的依赖文件, 生成的命令)
2. 隐晦规则 :: make的自动推导功能所执行的规则（[email protected] $* $^ ...）
3. 变量定义 :: Makefile中定义的变量
4. 文件指示 ::其包括了三个部分，一个是在一个Makefile中引用另一个Makefile，就像C语言中的include一样；另一个是指根据某些情况指定Makefile中的有效部分，就像C语言　　中的预编译#if一样；还有就是定义一个多行的命令。有关这一部分的内容，我会在后续的部分中讲述。
5. 注释     :: Makefile只有行注释 "#", 如果要使用或者输出"#"字符, 需要进行转义, "\#"

　　简单Makefile展示如下：

include ../Make.defines

PROGS =    test01            test02

all:    ${PROGS}
test01:    test01.o
        ${CC} ${CFLAGS} -o [email protected] test01.o ${LIBS}
test02:    test02.o
        ${CC} ${CFLAGS} -o [email protected] test02.o ${LIBS}
        
clean:
        rm -f ${PROGS} ${CLEANFILES}

 　　事例中几点注意如下：

　　1.首行导入了其他的Makefile相关文件，事例假定此文件为二级目录，导入文件为一级目录下的Make.define文件

　　2.第二行显示定义了变量PROGS, test01后面的 \为换行符，在参数较多时方便代码查看。

　　3.all表示一个标签，在此例中表示所有目标，即${PROGS}所指定的所有执行文件。clean同理。

　　4.命令行一定要以TAB开头（Makefile规定）

　　5.命令行定义中使用了隐晦规则，[email protected]表示目标文件，在此例中即指代test01或test02.

　　6.命令行中的变量均为Make.define文件中定义，表示编译所用的参数

3.Makefile工作方式

　　为方便说明，简化上述Makefile如下：

include ../Make.defines

test01:    test01.o
        ${CC} ${CFLAGS} -o [email protected] test01.o ${LIBS}
        
clean:
        rm -f ${PROGS} ${CLEANFILES}

　　在默认的方式下，在make命令后：

    1、make会在当前目录下找名字叫“Makefile”或“makefile”的文件。
    2、如果找到，它会找文件中的第一个目标文件（target），即显示定义的test01。他会找到“test01”这个文件，并把这个文件作为最终的目标文件。
    3、如果test01文件不存在，或是test01所依赖的后面的 .o 文件的文件修改时间要比all这个文件新，那么，他就会执行后面所定义的命令来生成test01这个文件。
    4、如果test01所依赖的.o文件也存在，那么make会在当前文件中找目标为.o文件的依赖性，如果找到则再根据那一个规则生成.o文件。（这有点像一个堆栈的过程）
    5、当然，你的C文件和H文件是存在的啦，于是make会生成 .o 文件，然后再用 .o 文件生命make的终极任务，也就是执行文件test01了。

 4.Makefile中一些杂项说明

　　4.1 文件包含

　　Makefile支持文件包含功能，类似于c/c++中的#include功能，最开始的例子已经使用，实例模型可以参考。其具体使用方法介绍如下：

　　include <filename>        #  filename可以是当前操作系统Shell的文件模式（可以保含路径和通配符）

 　　在include前面可以有一些空字符，但是绝不能是[Tab]键开始。include和<filename>;可以用一个或多个空格隔开。举个例子，你有这样几个Makefile：a.mk、b.mk、c.mk，还有一个文件叫foo.make，以及一个变量$(bar)，其包含了e.mk和f.mk，那么，下面的语句：

    include foo.make *.mk $(bar)

    等价于：

    include foo.make a.mk b.mk c.mk e.mk f.mk

　　make命令开始时，会把找寻include所指出的其它Makefile，并把其内容安置在当前的位置。就好像C/C++的#include指令一样。如果文件都没有指定绝对路径或是相对路径的话，make会在当前目录下首先寻找，如果当前目录下没有找到，那么，make还会在下面的几个目录下找：

    1、如果make执行时，有“-I”或“--include-dir”参数，那么make就会在这个参数所指定的目录下去寻找。
    2、如果目录<prefix>;/include（一般是：/usr/local/bin或/usr/include）存在的话，make也会去找。

如果有文件没有找到的话，make会生成一条警告信息，但不会马上出现致命错误。它会继续载入其它的文件，一旦完成makefile的读取，make会再重试这些没有找到，或是不能读取的文件，如果还是不行，make才会出现一条致命信息。如果你想让make不理那些无法读取的文件，而继续执行，你可以在include前加一个减号“-”。如：

    -include <filename>;
    其表示，无论include过程中出现什么错误，都不要报错继续执行。和其它版本make兼容的相关命令是sinclude，其作用和这一个是一样的。

　　4.2 几种赋值符号差异

　　Makefile中赋值符号中四种（=  ：=  ？= +=），区别如下：

　　1. = 是最基本的赋值，他会将整个Makefile展开后，将最后一个值付给变量。

　　x = foo
    y = $(x) bar
    x = xyz

    在上例中，y的值将会是 xyz bar ，而不是 foo bar 。

　　2. := 是覆盖之前的值，无需全部展开，在赋值处直接覆盖。

   x := foo
   y := $(x) bar
   x := xyz

   在上例中，y的值将会是 foo bar ，而不是 xyz bar 了。

　　3. ?= 是如果没有被赋值过就赋予等号后面的值（容易理解）
　　4. += 是添加等号后面的值（字面含义，直接追加）

　　4.3 编译参数整理

　　4.3.1： GCC参数整理：　　

　　在Makefile编译命令行中（即commend），第一个例子的${CCFLAG}. 变量中定义了一些编译器需要处理的工作（如：自动导出头文件包含 -M; 添加GDB调试：-g; 优化等级：-o ~ -o2）, gcc选项如下

　　用法：gcc [选项] 文件...
　　选项：
  　　-pass-exit-codes         在某一阶段退出时返回最高的错误码
  　　--help                   显示此帮助说明
  　　--target-help            显示目标机器特定的命令行选项
  　　(使用‘-v --help’显示子进程的命令行参数)
  　　-dumpspecs               显示所有内建 spec 字符串
  　　-dumpversion             显示编译器的版本号
  　　-dumpmachine             显示编译器的目标处理器
  　　-print-search-dirs       显示编译器的搜索路径
  　　-print-libgcc-file-name  显示编译器伴随库的名称
  　　-print-file-name=<库>    显示 <库> 的完整路径
  　　-print-prog-name=<程序>  显示编译器组件 <程序> 的完整路径
 　　 -print-multi-directory   显示不同版本 libgcc 的根目录
  　　-print-multi-lib         显示命令行选项和多个版本库搜索路径间的映射
  　　-print-multi-os-directory 显示操作系统库的相对路径
  　　-Wa,<选项>               将逗号分隔的 <选项> 传递给汇编器
 　　-Wp,<选项>               将逗号分隔的 <选项> 传递给预处理器
  　　-Wl,<选项>               将逗号分隔的 <选项> 传递给链接器

　　  -Wall 　　　　　　　　打开所有编译警告
 　　 -Xassembler <参数>       将 <参数> 传递给汇编器
 　　 -Xpreprocessor <参数>    将 <参数> 传递给预处理器
  　　-Xlinker <参数>          将 <参数> 传递给链接器
  　　-combine                 将多个源文件一次性传递给汇编器
  　　-save-temps              不删除中间文件
 　　 -pipe                    使用管道代替临时文件
  　　-time                    为每个子进程计时
  　　-specs=<文件>            用 <文件> 的内容覆盖内建的 specs 文件
 　　 -std=<标准>              指定输入源文件遵循的标准
 　　 --sysroot=<目录>         将 <目录> 作为头文件和库文件的根目录
  　　-B <目录>                将 <目录> 添加到编译器的搜索路径中
 　　 -b <机器>                为 gcc 指定目标机器(如果有安装)
 　　 -V <版本>                运行指定版本的 gcc(如果有安装)
  　　-v                       显示编译器调用的程序
  　　-###                     与 -v 类似，但选项被引号括住，并且不执行命令
  　　-E                       仅作预处理，不进行编译、汇编和链接
  　　-S                       编译到汇编语言，不进行汇编和链接
  　　-c                       编译、汇编到目标代码，不进行链接
  　　-o <文件>                输出到 <文件>
  　　-x <语言>                指定其后输入文件的语言允许的语言包括：c c++ assembler none
                           ‘none’意味着恢复默认行为，即根据文件的扩展名猜测
                           源文件的语言

　　以 -g、-f、-m、-O、-W 或 --param 开头的选项将由 gcc 自动传递给其调用的不同子进程。若要向这些进程传递其他选项，必须使用 -W<字母> 选项。

　　4.3.2: make参数整理（摘自跟我一起写Makefile）

下面列举了所有GNU make 3.80版的参数定义。其它版本和产商的make大同小异，不过其它产商的make的具体参数还是请参考各自的产品文档。

“-b”
“-m”
这两个参数的作用是忽略和其它版本make的兼容性。

“-B”
“--always-make”
认为所有的目标都需要更新（重编译）。

“-C <dir>;”
“--directory=<dir>;”
指定读取makefile的目录。如果有多个“-C”参数，make的解释是后面的路径以前面的作为相对路径，并以最后的目录作为被指定目录。如：“make –C ~hchen/test –C prog”等价于“make –C ~hchen/test/prog”。

“—debug[=<options>;]”
输出make的调试信息。它有几种不同的级别可供选择，如果没有参数，那就是输出最简单的调试信息。下面是<options>;的取值：
    a —— 也就是all，输出所有的调试信息。（会非常的多）
    b —— 也就是basic，只输出简单的调试信息。即输出不需要重编译的目标。
    v —— 也就是verbose，在b选项的级别之上。输出的信息包括哪个makefile被解析，不需要被重编译的依赖文件（或是依赖目标）等。
    i —— 也就是implicit，输出所以的隐含规则。
    j —— 也就是jobs，输出执行规则中命令的详细信息，如命令的PID、返回码等。
    m —— 也就是makefile，输出make读取makefile，更新makefile，执行makefile的信息。

“-d”
相当于“--debug=a”。

“-e”
“--environment-overrides”
指明环境变量的值覆盖makefile中定义的变量的值。

“-f=<file>;”
“--file=<file>;”
“--makefile=<file>;”
指定需要执行的makefile。

“-h”
“--help”
显示帮助信息。

“-i”
“--ignore-errors”
在执行时忽略所有的错误。

“-I <dir>;”
“--include-dir=<dir>;”
指定一个被包含makefile的搜索目标。可以使用多个“-I”参数来指定多个目录。

“-j [<jobsnum>;]”
“--jobs[=<jobsnum>;]”
指同时运行命令的个数。如果没有这个参数，make运行命令时能运行多少就运行多少。如果有一个以上的“-j”参数，那么仅最后一个“-j”才是有效的。（注意这个参数在MS-DOS中是无用的）

“-k”
“--keep-going”
出错也不停止运行。如果生成一个目标失败了，那么依赖于其上的目标就不会被执行了。

“-l <load>;”
“--load-average[=<load]”
“—max-load[=<load>;]”
指定make运行命令的负载。

“-n”
“--just-print”
“--dry-run”
“--recon”
仅输出执行过程中的命令序列，但并不执行。

“-o <file>;”
“--old-file=<file>;”
“--assume-old=<file>;”
不重新生成的指定的<file>;，即使这个目标的依赖文件新于它。

“-p”
“--print-data-base”
输出makefile中的所有数据，包括所有的规则和变量。这个参数会让一个简单的makefile都会输出一堆信息。如果你只是想输出信息而不想执行makefile，你可以使用“make -qp”命令。如果你想查看执行makefile前的预设变量和规则，你可以使用“make –p –f /dev/null”。这个参数输出的信息会包含着你的makefile文件的文件名和行号，所以，用这个参数来调试你的makefile会是很有用的，特别是当你的环境变量很复杂的时候。

“-q”
“--question”
不运行命令，也不输出。仅仅是检查所指定的目标是否需要更新。如果是0则说明要更新，如果是2则说明有错误发生。

“-r”
“--no-builtin-rules”
禁止make使用任何隐含规则。

“-R”
“--no-builtin-variabes”
禁止make使用任何作用于变量上的隐含规则。

“-s”
“--silent”
“--quiet”
在命令运行时不输出命令的输出。

“-S”
“--no-keep-going”
“--stop”
取消“-k”选项的作用。因为有些时候，make的选项是从环境变量“MAKEFLAGS”中继承下来的。所以你可以在命令行中使用这个参数来让环境变量中的“-k”选项失效。

“-t”
“--touch”
相当于UNIX的touch命令，只是把目标的修改日期变成最新的，也就是阻止生成目标的命令运行。

“-v”
“--version”
输出make程序的版本、版权等关于make的信息。

“-w”
“--print-directory”
输出运行makefile之前和之后的信息。这个参数对于跟踪嵌套式调用make时很有用。

“--no-print-directory”
禁止“-w”选项。

“-W <file>;”
“--what-if=<file>;”
“--new-file=<file>;”
“--assume-file=<file>;”
假定目标<file>;需要更新，如果和“-n”选项使用，那么这个参数会输出该目标更新时的运行动作。如果没有“-n”那么就像运行UNIX的“touch”命令一样，使得<file>;的修改时间为当前时间。

“--warn-undefined-variables”
只要make发现有未定义的变量，那么就输出警告信息。

　　4.4 Makefile规则检查

　　有时候，我们不想让我们的makefile中的规则执行起来，我们只想检查一下我们的命令，或是执行的序列。于是我们可以使用make命令的下述参数：

    “-n”
    “--just-print”
    “--dry-run”
    “--recon”
    不执行参数，这些参数只是打印命令，不管目标是否更新，把规则和连带规则下的命令打印出来，但不执行，这些参数对于我们调试makefile很有用处。

    “-t”
    “--touch”
    这个参数的意思就是把目标文件的时间更新，但不更改目标文件。也就是说，make假装编译目标，但不是真正的编译目标，只是把目标变成已编译过的状态。

    “-q”
    “--question”
    这个参数的行为是找目标的意思，也就是说，如果目标存在，那么其什么也不会输出，当然也不会执行编译，如果目标不存在，其会打印出一条出错信息。

    “-W <file>;”
    “--what-if=<file>;”
    “--assume-new=<file>;”
    “--new-file=<file>;”
    这个参数需要指定一个文件。一般是是源文件（或依赖文件），Make会根据规则推导来运行依赖于这个文件的命令，一般来说，可以和“-n”参数一同使用，来查看这个依赖文件所发生的规则命令。