Make Cheatsheet

Posted on In Views: Disqus: 
1
2
3
4
target ... : prerequisites ...
  recipe
  ...
  ...
  • target … 说明在一条规则里 target 可以有多个
  • prerequisites 可以为空
  • recipe 可以为空, 这时 make 相应的 target 会提示
    • Nothing to be done for 'target'.
    • 可以通过 ; 分号显示地指出 recipe 是空
      • target: ;
  • 如果 make 命令行没有指定任何目标，make 会将 Makefile 里解析出来的第一个目标作为默认目标

Make 基本原理

Static Pattern Rules

1
2
3
targets ...: target-pattern: prereq-patterns ...
  recipe
  ...

Static Pattern Rules vs. Implicit Rules

1
2
3
target-pattern : prereq-patterns
  recipe
  ...

Make 常用参数

-d, --debug=FLAGS

  • 所有支持的 FLAGS (多个 flags 用, 分开)
  • Debug Level Specification (GNU Make 4.3)
标志 名称 功能描述
a All 启用所有调试输出（等效于单独使用 -d）
b Basic 基本调试：显示目标重建决策、过期检查等核心信息
v Verbose 详细模式：比 b 更详细的执行信息
i Implicit 隐式规则：显示隐式规则搜索/应用过程
j Jobs 作业控制：输出子进程执行细节（命令/PID/退出码）
m Makefile Makefile 处理：跟踪 include/重解析过程
r Remaking 重制检查：显示 makefile 自身的重制决策
n None 禁用所有调试（特殊用途）

Make 常用变量

Make 变量赋值操作符

1
2
3
4
5
6
7
immediate = deferred
immediate ?= deferred
immediate := immediate
immediate ::= immediate
immediate :::= immediate-with-escape
immediate += deferred or immediate
immediate != immediate
  • != 用于将 shell 命令执行的结果赋给变量，等价于 variable := $(shell shell_cmd)

MAKECMDGOALS

表示执行 make 命令时用户给入的 targets, 这里执行 make 命令时 不仅包括从终端命令行执行 make, 也包括在 Makefile 规则里执行 make -f ...

1
$(info $(MAKECMDGOALS))

如果执行 make, 它不会打印任何东西，但如果执行 make all, 它的输出是 all

MAKEFILE_LIST

被 make 解析过的所有 Makefile 文件名列表，按照解析的先后顺序由左到右罗列。如果当前的 Makefile 里使用了 include, 如 include inc.mk, 那么 inc.mk 就会成为这个列表的最后一个。注意它是文件名列表，不是文件路径列表

CURDIR

Makefile 所在的目录的绝对路径

1
$(info $(CURDIR))

如果这个 Makefile 位于 /home/luc/gh/Makefile, 它打印的就是 /home/luc/gh

Make 常用函数

info, error, warning

  • 原型
    1
    2
    3
    $(info text...)
    $(error text...)
    $(warning text...)
    • 这3个函数被放在 GNU Make 官方文件 8.13 Functions That Control Make 章节，这里把它们放在常用函数最前面，是因为它们对于验证调试 Makefile 非常有用
    • $(info text...) 相当于 printf()
    • $(error text...) 相当于 assert(0)
    • info 和 warning 的区别是前者打印在 stdout, 后者打印在 stderr
    • 原样打印，不支持转义字符如 \n
    • info, warning, error 函数打印调试 makefile 之所以比在规则里使用 echo 方便，是因为它们作为内置函数可以在 makefile 的任何地方单独出现，而不像 echo 只能在规则里出现
    • make 里的函数也会展开 expansion, 相当于 make 函数都有返回值，info, warning 函数展开后都是空字串

