⑴ Makefile.am 規則和實例詳解
編寫Linux C 程序的時候,自己來寫Makefile著實的讓人很頭疼,如果是簡單的項目自己寫寫也就罷了,但是如果遇到大項目自己寫Makefile,那是要弄死人的,所以最近在研究Autotools工具自動生成Makefile,在用到autotools工具生成Makefile的時候,還是有一部分需要自己來完成的,那就是Makefile.am文件。
項目中寫在源文件里的Makefile.am是一種比我們了解的Makefile更高層次的編譯規則,它可以和編寫的configure.in(了解更多configure.in的規則請閱讀《 configure.ac (configure.in)詳解 》)文件一起通過調用automake命令,來生成Makefile.in文件,然後再調用./configure,將Makefile.in文件自動的生成Makefile文件。所以Makefile.am文件是要自動生成Makefile必不可少的元素,下面鵬博客就來和大家著重的學習下Makefile.am的寫法和規則。
先來說下Makefile.am中常見的文件編譯類型,詳細的編譯類型和全局變數鵬博客會在下面在圖表中列出:
PROGRAMS 表示可執行文件
SOURCES 表示源文件
HEADERS 頭文件。
LIBRARIES 表示庫文件
LTLIBRARIES 這也是表示庫文件,前面的LT表示libtool。
DATA 數據文件,不能執行。
SCRIPTS 腳本文件,這個可以被用於執行。如:example_SCRIPTS,如果用這樣的話,需要我們自己定義安裝目錄下的example目錄,很容易的,往下看。
一、基本寫法
下面就直接引入一個例子進行詳細講解,如下:
AUTOMAKE_OPTIONS = foreign
bin_PROGRAMS = client
client_SOURCES = key.c connect.c client.c main.c session.c hash.c
client_CPPFLAGS = -DCONFIG_DIR=\「$(sysconfdir)\」 -DLIBRARY_DIR=\」$(pkglibdir)\」
client_LDFLAGS = -export-dynamic -lmemcached
noinst_HEADERS = client.h
INCLUDES = -I/usr/local/libmemcached/include/
client_LDADD = $(top_builddir)/sx/libsession.la \
$(top_builddir)/util/libutil.la
上面就是一個Makefile.am示例文件,這個文件是用於生成client可執行應用程序,引用了兩個靜態庫和MC等動態庫的連接。
先來看個圖表一(列出了可執行文件、靜態庫、頭文件和數據文件,四種書寫Makefile.am文件個一般格式。):
對於可執行文件和靜態庫類型,如果只想編譯,不想安裝到系統中,可以用noinst_PROGRAMS代替bin_PROGRAMS,noinst_LIBRARIES代替lib_LIBRARIES。以此類推。
根據這個圖表一來分析下具體內容:
AUTOMAKE_OPTIONS :這個是用來設定automake的選項。automake主要是幫助開發GNU軟體的人員維護軟體套件,一般在執行automake時會檢查目錄下是否存在標准GNU套件中應具備的文件檔案,例如NEWS、AUTHOR、ChangeLog等,設成foreign時,automake會改用一般軟體套件標准來檢查,而gnu是預設設置,該級別下將盡可能地檢查包是否服從GNU標准,gnits是嚴格標准,不推薦。
bin_PROGRAMS :表示要生成的可執行應用程序文件,這里的bin表示可執行文件在安裝時需要被安裝到系統中,如果只是想編譯。不想被安裝到系統中,可以用noinst_PROGRAMS來代替。
那麼整個第一行 bin_PROGRAMS=client 詳細表示什麼意思那,解釋如下:
PROGRAMS知道這是一個可執行文件。
client表示編譯的目標文件。
bin表示目錄文件被安裝到系統的目錄。
如程序和圖片所示,包括頭文件,靜態庫的定義等等都是這種形式,如lib_LIBRARIES=util,表示將util庫安裝到lib目錄下。
繼續解釋文件內容:
client_SOURCES :表示生成可執行應用程序所用的所有源文件源文件,多個就空格隔開,我們注意到client_是由前面的bin_PROGRAMS指定的,如果前面是生成example, 那麼這里也就變成example_SOURCES,其它的規則類似標識也是一樣。
client_CPPFLAGS :這個和我們寫Makefile的時候意思是一樣的,都表示C語言的預處理器參數,這里指定了DCONFIG_DIR,以後在程序中,就可以直接使用CONFIG_DIR,不要把這個和另一個CFLAGS混淆,後者表示編譯器參數。
client_LDFLAGS :表示在連接時所需要的庫文件選項標識。這個也就是對應一些如-l,-shared等選項。
noinst_HEADERS :表示該頭文件只是參加可執行文件的編譯,而不用安裝到安裝目錄下。如果需要安裝到系統中,可以用include_HEADERS來代替。
INCLUDES :表示連接時所需要的頭文件。
client_LDADD :表示連接時所需要的庫文件,這里表示需要兩個庫文件的支持,下面會看到這個庫文件又是怎麼用Makefile.am文件後成的。
如圖表二:
全局變數 ,可能有人注意到文件中的$(top_builddir)等全局變數,其實這個是Makefile.am系統定義的一個基本路徑變數,表示生成目標文件的最上層目錄,如果這個Makefile.am文件變成其它的Makefile.am文件,那麼這個就表示其它的目錄,而不是這個當前目錄。我們還可以使用$(top_srcdir),這個表示工程的最頂層目錄,其實也是第一個Makefile.am的入口目錄,因為Makefile.am文件可以被遞歸性的調用。
如圖表三:(在Makefile.am中盡量使用相對路徑,系統預定義了兩個基本路徑)
$(sysconfdir) :在系統安裝工具的時候,我們經常能遇到配置安裝路徑的命令,如:./configure –prefix=/install/apache 其實在調用這個之後,就定義了一個變數$(prefix), 表示安裝的路徑,如果沒有指定安裝的路徑,會被安裝到默認的路徑,一般都是/usr/local。在定義$(prefix),還有一些預定義好的目錄,其實這一些定義都可以在頂層的Makefile文件中可以看到,如下面一些值:
bindir = $(prefix)/bin。
libdir = $(prefix)/lib。
datadir=$(prefix)/share。
sysconfdir=$(prefix)/etc。
includedir=$(prefix)/include。
這些量還可以用於定義其它目錄,例如我想 將client.h安裝到include/client目錄下 ,這樣寫Makefile.am文件:
clientincludedir=$(includedir)/client
clientinclude_HEADERS=$(top_srcdir)/client/client.h
這就達到了我的目的,相當於定義了一個安裝類型,這種安裝類型是將文件安裝到include/client目錄下。
我們自己也可以 定義新的安裝目錄下的路徑 ,如我在應用中簡單定義的:
devicedir = ${prefix}/device
device_DATA = package
這樣的話,package文件會作為數據文件安裝到device目錄之下,這樣一個可執行文件就定義好了。注意,這也相當於定義了一種安裝類型:devicedir,所以你想怎麼安裝就怎麼安裝,後面的XXXXXdir,dir是固定不變的。
二、配置靜態庫
下面我們來說下編譯靜態庫和編譯動態庫,我們說下靜態庫,下面這個例子比較簡單。直接指定 XXXX_LTLIBRARIES或者XXXX_LIBRARIES就可以了。同樣如果不需要安裝到系統,將XXXX換成noinst就可以。
一般推薦使用libtool庫編譯目標,因為automake包含libtool,這對於跨平台可移植的庫來說,是一個很好的事情。
看例子如下:
noinst_LTLIBRARIES = libutil.la
oinst_HEADERS = inaddr.h util.h compat.h pool.h xhash.h url.h device.h
ibutil_la_SOURCES = access.c config.c datetime.c hex.c inaddr.c log.c device.c pool.c rate.c sha1.c stanza.c str.c xhash.c
ibutil_la_LIBADD = @LDFLAGS@
第一行的noinst_LTLIBRARIES,這里要注意的是LTLIBRARIES,另外還有LIBRARIES,兩個都表示庫文件。前者表示libtool庫,用法上基本是一樣的。如果需要安裝到系統中的話,用lib_LTLIBRARIES。
.la 為libtool自動生成的一些共享庫,vi編輯查看,主要記錄了一些配置信息。可以用如下命令查看*.la文件的格式 $file *.la
.a 為靜態庫,是好多個.o合在一起,用於靜態連接
如果想編譯 .a 文件,那麼上面的配置就改成如下結果:
noinst_LTLIBRARIES = libutil.a
oinst_HEADERS = inaddr.h util.h compat.h pool.h xhash.h url.h device.h
ibutil_a_SOURCES = access.c config.c datetime.c hex.c inaddr.c log.c device.c pool.c rate.c sha1.c stanza.c str.c xhash.c
ibutil_a_LIBADD = @LDFLAGS@
注意:靜態庫編譯連接時需要其它的庫的話,採用XXXX_LIBADD選項,而不是前面的XXXX_LDADD。編譯靜態庫是比較簡單的,因為直接可以指定其類型。
三、配置動態庫
如果想要編譯XXX.so動態庫文件,需要用到_PROGRAMS類型,有一個關於安裝路徑的問題,如果希望將動態庫安裝到lib目錄下,按照前面所說的,只需要寫成lib_PROGRAMS就可以了,lib表示安裝的路徑,但是automake不允許這樣直接定義,所以可以採用下面的辦法,同樣是將動態庫安裝到lib目錄下:
projectlibdir=$(libdir)//新建一個目錄,就是該目錄就是lib目錄
projectlib_PROGRAMS=project.so
project_so_SOURCES=xxx.C
project_so_LDFLAGS=-shared -fpic//GCC編譯動態庫的選項
這個動態庫的編譯寫法是鵬博客網上總結的,希望有要的人自己來驗證下。
四、SUBDIRS功能用法
SUBDIRS 這是一個很重要的詞,我們前面生成了一個目標文件,但是一個大型的工程項目是由許多個可執行文件和庫文件組成,也就是包含多個目錄,每個目錄下都有用於生成該目錄下的目標文件的Makefile.am文件,但頂層目錄是如何調用,才能使下面各個目錄分別生成自己的目標文件呢?就是SUBDIRS關鍵詞的用法了。
看一下我的工程項目,這是頂層的Makefile.am文件
EXTRA_DIST = Doxyfile.in README.win32 README.protocol contrib UPGRADE
devicedir = ${prefix}/device
device_DATA = package
SUBDIRS = etc man
ifUSE_LIBSUBST
SUBDIRS += subst
endif
SUBDIRS += tools io sessions util client dispatch server hash storage sms
SUBDIRS表示在處理目錄之前,要遞歸處理哪些子目錄,要注意處理的順序。比如配置中的client對sessions和utils這兩上目標文件有依賴關系,就在client之前需要處理這兩個目標文件。
EXTRA_DIST :將哪些文件一起打包。
五、打包處理
Automake會自動的打包 ,自動打包的內容如下:
所有程序的源文件。
所有子目錄里的的Makefile.am文件。
Makefile.am中包含的文件。
./configure所要讀取的文件。
EXTRA_DIST所指定的文件。
dist和nodist指定的文件,也可將其中一個源文件指定為不打包:
例如: nodist_client_SOURCES = client.c
六、最後
這里是鵬博客總結的一些比較實用的Makefile.am的寫法和規則,看完了這篇文章已經可以很詳細的理解這個文件的內容,寫起來也應該不會陌生,但automake還有許多其他的規則需要掌握,鵬博客將會繼續全面的總結關於autotools 的一些規則和寫法,希望對大家有用處。也歡迎大家指出問題,幫我完善這個博客,希望大家支持!
automake的Makefile.am Makefile.am寫法
⑵ 在LINUX系統中編程序,makefile是怎麼生成的,是通過GCC或GDB編譯聯接生成的嗎
這位朋友我看是有點誤解了makefile的做用。makefile 是一個腳本,由他來控制編譯出的程序的版本。當你改寫了原文件後,通過makefile 來檢查依賴關系,來生成最終的文件。比如一個程序叫a 他的源碼叫a.c
a.c 又用到頭文件a.h ,a.h是1.h和2.h生成的
如果你改寫了1.h,通過編寫makefile文件。make時會調用makefile來依此按依賴關系生成最後的a
所以說編譯時程序並不知道生成a都用到什麼。怎麼可能自己生成呢。
makefile是要你自己編寫的,來告訴make來如何編譯。make工具就相當於一個腳本。