GNU/Make笔记(一)——编写Makefile

背景

目标

如果我们希望用C语言实现判断一个从外部输入的正整数a是否是质数的程序(要求a小于一预设值intmax)，那么我们需要在程序中实现以下功能：

• 读取外部输入a，并判断a是否为整数且小于intmax；

• 求不大于a的平方根的正整数b；

• 判断是否存在小于等于b且不等于1的整数c能整除a。若存在，则a为合数，否则为质数。

实现

上述功能由三个函数实现，分别保存在三个.c文件中，由main.c中main()统一调用。各函数功能见表格，具体代码见最后一节附录。通过编译.c产生.o文件，然后将所有.o链接起来，产生可执行程序prime。注意到这里需要math.h中的函数sqrt，因此需要用-lm链接数学库。

GNU/Make基本

什么是make

比较大的工程通常包含很多源文件，需要逐个编译并链接才能得到目标执行程序。手动编译和链接不仅操作麻烦，每次链接时还要重新输入所有目标文件以及需要的函数库，浪费时间精力。make是一种帮助我们自动编译与构建大型工程的工具。通过将规则（rule）写入Makefile文件，make就会根据规则中的依赖关系逐层编译目标文件，最后链接得到执行程序。make在Linux上的标准实现是GNU/Make，以下所有make指令均为GNU make。

事实上，除了编译程序外，make也可以帮助我们完成其他的工作，具体内容由规则决定。

规则

make需要Makefile来告诉它以什么样的顺序去编译和链接程序。Makefile中最核心的概念是规则，一个Makefile里可以包含多个规则。规则一般写成如下形式

[目标文件]: [前提文件]
    [命令 1]
    ...
    [命令 n]

其中

• 目标文件（Target）可以是一个.o文件，或者可执行程序，也可以仅仅是一个标签（比如clean目标是清除所以已编译的.o文件和可执行程序）。

• 前提文件（Prerequisites）是完成该目标所需要的文件或者目标。目标文件和前提文件之间用冒号分开。命令（Command）为该目标下执行的Shell命令，必须用Tab对命令缩进。这一系列命令统一称为规则的recipe。如果你不喜欢用Tab缩进，那么需要修改.RECIPEPREFIX换成你想要的符号。比如

  .RECIPEPREFIX := : all: :@echo "Recipe prefix symbol set to $(.RECIPEREFIX)"

make运行机制

在命令行输入make后,一般会按次序发生以下事件：

1. make在当前文件夹下搜索Makefile和makefile（GNU make还会包括GNUmakefile）文件并读取。搜寻顺序是GNUmakefile、makefile、Makefile，先找到哪个文件读哪个；

2. 找到Makefile后，读取Makefile中include包含的文件；

3. 初始化变量值，展开所有需要立即展开的变量；

4. 以第一个规则中的目标作为最终目标，根据最终目标以及依赖关系，建立依赖关系列表；

5. 执行除最终目标以外的所有目标的规则：规则中前提文件不存在，或者前提文件比目标文件新，则执行规则下的命令重建目标；

6. 执行最终目标所在规则。

Makefile具体写法

接下来以构造可执行程序prime为例，讲解Makefile的写法和make的运行。

最直接的Makefile

prime: read_a.o isqrt.o judge_p.o main.o
    gcc -o prime read_a.o isqrt.o main.o judge_p.o -lm

read_a.o: read_a.c
    gcc -c read.c

isqrt.o: isqrt.c
    gcc -c isqrt.c

judge_p.o: judge_p.c
    gcc -c judge_p.c

main.o: main.c
    gcc -c main.c

clean:
    rm -f prime read_a.o isqrt.o judge_p.o  main.o

此时在命令行输入

make

即可编译所有.o文件和prime。基本流程是：

1. 确定最终目标”prime”，确认前提文件.o是否存在；

2. 初始时.o文件均未编译，因此make搜寻以read.o为目标的规则。这一规则只依赖于read_a.c，而read_a.c存在，因而执行该规则内的指令gcc -c read_a.c, 编译得到read_a.o；

3. 同上，编译isqrt.o, judge_p.o和main.o；

4. .o全部编译完成后，回到prime目标执行链接的命令，产生可执行程序prime。

注意，make只会执行第一个规则，如果把prime放到后面，那么make将只会编译read_a.c，此时需要输入

make prime

在make后加上-d选项，可以查看make运行的具体流程

make -d

改进Makefile

定义显式变量

在Makefile中定义变量objects

objects = read_a.o isqrt.o judge_p.o main.o

用$()展开objects可以得到所有目标。

利用预定义隐式规则

make对一系列程序的编译预定义了隐式规则，例如C程序编译的隐式规则为

$(CC) -c main.c $(CFLAGS) $(CPPFLAGS)

且自动包含.c文件为前提文件。其中CC,CFLAGS和CPPFLAGS是make针对C程序编译的内建变量，其他的还有CXX,FC,FFLAGS,LDFLAGS等等。因此Makefile可以进一步简化为

objects = read_a.o isqrt.o judge_p.o main.o

prime: $(objects)
    gcc -o prime $(objects) -lm

.PHONY: clean
clean:
    rm -f prime $(objects)

