Makefile的注意事项

- 日理万妓 2022-08-07 11:58 241阅读 0赞

# 一、VPATH、vpath    #

在一些大的工程中，有大量的源文件，我们通常的做法是把这许多的源文件分类，并存放在不同的目录中。所以，**当make需要去找寻文件的依赖关系时**，你可以在文件前加上路径，但**最好的方法是把一个路径告诉make，让make在该路径下自动去找**。

Makefile文件变量“VPATH”就是完成这个功能的，如果没有指明这个变量，make只会在当前的目录中去找寻依赖文件和目标文件。如果定义了这个变量，那么，**make就会在当当前目录找不到的情况下，到所指定的目录中去找寻文件了**。

VPATH = src:../headers

上面的的定义指定两个目录，“src”和“../headers”，make会按照这个顺序进行搜索。目录由“冒号”分隔。（当然，当前目录永远是最高优先搜索的地方）

另一个设置文件搜索路径的方法是使用make的“vpath”关键字（注意，它是全小写的），这不是变量，这是一个make的关键字，这和上面提到的那个VPATH变量很类似，但是它更为灵活。它可以指定不同的文件在不同的搜索目录中。这是一个很灵活的功能。它的使用方法有三种：

1、vpath <pattern> <directories>
        为符合模式<pattern>的文件指定搜索目录<directories>。
    2、vpath <pattern>
        清除符合模式<pattern>的文件的搜索目录。
    3、vpath
        清除所有已被设置好了的文件搜索目录。

vapth使用方法中的<pattern>需要包含“%”字符。“%”的意思是匹配零或若干字符，例如，“%.h”表示所有以“.h”结尾的文件。<pattern>指定了要搜索的文件集，而<directories>则指定了<pattern>的文件集的搜索的目录。例如：

vpath %.h ../headers

该语句表示，要求make在“../headers”目录下搜索所有以“.h”结尾的文件。（如果某文件在当前目录没有找到的话）

我们可以连续地使用vpath语句，以指定不同搜索策略。如果连续的vpath语句中出现了相同的<pattern>，或是被重复了的<pattern>，那么，make会按照vpath语句的先后顺序来执行搜索。如：

vpath %.c foo
        vpath %   blish
        vpath %.c bar
    
    其表示“.c”结尾的文件，先在“foo”目录，然后是“blish”，最后是“bar”目录。

# 二、创建makefile的常用步骤 #

.PHONY: clean all
    CC = gcc
    CFLAGS = -g
    BIN = tcpsrv01 tcpcli01 tcpsrvselect tcpcliselect tcpsrvpoll tcpclipoll tcpsrvepoll
    INCLUDE = .
    #下面这条语句在当前目录下找不到.c文件，就会去"./mylib"目录下寻找
    vpath %.c ./mylib
    all: $(BIN)
    tcpsrv01:tcpsrv01.o signal.o
    #其实下面的一行可以写作“${CC} ${CFLAGS} -o $@ $<”，其他类似行均是，可用$<简化书写
            ${CC} ${CFLAGS} -o $@ tcpsrv01.o signal.o
    tcpcli01: tcpcli01.o
    	${CC} ${CFLAGS} -o $@ tcpcli01.o
    
    tcpsrvselect: tcpsrvselect.o wrapsock.o
    	${CC} ${CFLAGS} -o $@ tcpsrvselect.o wrapsock.o
    tcpcliselect: tcpcliselect.o wrapsock.o
    	${CC} ${CFLAGS} -o $@ tcpcliselect.o wrapsock.o
    
    tcpclipoll:tcpclipoll.o wrapsock.o
    	${CC} ${CFLAGS} -o $@ tcpclipoll.o wrapsock.o
    tcpsrvpoll:tcpsrvpoll.o wrapsock.o
    	${CC}  ${CFLAGS} -o $@ tcpsrvpoll.o wrapsock.o
    
    tcpsrvepoll:tcpsrvepoll.o wrapsock.o
    	${CC}  ${CFLAGS} -o $@ tcpsrvepoll.o wrapsock.o
    #sigchldwait.o:sigchldwait.c
    #	${CC} ${CPPFLAGS} -c sigchldwait.c
    #tpcsrv01.o:tcpsrv01.c
    #	${CC} ${CPPLAGS} -c tcpsrv01.c
    #tcpcli01.o:tcpcli01.c
    #	${CC} ${CPPLAGS} -c tcpcli01.c
    %.o:%.c
    	${CC} ${CFLAGS} -c $< -o $@ 
    clean:
    	rm -rf *.o ${BIN} *.c~ *.h~

