第六章:Makefile中的变量


Makefile中,变量是一个名字(像是C语言中的宏),代表一个文本字符串(变量的值)。在Makefile的目标、依赖、命令中引用变量的地方,变量会被它的值所取代(与C语言中宏引用的方式相同,因此其他版本的make也把变量称之为“宏”)。在Makefile中变量有以下几个特征:

1.        Makefile中变量和函数的展开(除规则命令行中的变量和函数以外),是在make读取makefile文件时进行的,这里的变量包括了使用“=”定义和使用指示符“define”定义的。

2.        变量可以用来代表一个文件名列表、编译选项列表、程序运行的选项参数列表、搜索源文件的目录列表、编译输出的目录列表和所有我们能够想到的事物。

3.        变量名是不包括“:”、“#”、“=”、前置空白和尾空白的任何字符串。需要注意的是,尽管在GNU make中没有对变量的命名有其它的限制,但定义一个包含除字母、数字和下划线以外的变量的做法也是不可取的,因为除字母、数字和下划线以外的其它字符可能会在make的后续版本中被赋予特殊含义,并且这样命名的变量对于一些shell来说是不能被作为环境变量来使用的。

4.        变量名是大小写敏感的。变量“foo”、“Foo”和“FOO”指的是三个不同的变量。Makefile传统做法是变量名是全采用大写的方式。推荐的做法是在对于内部定义定义的一般变量(例如:目标文件列表objects)使用小写方式,而对于一些参数列表(例如:编译选项CFLAGS)采用大写方式,但这并不是要求的。但需要强调一点:对于一个工程,所有Makefile中的变量命名应保持一种风格,否则会显得你是一个蹩脚的程序员(就像代码的变量命名风格一样)。

5.        另外有一些变量名只包含了一个或者很少的几个特殊的字符(符号)。称它们为自动化变量。像“$<”、“$@”、“$?”、“$*”等。

6.1      变量的引用

当我们定义了一个变量之后,就可以在Makefile的很多地方使用这个变量。变量的引用方式是:“$VARIABLE_NAME)”或者“${ VARIABLE_NAME }”来引用一个变量的定义。例如:“$(foo) ”或者“${foo}”就是取变量“foo”的值。美元符号“$”在Makefile中有特殊的含义,所有在命令或者文件名中使用“$”时需要用两个美元符号“$$”来表示。对一个变量的引用可以在Makefile的任何上下文中,目标、依赖、命令、绝大多数指示符和新变量的赋值中。这里有一个例子,其中变量保存了所有.o文件的列表:

 

objects = program.o foo.o utils.o

program : $(objects)

cc -o program $(objects)

 

$(objects) : defs.h

 

变量引用的展开过程是严格的文本替换过程,就是说变量值的字符串被精确的展开在变量被引用的地方。因此规则:

 

foo = c

prog.o : prog.$(foo)

$(foo) $(foo) -$(foo) prog.$(foo)

 

被展开后就是:

 

prog.c : prog.c

cc -c prog.c

 

通过这个例子会发现变量的展开过程和c语言中的宏展开的过程相同,是一个严格的文本替换过程。上例中变量“foo”被展开的过程中,变量值中的前导空格会忽略。举这个例子的目的是为了让我们更清楚地了解变量的展开过程,而不是建议大家按照这样的方式来书写Makefile。在实际书写时,最好不要这么干。否则将会给你带来很多不必要的麻烦。

注意:Makefile中在对一些简单变量的引用,我们也可以不使用“()”和“{}”来标记变量名,而直接使用“$x”的格式来实现,此种用法仅限于变量名为单字符的情况。另外自动化变量也使用这种格式。对于一般多字符变量的引用必须使用括号了标记,否则make将把变量名的首字母作为作为变量而不是整个字符串(“$PATH”在Makefile中实际上是“$(P)ATH”)。这一点和shell中变量的引用方式不同。shell中变量的引用可以是“${xx}”或者“$xx”格式。但在Makefile中多字符变量名的引用只能是“$(xx)”或者“${xx}”格式。

 