事实上在main.o中我们省去了prime.h，这是因为它被包含在main.c中，make会将其自动加入前提文件。从而显式规则只剩下以prime和clean为目标的规则。

这里用.PHONY声明伪规则（Phony rules），里面包含clean，以避免执行make时以clean作为最终目标。在这里并不是必要的，因为第一个目标是prime。但当工程较大、规则较多较杂时，声明伪规则可以避免不必要的问题。

修改内置变量

CC,CFLAGS,CXX,FC,FFLAGS,LDFLAGS等等是make中内置的变量，在隐式规则中使用。我们同样可以修改它们，配合%匹配来自定义程序编译的隐式规则。例如在makefile.include里面定义

CC = icc
CFLAGS = -Wall -g
LDFLAGS = -lm

此时.o文件的隐式规则中执行的命令实际就变成了

icc -c -o main.o main.c -Wall -g

在目标prime的规则中，用$(LDFLAGS)变量来包含数学库，编译器$CC

prime:
    $(CC) -o prime $(objects) $(CFLAGS) $(LDFLAGS)

模式规则

我们看到对于.o文件我们可以利用隐式规则来编译，但是当我们需要使用比较复杂的编译选项时，隐式规则就不适用了。此时可以利用%进行模式匹配来定义隐式规则，如prime.h在include文件夹内，需要用-I选项将该文件夹加入头文件搜索路径

INC= -I./include
%.o: %.c
    $(CC) -c -o [email protected] $< $(CFLAGS) $(INC)

其中%.o: %.c等价于以stem.c为前提产生目标文件stem.o。这样的规则称为模式规则(Pattern
rule)。我们可以用这种方法自定义执行命令，使之符合我们的需求。

自动变量

上面的命令中用到的[email protected]和$<是make的一个特殊功能，称为自动变量（automatic variable）。make中常用的自动变量见下表

通配符

包括一般的Shell通配符, 如*,?,[],[!]。例如clean目标中

clean:
    rm -f prime *.o

此外更为常用的通配符是wildcard和patsubst函数. 使用wildcard函数扩展通配符以及patsubst函数替换通配符。patsubst需要３个参数，第一个是个需要匹配的式样，第二个表示用什么来替换它，第三个是个需要被处理的由空格分隔的字列。以下objects定义的方法与显式定义等价

sources = $(wildcard *.c)
objects = $(patsubst %.c,%.o,$(sources))

第一个%匹配非空字符串，每次匹配的字符串叫做”柄”（stem），第二个%将被解读为第一参数所匹配的柄。该命令中，patsubst将$(sources)中的.c文件列表替换成对应的.o文件。这里的%不能用*来代替。

include外部文件

创建makefile.include文件，在里面定义变量：

# makefile.include
sources = $(wildcard *.c)
objects = $(patsubst %.c,%.o,$(sources))
CC      = icc
CFLAGS  = -Wall -g
LDFLAGS = -lm
INC     = -I./include

在Makefile里加入include指令把makefile.include中的变量包含进来。此时Makefile写成

include makefile.include

prime: $(objects)
    $(CC) -o prime $(objects) $(CFLAGS) $(LDFLAGS)

%.o: %.c
    $(CC) -c -o [email protected] $< $(CFLAGS) $(INC)

.PHONY: clean
clean:
    rm -f prime *.o

条件语法

make支持条件控制ifeq..else..endif，例如

debug=no
ifeq ($(debug),no)
    CFLAGS += -O3
else
    CFLAGS += -O0
endif

直接用make编译时将默认执行激进的O3优化。可在命令行增加宏debug定义来覆盖Makefile里定义好的值，如

make debug=yes

此时不会对程序进行优化。这样方便随时调试和比较优化带来的效率改进。

附录

代码附录

main.c

/* decide if an integer a is a prime number */
#include "prime.h"

int main()
{
    int a,b;
    a = read_a();
    b = isqrt(a);
    judge_p(a,b);
    return 0;
}

read_a.c

#include "prime.h"
#define intmax 100
int read_a()
{
    int a;
    printf(" Type the number a (4<=a<%d): ",intmax);
    scanf("%d",&a);
    if (a < 4 || a > intmax)
    {
        printf("%d is not in range. Exit\n",a);
        exit(1);
    }
    else
        return a;
}

isqrt.c

#include "prime.h"
int isqrt(int a)
{
    int t;
    t = sqrt(a);
    return t;
}

judge_p.c

#include "prime.h"
void judge_p(int a, int a_sqrt)
{
    int i;
    for (i=2;i<=a_sqrt;i++)
    {
        if (a%i == 0)
        {
            printf(" %d is not prime.\n",a);
            break;
        }
    }
    if (i==(a_sqrt+1))
        printf(" %d is prime.\n",a);
}

prime.h

#include <stdio.h>
#include <stdlib.h>
#include <math.h>

#ifndef __FUNC_H
#define __FUNC_H
int read_a();
int isqrt(int a);
void judge_p(int a,int b);
#endif

TeX文件编译的Makefile举例

# 编译about_make.tex
FILE = about_make.tex
TEX  = xelatex

all:
    $(TEX) $(FILE);
    $(TEX) $(FILE); # 需要连续编译两次以获得交叉引用的编号

参考资料

GNU manual of make: https://www.gnu.org/software/make/manual/make.html