makefile编写速成

目录

什么是makefile     

 编译过程

动态库生成流程

静态库生成流程

库文件命名规则

链接过程

链接选项和库类型解析

如何写makeflie 

简单例子:单个源文件的编译

进阶:多个源文件与模块化

文件结构:

Makefile 内容:

高级主题:处理大工程

项目结构示例:

Makefile 内容:


什么是makefile     

        Makefile 是一种文件,它定义了软件项目中源代码文件的编译规则。很多Windows程序员可能对其不太熟悉,因为常见的Windows集成开发环境(IDE)通常会自动处理这些任务。然而,对于追求专业素养的程序员来说,理解Makefile是很有价值的,尤其是在Unix环境中,手动编写Makefile几乎是必备技能。能否编写Makefile在一定程度上反映了程序员是否有能力管理大型项目。这是因为Makefile详细规定了项目的编译流程:哪些文件应优先编译,哪些随后,哪些需要重新编译,甚至可以包含执行特定系统命令的指令。实际上,Makefile的功能类似于Shell脚本,允许用户定制复杂的编译逻辑。其最大的优点在于实现“自动化编译”——一旦配置妥当,仅需输入make命令,整个项目就能按照预设规则自动完成编译过程,大大提升了开发效率。Make是一个解析并执行Makefile指令的工具,几乎所有的IDE都包含了类似的编译功能,如Delphi的make、Visual C++的nmake以及Linux下GNU提供的make。因此,Makefile已经成为了一种广泛接受的项目管理和编译策略。

 编译过程

        构建任何应用程序均需经历编译与链接阶段,在Linux系统中编译应用同样遵循这一流程。编译过程中,无论是.c、.cpp还是.s的源代码文件,都会先转换为目标文件(object file),这是一种编译后的中间产物,作为构建最终应用程序的基础材料,我们不必深入了解其具体内容。当源代码转化为目标文件后,便具有了进一步处理的特性,既能够组合进静态或动态库,也能直接合成完整的应用程序。在管理大型项目的多个模块时,通常建议采用库的方式来组织,以便于管理和故障排查。想象一下,大型项目中的每个模块都被制成库,这样在遇到问题时,可以通过分析各模块对应的库快速找到问题根源。要使用gcc从源文件a.c生成目标文件,命令如下:

gcc -c -o a.o a.c

gcc-c 参数用于纯编译阶段,只生成目标文件(例如 a.o),并且不检查 main 函数的存在或处理库调用。-o 参数用来命名输出文件。若要链接已有的目标文件 a.o 并生成可执行文件,可以使用命令:

gcc -o test a.o

这之后,执行 test 就能运行你的应用程序。而将编译和链接合并为一步的话,可以直接使用以下命令,无需生成中间的目标文件 a.o

gcc -o test a.c

假设 a.c 实现了一些接口定义,并且有相应的头文件 a.h,而 main.c 中定义了应用程序的入口 main 函数并调用了 a.c 中的接口。我们可以将 a.c 编译成库,以便于模块化管理和重复利用。

动态库生成流程

首先,需要分别编译源文件为对象文件:

gcc -c -o a.o a.c
gcc -c -o main.o main.c

然后,使用以下命令生成动态库文件(注意 -shared-fPIC 参数用于创建位置无关代码):

gcc -shared -fPIC -o libone.so a.o

静态库生成流程

静态库的创建则使用 ar 工具打包目标文件:

ar rcs libone.a a.o

库文件命名规则

动态库和静态库的文件名有一定的格式要求,分别为 libxxx.solibxxx.a

链接过程

在链接阶段,为了创建最终的可执行文件,可以使用如下命令:

gcc -o test main.o -L. -Wl,-rpath,. -lone

这里,

  • -o test 指定生成的可执行文件名为 test
  • -I 用于指定代码中引用的头文件路径(此例中未显示,但如果是外部头文件路径,则需添加)。
  • -L. 表示编译器在当前目录下查找库文件。
  • -Wl,-rpath,. 告诉应用程序在运行时从当前目录加载动态库;对于静态库,此选项不是必需的。
  • -lone 指定了要链接的库名为 libone.so 或 libone.a
  • -Wl,option 将选项传递给链接器,如果有逗号分隔的多个选项,则会分割处理。
  • -L 指定链接时搜索库文件的目录,所有 -lFOO 指定的库都会先在这个目录中查找,之后再查找默认路径。

链接选项和库类型解析

  • -rpath 选项: -rpath 指定了程序在运行时查找动态库的路径。当应用程序启动并需要加载 .so 文件(即共享库)时,它会从 -rpath 选项指定的位置进行搜索。对于交叉编译的情况,为了确保正确找到目标平台上的库文件,必须配合使用 --sysroot 选项。

    -rpath-link 选项: -rpath-link 主要在链接阶段起作用。假设你明确指定了一个动态库 foo.so,而这个库本身依赖于另一个未直接指定的库 bar.so。此时,链接器会首先尝试从 -rpath-link 提供的路径中查找 bar.so。换句话说,-rpath-link 提供了额外的路径帮助解决库之间的间接依赖关系,但这些路径不会被记录到最终的可执行文件中。

    动态库与静态库的区别:

  • 动态库:这类库仅在程序运行时加载,因此在链接阶段不仅需要指定运行时库的路径(通常是通过 -L-l 选项),还需要确保这些路径能被应用程序在运行时访问(例如通过 -rpath)。此外,在编译期间,编译器需要知道动态库的位置以验证函数调用的有效性。尽管编译环境中的动态库和运行环境中的可以不同,但后者必须包含所有必要的函数实现,不能有任何缺失。

  • 静态库:静态库在编译过程中就被嵌入到最终的可执行文件中。这意味着一旦程序编译完成,它就不再依赖于外部的静态库文件。因此,运行该程序只需要生成的可执行文件本身,而不必担心外部库的存在或版本兼容性问题。