一般在我们书写Makefile时,各部分变量引用的格式我们建议如下:

1.        make变量(Makefile中定义的或者是make的环境变量)的引用使用“$(VAR)”格式,无论“VAR”是单字符变量名还是多字符变量名。

2.        出现在规则命令行中shell变量(一般为执行命令过程中的临时变量,它不属于Makefile变量,而是一个shell变量)引用使用shell的“$tmp”格式。

3.        对出现在命令行中的make变量我们同样使用“$(CMDVAR) 格式来引用。

 

例如:

# sample Makefile

……

SUBDIRS := src foo

 

.PHONY : subdir

Subdir :

             @for dir in $(SUBDIRS); do  \

                    $(MAKE) –C $$dir || exit 1; \

       done

……

6.2      两种变量定义(赋值)

GNU make中,变量的定义有两种方式(或者称为风格)。我们把使用这两种方式定义的变量可以看作变量的两种不同风格。变量的这两种不同的风格的区别在于:1. 定义方式;2. 展开时机。下边我们分别对这两种不同的风格进行详细地讨论。

6.2.1       递归展开式变量

第一种风格的变量是递归方式扩展的变量。这一类型变量的定义是通过“=”或者使用指示符“define”定义的。这种变量的引用,在引用的地方是严格的文本替换过程,此变量值的字符串原模原样的出现在引用它的地方。如果此变量定义中存在对其他变量的引用,这些被引用的变量会在它被展开的同时被展开。就是说在变量定义时,变量值中对其他变量的引用不会被替换展开;而是变量在引用它的地方替换展开的同时,它所引用的其它变量才会被一同替换展开。语言的描述可能比较晦涩,让我们来看一个例子:

 

foo = $(bar)

bar = $(ugh)

ugh = Huh?

 

all:;echo $(foo)

 

执行“make”将会打印出“Huh?”。整个变量的替换过程时这样的:首先“$(foo)”被替换为“$(bar)”,接下来“$(bar)”被替换为“$(ugh)”,最后“$(ugh)”被替换为“Hug?”。整个替换的过程是在执行“echo $(foo)”时完成的。

这种类型的变量是其它版本的make所支持的类型。我们可以把这种类型的变量称为“递归展开”式变量。此类型变量存有它的优点同时也存在其缺点。其优点是:

这种类型变量在定义时,可以引用其它的之前没有定义的变量(可能在后续部分定义,或者是通过make的命令行选项传递的变量)。看一个这样的例子:

 

CFLAGS = $(include_dirs) -O

include_dirs = -Ifoo -Ibar

 

CFLAGS”会在命令中被展开为“-Ifoo -Ibar -O”。而在“CFLAGS”的定义中使用了其后才定义的变量“include_dirs”。

其缺点是:

1.        使用此风格的变量定义,可能会由于出现变量的递归定义而导致make陷入到无限的变量展开过程中,最终使make执行失败。例如,接上边的例子,我们给这个变量追加值:

 

CFLAGS = $(CFLAGS) –O

 

它将会导致make对变量“CFLAGS”的无限展过程中去(这种定义就是变量的递归定义)。因为一旦后续同样存在对“CLFAGS”定义的追加,展开过程将是套嵌的、不能终止的(在发生这种情况时,make会提示错误信息并结束)。一般书写Makefile时,这种追加变量值的方法很少使用(也不是我们推荐的方式)。看另外一个例子:

 

x = $(y)

y = $(x) $(z)

 

这种情况下变量在进行展开时,同样会陷入死循环。所以对于此风格的变量,当在一个变量的定义中需要引用其它的同类型风格的变量时需特别注意,防止变量展开过程的死循环。

