Linux Makefile文件详解

Makefile是一个用于构建和管理项目的工具，特别适用于C/C++项目。

它定义了项目中各个文件之间的依赖关系，并指定了如何编译和链接这些文件。

以下是一个简单的Makefile文件的示例，以及对其中关键部分的详细解释：

1. Makefile示例

# Makefile 示例

# 编译器
CC = gcc

# 编译选项
CFLAGS = -Wall -g

# 目标文件
TARGET = myprogram

# 源文件
SRCS = main.c func1.c func2.c

# 中间文件
OBJS = $(SRCS:.c=.o)

# 默认目标
all: $(TARGET)

# 目标文件生成规则
$(TARGET): $(OBJS)
 $(CC) $(CFLAGS) -o $@ $^

# 中间文件生成规则
%.o: %.c
 $(CC) $(CFLAGS) -c -o $@ $<

# 清理规则
clean:
 rm -f $(TARGET) $(OBJS)

2. Makefile解释

• CC： 编译器的变量，这里使用 gcc。
• CFLAGS： 编译选项的变量，这里设置了 -Wall（显示所有警告）和 -g（生成调试信息）。
• TARGET： 目标文件的变量，这里定义了最终生成的可执行文件的名字。
• SRCS： 源文件的变量，这里列出了所有的源文件。
• OBJS： 中间文件的变量，这里将源文件的后缀由 .c 替换为 .o。
• all： 默认目标，执行 make 命令时将会构建该目标。
• $(TARGET)： 目标文件的生成规则，告诉 Make 如何生成最终的可执行文件。
• $(OBJS)： 中间文件的生成规则，告诉 Make 如何生成中间目标文件。
• %.o: %.c： 通用规则，告诉 Make 如何将 .c 文件编译成对应的 .o 文件。
• clean： 清理规则，执行 make clean 时将删除生成的可执行文件和中间目标文件。

3. 使用 Makefile

在项目目录中，执行以下命令：

• 构建项目： make 或 make all。
• 清理项目： make clean。

4. 注意事项

• 空格问题： Makefile 使用 Tab 键而不是空格来缩进规则。
• 文件依赖： Makefile 的核心是文件之间的依赖关系，确保每个目标都依赖于正确的文件。
• 变量引用： 使用 $@ 表示目标，$^ 表示所有依赖文件，$< 表示第一个依赖文件。
• 通配符： 使用 % 通配符来表示一类文件，例如 %.o: %.c。

Makefile 是一个非常强大的工具，可以用于管理复杂的项目结构。以上示例是一个简单的入门级别的 Makefile，实际项目中可能会包含更多的配置和规则。

5. Makefile 规则

Makefile 通常包含规则（rules），规则描述了如何生成一个或多个目标文件。每个规则的基本格式如下：

target: dependencies
    command

• target： 目标文件的名字，可以是一个可执行文件、一个中间文件、或者一个标签。
• dependencies： 目标文件依赖的文件列表，即生成目标文件所需要的文件。
• command： 生成目标文件的命令，用于描述如何从依赖文件生成目标文件。

以下是一个简单的示例：

main: main.o utils.o
    gcc -o main main.o utils.o

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

utils.o: utils.c
    gcc -c utils.c

在这个例子中，main 是目标文件，依赖于 main.o 和 utils.o。生成 main 文件的命令是 gcc -o main main.o utils.o。类似地，main.o 依赖于 main.c，utils.o 依赖于 utils.c。

6. 自动变量

Makefile 中有一些特殊的变量，称为自动变量，它们在规则的命令中使用，表示一些特定的信息。一些常用的自动变量有：

• $@： 表示目标文件的名字。
• $<： 表示规则中的第一个依赖文件的名字。
• $^： 表示规则中所有的依赖文件的名字，用空格分隔。

以下是使用自动变量的例子：

main: main.o utils.o
    gcc -o $@ $^