如何写makeflie 

这一节从简单例子到难度进阶再到复杂大型工程举例说明怎样写好一个makeflie。

简单的makeflie编写

假设我们有一个简单的 C 程序 hello.c

// hello.c
#include 

int main() {
    printf("Hello, World!\n");
    return 0;
}

我们可以创建一个简单的 Makefile 来编译这个程序:

# Makefile for hello.c

CC = gcc           # 编译器
CFLAGS = -Wall     # 编译选项,这里开启了所有警告

hello: hello.c     # 目标:hello 依赖于 hello.c
	$(CC) $(CFLAGS) -o hello hello.c   # 使用指定的编译器和选项编译并生成可执行文件

在命令行中运行 make 即可编译该程序。

makefile编写进阶:多个源文件与模块化

考虑一个稍微复杂一点的例子,包含两个源文件 main.cmathlib.c,以及对应的头文件 mathlib.h

  • main.c 包含 main 函数。
  • mathlib.c 提供了一些数学函数。
  • mathlib.h 定义了 mathlib.c 中函数的原型。
文件结构:
project/
├── Makefile
├── main.c
└── mathlib.c
└── mathlib.h
Makefile 内容:
# Makefile for a project with multiple source files

CC = gcc
CFLAGS = -Wall -g       # 开启调试信息
LDFLAGS =                # 链接选项(如果需要)
LIBS =                   # 链接库(如果需要)

SRCS = main.c mathlib.c # 源文件列表
OBJS = $(SRCS:.c=.o)    # 对应的目标文件列表

TARGET = program         # 最终生成的可执行文件名

all: $(TARGET)

$(TARGET): $(OBJS)
	$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $^ $(LIBS)

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

clean:
	rm -f *.o $(TARGET)

.PHONY: all clean

在这个 Makefile 中:

  • SRCS 变量定义了所有的源文件。
  • OBJS 变量通过替换 .c 扩展名为 .o 自动生成目标文件列表。
  • TARGET 变量指定了最终生成的可执行文件名。
  • all 目标是默认构建目标,它依赖于 $(TARGET)
  • $(TARGET) 目标依赖于所有目标文件,链接这些文件生成最终的可执行文件。
  • %.o: %.c 规则告诉 make 如何从 .c 文件生成 .o 文件。
  • clean 目标用于清理生成的文件,确保环境干净。
复杂项目makefile

对于大型项目,通常会将代码组织成多个子目录或模块,并且可能涉及到静态库或动态库的创建。以下是一个更复杂的 Makefile 示例,展示如何管理这样的工程。

项目结构示例:
large_project/
├── Makefile
├── src/
│   ├── main.c
│   └── module1/
│       ├── module1.c
│       └── module1.h
│   └── module2/
│       ├── module2.c
│       └── module2.h
└── lib/
    └── libmodule.a (静态库)
Makefile 内容:
# Makefile for a large project with modules and libraries

CC = gcc
CFLAGS = -Wall -g -Isrc/module1 -Isrc/module2 # 包括模块的头文件路径
AR = ar             # 归档工具(用于创建静态库)
RANLIB = ranlib     # 更新库索引

SRC_DIR = src
BUILD_DIR = build
LIB_DIR = lib

SRCS = $(wildcard $(SRC_DIR)/*.c $(SRC_DIR)/*/*.c)
OBJS = $(patsubst %.c,$(BUILD_DIR)/%.o,$(SRCS))
TARGET = $(BUILD_DIR)/program

MODULE1_OBJS = $(patsubst %.c,$(BUILD_DIR)/%.o,$(wildcard $(SRC_DIR)/module1/*.c))
MODULE2_OBJS = $(patsubst %.c,$(BUILD_DIR)/%.o,$(wildcard $(SRC_DIR)/module2/*.c))

LIBRARY = $(LIB_DIR)/libmodule.a

all: $(TARGET)

$(TARGET): $(OBJS) $(LIBRARY)
	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)

$(LIBRARY): $(MODULE1_OBJS) $(MODULE2_OBJS)
	$(AR) rcs $@ $^
	$(RANLIB) $@

$(BUILD_DIR)/%.o: %.c | $(BUILD_DIR)
	@mkdir -p $(dir $@)
	$(CC) $(CFLAGS) -c $< -o $@

$(BUILD_DIR):
	mkdir -p $@

clean:
	rm -rf $(BUILD_DIR) $(LIBRARY)

.PHONY: all clean

在这个 Makefile 中:

  • SRC_DIR 和 BUILD_DIR 分别定义了源代码和构建输出的位置。
  • SRCS 和 OBJS 使用 wildcard 和 patsubst 函数来自动收集所有源文件及其对应的目标文件。
  • MODULE1_OBJS 和 MODULE2_OBJS 分别列出每个模块的目标文件。
  • LIBRARY 定义了要创建的静态库。
  • $(BUILD_DIR)/%.o: %.c 规则确保目标文件被放置在正确的构建目录中。
  • $(BUILD_DIR) 目标确保构建目录存在。
  • clean 目标用于清除所有生成的文件。

通过这种方式,你可以轻松地管理和扩展你的 Makefile,以适应任何规模的项目。随着项目的增长,你还可以引入更多高级特性,如条件编译、多平台支持等。

 

你可能感兴趣的:(开发语言)