2.        第二个缺点:这种风格的变量定义中如果使用了函数,那么包含在变量值中的函数总会在变量被引用的地方执行(变量被展开时)。

这是因为在这种风格变量的定义中,对函数引用的替换展开发生在变量展开的过程中,而不是在定义这个变量的时候。这样所带来的问题是:使make的执行效率降低(每一次在变量被展开时都要展开他所引用的函数);另外在某些时候会出现一些变量和函数的引用出现非预期的结果。特别是当变量定义中引用了“shell”和“wildcard”函数的情况,可能出现不可控制或者难以预料的错误,因为我们无法确定它在何时会被展开。

6.2.2       直接展开式变量

为了避免“递归展开式”变量存在的问题和不方便。GNU make支持另外一种风格的变量,称为“直接展开”式。这种风格的变量使用“:=”定义。在使用“:=”定义变量时,变量值中对其他量或者函数的引用在定义变量时被展开(对变量进行替换)。所以变量被定义后就是一个实际需要的文本串,其中不再包含任何变量的引用。因此

 

x := foo

y := $(x) bar

x := later

   

就等价于:

 

y := foo bar

x := later

 

和递归展开式变量不同:此风格变量在定义时就完成了对所引用变量和函数的展开,因此不能实现对其后定义变量的引用。如:

 

CFLAGS := $(include_dirs) -O

include_dirs := -Ifoo -Ibar

由于变量“include_dirs”的定义出现在“CFLAGS”定义之后。因此在“CFLAGS”的定义中,“include_dirs”的值为空。“CFLAGS”的值为“-O”而不是“-Ifoo -Ibar -O”。这一点也是直接展开式和递归展开式变量的不同点。注意这里的两个变量都是“直接展开”式的。大家不妨试试将其中某一个变量使用递归展开式定义后看一下又会出现什么样的结果。

下边我们来看一个复杂一点的例子。分析一下直接展开式变量定义(:=)的用法,这里也用到了makeshell函数和变量“MAKELEVEL”(此变量在make的递归调用时代表make的调用深度)。

其中包括了对函数、条件表达式和系统变量“MAKELEVEL”的使用:

 

ifeq (0,${MAKELEVEL})

cur-dir   := $(shell pwd)

whoami  := $(shell whoami)

host-type := $(shell arch)

MAKE := ${MAKE} host-type=${host-type} whoami=${whoami}

endif

 

第一行是一个条件判断,如果是顶层Makefile,就定义下列变量。否则不定义任何变量。第二、三、四、五行分别定义了一个变量,在进行变量定义时对引用到的其它变量和函数展开。最后结束定义。利用直接展开式的特点我们可以书写这样一个规则:

 

${subdirs}:

${MAKE} cur-dir=${cur-dir}/$@ -C $@ all

 

它实现了在不同子目录下变量“cur_dir”使用不同的值(为当前工作目录)。

在复杂的Makefile中,推荐使用直接展开式变量。因为这种风格变量的使用方式和大多数编程语言中的变量使用方式基本上相同。它可以使一个比较复杂的Makefile在一定程度上具有可预测性。而且这种变量允许我们利用之前所定义的值来重新定义它(比如使用某一个函数来对它以前的值进行处理并重新赋值),此方式在Makefile中经常用到。尽量避免和减少递归式变量的使用。

6.2.3       如何定义一个空格

使用直接扩展式变量定义我们可以实现将一个前导空格定义在变量值中。一般变量值中的前导空格字符在变量引用和函数调用时被丢弃。利用直接展开式变量在定义时对引用的其它变量或函数进行展开的特点,我们可以实现在一个变量中包含前导空格并在引用此变量时对空格加以保护。像这样:

 

nullstring :=

space := $(nullstring) # end of the line

 

这里,变量“space”就表示一个空格。在“space”定义行中的注释使得我们的目的更清晰(明确地描述一个空格字符比较困难),注释和变量引用“$(nullstring)”之间存在一个空格。通过这种方式我们就明确的指定了一个空格。这是一个很好地实现方式。通过引用变量“nullstring”标明变量值的开始,采用“#”注释来结束,中间是一个空格字符。

