Makefile

最新推荐文章于 2024-06-10 09:55:22 发布

wangwl1998

最新推荐文章于 2024-06-10 09:55:22 发布

阅读量1.2k

点赞数 2

文章标签： linux

本文链接：https://blog.csdn.net/wangwl1998/article/details/129896811

版权

前言

Makefile 是一种构建工具，它可以自动化编译、打包、测试、部署等操作。Makefile 文件通常被命名为“Makefile”或者“makefile”，它们是按照特定格式编写的文本文件，用来描述如何生成目标文件（也称为“目标”）。

Makefile 格式

Makefile 文件由多个规则（rule）组成，具体格式如下：

target: dependencies
        command

其中，

target 是要生成的目标文件名，可以是一个可执行文件、一个库文件、一个中间文件等。
dependencies 是生成 target 所需的依赖项，可以是其他的目标文件、源代码文件、头文件等。
command 是生成 target 的具体命令，可以是编译、链接、打包等操作。

注意，command 使用的缩进必须是一个 Tab 键，不能是空格键。

示例

下面是一个简单的 Makefile 示例，用于编译一个 C++ 程序：

CC=g++
CFLAGS=-c -Wall
LDFLAGS=
SOURCES=main.cpp hello.cpp
OBJECTS=$(SOURCES:.cpp=.o)
EXECUTABLE=hello

all: $(SOURCES) $(EXECUTABLE)

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

.cpp.o:
        $(CC) $(CFLAGS) $< -o $@

clean:
        rm -rf *o $(EXECUTABLE)

这个 Makefile 文件中定义了以下几个变量：

CC：编译器，本例中为 g++。
CFLAGS：编译选项，本例中包括 -c（表示只编译，不链接）和 -Wall（启用所有警告）。
LDFLAGS：链接选项，本例中为空。
SOURCES：源文件列表，本例中包括 main.cpp 和 hello.cpp。
OBJECTS：目标文件列表，本例中是将 .cpp 后缀的文件替换为 .o 后缀得到的。
EXECUTABLE：可执行文件名，本例中为 hello。

Makefile 中还定义了三个规则：

all：默认规则，生成所有目标文件。本例中依赖于 $(SOURCES) 和 $(EXECUTABLE)，生成 $(EXECUTABLE)。
$(EXECUTABLE)：生成可执行文件。依赖于 $(OBJECTS)，使用 $(CC) 和 $(LDFLAGS) 进行链接，生成最终的可执行文件。
.cpp.o：生成中间文件。依赖于对应的 .cpp 源文件，使用 $(CC) 和 $(CFLAGS) 进行编译，生成对应的 .o 目标文件。

最后，还定义了一个 clean 规则，用于删除所有中间文件和可执行文件。

Makefile 语法

除了上面介绍的格式外，Makefile 还支持一些常用的语法，包括：

注释：以 # 开头的行被视为注释，Makefile 忽略它们。
目标通配符：可以使用 % 通配符表示多个目标，例如：

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

这个规则匹配所有 .o 文件，并且依赖于对应的 .c 源文件。

变量：可以定义和使用变量，例如：

CC=gcc
CFLAGS=-g -Wall

hello: hello.o
        $(CC) $(CFLAGS) hello.o -o hello

这里定义了两个变量 CC 和 CFLAGS，并在后面的规则中使用它们。

函数：Makefile 支持一些内置函数，例如：

$(wildcard *.txt)

这个函数返回当前目录下所有以 .txt 结尾的文件名。

条件语句：Makefile 支持 ifeq/ifneq 语句用于条件判断，例如：

ifeq ($(DEBUG),1)
    CFLAGS += -DDEBUG
endif

这个语句判断 DEBUG 变量是否等于 1，如果是，则将编译选项添加一个宏定义 -DDEBUG。

示例

下面是一个更复杂的 Makefile 示例，用于编译一个包含多个源文件和子目录的项目：