dir, notdir

  • 原型
    1
    2
    $(dir names...)
    $(notdir names...)
    • 这两个内置函数被放在 GNU Make 官方文档 8.3 Functions for File Names 章节的头两个，可见它们的使用之多。这一章节的函数都是专门用来拆分文件路径的。
    • $(dir names...) 只取出后面文件路径(或文件路径列表)的目录部分, 相当于 shell 里的 dirname
    • $(notdir names...) 只取出后面文件路径(或文件路径列表)的文件名部分, 相当于 shell 里的 basename
    • 举个例子 Linux kernel scripts/Kbuild.include 中 dot-target 定义的例子:
      • `dot-target = $(dir @).@).(notdir $@)
      • 这个 dot-target 其实就是把 foo/bar.o 变成 foo/.bar.o

filter, filter-out

  • 原型
    1
    2
    $(filter pattern...,text)
    $(filter-out pattern...,text)
    • filter 函数返回 text 中所有匹配 pattern... 的单词
    • pattern... 表示可以提供多个用空白分隔的 pattern
    • filter-out 是返回那些不匹配的，即它的结果与 filter 正好相反

foreach

  • 原型
    1
    $(foreach var, list, text)
    • expansion 时机：var, list 在一开始就展开，而 text 是在后面才展开
    • list 是一个空白分隔的字符串
    • text 的多次展开也被空白连接成一整个长字符串

if

  • 原型
    1
    $(if condition, then-part[, else-part])
    • 如果 condition 展开后是 非空字串non-empty string, 则为真，如果是空字串，则执行 else-part(如果有的话)
    • then-part 和 else-part 永远只能有一个被求值 (evaluated)
    • if 函数同样有返回值，条件真时，返回 then-part 的求值结果; 条件假时，返回 else-part 的求值结果, 如果没有 else-part, 返回空字串

or, and

  • 原型
    1
    2
    $(or condition1[,condition2[,condition3...]]）
    $(and condition1[,condition2[,condition3...]]）
    • 短路或(short-circuiting OR)(不是骂人🐶), 即一个挨一个展开 condition, 只要遇到一个展开为非空字串，就停止，这个函数返回的就是展开的那个字串，如果所有 condition 展开都是空，则返回空字串
    • 短路与(short-circuiting AND), 即一个挨一个展开 condition, 只要遇到一个展开为空字串，就停止，这个函数返回的就是空字串，如果所有 condition 展开都是非空字串，返回最后一个字串
    • condition 可以有 1 到 n 个

origin

  • 原型
    1
    $(origin variable)
    • variable 不需要加 $ 符号
    • 它的功能类似 shell 里的 which 或 type (告诉你一个命令是不是 shell 内置命令)
    • 它的返回值有以下这些(都是字串)
      • undefined
      • default
      • environment
      • environment override
      • file
      • command line
      • override
      • automatic

用户自定义函数

像其它语言一样，在 Makefile 里也可以自己定义函数， 例如

1
rust_exports = $(NM) -p --defined-only $(1) | awk '$$2~/(T|R|D|B)/ && $$3!~/__(pfx|cfi|odr_asan)/ { printf $(2),$$3 }'

如何调用它

1
$(call rust_exports,$<,"EXPORT_SYMBOL_RUST_GPL(%s);\n")
  • 调用自定义函数使用 Make 内置函数 $(call variable,param,param,...)
  • 在这个例子里，第1个实参是 $<, 第2个实参是一个字符串，实际上是 awk printf 函数接受的格式字符串(format string)

函数 例2

1
2
3
if_makefile_exists = $(if $(if-exist-cond),$(cmd),@：)
if-exist-cond = $(wildcard $(1)/Makefile)
cmd = make -C $(1) $(2)
  • if_makefile_exists 函数接受两个参数，
    • 参数1：目录名
    • 参数2：Target
  • 功能是如果参数1指定的目录下存在 Makefile, 则构建参数2指定的目标，否则什么都不做(@:)
  • 调用方法：$(call if_makefile_exists,images/dot,all)

递归函数

1
rwildcard = $(foreach d,$(wildcard $1*),$(call rwildcard $d/,$(2)) $(filter $(subst *,%,$(2)),$d))
  • rwildcard 即 recursive wildcard, 相当于 find, 调用方法 $(call rwildcard,$(A_PATH)/,*.c), 找出 $(A_PATH) 目录下的所有 .c 文件，效果相当于 $(shell find $(A_PATH) -name '*.c' --type f)

Make 替换引用 (substitution reference)

  • 基本语法 $(VAR:OLD=NEW)

  • 例1: 替换

    1
    2
    SRCS := foo.c bar.c
    OBJS := $(SRCS:.c=.o)

  • 例2: 引用。% 作为占位符, 代表原始变量

    1
    2
    dirs := src include
    dirs := $(dirs:%=/%)

  • 例3: 引用。% 可以省略

    1
    2
    names := a b c
    files := $(names:=file)

Make 用户手册