make对变量进行处理时变量值中尾空格是不被忽略的,因此定义一个包含一个或者多个空格的变量定义时,上边的实现就是一个简单并且非常直观的方式。但是需要注意:当定义不包含尾空格的变量时,就不能使用这种方式,将变量定义和注释书写在同一行并使用若干空格分开。否则,注释之前的空格会被作为变量值的一部分。例如下边的做法就是不正确的:

 

dir := /foo/bar    # directory to put the frobs in

 

变量“dir”的值是“/foo/bar    ”(后面有4个空格),这可能并不是想要实现的。如果一个文件以它作为路径来表示“$(dir)/file”,那么大错特错了。

在书写Makefile时。推荐将注释书写在独立的行或者多行,防止出现上边例子中的意外情况,而且将注释书写在独立的行也使得Makefile清晰,便于阅读。对于特殊的定义,比如定义包含一个或者多个空格空格的变量时进行详细地说明和注释。

6.2.4       ?=”操作符

GNU make中,还有一个被称为条件赋值的赋值操作符“?=”。被称为条件赋值是因为:只有此变量在之前没有赋值的情况下才会对这个变量进行赋值。例如:

FOO ?= bar

 

其等价于:

ifeq ($(origin FOO), undefined)

FOO = bar

endif

 

含义是:如果变量“FOO”在之前没有定义,就给它赋值“bar”。否则不改变它的值。

6.3      变量的高级用法

本节讨论关于变量的高级用法,这些高级的用法使我们可以更灵活的使用变量。

6.3.1       变量的替换引用

对于一个已经定义的变量,可以使用“替换引用”将其值中的后缀字符(串)使用指定的字符(字符串)替换。格式为“$(VAR:A=B)”(或者“${VAR:A=B}”),意思是,替换变量“VAR”中所有“A”字符结尾的字为“B”结尾的字。“结尾”的含义是空格之前(变量值多个字之间使用空格分开)。而对于变量其它部分的“A”字符不进行替换。例如:

 

foo := a.o b.o c.o

bar := $(foo:.o=.c)

 

在这个定义中,变量“bar”的值就为“a.c b.c c.c”。使用变量的替换引用将变量“foo”以空格分开的值中的所有的字的尾字符“o”替换为“c”,其他部分不变。如果在变量“foo”中如果存在“o.o”时,那么变量“bar”的值为“a.c b.c c.c o.c”而不是“a.c b.c c.c c.c”。

变量的替换引用其实是函数“patsubst”的一个简化实现。在GNU make中同时提供了这两种方式来实现同样的目的,以兼容其它版本make

另外一种引用替换的技术使用功能更强大的“patsubst”函数。它的格式和上面“$(VAR:A=B)”的格式相类似,不过需要在“A”和“B”中需要包含模式字符“%”。这时它和“$(patsubst A,B $(VAR))所实现功能相同。例如:

 

foo := a.o b.o c.o

bar := $(foo:%.o=%.c)

 

这个例子同样使变量“bar”的值为“a.c b.c c.c”。这种格式的替换引用方式比第一种方式更通用。

6.3.2       变量的套嵌引用

计算的变量名是一个比较复杂的概念,仅用在那些复杂的Makefile中。通常我们不需要对它的计算过程进行深入地了解,只要知道当一个被引用的变量名之中含有“$”时,可得到另外一个值。如果您是一个比较喜欢追根问底的人,或者想弄清楚make计算变量的过程。那么就可以参考本节的内容。

一个变量名(文本串)之中可以包含对其它变量的引用。这种情况我们称之为“变量的套嵌引用”或者“计算的变量名”。先看一个例子:

 

x = y

y = z

a := $($(x))

 

