dbm数据库源代码分析(17)：Makefile文件和其他文件

   （1）Makefile文件。make工具使用Makefile文件来对整个项目进行编译、安装、打包发布等。gdbm项目的Makefile文件内容如下：
     1）收集系统的配置信息，并定义一些变量来保存它们，以便后面构建时能方便地使用它们。主要有：
       a）目录信息和构建工具：项目顶级目录top_builddir、源代码目录srcdir、编译器CC=gcc、库构建工具LIBTOOL=./libtool；
       b）安装工具：INSTALL=/usr/bin/install、INSTALL_PROGRAM及INSTALL_DATA；
       c）文档生成工具：MAKEINFO=makeinfo、TEXI2DVI=texi2dvi；
       d）依赖的库及编译器选项：LIBS、CFLAGS等；
       e）安装目录：包括可执行程序、库文件、手册页的安装目录。如libdir=/usr/local/lib、includedir=/usr/local/include、infodir=/usr/local/info、man3dir=/usr/local/man/man3等。
     2）收集项目各个模块的文件信息，并定义一些变量来保存它们。主要有后缀规则（编译的源文件和目标文件后缀）、每个模块的源文件列表、头文件列表、目标文件列表、libtool目标文件列表、可执行程序列表、文档文件列表、生成的库文件列表、以及发布包中的文件列表等；
     3）默认编译目标all：一般依赖于生成各个模块的库文件目标；
     4）安装目标install：用于安装gdbm。先在mkinstalldirs脚本中指定库文件libgdbm.la、头文件gdbm.h、man(3)手册页gdbm.3、info手册页gdbm.info的安装目录，然后用INSTALL_DATA指定的工具安装它们，la型的库文件一般用libtool来安装；
     5）安装兼容包的目标install-compat：安装ndbm和dbm部分。先在mkinstalldirs脚本中指定库文件libgdbm_compat.la、头文件ndbm.h和dbm.h的安装目录，然后安装它们；
     6）生成各个模块的库文件目标：有目标libgdbm.la、libgdbm_compat.la；
     7）目标gdbm.h：生成头文件gdbm.h，直接把gdbm.proto、gdbm.proto2以及gdbmerrno.h中一个全局变量复制到gdbm.h中；
     8）用来生成测试程序和转换程序的各个目标：testgdbm、testndbm、testdbm、conv2gdbm等；
     9）生成文档的目标：gdbm.info、gdbm.dvi。调用相应生成工具把gdbm.textinfo源文件输出为相应格式的文档；
     10）目标clean：清除之前编译生成的目标文件、可执行文件及配置文件；
     11）目标distclean：清除所有生成的文件，回到./configure之前的状态；
     12）目标dist：用tar和gzip工具将程序打包发布，包扩展名为.tar.gz；
     13）项目各个模块中生成.o目标文件的目标：dbm、ndbm、gdbm三大模块要生成的各个目标文件；
     14）测试程序和转换程序.o目标文件的目标：testgdbm.o、testndbm.o、testdbm.o、conv2gdbm.o等目标。