# Makefile for my project

# Variables
CC=g++
CFLAGS=-c -Wall
LDFLAGS=
SOURCES=main.cpp hello.cpp subdir/bar.cpp
OBJECTS=$(SOURCES:.cpp=.o)
EXECUTABLE=myproject

# Rules
all: $(SOURCES) $(EXECUTABLE)

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

%.o: %.cpp
        $(CC) $(CFLAGS) $< -o $@

clean:
        rm -rf $(OBJECTS) $(EXECUTABLE)

# Subdirectories
subdirs := subdir

.PHONY: subdirs $(subdirs)

subdirs: $(subdirs)

$(subdirs):
        $(MAKE) -C $@

# Conditional compilation
ifeq ($(DEBUG),1)
    CFLAGS += -DDEBUG
endif

这个 Makefile 文件中包含了多个变量、规则和语法：

CC 和 CFLAGS：定义编译器和编译选项。
SOURCES 和 OBJECTS：定义源文件和目标文件列表。
EXECUTABLE：定义生成的可执行文件名。
all：默认规则，生成所有目标文件。
$(EXECUTABLE)：生成可执行文件，依赖于所有的目标文件。
.cpp.o：生成中间 .o 文件。
clean：删除所有中间文件和可执行文件。
subdirs 和 $(subdirs)：用于支持在子目录中进行编译。使用 $(MAKE) 调用 make 命令进入子目录进行编译。
ifeq/ifneq：用于根据变量 DEBUG 的值来判断是否添加 -DDEBUG 宏定义。

总结

Makefile 是一个非常强大的构建工具，可以帮助我们自动化构建过程，提高开发效率。本文介绍了 Makefile 的基本语法和常用功能，希望能对你编写 Makefile 程序有所帮助。

Makefile 高级用法

除了基本语法和常用功能外，Makefile 还支持一些高级用法，可以进一步提高我们的构建效率。下面介绍一些常用的高级用法。

自动查找源文件

有时候，我们的项目中包含大量的源代码文件，手动列出每个文件名是非常麻烦的。这时候，我们可以使用 Makefile 的自动查找功能，来自动搜索所有的源代码文件并编译它们。

例如，我们可以使用以下规则来自动查找所有的 .cpp 文件，并将其编译成对应的 .o 文件：

SOURCES := $(shell find . -name "*.cpp")
OBJECTS := $(patsubst %.cpp,%.o,$(SOURCES))

all: $(OBJECTS)

%.o: %.cpp
        $(CXX) -c -o $@ $<

这里 find 命令会在当前目录及其子目录中搜索所有的 .cpp 文件，$(patsubst) 函数会将所有的 .cpp 文件替换成对应的 .o 文件，最终生成一个对象文件列表。

条件编译

我们可以使用 Makefile 的条件编译功能，在不同的平台或配置下使用不同的编译选项。例如，我们可以定义一个 DEBUG 变量，根据其值来判断是否添加 -DDEBUG 宏定义。

ifeq ($(DEBUG),1)
    CFLAGS += -DDEBUG
endif

在调用 Makefile 时，可以添加额外的参数来设置 DEBUG 变量的值：

make DEBUG=1

多个目标文件

有时候，我们的项目需要生成多个目标文件，例如一个可执行文件和一个静态库。我们可以使用 Makefile 的多个目标功能来实现这一点。

例如，下面的规则可以同时生成可执行文件和静态库：

all: myapp mylib.a

myapp: main.o hello.o
        $(CXX) -o $@ $^

mylib.a: hello.o
        ar rc $@ $^

这里 myapp 依赖于 main.o 和 hello.o，生成可执行文件；mylib.a 依赖于 hello.o，生成静态库。

并行编译

Makefile 默认是单线程编译，即每次只编译一个目标文件。如果我们的机器配置比较高，可以使用 Makefile 的并行编译功能，来加快构建速度。