## 1、书写依赖关系、规则 ##

all: $(BIN)
    BIN = tcpsrv01 tcpcli01 tcpsrvselect tcpcliselect tcpsrvpoll tcpclipoll tcpsrvepoll
    tcpsrv01:tcpsrv01.o signal.o
        ${CC} ${CFLAGS} -o $@ tcpsrv01.o signal.o

第一行是指定了目标all，那么使用make可以创建all代表的所有目标。如果没有指定一个all目标，那么make命令只创建它在文件Makefile中找到的第一个目标。

第二三行就是依赖关系，即每个文件与源文件之间的关系。先写目标，然后是冒号，接着是空格或制表符，最后是用空格或制表符分开的文件列表。

第四行就是规则，它们定义了目标的创建方式：通过gcc来创建.o文件。规则所在的行必须以制表符Tab开头，用空格不行。

## 2、注释和宏 ##

makefile文件中注释以\#开头，一直延续到该行结束。

在上一点中的BIN就是一个宏，makefile中宏经常用来设置编译器的选项，在软件开发过程中，通常开发人员不会对编译结果进行优化，而是将调试信息包含进去；但是对软件的发行版，往往需要反过来做，即编译结果是一个不包含调试信息的较小的二进制可执行文件，使其执行速度尽可能快。另外，假设Makefile使用的是gcc编译器，而其他Unix系统使用的是cc或c89，那么为了makefile的可移植性，使用宏可以很方便地近改变一次宏而不要在makefile中多处改变编译命令。

Makefile中三个特殊的宏：

$?：当前目标所依赖的文件列表中比当前目标文件还要新的文件；

$@：当前目标的名字；

$<：当前依赖文件的名字，所以，其实如最开始的Makefile中注释的那样，可以用$<简化书写。

$\*：不包括后缀名的当前依赖文件的名字

## 3、clean删除选项、install安装选项 ##

clean:
    	rm -rf *.o ${BIN} *.c~ *.h~

目标clean用rm删除目标文件、.o文件等， **rm命令以-开头**，减号的含义是让make命令忽略rm命令的执行结果，这意味着，即使由于目标文件不存在而导致rm命令返回错误，命令make clean也会成功。

# where to install
    INSTDITR = /usr/local/bin
    install: all
    	@if [ -d $(INSTDIR) ]; \
    		then \
    		cp all $(INSTDIR); \
    		chomod a+x $(INSTDIR)/all; \
    		chomod og-w $(INSTDIR)/all; \
    		echo "Installed in $(INSTDIR)"; \
    	else \
    		echo "Sorry, $(INSTDIR) does not exist"; \
    	fi

上面是安装目标程序到另一个文件夹下的命令，该 **命令以符号@开头，表示**make在执行这些规则之前不会在标准输出上显示命令本身。  
上面的代码并没有再执行下一个命令前检查前一个命令的执行是否成功，如果这点很重要，可以将这些命令用符号&&连接起来，如下，这样的话，只有前面的命令都执行成功了，后面的命令才会执行。

# where to install
    INSTDITR = /usr/local/bin
    install: all
    	@if [ -d $(INSTDIR) ]; \
    		then \
    		cp all $(INSTDIR) &&\
    		chomod a+x $(INSTDIR)/all && \
    		chomod og-w $(INSTDIR)/all && \
    		echo "Installed in $(INSTDIR)"; \
    	else \
    		echo "Sorry, $(INSTDIR) does not exist"; false\
    	fi

