一个简单的通用Makefile实现

news/2024/7/5 21:35:50

一个简单的通用Makefile实现

 

MakefileLinux下程序开发的自动化编译工具,一个好的Makefile应该准确的识别编译目标与源文件的依赖关系,并且有着高效的编译效率,即每次重新make时只需要处理那些修改过的文件即可。Makefile拥有很多复杂的功能,这里不可能也没必要一一介绍,为了简化问题的复杂性,本文仅和大家讨论针对单目录下的C/C++项目开发,如何写一个通用的Makefile

首先,我们假设当前工程目录为prj/,该目录下有6个文件,分别是:main.cabc.cxyz.cabc.hxyz.hMakefile。其中main.c包含头文件abc.hxyz.habc.c包含头文件abc.hxyz.c包含头文件xyz.h,而abc.h又包含了xyz.h。它们的依赖关系如图1

1 文件依赖关系

第一次使用Makefile应该写成这个样子(假设生成目标main):

main:main.o abc.o xyz.o

    gcc main.o abc.o xyz.o -o main

main.o:main.c abc.h xyz.h

    gcc -c main.c –o main.o -g

abc.o:abc.c abc.h xyz.h

    gcc -c abc.c –o abc.o -g

xyz.o:xyz.c xyz.h

    gcc -c xyz.c -o xyz.o -g

clean:

    rm main main.o abc.o xyz.o -f

虽然这样Makefile完全符合Makefile的书写规则,但是当代码文件再增加几倍后,再管理这些命令将会是一个噩梦!!!因此Makefile提供了默认规则和自动推导帮我们完成一些常用功能。然后,我们将Makefile修改如下:

EXE=main

CC=gcc

OBJ=main.o abc.o xyz.o

CFLAGS=-g

(EX E ):(OBJ)

    (CC ) ^ -o $@

clean:

    rm (EX E )(OBJ) -f

变量EXECCOBJ分别代指目标程序名,编译器名,目标文件名。CFLAGSMakefile的预定义变量,它会附加在每条编译命令(gcc -c)之后。

$(EXE)是对变量的引用,$^代指所有的依赖项——即$(OBJ)$@代指目标项——即$(EXE)。该命令等价于: (CC ) (OBJ) -o $(EXE)

这个Makefile只有目标文件链接的命令,源文件的编译命令都被忽略了!这正是Makefile的自动推导功能——它可以将目标文件自动依赖于同名的源文件,即:

main.o:main.c

    gcc -c main.c -o main.o

abc.o:abc.c

    gcc -c abc.c -o abc.o

xyz.o:xyz.c

    gcc -c xyz.c -o xyz.o

按照上述方式,只要工程下增加了源文件后,只需要在OBJ初始化处增加一个*.o即可。但是这种方式是有问题的,Makefile的自动推导功能只会推导出目标文件对源文件的依赖关系,而不会增加头文件的依赖关系!!!这导致的直接问题就是修改项目的头文件,不会导致make的自动更新!除非修改头文件后运行一次make clean,再运行make…… :-)

为了能让make自动包含头文件的依赖关系,我们需要做一点额外的工作。幸运的是gcc为我们提供了一个编译选项(gcc -M,对于g++-MM),能输出目标文件的依赖关系!比如:

$gcc -M main.c

main.o:main.c abc.h xyz.h

如果将每个源文件的依赖关系包含到Makefile里,就可以使得目标文件自动依赖于头文件了!再次修改原先的Makefile

EXE=main

CC=gcc

SRC=$(wildcard *.c)

OBJ=$(SRC:.c=.o)

CFLAGS=-g

all:depend $(EXE)

depend:

@ (CC ) M M(SRC) > .depend

-include .depend

(EX E ):(OBJ)

(CC ) (OBJ) -o $(EXE)

clean:

@rm (EX E )(OBJ) .depend -f

我们虚设了一个目标all,它依赖于depend和实际的目标EXE。而depend正式将所有的源文件对应的目标文件的依赖关系输入到.depend文件,并包含在Makefile内!这里有几个细节需要说明:

1.depend文件是隐藏文件,避免和工程的文件混淆。

2include命令之前增加符号‘-’,避免第一次make时由于.depend文件不存在报告错误信息。

3SRC初始化为wildcard *.c表示当前目录下的所有.c源文件,这就省去了我们手动输入新增的源文件。

4OBJ初始化为SRC:.c=.o,表示将SRC中所有.c结尾的文件名替换为.o结尾的,这样就自动生成了源文件的目标文件序列。

5cleanrm命令钱@符号表示执行该命令时不输出任何信息。

这样,每次执行make时都会重新计算目标文件的依赖关系,并输出到.depend文件,然后包含到Makefile后进行编译工作,这样目标文件的依赖关系就不会出错了!而我们得到了一个能自动包含源文件和识别头文件依赖关系的Makefile,将该文件应用于任何单目录的C/C++工程(C++需要修改部分细节,不作赘述)都能正常工作。

但是,这种方式也有一定的不足,当头文件的依赖关系不发生变化时,每次make也会重新生成.depend文件。如果这样使得工程的编译变得不尽人意,那么我们可以尝试将依赖文件拆分,使得每个源文件独立拥有一个依赖文件,这样每次make时变化的只是一小部分文件的依赖关系。

