本文主要是介绍编写易于扩展的 Makefile,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
from: http://www.ibm.com/developerworks/cn/linux/l-cn-makefile-ext/index.html?ca=drs-
前言
在开发 UNIX 平台下的软件时,为了使程序得到最佳优化往往需要使用平台原生的编译器及库文件。例如,为 AIX 平台开发的产品其中的 C++ 源程序往往使用 xlC_r 来编译连接。类似的 Linux 平台软件一般使用 GCC 来编译。这就需要项目中的 Makefile 能够支持多个平台的不同编译器,并且便于对编译参数进行更新。本文将通过一个实例项目来介绍如何创建这种可扩展的 Makefile。
本文中用到的实例项目
我们通过下面这个实例 C++ 项目来介绍如何创建易于扩展的 Makefile。
在这个项目中,我们会生成一个动态链接库程序和一个可执行例子程序。可执行例子程序会调用动态链接库程序提供的功能。
项目文件结构如下: [dev1@dev-linux1 project]$ pwd /home/dev1/dw/project [dev1@dev-linux1 project]$ ls -R .: example include mak src ./example: foo.cpp foo.h main.cpp Makefile ./include: matrixhelper.h stringhelper.h ./mak: Makefile make.settings ./src: Makefile matrixhelper.cpp stringhelper.cpp |
其中:
- src 目录存放动态链接库的源代码文件。
- example 目录存放可执行例子程序的源代码文件。
- include 目录存放动态链接库文件提供给外部使用的头文件。
- mak 目录存放主控 Makefile 和平台相关的设置文件。
各个 Makefile 中的内容
project/mak/make.settings 中定义了其他 Makefile 中需要用到的一些变量。这些变量中存放平台和编译器相关的参数。其中利用了 shell 命令来区分不同的平台。当然我们也可以根据预定义的环境变量取值来区分不同平台(这些环境变量的值可以在用户的 profile 中设置)。其内容如下: ifdef BITS64 BITS=64 else BITS=32 endif |
根据环境变了 BITS64 是否定义来判断要编译的程序是 32 位还是 64 位。
ifdef DEBUG MODE = debug MODEFLAG = -g -D_DEBUG else MODE = release MODEFLAG = -O3 -DNDEBUG endif |
根据环境变量 DEBUG 是否定义来判断要编译的程序是 release 模式还是 debug 模式。其中定义了变量 MODE 存放编译模式 (release 或 debug) 字符串信息。MODEFLAG 存放编译模式特定的编译参数。
EXECOMPILE = $(MODEFLAG) -DUNIX EXELINK = $(MODEFLAG) |
定义了适用于所有平台和编译器的编译链接命令中要用到的参数。其中 EXECOMPILE 是用来编译可执行文件代码的参数。这里已经包含了 debug 或者 release 模式特定的编译参数信息。EXELINK 是用来链接可执行文件代码的参数。
OSNAME = $(shell uname) |
根据 shell 命令 uname 得出当前操作系统的名字字符串,这个字符串将用于区分不同操作系统。
ifeq ($(OSNAME), AIX) CC = xlC_r EXECOMPILE += -q$(BITS) -c -DAIX LIBCOMPILE = $(EXECOMPILE) EXELINK += -q$(BITS) -bnoipath LIBLINK = $(EXELINK) -G LIBSUFFIX = .a Endif |
如果当前操作系统的名称是 AIX,使用 xlC_r 编译器。在这里添加 AIX 平台 xlC_r 特有的编译和链接参数,并且定义新的变量 CC 表示编译器名称。LIBCOMPILE 表示动态链接库文件的编译参数,LIBLINK 表示动态链接库文件的链接参数,LIBSUFFIX 表示动态链接库文件的扩展名。
ifeq ($(OSNAME), Linux) CC = g++ EXECOMPILE += -m$(BITS) -c -DLINUX LIBCOMPILE = $(EXECOMPILE) -fPIC -Wall EXELINK += -m$(BITS) -fpie LIBLINK = $(EXELINK) -fPIC -shared LIBSUFFIX = .so endif |
和 AIX 系统类似,这里定义了 Linux 系统所使用编译器的参数。
PLATFORM=`uname`$(BITS) TOPDIR = ../do/$(PLATFORM)/$(MODE) BINDIR = $(TOPDIR)/bin LIBNAME = myutil |
这里定义几个变量来表示不同平台下的路径。我们会将最终编译结果以及中间文件分平台存放在不同的目录下,以便同时编译多个平台。LIBNAME 是动态链接库文件的输出文件名,不包含 lib 前缀和扩展名后缀。
有了以上定义的变量,我们就可以在后边的 Makefile 中引用这些变量来进行编译链接,做到平台无关。
project/mak/Makefile 是主控 Makefile,它会调用另外两个 Makeifile 来完成整个项目的编译。内容如下: include make.settings |
包含 make.settings 以便使用其中定义的变量。
all: dirs build dirs: if [ -d $(TOPDIR) ] ; then true; else mkdir -p $(TOPDIR) ; fi; \ |
创建相关目录。
build: cd ../src && $(MAKE) cd ../example && $(MAKE) |
进入 src 目录,编译链接动态链接库文件。进入 example 目录,编译链接可执行示例程序。
clean: cd ../src && $(MAKE) clean cd ../example && $(MAKE) clean |
清除编译接结果以及中间结果。
project/src/Makefile 中编译组成动态链接库文件的源文件,并链接生成最终的动态链接库程序。内容如下: include ../mak/make.settings |
包含 make.settings 以便使用其中定义的变量。
OBJDIR = $(TOPDIR)/obj/dllobjs |
定义存放中间文件的目录。
INCLUDEDIR = -I../include OBJS = \ stringhelper.o \ matrixhelper.o |
需要编译的所有中间文件。
DLL = $(BINDIR)/lib$(LIBNAME)$(LIBSUFFIX) |
定义最终生成的动态链接库文件的完整路径和文件名。
all: dirs $(DLL) dirs: if [ -d $(OBJDIR) ] ; then true; else mkdir -p $(OBJDIR) ; fi; \ |
创建相关目录。
$(DLL): $(OBJS) $(CC) $(LIBLINK) -o $@ $(OBJDIR)/* |
链接所有动态链接库中间文件,生成库文件。这里用到了 make.settings 中定义的平台以及编译器相关的用于动态链接库文件的链接参数。
$(OBJS): %.o:%.cpp $(CC) $(LIBCOMPILE) $(INCLUDEDIR) $< -o $(OBJDIR)/$@ |
编译动态链接库文件的所有源文件成为中间文件。这里用到了 make.settings 中定义的平台以及编译器相关的用于动态链接库文件的编译参数。
clean: -rm -rf $(OBJDIR)/* -rm $(DLL) |
清除编译链接结果以及中间结果。
project/example/Makefile 中编译组成动可执行例子程序的源文件,并链接生成最终的可执行例子程序。内容如下: include ../mak/make.settings |
包含 make.settings 以便使用其中定义的变量。
OBJDIR = $(TOPDIR)/obj/exampleobjs |
定义存放中间文件的目录。
INCLUDEDIR = -I../include OBJS = \ main.o \ foo.o |
需要编译的所有中间文件。
APP = $(BINDIR)/example1 |
定义最终生成的动态链接库文件的完整路径和文件名。
all: dirs $(APP) dirs: if [ -d $(OBJDIR) ] ; then true; else mkdir -p $(OBJDIR) ; fi; \ |
创建相关目录。
$(APP): $(OBJS) $(CC) $(EXELINK) -L$(BINDIR) -l$(LIBNAME) -o $@ $(OBJDIR)/* |
链接所有可执行例子程序的中间文件,生成可执行例子程序。这里用到了 make.settings 中定义的平台以及编译器相关的用于可执行文件的链接参数。
$(OBJS): %.o:%.cpp $(CC) $(EXECOMPILE) $(INCLUDEDIR) $< -o $(OBJDIR)/$@ |
编译可执行文件的所有源文件成为中间文件。这里用到了 make.settings 中定义的平台以及编译器相关的用于可执行文件的编译参数。
clean: -rm -rf $(OBJDIR)/* -rm $(APP) |
清除编译链接结果以及中间结果。
如何使用
编译 64 位 release 版本可以执行命令: gmake BITS64=1 |
编译 32 位 debug 版本可以执行命令:
gmake DEBUG=1 |
包含 AIX 平台 64 位和 Linux 平台 64 位 release 版本中间文件、动态链接库文件和可执行文件的 do 目录结构如下:
[dev1@dev-linux1 do]$ pwd /home/dev1/dw/project/do [dev1@dev-linux1 do]$ ls -R .: AIX64 Linux64 ./AIX64: release ./AIX64/release: bin obj ./AIX64/release/bin: example1 libmyutil.a ./AIX64/release/obj: dllobjs exampleobjs ./AIX64/release/obj/dllobjs: matrixhelper.o stringhelper.o ./AIX64/release/obj/exampleobjs: foo.o main.o ./Linux64: release ./Linux64/release: bin obj ./Linux64/release/bin: example1 libmyutil.so ./Linux64/release/obj: dllobjs exampleobjs ./Linux64/release/obj/dllobjs: matrixhelper.o stringhelper.o ./Linux64/release/obj/exampleobjs: foo.o main.o |
如何扩展
假设我们要增加对 HP-UX 平台的支持,使用编译器 aCC,只需要添加以下内容到 project/mak/make.settings 即可: ifeq ($(OSNAME), HP-UX) CC = aCC XECOMPILE += +DD$(BITS) -c -D_REENTRANT -DHPUX -DHP_UX LIBCOMPILE = $(EXECOMPILE) +Z EXELINK += -DD$(BITS) LIBLINK = $(EXELINK) -b +Z LIBSUFFIX = .sl Endif |
其他 Makefile 文件均无需改动。
在真实的项目应用中,project/mak/make.settings 可以存放在其他地方,供多个工程公用。这样,当我们需要给所有工作增加新的平台支持,或者对已有平台的某些编译连接参数进行修改,只需要修改这一个文件即可。这极大的简化了 Makefile 更新的工作。
这篇关于编写易于扩展的 Makefile的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!