一個工程實例來學習 Makefile


March 3, 2015 8:19 PM

Makefile 文件的編寫

學習前的准備

需要准備的工程目錄結構如下:

.
├── add
│   ├── add_float.c
│   ├── add.h
│   └── add_int.c
├── main.c
└── sub
    ├── sub_float.c
    ├── sub.h
    └── sub_int.c

文件編譯為可執行文件cacu
NOTE:需要的源代碼:MakefileExample.tar

Makefile的介紹

使用 GCC 的命令行進行程序編譯在單個文件下是比較方便的,當工程中的文件逐漸增多,甚至變得十分龐大的時候,使用 GCC 命令編譯就會變得力不從心。Linux 中的 make 工具提供了一種管理工程的功能,可以方便的進行程序的編譯,對更新的文件進行重編譯。

Makefile的基本格式為:

TARGET... : DEPENDEDS...
	COMMAND
    ...
    ...
  • TARGET:規則所定義的目標,通常是最后生成的文件,也可以是一個“動作”,稱之為“偽目標”。
  • DEPENDEDS:執行此規則所必須的依賴條件。
  • COMMAND:規則所執行的命令。命令可以是多個,每個命令占一行,以 Tab 開頭。

動手編寫多文件工程的Makefile

1.命令行編譯程序

如果在命令行下手動編譯該程序比較麻煩,需要先編譯每個文件,生成目標文件,最后再將5個目標文件編譯成可執行文件。

#get add_int.o target
gcc -c add/add_int.c -o add/add_int.o -ggdb

#get add_float.o target
gcc -c add/add_float.c -o add/add_float.o -ggdb

#get sub_float.o target
gcc -c sub/sub_float.c -o sub/sub_float.o -ggdb

#get sub_int.o target
gcc -c sub/sub_int.c -o sub/sub_int.o -ggdb

#get main.o target
gcc -c main.c -o main.o -Iadd -Isub -ggdb

#get cacu bin file
gcc -o cacu add/add_int.o add/add_float.o sub/sub_int.o sub/sub_float.o main.o -ggdb

#get main.S target
gcc -S add/add_int.o add/add_float.o sub/sub_int.o sub/sub_float.o main.o

2.多文件的Makefile

使用make進行項目管理,需要編寫Makefile。在編譯時,make程序按照順序從Makefile文件中讀取指令,依次執行!

#get cacu bin file
cacu:add_int.o add_float.o sub_int.o sub_float.o main.o
	gcc -o cacu add/add_int.o add/add_float.o \
		sub/sub_int.o sub/sub_float.o main.o -ggdb

#get add_int.o target
add_int.o:add/add_int.c add/add.h
	gcc -c -o add/add_int.o add/add_int.c -ggdb

#get add_float.o target
add_float.o:add/add_float.c add/add.h
	gcc -c -o add/add_float.o add/add_float.c -ggdb

#get sub_int.o target
sub_int.o:sub/sub_int.c sub/sub.h
	gcc -c -o sub/sub_int.o sub/sub_int.c -ggdb

#get sub_float.o target
sub_float.o:sub/sub_float.c sub/sub.h
	gcc -c -o sub/sub_float.o sub/sub_float.c -ggdb

#get main.o target
main.o:main.c add/add.h sub/sub.h
	gcc -c -o main.o main.c -Iadd -Isub -ggdb

#clean project
clean:
	rm -f cacu add/add_int.o add/add_float.o \
		sub/sub_int.o sub/sub_float.o main.o

當需要編譯工程時,直接在工程目錄中執行make即可。如果想清除編譯過程中生成的目標文件和cacu,執行make clean即可。

3.使用用戶自定義變量的Makefile

在Makefile文件中,用戶可以自定義變量,方便用戶修改參數。
使用變量后,原本冗長的文件可以化簡為:

CC = gcc
CFLAGS = -Iadd -Isub -O2
OBJS = add/add_int.o add/add_float.o sub/sub_float.o sub/sub_int.o main.o
TARGET = cacu
RM = rm -f

$(TARGET):$(OBJS)
	$(CC) -o $(TARGET) $(OBJS) $(CFLAGS)

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

clean:
	$(RM) $(TARGET) $(OBJS)

NOTE:$(OBJS):%.o:%.c中 %.o:%.c 是將 $(OBJS) 中以 .o 結尾的文件替換成以 .c 結尾的文件。

其中 $< 和 $@ 是自動化變量,下一節會介紹。

4.使用預定義變量的Makefile

在Makefile中還有一些變量是系統預定義的,用戶可以直接使用。

Makefile中經常使用的變量及含義