#### 开始系统配置部分 #### # 指定源代码目录、构建项目的顶级目录：为本Makefile文件所在的目录 srcdir = . top_builddir = . # 指定构建用的gcc编译器、构建库时的libtool通用脚本：用SHELL来执行libtool # SHELL是make的内置变量，通常值为/bin/sh CC = gcc LIBTOOL = $(SHELL) $(top_builddir)/libtool # 指定生成库的版本：gdbm 1.8.3构建的共享库的版本为3.0 SHLIB_VER = 3 0 0 # 指定安装工具：install工具用来拷贝文件并设置属性，-c选项无作用，-m设置权限模式 INSTALL = /usr/bin/install -c INSTALL_PROGRAM = ${INSTALL} INSTALL_DATA = ${INSTALL} -m 644 # 文件所有权和组 BINOWN = bin BINGRP = bin # 指定gdbm文档生成工具：makeinfo和texi2dvi工具可以将Textinfo文档输出成各种格式 MAKEINFO = makeinfo TEXI2DVI = texi2dvi DEFS = # 指定构建时需要库：为标准C库libc.so LIBS = -lc # 指定编译器的编译选项 CFLAGS = -g -O2 LDFLAGS = # 指定安装目录的前缀：常包括可执行程序、库文件、手册页的安装目录 prefix = /usr/local exec_prefix = ${prefix} binprefix = $(exec_prefix) manprefix = $(prefix) # 放置库文件libgdbm.a的目录，为/usr/local/lib libdir = ${exec_prefix}/lib # 放置头文件gdbm.h和dbm.h的目录，为/usr/local/include includedir = ${prefix}/include # 放置Info和man文档的目录，为/usr/local/info和/usr/local/man/man3 infodir = ${prefix}/info man3dir = ${prefix}/man/man3 manext = 3 #### 结束系统配置部分 #### # 删除默认的后缀，然后定义自己的后缀，有“.c .lo .o”（不先删除则会追加到原来的后缀列表中） .SUFFIXES: .SUFFIXES: .c .lo .o # 后缀规则：将所有的.c文件转换为.o文件。注意后缀规则不允许有任何的依赖文件，make会自动扫描目录的相应后缀的文件 .c.o: $(CC) -c $(CPPFLAGS) $(DEFS) -I. -I$(srcdir) $(CFLAGS) $< # 后缀规则：用libtool将所有的.c文件编译成.lo文件后，其实就是在.o文件中添加了一些信息 .c.lo: $(LIBTOOL) --mode=compile $(CC) -c $(CPPFLAGS) $(DEFS) -I. -I$(srcdir) $(CFLAGS) $< SHELL = /bin/sh # 要生成的测试和转换程序 PROGS = libgdbm.la testgdbm testdbm testndbm tndbm tdbm conv2gdbm # dbm源文件列表 DBM_CF = dbminit.c delete.c fetch.c store.c seq.c close.c # ndbm源文件列表 NDBM_CF = dbmopen.c dbmdelete.c dbmfetch.c dbmstore.c dbmseq.c / dbmclose.c dbmdirfno.c dbmpagfno.c dbmrdonly.c # gdbm源文件列表 GDBM_CF = gdbmopen.c gdbmdelete.c gdbmfetch.c gdbmstore.c gdbmclose.c / gdbmreorg.c gdbmseq.c gdbmsync.c gdbmerrno.c gdbmexists.c gdbmfdesc.c / gdbmsetopt.c bucket.c falloc.c findkey.c global.c hash.c update.c / version.c # 测试程序源文件列表 TEST_CF = testdbm.c testndbm.c testgdbm.c # dbm目标文件列表 DBM_OF = dbminit.o delete.o fetch.o store.o seq.o close.o # ndbm目标文件列表 NDBM_OF = dbmopen.o dbmdelete.o dbmfetch.o dbmstore.o dbmseq.o / dbmclose.o dbmdirfno.o dbmpagfno.o dbmrdonly.o # gdbm目标文件列表 GDBM_OF = gdbmopen.o gdbmdelete.o gdbmfetch.o gdbmstore.o gdbmclose.o / gdbmreorg.o gdbmseq.o gdbmsync.o gdbmerrno.o gdbmexists.o gdbmfdesc.o / gdbmsetopt.o bucket.o falloc.o findkey.o global.o hash.o update.o / version.o # dbm的libtool目标文件列表 DBM_LOF = dbminit.lo delete.lo fetch.lo store.lo seq.lo close.lo NDBM_LOF = dbmopen.lo dbmdelete.lo dbmfetch.lo dbmstore.lo dbmseq.lo / dbmclose.lo dbmdirfno.lo dbmpagfno.lo dbmrdonly.lo GDBM_LOF = gdbmopen.lo gdbmdelete.lo gdbmfetch.lo gdbmstore.lo gdbmclose.lo / gdbmreorg.lo gdbmseq.lo gdbmsync.lo gdbmerrno.lo gdbmexists.lo / gdbmfdesc.lo gdbmsetopt.lo bucket.lo falloc.lo findkey.lo global.lo / hash.lo update.lo version.lo # gdbm文档文件列表 TEX_F = gdbm.aux gdbm.cp gdbm.dvi gdbm.fn gdbm.ky gdbm.log gdbm.pg / gdbm.toc gdbm.tp gdbm.vr TEXI_F = gdbm.info # 所有的源文件列表 SRCS = $(DBM_CF) $(NDBM_CF) $(GDBM_CF) $(TEST_CF) # 原来的一个库中的所有文件列表 #OBJS = $(DBM_OF) $(NDBM_OF) $(GDBM_OF) # #LOBJS = $(DBM_LOF) $(NDBM_LOF) $(GDBM_LOF) # 新的库进行了重新组织，分开成几个库 OBJS = $(GDBM_OF) LOBJS = $(GDBM_LOF) C_OBJS = $(DBM_OF) $(NDBM_OF) C_LOBJS = $(DBM_LOF) $(NDBM_LOF) # gdbm头文件列表 HDRS = gdbmdefs.h extern.h gdbmerrno.h systems.h dbm.h ndbm.h gdbmconst.h / proto.h # 其他需要的文件列表，包括一些构建性文件等 MSCFILES = COPYING ChangeLog Makefile.in README gdbm.3 gdbm.texinfo / gdbm.info NEWS INSTALL gdbm.proto gdbm.proto2 conv2gdbm.c / configure configure.in getopt.c getopt.h samp1.cc / autoconf.h.in install-sh mkinstalldirs config.guess config.sub / aclocal.m4 ltconfig ltmain.sh # 用来打包发布的文件列表（.tar.gz包中的文件列表） DISTFILES = $(SRCS) $(HDRS) $(MSCFILES) # 目标all：默认目标，依赖于另外两个目标 all: libgdbm.la libgdbm_compat.la # 目标progs：用于生成测试程序和转换程序 progs: $(PROGS) # 目标install：用于安装gdbm。先在mkinstalldirs脚本中指定库文件libgdbm.la、头文件gdbm.h、 # man(3)手册页gdbm.3、info手册页gdbm.info的安装目录， # 然后用INSTALL_DATA指定的工具安装它们，la型的库文件一般用libtool来安装 install: libgdbm.la gdbm.h gdbm.info $(srcdir)/mkinstalldirs $(INSTALL_ROOT)$(libdir) / $(INSTALL_ROOT)$(includedir) $(INSTALL_ROOT)$(man3dir) / $(INSTALL_ROOT)$(infodir) $(LIBTOOL) $(INSTALL) -c libgdbm.la $(INSTALL_ROOT)$(libdir)/libgdbm.la $(INSTALL_DATA) -o $(BINOWN) -g $(BINGRP) gdbm.h / $(INSTALL_ROOT)$(includedir)/gdbm.h $(INSTALL_DATA) -o $(BINOWN) -g $(BINGRP) $(srcdir)/gdbm.3 / $(INSTALL_ROOT)$(man3dir)/gdbm.3 $(INSTALL_DATA) -o $(BINOWN) -g $(BINGRP) $(srcdir)/gdbm.info / $(INSTALL_ROOT)$(infodir)/gdbm.info # 目标install-compat：安装ndbm和dbm部分。先在mkinstalldirs脚本中指定库文件libgdbm_compat.la、 # 头文件ndbm.h和dbm.h的安装目录，然后安装它们 install-compat: $(srcdir)/mkinstalldirs $(INSTALL_ROOT)$(libdir) / $(INSTALL_ROOT)$(includedir) $(LIBTOOL) $(INSTALL) -c libgdbm_compat.la / $(INSTALL_ROOT)$(libdir)/libgdbm_compat.la $(INSTALL_DATA) -o $(BINOWN) -g $(BINGRP) $(srcdir)/dbm.h / $(INSTALL_ROOT)$(includedir)/dbm.h $(INSTALL_DATA) -o $(BINOWN) -g $(BINGRP) $(srcdir)/ndbm.h / $(INSTALL_ROOT)$(includedir)/ndbm.h #libgdbm.a: $(OBJS) gdbm.h # rm -f libgdbm.a # ar q libgdbm.a $(OBJS) # $(RANLIB) libgdbm.a # 目标libgdbm.la：生成gdbm库文件libgdbm.la，直接用libtool编译并生成它 libgdbm.la: $(LOBJS) gdbm.h rm -f libgdbm.la $(LIBTOOL) --mode=link $(CC) -o libgdbm.la -rpath $(libdir) / -version-info $(SHLIB_VER) $(LOBJS) # 目标libgdbm_compat.la：生成ndbm和dbm库的文件libgdbm_compat.la标，直接用libtool编译并生成它 libgdbm_compat.la: $(C_LOBJS) gdbm.h rm -f libgdbm_compat.la $(LIBTOOL) --mode=link $(CC) -o libgdbm_compat.la -rpath $(libdir) / -version-info $(SHLIB_VER) $(C_LOBJS) # 目标gdbm.h：生成头文件gdbm.h，直接把gdbm.proto、gdbm.proto2以及gdbmerrno.h中一个全局变量复制到gdbm.h中 gdbm.h: gdbm.proto gdbmerrno.h gdbm.proto2 rm -f gdbm.h cp $(srcdir)/gdbm.proto gdbm.h chmod +w gdbm.h grep _ $(srcdir)/gdbmerrno.h >> gdbm.h cat $(srcdir)/gdbm.proto2 >> gdbm.h chmod -w gdbm.h # 下面几个目标用来生成测试程序和转换程序 testgdbm: testgdbm.o libgdbm.la $(LIBTOOL) $(CC) $(LDFLAGS) -o testgdbm testgdbm.o libgdbm.la testdbm: testdbm.o libgdbm.la libgdbm_compat.la $(LIBTOOL) $(CC) $(LDFLAGS) -o testdbm testdbm.o libgdbm.la libgdbm_compat.la tdbm: testdbm.o $(CC) $(LDFLAGS) -o tdbm testdbm.o $(LIBS) testndbm.o: testndbm.c $(CC) -c -I. -I$(srcdir) $(CFLAGS) $(DEFS) -DGNU $(srcdir)/testndbm.c testndbm: testndbm.o libgdbm.la libgdbm_compat.la $(LIBTOOL) $(CC) $(LDFLAGS) -o testndbm testndbm.o libgdbm.la libgdbm_compat.la tndbm.o: testndbm.c cp $(srcdir)/testndbm.c ./tndbm.c $(CC) -c -I. -I$(srcdir) $(CFLAGS) $(DEFS) ./tndbm.c rm -f ./tndbm.c tndbm: tndbm.o $(CC) $(LDFLAGS) -o tndbm tndbm.o $(LIBS) conv2gdbm: conv2gdbm.o libgdbm.la $(LIBTOOL) $(CC) $(LDFLAGS) -o conv2gdbm conv2gdbm.o $(LIBS) libgdbm.la lintgdbm: lint $(DEFS) $(LFLAGS) $(DBM_CF) $(NDBM_CF) $(GDBM_CF) testgdbm.c TAGS: $(SRCS) etags $(SRCS) info: gdbm.info # 目标gdbm.info：用于生成info文档gdbm.info，调用makeinfo工具来把gdbm.textinfo源文件输出为info文档 gdbm.info: gdbm.texinfo $(MAKEINFO) $(srcdir)/gdbm.texinfo dvi: gdbm.dvi # 目标gdbm.dvi：用于生成dvi文档gdbm.dvi，调用texi2dvi工具来把gdbm.textinfo源文件输出为dvi文档 gdbm.dvi: gdbm.texinfo $(TEXI2DVI) $(srcdir)/gdbm.texinfo # 目标clean：清除之前编译生成的目标文件、可执行文件及配置文件 clean: rm -rf $(PROGS) $(TEX_F) *.a *.la *.o *.lo core *.core junk* / .libs _libs mostlyclean: clean # 目标distclean：清除所有生成的文件，回到./configure之前的状态 distclean: clean rm -f Makefile autoconf.h config.status config.cache config.log / gdbm.h libtool $(TEXI_F) *~ realclean: distclean rm -f TAGS -rm -f / `sed -n 's/.*/([0-9][0-9]*/.[0-9][0-9]*/.[0-9][0-9]*/).*/gdbm-/1/p' / version.c`.tar.gz # 目标dist：用tar和gzip工具将程序打包发布，包扩展名为.tar.gz dist: echo / `sed -n 's/.*/([0-9][0-9]*/.[0-9][0-9]*/.[0-9][0-9]*/).*/gdbm-/1/p' / version.c` > .fname rm -rf `cat .fname` mkdir `cat .fname` ln $(DISTFILES) `cat .fname` tar chf `cat .fname`.tar `cat .fname` gzip `cat .fname`.tar rm -rf `cat .fname` .fname # dbm文件的目标 dbminit.o: autoconf.h gdbmdefs.h proto.h extern.h gdbmerrno.h delete.o: autoconf.h gdbmdefs.h proto.h extern.h fetch.o: autoconf.h gdbmdefs.h proto.h extern.h store.o: autoconf.h gdbmdefs.h proto.h extern.h seq.o: autoconf.h gdbmdefs.h proto.h extern.h # ndbm文件的目标 dbmopen.o: autoconf.h gdbmdefs.h extern.h gdbmerrno.h dbmdelete.o: autoconf.h gdbmdefs.h extern.h dbmfetch.o: autoconf.h gdbmdefs.h extern.h dbmstore.o: autoconf.h gdbmdefs.h extern.h dbmseq.o: autoconf.h gdbmdefs.h extern.h dbmclose.o: autoconf.h gdbmdefs.h systems.h dbmpagfno.o: autoconf.h gdbmdefs.h extern.h dbmdirfno.o: autoconf.h gdbmdefs.h extern.h # gdbm文件的目标 gdbmclose.o: autoconf.h gdbmdefs.h gdbmdelete.o: autoconf.h gdbmdefs.h gdbmerrno.h gdbmfetch.o: autoconf.h gdbmdefs.h gdbmerrno.h gdbmfdesc.o: autoconf.h gdbmdefs.h gdbmopen.o: autoconf.h gdbmdefs.h gdbmerrno.h gdbmreorg.o: autoconf.h gdbmdefs.h gdbmerrno.h extern.h gdbmseq.o: autoconf.h gdbmdefs.h gdbmstore.o: autoconf.h gdbmdefs.h gdbmerrno.h # gdbm支持文件的目标 bucket.o: autoconf.h gdbmdefs.h falloc.o: autoconf.h gdbmdefs.h findkey.o: autoconf.h gdbmdefs.h global.o: autoconf.h gdbmdefs.h gdbmerrno.h hash.o: autoconf.h gdbmdefs.h update.o: autoconf.h gdbmdefs.h version.o: extern.h: gdbmdefs.h: gdbmconst.h systems.h touch gdbmdefs.h # 其他的程序，主要是测试程序和转换程序的目标 testgdbm.o: autoconf.h gdbmdefs.h extern.h gdbmerrno.h systems.h testdbm.o: autoconf.h testndbm.o: autoconf.h ndbm.h tdbm.o: autoconf.h conv2gdbm.o: autoconf.h gdbm.h

   其他未解剖的构建性文件主要还有aclocal.m4、configure脚本（由configure.in生成，configure.in前面已经解剖过了）、config.guess、config.sub、install-sh、config.status、libtool。一般都是由Autotools工具根据系统和项目的配置信息自动生成，我们无需过问。这些文件都比较长且很繁锁，因为自动工具在生成它们要考虑各种平台的差异（如BSD、System V、HP UNIX等等）、同一平台不同版本的变迁、以及同一平台上不同用户的不同配置等。这里只对其中一些文件作一些简单的介绍。
   （2）config.guess：GNU构建系统区分三类机器，运行构建用的编译器的“构建”机器、运行构建的软件包的“主机”机器、编译器用来产生代码的“目标”机器。这个脚本用来猜测“构建”机器的类型，并输出脚本所运行的系统的配置名(configure name)。
   （3）config.sub：使系统的配置名规范化。
   （4）config.status：这是一个动态生成的脚本文件，用于检测一些与编译器具体相关的参数，它由configure脚本生成。这个文件可用来重新创建configure脚本。
   （5）libtool：libtool 是一个通用库支持脚本，将使用动态库的复杂性隐藏在统一、可移植的接口中；使用libtool的标准方法，可以在不同平台上创建并调用动态库。可以认为 libtool是gcc的一个抽象，其包装了gcc（或者其他的编译器），用户无需知道细节，只要告诉libtool需要编译哪些库即可，libtool 将处理库的依赖等细节。libtool只与后缀名为lo、la为的libtool文件打交道。libtool 主要的一个作用是在编译大型软件的过程中解决了库的依赖问题；将繁重的库依赖关系的维护工作承担下来，从而释放了程序员的人力资源。libtool提供统一的接口，隐藏了不同平台间库的名称的差异等细节，生成一个抽象的后缀名为la高层库libxx.la（其实是个文本文件），并将该库对其它库的依赖关系，都写在该la的文件中。该文件中的dependency_libs记录该库依赖的所有库（其中有些是以.la文件的形式加入的）；libdir则指出了库的安装位置；library_names记录了共享库的名字；old_library记录了静态库的名字。
   注意Linux中.o .a .so .la .lo的区别。.o是编译出的目标文件；.a是静态库，其实就是把若干.o文件打成了一个包；.so为动态链接库（共享库）；.lo是使用libtool编译出的目标文件，其实就是在.o文件中添加了一些信息；.la是使用libtool编译出的库文件，其实是个文本文件，记录同名动态库的和静态库的相关信息。

   最后只剩下三个文档文件gdbm.3、gdbm.info、gdbm.textinfo了。也作一下简单的介绍。
   （6）gdbm.3：用来生成man(3)手册页的源文件，它主要的功能就是对手册页的格式进行排版，一般直接安装到/usr/local/man/man3下。这样就可以用命令man gdbm或man 3 gdbm自动对其进行排版并显示排版结果。我们也可用groff（或nroff）工具对它进行处理，以输出为ASCII文本（-Tascii选项）或PostScript（-Tps选项）等。
   （7）gdbm.info：info手册页（与man手册页类似，都是提供程序的帮助信息），直接安装到/usr/local/info下，就可以用命令info gdbm来查看了。它是由makeinfo工具根据gdbm.textinfo源文件生成而来的。是八进制的流文件，也可用cat命令查看其内容。
   （8）gdbm.textinfo：Textinfo源文件，可用输出为各种格式的文档，如info文档、普通文本、HTML、DVI、PDF、XML、Docbook等。