Makefile总结

2022-08-30 19:59:08 浏览数 (1)

大家好,又见面了,我是你们的朋友全栈君。

Makefile是一个规定了怎么去编译和链接程序的脚本文件,在执行make命令时会执行该文件,window环境下的IDE,如visual studio已经集成了该功能,不需要关心程序的编译规则,在linux下做C/C 开发时经常用到,会写Makefile是程序员的必备技能。说到这里首先要知道一个工具make。

make是一个解释Makefile中指令的命令工具,常见的IDE都集成了这个工具。目前centos 7.3 GNU的make版本是3.82

为什么要用Makefile

在做C/C 开发过程中,比如有如下文件:

代码语言:javascript复制
a.c  b.c  main.c

编译生成可执行二进制文件

代码语言:javascript复制
gcc a.c b.c main.c -o main

对其中任意一个文件修改都要重新编译所有的文件,在一个大型的项目中往往有成百上千个文件,不仅书写起来麻烦,编译也消耗很长的时间,Makefile可以很好的解决这个问题,编译过程会判断文件是否有过修改,只对修改的文件重新编译生成目标文件,不仅提高了效率,还减少了出错。

规则

目标文件:依赖文件 [Tab]系统指令1 (注意:系统指令前必须有tab)

示例

例如现有main.cpp test.cpp test.h三个文件,用Makefile实现增量编译(当其中有一个文件变化时,重新编译该文件)

代码语言:javascript复制
    helloworld: main.o test.o
        g   main.o test.o -o helloworld
    
    main.o: main.cpp test.h
        g   -c main.cpp -o main.o
    
    test.o: test.cpp test.h
        g   -c test.cpp -o test.o
    
    clean:
        rm *.o helloworld

注释

行前面加”#”号,如#g main.o test.o -o helloworld 表示注释了该行

变量

变量在声明时赋予初值,引用变量时需要在变量名前加上”$”符号,用小括号”()”或大括号”{}”把变量括起来。

用=定义一个变量,并且赋值(等号两边可以加空格)

用 =追加字符串

代码语言:javascript复制
例:    
A = src
echo $(A)  
@echo $(A)  ##只输出echo的结果,不显示执行的命令

可对上述的Makefile进行修改:

代码语言:javascript复制
CC = g  
BIN = helloworld
OBJ = main.o test.o

$(BIN): $(OBJ)
    $(CC) $(OBJ) -o $(BIN)

main.o: main.cpp test.h
    $(CC) -c main.cpp -o main.o

test.o: test.cpp test.h
    $(CC) -c test.cpp -o test.o

clean:
    rm $(OBJ) $(BIN)

特殊变量:

代码语言:javascript复制
$@ 目标文件
$^ 依赖项列表
$< 依赖项列表第一项

通过make -p可以查看很多自定义的变量,如CC(默认值为cc),RM(默认值为rm -f) 可对上述的Makefile再进行修改:

代码语言:javascript复制
CC=g  
BIN=helloworld
OBJ=main.o test.o

$(BIN):$(OBJ)
        $(CC) $^ -o $@

main.o:main.cpp test.h
        $(CC) -c $< -o $@

test.o:test.cpp test.h
        $(CC) -c $< -o $@

clean:
        rm $(OBJ) $(BIN)

函数

函数可以使得Makefile文件写起来更加简洁,如对于上百个文件,一个个手敲出*.cpp也很麻烦,Makefile提供了wilcard和patsubst函数。

Makefile中有一些预定义函数,形式

代码语言:javascript复制
$(函数名  参数列表)
参数列表:以逗号分隔
函数名和参数之间用空格分开

函数1:shell

代码语言:javascript复制
获取当前目录路径: PWD = $(shell pwd)

函数2:wildcard

代码语言:javascript复制
获取当前目录下所有.cpp文件:SRC = $(wildcard *.cpp)

函数3:patsubst

代码语言:javascript复制
获取当前目录下所有.cpp文件编译后的所有目标文件.o:OBJ = $(patsubst %.cpp, %.o, $(SRC))

函数4:addprefix

代码语言:javascript复制
把所有的.o文件输出到固定目录,这是需要对所有的.o文件加前缀
OBJS = $(addprefix ../build/obj/, $(OBJ))

可对上边的Makefile再进行修改:

代码语言:javascript复制
CC=g  
BIN=helloworld
SRC=$(wildcard *.cpp)
OBJ=$(patsubst %.cpp, %.o, $(SRC))
OBJSFULLPATH=$(addprefix ../build/obj/, $(OBJ))
$(BIN):$(OBJ)
        $(CC) $^ -o $@

%.o:%.cpp
        $(CC) -c &< -o ../build/obj/$@

clean:
        $(RM) $(OBJ) $(BIN)

伪目标

有时候我们通过make指定目标来执行特定的命令,这个目标不是真正的文件名,称为伪目标。也可以把伪目标称为标签。

