本篇筆記主要分析nodeos程序的流程
1、代碼所在路徑（yourpath換成你的路徑）
yourpath/eos/programs/nodeos/main.cpp
2、首先main函數(shù)中的代碼并不長，可以通過五個(gè)類來學(xué)習(xí)這段代碼。
app().set_version(eosio::nodeos::config::version);
app().register_plugin<history_plugin>();
auto root = fc::app_path();
app().set_default_data_dir(root / "eosio/nodeos/data" );
app().set_default_config_dir(root / "eosio/nodeos/config" );
http_plugin::set_defaults({
.address_config_prefix = "",
.default_unix_socket_path = "",
.default_http_port = 8888
});
if(!app().initialize<chain_plugin, http_plugin, net_plugin, producer_plugin>(argc, argv))
return INITIALIZE_FAIL;
initialize_logging();
ilog("nodeos version ${ver}", ("ver", app().version_string()));
ilog("eosio root is ${root}", ("root", root.string()));
app().startup();
app().exec();
上面的代碼，均是通過調(diào)用app()的成員函數(shù)來實(shí)現(xiàn)的。我們很明顯的看到main函數(shù)的生命周期和app()返回的對(duì)象是完全相同的。所以，第一個(gè)分析的就是app()返回的類對(duì)象。
1、application類（單例模式）
查看app()函數(shù)，發(fā)現(xiàn)其返回的是一個(gè)application類對(duì)象的一個(gè)引用，對(duì)象是通過application類的靜態(tài)方法instance創(chuàng)建的。instance方法創(chuàng)建一個(gè)application類對(duì)象，并返回其引用。由此實(shí)現(xiàn)一個(gè)單例模式，每次調(diào)用app()僅創(chuàng)建一個(gè)對(duì)象。
application& app() { return application::instance(); }
application& application::instance() { static application _app; return _app; }
main函數(shù)中出現(xiàn)的set_version和set_default_data_dir和set_default_config_dir均為簡單的成員函數(shù)，這里略過不寫。
主要分析一下其他幾個(gè)函數(shù)：register_plugin、initialize、startup、exec。
register_plugin函數(shù)是一個(gè)模板函數(shù)，功能是對(duì)插件進(jìn)行注冊。注冊即創(chuàng)建一個(gè)插件對(duì)象，并保存在application對(duì)象的plugins變量里面。注冊插件的時(shí)候是需要注冊其依賴插件的。比如p2p插件依賴于chain插件，那么在注冊p2p插件時(shí)，也需要注冊chain插件。其中獲取請求插件，采用了一個(gè)宏實(shí)現(xiàn)了遞歸獲取的方式，后續(xù)在plugins類中詳細(xì)說明。
template<typename Plugin>
auto& register_plugin() {
auto existing = find_plugin<Plugin>();
if(existing)
return *existing;
auto plug = new Plugin();
plugins[plug->name()].reset(plug);
plug->register_dependencies(); // 比較重要的地方，調(diào)用的是plugins類中的函數(shù)，后續(xù)分析。
return *plug;
}
initialize函數(shù)是一個(gè)變參模板函數(shù)，功能是對(duì)插件進(jìn)行初始化（調(diào)用每個(gè)插件的initialize方法）。內(nèi)部將變參參數(shù)初始化為一個(gè)vector向量，并調(diào)用initialize_impl函數(shù)來具體實(shí)現(xiàn)。
//application.hpp
template<typename... Plugin>
bool initialize(int argc, char** argv) {
return initialize_impl(argc, argv, {find_plugin<Plugin>()...});
}
//application.cpp 調(diào)用插件的initialize方法。
for (auto plugin : autostart_plugins)
if (plugin != nullptr && plugin->get_state() == abstract_plugin::registered)
plugin->initialize(options);
startup函數(shù)很簡單，功能用來啟動(dòng)初始化過的插件，內(nèi)部調(diào)用每個(gè)插件的startup函數(shù)來啟動(dòng)。
for (auto plugin : initialized_plugins) plugin->startup();
exec函數(shù)使用了boost::asio::io_service io服務(wù)，在每個(gè)啟動(dòng)的插件線程里使用異步io的地方，均使用的是application對(duì)象的io服務(wù)，exec函數(shù)創(chuàng)建了異步IO異常終止的信號(hào)，并對(duì)其做了資源釋放處理。
void application::exec() {
std::shared_ptr<boost::asio::signal_set> sigint_set(new boost::asio::signal_set(*io_serv, SIGINT));
sigint_set->async_wait([sigint_set,this](const boost::system::error_code& err, int num) {
quit();
sigint_set->cancel();
});
std::shared_ptr<boost::asio::signal_set> sigterm_set(new boost::asio::signal_set(*io_serv, SIGTERM));
sigterm_set->async_wait([sigterm_set,this](const boost::system::error_code& err, int num) {
quit();
sigterm_set->cancel();
});
std::shared_ptr<boost::asio::signal_set> sigpipe_set(new boost::asio::signal_set(*io_serv, SIGPIPE));
sigpipe_set->async_wait([sigpipe_set,this](const boost::system::error_code& err, int num) {
quit();
sigpipe_set->cancel();
});
io_serv->run();
shutdown(); /// perform synchronous shutdown
}
2、abstract_plugin類
通過對(duì)application類的幾個(gè)函數(shù)的分析，發(fā)現(xiàn)初始化啟動(dòng)插件真正的實(shí)現(xiàn)，是通過插件自身的initialize方法和startup方法來實(shí)現(xiàn)的，下面主要分析其他四個(gè)類--插件類。這四個(gè)類可以用一個(gè)圖來表示：
其中abstract_plugin是虛基類，plugin是它的子類，http_plugin是plugin的子類，http_plugin_impl包含在http_plugin中。即前三個(gè)類是繼承關(guān)系，后面一個(gè)類是包含關(guān)系。
回到上面遺留的問題--“插件是如何注冊其依賴插件的”。
plug->register_dependencies();父類指針指向的是子類對(duì)象，該方法在plugin類中實(shí)現(xiàn)。
virtual void register_dependencies() {
static_cast<Impl*>(this)->plugin_requires([&](auto& plug){});
}
plugin_requires函數(shù)并非Plugin類的成員函數(shù)，是其子類的成員函數(shù)，所以父類指針需要轉(zhuǎn)換為子類指針，才可以調(diào)用。該函數(shù)由一個(gè)宏來實(shí)現(xiàn)，并實(shí)現(xiàn)了遞歸調(diào)用。(BOOST_PP_SEQ_FOR_EACH宏的作用，將第三個(gè)參數(shù)序列分別與第二個(gè)參數(shù)進(jìn)行按照第一個(gè)參數(shù)的方式進(jìn)行拼接，)
APPBASE_PLUGIN_REQUIRES((chain_plugin))
//宏代碼：
#define APPBASE_PLUGIN_REQUIRES_VISIT( r, visitor, elem ) \
visitor( appbase::app().register_plugin<elem>() );
#define APPBASE_PLUGIN_REQUIRES( PLUGINS ) \
template<typename Lambda> \
void plugin_requires( Lambda&& l ) { \
BOOST_PP_SEQ_FOR_EACH( APPBASE_PLUGIN_REQUIRES_VISIT, l, PLUGINS ) \
}
//-----------------------------------------展開結(jié)果-------------------------------------------
//宏展開：
template<typename Lambda>
void plugin_requires( Lambda&& l ) {
BOOST_PP_SEQ_FOR_EACH( APPBASE_PLUGIN_REQUIRES_VISIT, l, (chain_plugin) )
}
//繼續(xù)展開
template<typename Lambda>
void plugin_requires( Lambda&& l ) {
l( appbase::app().register_plugin<chain_plugin>() );
}
所以plugin_requires函數(shù)為http_plugin類的成員函數(shù)，參數(shù)為一個(gè)lambda表達(dá)式。調(diào)用過程為static_cast<Impl*>(this)->plugin_requires([&](auto& plug){});，傳入的表達(dá)式為[&](auto& plug){}。
所以調(diào)用此表達(dá)式，參數(shù)為appbase::app().register_plugin<chain_plugin>()。使用宏的方式實(shí)現(xiàn)成員函數(shù)的遞歸調(diào)用，之前沒有遇到過這種寫法，很奇怪。
再來看abstract_plugin類，此類很簡單，代碼很少，實(shí)現(xiàn)了插件的初始化、啟動(dòng)、停止等幾個(gè)虛方法，是一個(gè)虛基類。具體代碼均有其派生類的多態(tài)實(shí)現(xiàn)，所以下面分析另外三個(gè)類。
virtual void set_program_options( options_description& cli, options_description& cfg ) = 0;
virtual void initialize(const variables_map& options) = 0;
virtual void startup() = 0;
virtual void shutdown() = 0;
3、plugin類
plugin類是eos各個(gè)插件的父類，保存了插件的狀態(tài)（注冊、啟動(dòng)等），實(shí)現(xiàn)了初始化、啟動(dòng)等接口，內(nèi)部邏輯是通過子類來實(shí)現(xiàn)的。
virtual void register_dependencies() {
static_cast<Impl*>(this)->plugin_requires([&](auto& plug){});
}
virtual void initialize(const variables_map& options) override {
if(_state == registered) {
_state = initialized;
static_cast<Impl*>(this)->plugin_requires([&](auto& plug){ plug.initialize(options); });
static_cast<Impl*>(this)->plugin_initialize(options);
//ilog( "initializing plugin ${name}", ("name",name()) );
app().plugin_initialized(*this);
}
assert(_state == initialized); /// if initial state was not registered, final state cannot be initiaized
}
virtual void startup() override {
if(_state == initialized) {
_state = started;
static_cast<Impl*>(this)->plugin_requires([&](auto& plug){ plug.startup(); });
static_cast<Impl*>(this)->plugin_startup();
app().plugin_started(*this);
}
assert(_state == started); // if initial state was not initialized, final state cannot be started
}
4、net_plugin類（同級(jí)插件：http_plugin、chain_plugin等）
net_plugin類是plugin類的子類，該類主要實(shí)現(xiàn)了p2p插件的插件配置、初始化、啟動(dòng)、停止、廣播區(qū)塊的方法，但其內(nèi)部實(shí)現(xiàn)均是通過的net_plugin_impl類的方法來完成的，net_plugin類包含一個(gè)net_plugin_impl類的實(shí)例（每個(gè)插件都是類似的結(jié)構(gòu)）。
class net_plugin : public appbase::plugin<net_plugin>
{
public:
net_plugin();
virtual ~net_plugin();
APPBASE_PLUGIN_REQUIRES((chain_plugin))
virtual void set_program_options(options_description& cli, options_description& cfg) override;
void plugin_initialize(const variables_map& options);
void plugin_startup();
void plugin_shutdown();
void broadcast_block(const chain::signed_block &sb);
string connect( const string& endpoint );
string disconnect( const string& endpoint );
optional<connection_status> status( const string& endpoint )const;
vector<connection_status> connections()const;
size_t num_peers() const;
private:
std::unique_ptr<class net_plugin_impl> my;
};
plugin_initialize 初始化插件，其本質(zhì)是實(shí)例化net_plugin_impl。my為net_plugin_impl類對(duì)象的指針。
void net_plugin::plugin_initialize( const variables_map& options ) {
ilog("Initialize net plugin");
try {
// 讀取配置信息，初始化net_plugin_imul 對(duì)象的成員變量
peer_log_format = options.at( "peer-log-format" ).as<string>();
my->network_version_match = options.at( "network-version-match" ).as<bool>();
my->sync_master.reset( new sync_manager( options.at( "sync-fetch-span" ).as<uint32_t>()));
my->dispatcher.reset( new dispatch_manager );
plugin_startup函數(shù)啟動(dòng)了一個(gè)p2p節(jié)點(diǎn)網(wǎng)絡(luò)。包括1、設(shè)置監(jiān)聽循環(huán)，對(duì)其他節(jié)點(diǎn)發(fā)送過來的消息進(jìn)行響應(yīng)。2、根據(jù)配置文件中的seed節(jié)點(diǎn)信息，連接到其他節(jié)點(diǎn)，并發(fā)送消息請求，同步區(qū)塊等消息（詳細(xì)筆記寫在下一篇）。通信用到的消息類型共分為如下幾種：
using net_message = static_variant<handshake_message,
chain_size_message,
go_away_message,
time_message,
notice_message,
request_message,
sync_request_message,
signed_block,
packed_transaction>;
5、net_plugin_impl類
該類涉及到的是核心業(yè)務(wù)的具體實(shí)現(xiàn)。也是最復(fù)雜的一個(gè)類，下一篇筆記重點(diǎn)寫下net插件的學(xué)習(xí)過程。
net_plugin_impl類通信使用的是boost::asio異步通信的庫。該類成員變量包括了當(dāng)前連接的p2p節(jié)點(diǎn)對(duì)象、區(qū)塊同步管理對(duì)象、鏈id、節(jié)點(diǎn)id、網(wǎng)絡(luò)通信用的相關(guān)變量。
class net_plugin_impl {
public:
unique_ptr<tcp::acceptor> acceptor;
tcp::endpoint listen_endpoint;
string p2p_address;
uint32_t max_client_count = 0;
uint32_t max_nodes_per_host = 1;
uint32_t num_clients = 0;
vector<string> supplied_peers;
vector<chain::public_key_type> allowed_peers; ///< peer keys allowed to connect
std::map<chain::public_key_type,
chain::private_key_type> private_keys; ///< overlapping with producer keys, also authenticating non-producing nodes
enum possible_connections : char {
None = 0,
Producers = 1 << 0,
Specified = 1 << 1,
Any = 1 << 2
};
possible_connections allowed_connections{None};
connection_ptr find_connection( string host )const;
std::set< connection_ptr > connections; // 已連接的p2p seed節(jié)點(diǎn) 指針集合
bool done = false;
unique_ptr< sync_manager > sync_master; // 區(qū)塊同步管理類指針
unique_ptr< dispatch_manager > dispatcher;
.......
}
net_plugin插件的詳細(xì)內(nèi)容，下一篇筆記詳細(xì)寫。