这个规则等价于之前的规则，使用了自动变量来表示目标文件和所有依赖文件。

7. 通用规则

如果有多个类似的目标文件，可以使用通用规则。通用规则使用通配符 % 来匹配文件名的一部分。

%.o: %.c
    gcc -c $<

这个规则表示，对于任何 .o 文件，其依赖于同名的 .c 文件，生成规则是 gcc -c $<。

8. 变量

Makefile 中可以定义变量，用于存储字符串、文件名、编译选项等信息。变量的定义格式如下：

VAR_NAME = value

使用变量的示例：

CC = gcc
CFLAGS = -Wall -O2

main: main.o utils.o
    $(CC) -o $@ $^ $(CFLAGS)

在这个例子中，CC 和 CFLAGS 都是变量，分别存储了编译器和编译选项。在规则的命令中使用时，用 $(CC) 和 $(CFLAGS) 替代具体的值。

9. include 指令

Makefile 可以包含其他 Makefile，使用 include 指令。这样可以将 Makefile 分成多个模块，提高可维护性。

include common.mk

main: main.o utils.o
    $(CC) -o $@ $^ $(CFLAGS)

10. PHONY 目标

有时候，我们需要定义一些不产生实际文件的目标，例如清理临时文件或执行一些特定的任务。

为了告诉 Make 这些目标不是文件名，可以使用 .PHONY 目标。

.PHONY: clean

clean:
    rm -f *.o main

这个例子中，clean 是一个 PHONY 目标，用于删除临时文件。

当构建一个软件项目时，make 工具可用于自动化编译过程，确保只有发生了改变的文件被重新编译。

make 使用一个名为 Makefile 的文件，其中包含了一系列规则和指令，描述了文件之间的依赖关系以及如何生成目标文件。

以下是一个简单的 Makefile 文件的结构和基本要素：

11. 基本结构

Makefile 文件由一系列规则和变量组成。每个规则描述了一个或多个目标文件的生成方式。基本结构如下：

# 注释以 '#' 开头
# 变量定义
CC = gcc
CFLAGS = -Wall

# 第一个规则是默认规则
all: target1 target2

# 规则：目标文件依赖的文件
# [tab] 指令（生成目标文件的命令）
target1: dependency1 dependency2
    $(CC) $(CFLAGS) -o target1 dependency1 dependency2

target2: dependency3 dependency4
    $(CC) $(CFLAGS) -o target2 dependency3 dependency4

12. 变量

在 Makefile 中，可以使用变量来存储和引用值。

在上述例子中，CC 和 CFLAGS 就是变量，分别存储编译器和编译选项。

13. 规则

规则由以下几部分组成：

• 目标（Target）： 描述生成的文件的名称。可以有多个目标，以空格分隔。
• 依赖关系（Dependencies）： 描述目标文件依赖的文件。如果依赖文件的内容发生变化，那么目标文件将被重新生成。
• 指令（Commands）： 描述如何生成目标文件的命令。指令前必须有一个制表符（\t）。

14. 默认规则

第一个规则通常是默认规则，即在执行 make 命令时默认执行的规则。在上述例子中，默认规则是all: target1 target2。

15. 通配符

Makefile 支持通配符，用于匹配文件列表。常用的通配符包括 *（匹配任意字符）和 %（匹配任意字符序列）。

# 匹配所有以.c结尾的文件
sources = $(wildcard *.c)

16. 自动生成依赖关系

使用 -M 选项可以让编译器自动生成依赖关系。这对于跟踪头文件之间的依赖关系很有帮助。

# 自动生成依赖关系
%.d: %.c
    $(CC) -M $< > $@

17. include 指令

使用 include 指令可以将其他 Makefile 文件包含进当前 Makefile 中。

# 包含其他 Makefile 文件
include other.mk

18. 示例

下面是一个简单的 C 语言项目的 Makefile 示例：

CC = gcc
CFLAGS = -Wall
LDFLAGS =