例如，我们可以在调用 make 命令时，添加 -j 参数来指定并行编译的线程数：

make -j4

这里表示使用 4 个线程进行编译。根据机器配置和项目大小，可以适当调整线程数。

总结

介绍了 Makefile 的高级用法，包括自动查找源文件、条件编译、多个目标文件和并行编译等。掌握这些高级用法，可以进一步提高我们的构建效率和开发体验。

Makefile 和 CMake 的比较

除了 Makefile，还有许多构建工具可供选择，其中最流行的是 CMake。下面对比一下 Makefile 和 CMake 的异同点。

异同点

语法不同：Makefile 采用文本格式，需要手动编写；CMake 使用脚本格式，可以通过调用函数和变量来简化编写。
平台兼容性：Makefile 只适用于 UNIX 系统，而 CMake 可以生成多个平台的构建文件，包括 Windows、Linux、macOS 等。
多库支持：在 Makefile 中，需要手动处理库文件之间的依赖关系；而在 CMake 中，使用 target_link_libraries 函数可以自动处理库文件之间的依赖关系。
多配置支持：在 Makefile 中，需要手动指定不同的编译选项和链接选项；而在 CMake 中，可以为不同的构建类型（Debug、Release 等）设置不同的编译选项和链接选项。
构建目录分离：在 Makefile 中，需要手动创建多个编译目录，以避免源代码和中间文件混杂在一起；而在 CMake 中，可以使用 out-of-source 编译方式，将中间文件和可执行文件等分离到指定的目录中。

选择哪种工具？

在选择构建工具时，应该根据项目的规模和复杂度、团队成员的经验和熟练程度、项目所需的平台等因素进行综合考虑。如果项目比较小，团队成员对 Makefile 比较熟悉，并且只需要在 UNIX 系统下进行构建，那么选择 Makefile 可能是更好的选择；而如果项目比较大、需要支持多个平台或者团队成员更加倾向于使用 CMake，那么选择 CMake 可能更加合适。

###总结

本节介绍了 Makefile 和 CMake 的异同点，并提供了一些建议来帮助你选择何种工具来构建你的项目。无论选择哪种工具，都应该在实践中不断进行优化和改进，以提高开发效率和构建速度。

Makefile 最佳实践

在编写 Makefile 时，一些最佳实践可以帮助我们提高代码质量和效率。

分离源文件和中间文件

为了避免源文件和中间文件混杂在一起，可以将它们分离到不同的目录中。例如，将所有的源代码放在 src 目录中，将中间文件放在 build 目录中：

SRCDIR := src
BUILDDIR := build

SOURCES := $(wildcard $(SRCDIR)/*.cpp)
OBJECTS := $(patsubst $(SRCDIR)/%.cpp,$(BUILDDIR)/%.o,$(SOURCES))

$(BUILDDIR)/%.o: $(SRCDIR)/%.cpp
        $(CXX) -c -o $@ $<

这里使用了变量 SRCDIR 和 BUILDDIR 来指定源代码和中间文件的目录，使用 wildcard 函数和模式替换来匹配所有的源文件和中间文件，使用 patsubst 函数将源文件名替换成对应的中间文件名。

使用变量和函数

Makefile 支持定义变量和使用内置函数，可以大大简化代码的编写和维护。

例如，可以定义一个 CXXFLAGS 变量来存储编译选项：

CXXFLAGS := -Wall -O2

然后，在编译命令中使用 $() 符号来引用变量值：

$(CXX) $(CXXFLAGS) -c -o $@ $<

同样地，可以使用内置函数来获取当前目录下的文件列表、替换文件名等。

使用模式规则

Makefile 支持模式规则，可以一次性处理多个文件。例如，以下规则会自动匹配所有的 .cpp 文件，并将其编译成对应的 .o 文件：

%.o: %.cpp
        $(CXX) -c -o $@ $<

可以通过类似的方式，一次性处理多个源文件、生成多个目标文件等。

删除中间文件

为了避免中间文件占据过多的磁盘空间，可以添加一个 clean 规则来删除所有的中间文件和可执行文件：

clean:
        rm -rf $(BUILDDIR)/* $(TARGET)

这里使用 rm 命令和递归选项 -r 来删除指定目录下的所有文件，使用通配符 * 来匹配所有的文件名。

使用版本控制

为了保证 Makefile 在不同的环境下都能够正确运行，建议将 Makefile 添加到版本控制系统中，并在项目中提供一个完整的构建流程。

例如，在项目根目录中添加一个 build.sh 脚本或 README.md 文件，文档化构建流程、依赖关系和环境要求。这样，其他开发人员可以轻松地搭建开发环境并构建项目。

总结

本节介绍了 Makefile 的最佳实践，包括分离源文件和中间文件、使用变量和函数、使用模式规则、删除中间文件和使用版本控制等。掌握这些最佳实践可以帮助我们编写更加优秀、高效的 Makefile 程序。

Makefile 常见问题解决

在编写 Makefile 时，会遇到一些常见的问题。下面介绍一些解决这些问题的方法。

编译错误

编译错误是最常见的问题之一，可以通过以下步骤来解决：

首先检查错误信息和警告信息，并根据它们来找出代码中的错误。
如果错误信息不够清晰，可以使用 -E 选项来输出预处理结果，然后手动检查。
可以使用 -Wall 选项来开启所有警告信息，并尽可能地修复这些警告信息。
可以使用 GDB 调试器来调试程序并查找错误。

依赖关系错误

Makefile 中的依赖关系是非常重要的，错误的依赖关系可能导致编译错误或构建失败。可以通过以下步骤来解决依赖关系错误：

确保所有的依赖关系都正确列出，并使用正确的格式。
确保所有的依赖关系都是准确的，包括头文件依赖、库文件依赖等。
使用 -M 选项来输出自动生成的依赖关系，并手动检查其正确性。
使用 -MM 选项来自动生成不包含系统头文件的依赖关系。

执行错误

执行错误包括构建失败、链接错误等。可以通过以下步骤来解决执行错误：

检查编译器的版本和选项是否正确。
检查库文件和头文件的路径是否正确。
检查环境变量和系统设置是否正确。
在必要时，可以将 -v 选项添加到编译命令中，以输出详细的调试信息。

性能问题

性能问题可能导致构建时间过长或者占用过多的资源。可以通过以下步骤来优化性能问题：

使用并行编译来加速构建速度。
使用静态库替代动态库，以避免多次加载和卸载库文件。
编写高效的代码，并尽可能地减少不必要的操作和内存分配。
使用 Profile 工具来分析程序的性能瓶颈。

总结

本节介绍了 Makefile 中常见的问题及其解决方法，包括编译错误、依赖关系错误、执行错误和性能问题等。在实践中，我们应该善于利用工具和技巧来解决这些问题，并不断优化 Makefile 的质量和效率。

Makefile 实例

下面给出一个简单的 Makefile 实例，用于编译一个 C++ 程序，并将中间文件和可执行文件分别放在 build 和 bin 目录中。

# Makefile for a simple C++ program

CXX = g++
CXXFLAGS = -Wall -O2
SRCDIR := src
BUILDDIR := build
BINDIR := bin
TARGET := $(BINDIR)/program

SOURCES := $(wildcard $(SRCDIR)/*.cpp)
OBJECTS := $(patsubst $(SRCDIR)/%.cpp,$(BUILDDIR)/%.o,$(SOURCES))

$(TARGET): $(OBJECTS)
        $(CXX) $(CXXFLAGS) $^ -o $@

$(BUILDDIR)/%.o: $(SRCDIR)/%.cpp
        $(CXX) $(CXXFLAGS) -c -o $@ $<

.PHONY: clean
clean:
        rm -rf $(BUILDDIR)/* $(TARGET)