这个例子中,最终定义了“a”的值为“z”。来看一下变量的引用过程:首先最里边的变量引用“$(x)”被替换为变量名“y”(就是“$($(x))”被替换为了“$(y)”),之后“$(y)”被替换为“z”(就是a := z)。这个例子中(a:=$($(x)))所引用的变量名不是明确声明的,而是由$(x)扩展得到。这里“$(x)”相对于外层的引用就是套嵌的变量引用。

上个例子我们看到是一个两层的套嵌引用的例子,具有多层的套嵌引用在Makefile中也是允许的。下边我们在来看一个三层套嵌引用的例子:

 

x = y

y = z

z = u

a := $($($(x)))

 

这个例子最终是定义了“a”的值为“u”。它的扩展过程和上边第一个例子的过程相同。首先“$(x)”被替换为“y”,则“$($(x))”就是“$(y)”,“$(y)”再被替换为“z”,所以就有“a:=$(z)”;“$(z)”最后被替换为“u”。

以上两个套嵌引用的例子中没有用到递归展开式变量的特点。递归展开式变量的变量名的计算过程,也是按照相同的方式被扩展的。例如:

 

x = $(y)

y = z

z = Hello

a := $($(x))

 

此例最终实现了“a:=Hello”这么一个定义。这里$($(x))被替换成了$($(y)),因为$(y)值是“z”,所以,最终结果是:a:=$(z),也就是“Hello”。

递归变量的套嵌引用过程,也可以包含变量的修改引用和函数调用。看下边的例子,其中使用了make的文本处理函数:

 

x = variable1

variable2 := Hello

y = $(subst 1,2,$(x))

z = y

a := $($($(z)))

 

此例同样的实现“a:=Hello”。“$($($(z)))”首先被替换为“$($(y))”,之后再次被替换为“$($(subst 1,2,$(x)))”(“$(x)”的值是“variable1”,所以有“$($(subst 1,2,$(variable1)))”)。函数处理之后为“$(variable2)”。之后对它在进行替换展开。最终,变量“a”的值就是“Hello”。从上边的例子中我们看到,计算的变量名的引用过程存在多层套嵌,也使用了文本处理函数。这个复杂的计算变量的过程,会使很多人感到混乱甚至迷惑。上例中所要实现的目的就没有直接使用“a:=Hello”来的直观。在书写Makefile时,应尽量避免使用套嵌的变量引用。在一些必需的地方,也最好不要使用高于两级的套嵌引用。使用套嵌的变量引用时,如果涉及到递归展开式变量的引用时需要特别注意。一旦处理不当就可能导致递归展开错误,从而导致难以预料的结果。

一个计算的变量名可以不是对一个完整、单一的其他变量的引用。其中可以包含多个变量的引用,也可以包含一些文本字符串。就是说,计算变量的名字可以由一个或者多个变量引用同时加上字符串混合组成。例如:

 

a_dirs := dira dirb

1_dirs := dir1 dir2

 

a_files := filea fileb

1_files := file1 file2

 

ifeq "$(use_a)" "yes"

a1 := a

else

a1 := 1

endif

 

ifeq "$(use_dirs)" "yes"

df := dirs

else

df := files

endif

 

dirs := $($(a1)_$(df))

 

这个例子对变量“dirs”进行定义,变量的可能取值为“a_dirs”、“1_dirs”、“a_files”和“a_files”四个之一,具体依赖于“use_a”和“use_dirs”的定义。

计算的变量名也可以使用上一小节我们讨论过的“变量的替换引用”。例如:

 

a_objects := a.o b.o c.o

1_objects := 1.o 2.o 3.o

 

sources := $($(a1)_objects:.o=.c)

 

这个例子实现了变量“sources”的定义,它的可能取值为“a.c b.c c.c”和“1.c 2.c 3.c”,具体依赖于“a1”的定义。大家自己分析一下计算变量名的过程。