SRCDIR = src
OBJDIR = obj
BINDIR = bin

SOURCES = $(wildcard $(SRCDIR)/*.c)
OBJECTS = $(patsubst $(SRCDIR)/%.c,$(OBJDIR)/%.o,$(SOURCES))
EXECUTABLE = $(BINDIR)/my_program

all: $(EXECUTABLE)

$(EXECUTABLE): $(OBJECTS)
    $(CC) $(LDFLAGS) -o $@ $^

$(OBJDIR)/%.o: $(SRCDIR)/%.c
    $(CC) $(CFLAGS) -c -o $@ $<

clean:
    rm -rf $(OBJDIR)/*.o $(EXECUTABLE)

这个 Makefile 文件描述了一个简单的项目结构，其中源文件位于 src 目录，目标文件位于 obj 目录，可执行文件位于 bin 目录。这个 Makefile 包含了 all（默认目标）、clean（清理目标）等规则。

19. 函数

Makefile 支持一些内建的函数，用于处理字符串、路径等。常用的函数包括 $(wildcard), $(patsubst), $(foreach), 等等。

# 获取所有.c文件的列表
C_FILES = $(wildcard src/*.c)

# 将.c文件替换成.o文件
O_FILES = $(patsubst src/%.c, obj/%.o, $(C_FILES))

# 使用foreach迭代
SOURCES = file1.c file2.c file3.c
OBJECTS = $(foreach src, $(SOURCES), obj/$(src:.c=.o))

20. 条件语句

Makefile 中可以使用条件语句，根据不同的条件执行不同的指令。

# 条件语句
ifeq ($(DEBUG),1)
    CFLAGS += -g
else
    CFLAGS += -O2
endif

21. 递归调用

Makefile 可以通过递归调用来构建子目标。

# 递归调用
subtarget:
    $(MAKE) -C subdir

22. 示例

下面是一个包含多个源文件、头文件以及库文件的 Makefile 示例：

CC = gcc
CFLAGS = -Wall
LDFLAGS =

SRCDIR = src
INCDIR = include
OBJDIR = obj
BINDIR = bin
LIBDIR = lib

SOURCES = $(wildcard $(SRCDIR)/*.c)
HEADERS = $(wildcard $(INCDIR)/*.h)
OBJECTS = $(patsubst $(SRCDIR)/%.c,$(OBJDIR)/%.o,$(SOURCES))
EXECUTABLE = $(BINDIR)/my_program
LIBRARY = $(LIBDIR)/libmylibrary.a

all: $(EXECUTABLE) $(LIBRARY)

$(EXECUTABLE): $(OBJECTS)
    $(CC) $(LDFLAGS) -o $@ $^

$(LIBRARY): $(OBJECTS)
    ar rcs $@ $^

$(OBJDIR)/%.o: $(SRCDIR)/%.c $(HEADERS)
    $(CC) $(CFLAGS) -I$(INCDIR) -c -o $@ $<

clean:
    rm -rf $(OBJDIR)/*.o $(EXECUTABLE) $(LIBRARY)

这个 Makefile 描述了一个包含多个源文件的项目，其中包括了默认目标 all、清理目标 clean，以及两个生成目标：一个可执行文件和一个静态库。

注意到这个 Makefile 中的变量和规则可以根据项目的结构和需求进行适当的调整。

23. 安装规则

Makefile 可以包含安装规则，用于将可执行文件、库文件等安装到指定位置。

以下是一个简单的安装规则示例：

INSTALL_DIR = /usr/local/bin

install: $(EXECUTABLE)
    cp $(EXECUTABLE) $(INSTALL_DIR)

uninstall:
    rm -f $(INSTALL_DIR)/$(notdir $(EXECUTABLE))

在这个示例中，install 规则将可执行文件拷贝到指定目录（$(INSTALL_DIR)）。

uninstall 规则则删除已安装的可执行文件。