EXE=main

CC=gcc

SRC=$(wildcard *.c)

OBJ=$(SRC:.c=.o)

DEP= (patsubst (SRC))

CFLAGS=-g

(EX E ):(OBJ)

(CC ) ^ -o $@

$(DEP):.%.d:%.c

@set -e;\

rm -f $@;\

(CC ) M < > @. $$$;\

sed 's, $ \.o[ :]*,\1.o @:,g <@.

> $@;\

rm -f @. $$$

-include $(DEP)

clean:

@rm (EX E )(OBJ) $(DEP) -f

Makefile增加了一个变量DEP,初始化为patsubst %.c,.%.d,$(SRC),表示将SRC中的以*.c结尾的源文件名替换为.*.d的形式,比如main.c对应着文件.main.d,这就是main.c的依赖关系文件,且是隐藏的。

为了生成每个源文件的依赖文件,建立了目标依赖关系$(DEP):.%.d:%.c,该关系表示,对于目标DEP,通过$@可以访问一个依赖文件,通过$>则访问对应的同名源文件。命令部分使用\连接,表示当前命令作为一个整体在一个进程内执行。该组命令的含义是:将gcc -M生成的信息输出到一个临时文件,然后在:之前加上当前的文件名输出到依赖文件。比如对于main.c生成的临时文件信息为:

main.o:main.c abc.h xyz.h

处理后依赖文件信息是:

main.o .main.d:main.c abc.h xyz.h

这样的依赖关系表示main.o和它的依赖关系文件的依赖项是一致的,只要相关的源文件或头文件发生了改变,才会重新生成目标文件和依赖关系文件,也就达到了依赖关系文件单独更新的目的了。

虽然如此,但是这样的Makefile也不是完美的。现假设工程目录内新增一个源文件lmn.c,按照Makefile的指令make后会产生.lmn.d依赖关系文件。而如果我们再删除lmn.c源文件后,重新make.lmn.d依然存在!尤其是当重复增删很多源文件后,工程目录下可能会存在很多无用的依赖文件,当然这些问题可以通过make clean解决。

通过前边的讨论,我们得到一个能在单目录工程下工作的通用Makefile,至于是实现为单独一个依赖文件的形式,还是每个源文件产生一个独立的依赖文件,要根据程序作者自己的喜恶来选择。虽然每种方法都有一些细微的瑕疵,但是不影响这个通用的Makefile的实用性,试想一下在工程目录下拷贝一份当前的Makefile,稍加修改便可以正确的编译开发,一定会令人心情大好。希望本文对你学习Linux写的程序开发有所帮助!


http://www.niftyadmin.cn/n/1962316.html

相关文章

一个大三学渣的最后一年挣扎(前端)

开篇 看标题大家就应该知道了本人技术水平确实不咋地&#xff0c;一直处在一个无法跨越的区域中。说实话&#xff0c;我有的时候也很想规划一下自己&#xff0c;奈何能力不够&#xff0c;总是淡淡无奇&#xff0c;大学&#xff0c;前两年&#xff0c;过的是浑浑噩噩&#xff0c…

vulnhub-CH4INRULZ渗透测试

环境搭建 vulnhub官网https://download.vulnhub.com/ch4inrulz/CH4INRULZ_v1.0.1.ova 下载好后直接拖进来&#xff0c;失败就再拖一次&#xff0c;成功部署后就是一个登陆界面 思路 nmap扫出地址并且得到四个端口,80和8011开放了Web服务&#xff0c;之后扫文件发现index.ht…

基于SSM框架实现oa项目

部分源代码和数据库在博客文件中db和src web.xml配置 <?xml version"1.0" encoding"UTF-8"?><web-app xmlns:xsi"http://www.w3.org/2001/XMLSchema-instance" xmlns"http://java.sun.com/xml/ns/javaee" xsi:schemaLocati…

Ubuntu 12.04 安装使用DHCP Server

简单的DHCP server 在创建HDFS集群的时候&#xff0c;深感/etc/hosts中添加配置的不方便&#xff0c;容易不一致导致错误&#xff0c;工作量也大。 还是在局域网内创建dhcp服务器来的方便。官方文档&#xff1a;https://help.Ubuntu.com/community/isc-dhcp-server 先创建一…

Directx11代码下载

很多年前的代码&#xff0c;看还有朋友需要&#xff0c;上传到百度网盘了https://pan.baidu.com/s/1pnGFt84htvdXeK86pvyR8Qhttps://pan.baidu.com/s/1zTqSTFMc2M7dPNfIozXTjg转载于:https://www.cnblogs.com/mikewolf2002/p/10222254.html

收藏一下网站

http://www.x-io.co.uk/products/x-imu/ 国外 http://www.mxkong.com/forum.php 国内模型控网

disable_functions绕过总结

提要 Linux 中 PHP 环境&#xff0c;已知disable_functionsexec、passthru、popen、proc_open、shell_exec、system请写出两种有可能实现任意命令执行的方式 exec <?phpecho exec(whoami);?> — 执行一个外部程序 passthru <?…