4、后缀和模式规则

要想增加一条新的后缀规则，首先需要在Makefile文件中增加一行语句，告诉make命令这个新的后缀名。然后即可用这个心的后缀名来定义规则。make使用特殊语法：

.<old_suffix> .<new_suffix>:

来定义一条通用规则，利用这规则可以从带有旧后缀名的文件创建带有新后缀名的文件，并保留原文件名的前半部分。

下面的Makefile片段中，用一个新的通用规则将.cpp文件编译为.o文件：

.SUFFIXES:   .cpp
    .cpp.o:
    $(CC) $(CFLAGS) -I$(INCLUDE) -c $<

特殊依赖关系.cpp.o告诉make，紧随其后的规则用于将后缀名为.cpp的文件转换为后缀名为.o的文件。$<将被扩展为起始文件的名字（包含旧的后缀名），注意，只需要告诉make如何从.cpp文件中得到.o文件，make已经知道如何从一个目标文件得到一个二进制可执行文件了。

最新的make版本还包含一个新的语法以实现同样效果，而且功能更强大。例如，模式规则可以用%通配符语法来匹配文件名，而不是仅依赖于文件的后缀名。

如下的可以达到与上例中.cpp规则同样的效果：

%.cpp: %o
    $(CC) $(CFLAGS) -I(INCLUDE) -c $<

# 三、make遇到的一些问题 #

1、在看开源代码libnids时，其makefile文件中有$(MAKE)这个变量（makefile文件如下），一番查询后才弄明白。

//libnids的makefile文件，注意$(MAKE)变量：
    #
    # Makefile for libnids.
    #
    # Dug Song <dugsong@monkey.org>
    
    
    all: static 
    install: _install
    static shared _install _installshared:
    	cd src ; $(MAKE) $(AM_MAKEFLAGS) $@
    #	cd samples; $(MAKE) $(AM_MAKEFLAGS) $@
    clean:
    	cd src ; $(MAKE) $(AM_MAKEFLAGS) $@
    	cd samples; $(MAKE) $(AM_MAKEFLAGS) $@
    	
    distclean: clean
    	rm -f Makefile */Makefile */config.h config.status config.cache config.log *~ 
    
    # EOF

**$(MAKE)**时make内置的参数，**通过“make -p"可以查看所有make内置的参数**：

![Center][]

2、在makefile中生成.so动态库

有时候需要makefile文件产生动态库，然后再使用这个动态库，具体做法是：先通过gcc/g++将源文件.c/.cpp编译为目标文件.o；然后通过gcc或g++将.o文件做成动态库（参加文章[extern “c“][extern _c]）。如下是微博项目中的makefile片段，显示了生成.so文件的例子：

BIN = weibo
    CC = gcc
    CXX = g++
    CFLAGS = -lnids -lpcap -lnet -lgthread-2.0
    BIN_SO = libfilter_weibo.so
    all: ${BIN_SO} $(BIN)
    
    filter_weibo.o: filter_weibo.cpp                           #首先编译源文件为.o
    	${CXX} -c $< -o $@
    
    ${BIN_SO}: filter_weibo.o                                 #然后将.o文件生成为动态库
    	${CXX} $< --shared -o ${BIN_SO}
    
    ${BIN}: weibo.o                                                 #对生成的动态库的使用
    	${CC} -o $@ weibo.o -L ./ -lfilter_weibo ${CFLAGS}
    
    send_data.o: send_data.c
    	$(CC)  ${CFLAGS}  -c $< -o $@
    
    weibo.o: weibo.c
    	${CC} ${CFLAGS} -c $< -o $@
    
    
    clean:
    	rm -rf *.o  *.so $(BIN)

[Center]: /images/20220805/aa2a3cfea7d34300b96169b62441ce2b.png
[extern _c]: http://blog.csdn.net/u013074465/article/details/42738553#t1