變量名 含 義 默 認 值
AR 生成靜態庫庫文件的程序名稱 ar
AS 匯編編譯器的名稱 as
CC C語言編譯器的名稱 cc
CPP C語言預編譯器的名稱 $(CC) -E
CXX C++語言編譯器的名稱 g++
FC FORTRAN語言編譯器的名稱 f77
RM 刪除文件程序的名稱 rm -f
ARFLAGS 生成靜態庫庫文件程序的選項 無默認值
ASFLAGS 匯編語言編譯器的編譯選項 無默認值
CFLAGS C語言編譯器的編譯選項 無默認值
CPPFLAGS C語言預編譯器的編譯選項 無默認值
CXXFLAGS C++語言編譯器的編譯選項 無默認值
FFLAGS FORTRAN語言編譯器的編譯選項 無默認值

因此,前面的Makefile文件可以改寫成:

CFLAGS = -Iadd -Isub -O2
OBJS = add/add_int.o add/add_float.o \
	   sub/sub_int.o sub/sub_float.o main.o
TARGET = cacu

$(TARGET):$(OBJS)
	$(CC) -o $(TARGET) $(OBJS) $(CFLAGS)

clean:
	-$(RM) $(TARGET) $(OBJS)

其中變量$(CC) $(RM)可以直接使用,默認值分別是ccrm -f。另外CFLAGS等變量是調用編譯器時的默認選項配置,在生成main.o時沒有指定編譯選項,make程序自動調用了文件中定義的CFLAGS選項來增加頭文件的搜索路徑。

5.使用自動變量的Makefile

還記得上面出現的 $< 和 $@ 嗎?它們是Makefile中的自動變量,分別代表依賴項和目標項。下面是一些常見的自動變量及其含義:

Makefile 中常見的自動變量和含義

變量 含義
* 表示目標文件的名稱,不包含目標文件的擴展名
+ 表示所有的依賴文件,這些依賴文件之間以空格分開,按照出現的先后為順序,其中可能包含重復的依賴文件
< 表示依賴項中第一個依賴文件的名稱
? 依賴項中,所有目標文件時間戳晚的依賴文件,依賴文件之間以空格分開
@ 目標項中目標文件的名稱
^ 依賴項中,所有不重復的依賴文件,這些文件之間以空格分開

由此,對上面的Makefile文件進行重寫,代碼如下:

CFLAGS = -Iadd -Isub -O2
OBJS = add/add_int.o add/add_float.o \
	   sub/sub_int.o sub/sub_float.o main.o
TARGET = cacu

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

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

clean:
	-$(RM) $(TARGET) $(OBJS)

6.設置搜索路徑

在大的系統中,通常存在很多目錄,手動添加目錄的方法不僅十分笨拙而且容易造成錯誤。Make 的目錄搜索功能提供了一個解決此問題的方法,指定需要搜索的目錄, make 會自動找到指定文件的目錄並添加到文件上, VPATH 變量可以實現此目的。VPATH 變量的使用方法如下:

VPATH = path1:path2:...

VPATH 右邊是冒號(:)分割路徑名稱,例如下面的指令:

VPATH = add:sub
add_int.o:%.o:%.c
	$(CC) -c -o $@ $<

Make 的搜索路徑包含 add 和 sub 目錄。add_int.o 規則自動擴展成如下代碼:

add_int.o:add/add_int.c
	cc -c -o add_int.o add/add_int.c

用添加路徑的方法改寫上面的 Makefile 文件,代碼如下:

CFLAGS = -Iadd -Isub -O2
OBJDIR = objs
VPATH = add:sub:.
OBJS = add_int.o add_float.o sub_int.o sub_float.o main.o
TARGET = cacu