使用嵌套的变量引用的唯一限制是,不能通过指定部分需要调用的函数名称(调用的函数包括了函数名本身和执行的参数)来实现对这个函数的调用。这是因为套嵌引用在展开之前已经完成了对函数名的识别测试。我们来看一个例子,此例子试图将函数执行的结果赋值给一个变量:

 

ifdef do_sort

func := sort

else

func := strip

endif

 

bar := a d b g q c

 

foo := $($(func) $(bar))

 

此例的本意是将“sort”或者“strip”(依赖于是否定义了变量“do_sort”)以“a d b g q c”的执行结果赋值变量“foo”。在这里使用了套嵌引用方式来实现,但是本例的结果是:变量“foo”的值为字符串“sort a d b g q c”或者“strip a d g q c”。这是目前版本的make在处理套嵌变量引用时的限制。

计算的变量名可以用在:1. 一个使用赋值操作符定义变量的左值部分;2. 使用“define”定义的变量名中。例如:

 

dir = foo

$(dir)_sources := $(wildcard $(dir)/*.c)

define $(dir)_print

lpr $($(dir)_sources)

endef

 

在这个例子中我们定义了三个变量:“dir”,“foo_sources”和“foo_print”。

计算的变量名在进行替换时的顺序是:从最里层的变量引用开始,逐步向外进行替换。一层层展开直到最后计算出需要应用的具体的变量,之后进行替换展开得到实际的引用值。

变量的套嵌引用(计算的变量名)在我们的Makefile中应该尽量避免使用。在必需的场合使用时掌握的原则是:套嵌使用的层数越少越好,使用多个两层套嵌引用代替一个多层的套嵌引用。如果在你的Makefile中存在一个层次很深的套嵌引用。会给其他人阅读造成很大的困难。而且变量的多级套嵌引用在某些时候会使简单问题复杂化。

作为一个优秀的程序员,在面对一个复杂问题时,应该是寻求一种尽可能简单、直接并且高效的处理方式来解决,而不是将一个简单问题在实现上复杂化。如果想在简单问题上突出自己使用某种语言的熟练程度,是一种非常愚蠢、且不成熟的行为。

注意:

套嵌引用的变量和递归展开的变量在本质上存在区别。套嵌的引用就是使用一个变量表示另外一个变量,或者更多的层次;而递归展开的变量表示当一个变量存在对其它变量的引用时,对这变量替换的方式。递归展开在另外一个角度描述了这个变量在定义是赋予它的一个属性或者风格。并且我们可以在定义个一个递归展开式的变量时使用套嵌引用的方式,但是建议你的实际编写Makefile时要尽量避免这种复杂的用法。

6.4      变量取值

一个变量可以通过以下几种方式来获得值:

²       在运行make时通过命令行选项来取代一个已定义的变量值。

²       makefile文件中通过赋值的方式或者使用“define”来为一个变量赋值。

²       将变量设置为系统环境变量。所有系统环境变量都可以被make使用。

²       自动化变量,在不同的规则中自动化变量会被赋予不同的值。它们每一个都有单一的习惯性用法。

²       一些变量具有固定的值。

6.5      如何设置变量

Makefile中变量的设置(也可以称之为定义)是通过“=”(递归方式)或者“:=”(静态方式)来实现的。“=”和“:=”左边的是变量名,右边是变量的值。下边就是一个变量的定义语句:

 

objects = main.o foo.o bar.o utils.o

 

这个语句定义了一个变量“objects”,其值为一个.o文件的列表。变量名两边的空格和“=”之后的空格在make处理时被忽略。

使用“=”定义的变量称之为“递归展开”式变量;使用“:=”定义的变量称为“直接展开”式变量,“直接展开”式的变量如果其值中存其他变量或者函数的引用,在定义时这些引用将会被替换展开。

定义一个变量时需要明确以下几点:

1.        变量名之中可以包含函数或者其它变量的引用,make