不管是否為開源軟體,提供適配不同平臺的編譯和打包工具有利于軟體的推廣使用,Bitcoin可運行在多個平臺下,包括windows, Unix/Linux(如:Centos、Ubuntu、FreeBSD、Debian)、macOS等系統,用戶可在這些平臺下修改和編譯Bitcoin核心源代碼,在接下來的所有文章中,我以CentOS Stream 8作業系統為例,使用autoconf-2.69和GNU c++11.2(支持最新的C++20和C++23)作為打包和編譯工具,來分析Bitcoin源代碼和進行編譯,同時開發一些演示用的例子,
Bitcoin使用的是Autoconf作為編譯和配置工具,它的開發語言是C++,因此如果用戶希望要分析其源代碼并能進行代碼調式的,就有必要首先了解Autoconf,它是一個在Bourne shell(就是通常所說的shell,擴展名為.sh的檔案)下制作供編譯、安裝和打包軟體的配置腳本的工具,有點類似于Java平臺下的配置工具Ant、Maven 、Gradle,這些都可以幫助用戶快速編譯、打包分發Java應用,有人可能會說使用原始的命令列來完成編譯和打包,不需要這些工具,這當然沒有問題的,不過你因此可能需要付出大量時間在這上面,早期在Linux平臺行C++編譯,就需要自己撰寫Makefile檔案,當需要在多個平臺下進行交叉編譯時涉及大量的腳本撰寫作業,這對于不熟悉shell編程的人來說是一個挑戰且費時費力,
接下來花點時間帶大家了解下Autoconf如何使用,以及如何在自己的專案中使用Autoconf,它與Automake、Libtool等軟體組成了GNU構建系統,也就是說Autoconf需和Automake,Libtool配合使用,各司其職,當前在CentOS Stream 8系統下,這個三個工具用如下命令獲得版本號(注:#符號表示Linux Shell命令提示符):
# autoconf --version
autoconf (GNU Autoconf) 2.69
Copyright (C) 2012 Free Software Foundation, Inc.
License GPLv3+/Autoconf: GNU GPL version 3 or later
# automake --version
automake (GNU automake) 1.16.1
Copyright (C) 2018 Free Software Foundation, Inc.
# libtool --version
libtool (GNU libtool) 2.4.6
Written by Gordon Matzigkeit, 1996
Autoconf作業流程:

上圖是分解后的步驟,看來步驟很多,實際上可以縮減成一個命令就能完成(在后面會介紹),上圖的步驟節點分成兩種型別:橢圓形的表示命令,矩形表示輸入或輸出的檔案,下面通過例子來說明如何使用這些命令,
假設用戶創建了一個名為tutorial_autoconf_app的專案,所有專案檔案保存在名為tutorial_autoconf目錄下,該目錄的結構如下:
[root@localhost tutorial_autoconf]# tree
.
├── doc
└── src
├── main.cpp
├── tutorialtest.cpp
└── tutorialtest.h
2 directories, 3 files
其中src目錄存放跟專案相關的所有源代碼,doc目錄存放檔案,現實中用戶可以根據需要來創建自己所需的目錄,在src中添加三個簡單的c++程式,內容如下:
tutorialtest.h
#ifndef TUTORIAL_AUTOCONF_TEST_H_
#define TUTORIAL_AUTOCONF_TEST_H_
#include <string>
#include <iostream>
class TutorialTest
{
public:
TutorialTest(const std::string& msg);
};
#endif // TUTORIAL_AUTOCONF_TEST_H_
tutorialtest.cpp
#include <tutorialtest.h>
TutorialTest::TutorialTest(const std::string& msg)
{
std::cout << msg << std::endl;
}
main.cpp
#include <stdio.h>
#include <iostream>
#include <tutorialtest.h>
int main(int argc, char*argv [])
{
TutorialTest t{"Hello autoconf tutorial test......"};
exit(EXIT_SUCCESS);
}
推薦使用windows的用戶使用Visual Studio Code作為代碼編輯器,在vscode中安裝Rmote SSH插件后,它可以直接連接到Centos(或類似的Linux)系統進行檔案編輯、目錄創建等操作,它就像在本地操作一樣的感覺,安裝C/C++ IntelliSense插件后就有自動提示和智能標簽這些功能,vscode也有針對Ubuntu版本的,因此使用Ubuntu桌面的也可以使用vscode,不用圖形桌面的用戶,直接使用vim編輯器也可以,
現在我們嘗試按照上面的流程圖并按以下順序來完成一個簡單的Autoconf使用測驗,以下的幾個指令均在根目錄tutorial_autoconf下執行,
- 執行autoscan命令:它會生成兩個檔案autoscan.log和configure.scan,其中 .log是記錄日志,configure.scan檔案是configure.ac的原型模板,你可以直接將它更名為configure.ac,Autoconf就是使用此檔案來生成配置腳本(也就是執行configure的腳本,后面會講到),configure.scan內容:
# -*- Autoconf -*- # Process this file with autoconf to produce a configure script. #指定Autoconf的版本 AC_PREREQ([2.69]) AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS]) #指定某個源代碼檔案以確保該目錄存在 AC_CONFIG_SRCDIR([src/main.cpp]) #輸出配置后的宏定義實體檔案,通常為config.h AC_CONFIG_HEADERS([config.h]) # Checks for programs. # 使用c++編譯器 AC_PROG_CXX # 使用C語言編譯器 AC_PROG_CC # Checks for libraries. # Checks for header files. # Checks for typedefs, structures, and compiler characteristics. # Checks for library functions. # 生成Makefile.in,該檔案運行配置程式時生成最終的Makfile的中間檔案 # 當檔案目錄下沒有Makfile.am檔案,Makefile.in也不能產生 AC_CONFIG_FILES([Makefile]) AC_OUTPUT上面的configure.ac是一些基本的陳述句,所以暫時也時無法使用的,這里說明一下基本的語法,AC_開頭就是宏,凡是學過c/c++都知道宏的含義,只不過這里是shell使用的宏,它的作用就是通過M4(Autoconf的一個宏執行工具)決議成為配置中可執行的腳本,從而完成宏到腳本的轉換,為最終的Makefile提供幫助,關于宏的使用可參考https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.70/autoconf.html,這里只針對一部分宏做一些解釋,
注意宏的括號內的一般需要成對使用[ ]符號,且宏名稱與后面的圓括號之間不能有空格符,一般情況下使用AC_PROG_CXX編譯就足夠,因為支持C++語言編譯的也支持C編譯,因此可以去掉AC_PROG_CC宏,下面對configure.ac做一些補充和完善,
configure.ac
# -*- Autoconf -*- # Process this file with autoconf to produce a configure script. #指定Autoconf的版本 AC_PREREQ([2.69]) dnl AC_INIT(package, version, bug-report-address) AC_INIT([TutorialAutoconfApp], [VERSION], [BUG-REPORT-ADDRESS]) # AC_INIT ([oops], [1.0]) # incorrect #指定某個源代碼檔案以確保該目錄存在 AC_CONFIG_SRCDIR([src/main.cpp]) #輸出配置后的宏定義實體檔案,通常為config.h AC_CONFIG_HEADERS([config.h]) dnl 設定Automake 選項: dnl subdir-objects - 如果指定了此選項,則物件將放置在與源檔案子目錄對應的構建目錄的子目錄中, 例如,如果源檔案是 subdir/file.cxx,那么輸出檔案將是 subdir/file.o dnl foreign - Automake 將只檢查正確操作所絕對需要的那些東西, 例如,雖然 GNU 標準規定了 NEWS 檔案的存在,但在這種模式下不需要它, 該選項還會默認關閉一些警告(其中包括可移植性警告), AM_INIT_AUTOMAKE([subdir-objects foreign]) # Checks for programs. # 自動檢測使用c++編譯器 AC_PROG_CXX # 自動檢測使用C語言編譯器,一般不需要,C++編譯器也支持C的編譯 # AC_PROG_CC # Checks for libraries. # Checks for header files. # Checks for typedefs, structures, and compiler characteristics. # Checks for library functions. # 在運行autoconf后,在對應的目錄下生成Makefile.in檔案,它是運行配置程式時生成最終的Makfile的輸入檔案 # 當檔案目錄下沒有Makfile.am檔案,Makefile.in也不能生成 AC_CONFIG_FILES([Makefile]) AC_OUTPUT注意上面使用了兩中注釋方法 dnl 和 # ,區別在于 dnl及其注釋會在最終的Makefile中丟棄,所以它在只是原始檔案中的注釋,而#和注釋會出現在最終的Makefile中,在執行aclocal命令之前,我們需要編輯Makefile.am檔案,它定義了編譯需要的源檔案,編譯引數和輸出的目標檔案,下面是一個簡單的Makefile.am,存放在根目錄下,內容如下:
Makefile.am
# 到該目錄搜索源代碼檔案 SRC_INCLUDE = "-I$(top_srcdir)/src" # 輸出的目標程式名稱 bin_PROGRAMS = autoconf_test # 編譯目標程式需要包含的源代碼檔案 autoconf_test_SOURCES = \ src/main.cpp \ src/tutorialtest.cpp \ src/tutorialtest.h # 編譯引數 autoconf_test_CPPFLAGS = $(AM_CPPFLAGS) $(SRC_INCLUDE) autoconf_test_CXXFLAGS = $(AM_CXXFLAGS) $(SRC_INCLUDE)Makefile.am中的bin_PROGRAMS指定了編譯輸出的目標檔案名,如果有多個,可以通過空格分開,_SOURCES和_CXXFLAGS的前綴必須與bin_PROGRAMS中定義的名稱對應,_CXXFLAGS是C++ 編譯器的除錯和優化選項,CPPFLAGS 應該用于 C 前處理器的標志,兩個可以同時存在,在Autoconf中,分別用AM_CPPFLAGS和AM_CXXFLAGS來代替,
- 執行aclocal命令:生成aclocal.m4和目錄autom4te.cache,它借助m4將其中的宏實作為配置腳本中可執行的代碼,在本地中目錄/usr/share/aclocal中有很多.m4檔案,它是具體執行宏轉換的實作檔案,
- 執行autoheader命令:生成config.h.in
- 執行autoconf命令:生成configure
- 執行automake --add-missing: 如果給出了 --add-missing 選項,automake 將添加一個通用版本的 INSTALL 檔案以及包含在此 Automake 發行版,執行完該命令將生成depcomp、install-sh、missing、Makefile.in四個檔案,
經過上面幾個步驟后,我們再看看根目錄下的檔案:
[root@localhost tutorial_autoconf]# tree
.
├── aclocal.m4
├── autom4te.cache
├── autoscan.log
├── config.h.in
├── configure
├── configure.ac
├── doc
├── install-sh
├── Makefile.am
├── Makefile.in
├── missing
└── src
├── main.cpp
├── tutorialtest.cpp
└── tutorialtest.h
我們可以將上面的幾個命令簡化成一個命令,效果一致,只需要執行:
# autoreconf -fvi
執行上述命令的前提是必須事先編輯好Makefile.am和configure.ac檔案,當有了配置腳本configure之后,我們就可以嘗試進行下面的編譯,
編譯和測驗:
在經過了上述的操作后,已經具備了生成Makefile的前提條件,Makefile是執行編譯和打包的必備檔案,為了將編譯輸出的中間檔案不和根目錄下的檔案混在一起,在根目錄下新建build目錄并在該目錄下執行:
# mkdir build
# cd build
# ../configure
# make
在完成make編譯后,build目錄下生成了一個autoconf_test可執行檔案,他就是最終的輸出檔案,運行測驗如下:
[root@localhost build]# ./autoconf_test
Hello autoconf tutorial test......
總結:
簡化后的步驟可歸納為:
- 編輯configure.ac和Makefile.am
- 執行autoreconf -fvi生成相關檔案
- 運行configure完成配置并生成Makefile
- 執行make完成編譯并生成目標檔案
本文展示了最簡單的Autoconf的使用,它幫助用戶了解Autoconf最基本的原理和方法,現實遠比這復雜得多,configure.ac和Makefile.am需要撰寫的內容也會隨著專案的規模大變得非常龐大,Autoconf優點是它可以幫助用戶實作快速的跨平臺的編譯安裝打包,缺點是所使用的M4對于一些開發者來說是陌生的,因此他們需要專門學習,一些開發者并不遵循配置腳本的一些習慣約定,甚至有的語法比較怪異難理解,
轉載請註明出處,本文鏈接:https://www.uj5u.com/qukuanlian/385676.html
標籤:區塊鏈
上一篇:JASMINER:元宇宙與web3.0是互聯網的未來式
下一篇:區塊鏈私有鏈new