上边的Makefile,在执行make clean 后会删除.o和可执行文件,如果在当前目录下创建一个名称为clean的文件,再执行make clean后会提示:

代码语言:javascript复制
make: “clean”是最新的。

并没有执行删除操作。

这种情况可以使用伪目标来解决,可避免在makefile中定义的执行命令目标和当前目录下实际文件名冲突。

一旦定义为伪目标,make执行规则不会去查找隐含规则,同样也提高了效率。

在上边的Makefile中把clean定义为伪目标即可

代码语言:javascript复制
.PHONY:clean

还有个特表的伪目标 all ,如我们通过Makefile创建多个可执行文件时,可以使用到:

代码语言:javascript复制
如:
all: bin1 bin2 bin3

bin1: **.o

bin2: **.o

bin3: **.o

对上边的Makefile再升级

代码语言:javascript复制
CC=g  
BIN=helloworld
SRC=$(wildcard *.cpp)
OBJ=$(patsubst %.cpp, %.o, $(SRC))

.PHONY: all clean

all: $(BIN) Install

$(BIN):$(OBJ)
        $(CC) $^ -o $@

main.o:main.cpp test.h
        $(CC) -c $< -o $@

test.o:test.cpp test.h
        $(CC) -c $< -o $@

Install:
        @echo "install..."

clean:
        $(RM) $(OBJ) $(BIN)

嵌套执行

大型项目中所有的源代码不可能放到一个目录下,一般模块化的代码是分开的,有生成库的目录,有生成最终可执行文件的目录,有进行测试的目录等,这样的结构代码清晰易维护。通过主目录下的Makefile分别管理各个目录下的Makefile编译。这就要用到嵌套执行。

举个简单的例子,代码结构如下:

代码语言:javascript复制
|---lib
|    |---fun.cpp
|    |---fun.h
|    |---Makefile
|
|---src
|    |---main.cpp
|    |---Makefile
|    
|---bin
|    |---server

make -C lib 该命令表示执行lib目录下的Makefile。 lib目录下的Makefile内容如下:

代码语言:javascript复制
CC=g  
LIB=libfun.a
SRC=$(wildcard *.cpp)
OBJ=$(patsubst %.cpp, %.o, $(SRC))

$(LIB):$(OBJ)
        $(AR) rcs $@ $^

fun.o:fun.cpp
        $(CC) -c $^ -o $@

clean:
        rm $(OBJ) $(LIB)

src目录下的Makefile如下:

代码语言:javascript复制
CC=g  
BIN=../bin/server
LIBDIR=../lib
HDIR=../lib
LIBS= -lfun
SRC=$(wildcard *.cpp)
OBJ=$(patsubst %.cpp, %.o, $(SRC))


$(BIN):$(OBJ)
        $(CC) $^ -o  $@ -L$(LIBDIR)  $(LIBS)

$(OBJ):$(SRC)
        $(CC) -c $^ -o $@ -I$(HDIR)

clean:
        rm $(OBJ) $(BIN)

主目录的Makefile如下:

代码语言:javascript复制
.PHONY: all clean

all: server lib

server:
        $(MAKE) -C lib
        $(MAKE) -C src

clean:
        $(MAKE) -C lib clean
        $(MAKE) -C src clean

参数传递

主Makefile在调用子目录Makefile,有时我们需要传递参数,两种方法: 方法一: 在上层Makefile中使用”export”关键字对要传递的变量进行声明。

代码语言:javascript复制
export DIR = /var/log

相反如不希望传递变量,可以使用”unexport”关键字

方法二: 在调用子Makefile命令上指定变量。

代码语言:javascript复制
$(MAKE) -C src DIR=/var/log

条件语句

Makefile中常见的条件语句有: ifeq-else-endif ifneq-else-endif ifdef-else-endif

举个调试经常用到的例子:

代码语言:javascript复制
DEBUG=true

ifeq ($(DEBUG), true)
        CC=g   -g
else
        CC=g  
endif

通用模板

优化Makefile,添加文件夹,把源码都放入src和lib文件夹,保持增量编译,即为Makefile通用模板

代码语言:javascript复制
EXE = helloworld
GCC = g  
SUBDIR = src lib

CPP_SOURCES = $(foreach dir, $(SUBDIR), $(wildcard $(dir)/*.cpp))
CPP_OBJECTS = $(patsubst %.cpp, %.o, $(CPP_SOURCES))
DEP_FILES = $(patsubst %.o, %.d, $(CPP_OBJECTS))

$(EXE): $(CPP_OBJECTS)
        $(GCC) $(CPP_OBJECTS) -o $@

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

-include $(DEP_FILES)

clean:
        rm  $(CPP_OBJECTS)  $(EXE)

发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/144794.html原文链接:https://javaforall.cn

0 人点赞