$(TARGET):$(OBJSDIR) $(OBJS)
	$(CC) -o $(TARGET) $(OBJDIR)/*.o $(CFLAGS)

$(OBJDIR):
	mkdir -p ./$@

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

clean:
	-$(RM) $(TARGET)
	-$(RM) $(OBJDIR)/*.o -r

7.自動推導規則

使用命令 make 編譯擴展名為 .c 的 C 語言文件的時候,源文件的編譯規則不用明確地給出。這是因為 make 進行編譯的時候會使用一個默認的編譯規則,按照默認規則完成對 .c 文件的編譯,生成對應的 .o 文件。它執行命令 cc -c 來編譯 .c 源文件。在 Makefile 中只需要給出需要重建的目標文件(一個 .o 文件),make 會自動為這個 .o 文件尋找合適的依賴文件(對應的 .c 文件),並且使用默認的命令來構建這個目標文件。

對於上邊的例子,默認規則是使用命令cc -c main.c -o main.o來創建文件 main.o 。對一個目標文件是“文件名.o“,依賴文件是”文件名.c“的規則,可以省略其編譯規則的命令行,由 make 命令決定如何使用編譯命令和選項。此默認規則稱為 make 的隱含規則。

這樣,在書寫 Makefile 時,就可以省略掉描述 .c 文件和 .o 依賴關系的規則,而只需要給出那些特定的規則描述(.o 目標所需要的 .h 文件)。因此上面的例子可以使用更加簡單的方式書寫, Makefile 文件的內容如下:

CFLAGS = -Iadd -Isub -O2
VPATH = add:sub
OBJS = add_int.o add_float.o sub_int.o sub_float.o main.o
TARGET = cacu
$(TARGET):$(OBJS)
	$(CC) -o $(TARGET) $(OBJS) $(CFLAGS)

clean:
	-$(RM) $(TARGET)
	-$(RM) $(OBJS)

8.遞歸 make

對於規模比較大的程序,需要多個人在多個目錄下進行開發。如果只用一個 Makefile 來維護就會比較麻煩,因此可以在每個目錄下建立自己的 Makefile ,然后在總控 Makefile 中調用子目錄的 Makefile 文件。

目錄結構如下:

.
├── add
│   ├── add_float.c
│   ├── add.h
│   ├── add_int.c
│   └── Makefile
├── main.c
├── Makefile
└── sub
    ├── Makefile
    ├── sub_float.c
    ├── sub.h
    └── sub_int.c

1.遞歸調用的方式

add:
	cd add && $(MAKE)

它等價於

add:
	$(MAKE) -C add

2.總控Makefile

CC = gcc
CFLAGS = -O2
TARGET = cacu
export OBJSDIR = $(shell pwd)/objs

$(TARGET):$(OBJSDIR) main.o
	$(MAKE) -C add
	$(MAKE) -C sub
	$(CC) -o $(TARGET) $(OBJSDIR)/*.o

$(OBJSDIR):
	mkdir -p $@

main.o:%.o:%.c
	$(CC) -c $< -o $(OBJSDIR)/$@ $(CFLAGS) -Iadd -Isub

clean:
	-$(RM) $(TARGET)
	-$(RM) $(OBJSDIR)/*.o

如果總控 Makefile 中的一些變量需要傳遞給下層的 Makefile,可以使用 export 命令。如:export OBJSDIR = ./objs

3.子目錄Makefile的編寫

Add 目錄下的 Makefile 如下:

OBJS = add_int.o add_float.o
all:$(OBJS)

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

clean:
	$(RM) $(OBJS)

Sub 目錄下的 Makefile 如下:

OBJS = sub_int.o sub_float.o
all:$(OBJS)

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

clean:
	$(RM) $(OBJS)

Makefile 中的函數

1.獲取匹配模式的文件名wildcard

這個函數的功能是查找當前目錄下所有符合模式 PATTERN 的文件名,其返回值是以空格分割的、當前目錄下的所有符合模式 PATTERN 的文件名列表。其原型如下:

$(wildcard PATTERN)

例如,如下模式返回當前目錄下所有擴展名位 .c 的文件列表。

$(wildcard *.c)

2.模式替換函數patsubst

這個函數的功能是查找字符串 text 中按照空格分開的單詞,將符合模式 pattern 的字符串替換成 replacement。 Pattern 中的模式可以使用通配符, % 代表 0 個到 n 個字符,當 pattern 和 replacement 中都有 % 時,符合條件的字符將被 replacement 中的替換。函數的返回值是替換后的新字符串。其原型如下:

$(patsubst pattern, replacement, text)

例如,需要將 C 文件替換為 .o 的目標文件可以使用如下模式:

$(patsubst %.c, %.o, add.c)

上面的模式將 add.c 字符串作為輸入,當擴展名為 .c 時符合模式 %.c ,其中 % 在這里代表 add,替換為 add.o,並作為輸出字符串。

$(patsubst %.c, %.o, $(wildcard *.c))

輸出的字符串將當前擴展名為 .c 的文件替換成 .o 的文件列表。

3.循環函數foreach

這個函數的原型為:

$(foreach VAR, LIST, TEXT)

函數的功能為 foreach 將 LIST 字符串中一個空格分割的單詞,先傳給臨時變量 VAR ,然后執行 TEXT 表達式, TEXT 表達式處理結束后輸出。其返回值是空格分割表達式 TEXT 的計算結果。

例如,對於存在 add 和 sub 的兩個目錄,設置 DIRS 為 "add sub ./" 包含目錄 add、sub 和當前目錄。表達式 $(wildcard $(dir)/*.c) ,可以取出目錄 add 和 sub 及當前目錄中的所有擴展名為 .c 的C語言源文件:

DIRS = sub add ./
FILES = $(foreach dir, $(DIRS), $(wildcard $(dir)/*.c))

利用上面幾個函數對原有的 Makefile 文件進行重新編寫,使新的 Makefile 可以自動更新各個目錄下的C語言源文件:

CC = gcc
CFLAGS = -O2 -Iadd -Isub
TARGET = cacu
DIRS = sub add .
FILES = $(foreach dir, $(DIRS), $(wildcard $(dir)/*.c))
OBJS = $(patsubst %.c, %.o, $(FILES))
$(TARGET):$(OBJS)
	$(CC) -o $(TARGET) $(OBJS)

clean:
	-$(RM) $(TARGET)
	-$(RM) $(OBJS)

總結

至此,已經可以閱讀大部分軟件的 Makefile 了~~~


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM