本篇筆記主要分析nodeos程序的流程
1井仰、代碼所在路徑（yourpath換成你的路徑）
yourpath/eos/programs/nodeos/main.cpp
2活喊、首先main函數中的代碼并不長公壤，可以通過五個類來學習這段代碼丰介。
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();
上面的代碼魂拦，均是通過調用app()的成員函數來實現的焚虱。我們很明顯的看到main函數的生命周期和app()返回的對象是完全相同的。所以链嘀，第一個分析的就是app()返回的類對象。
1档玻、application類（單例模式）
查看app()函數怀泊，發(fā)現其返回的是一個application類對象的一個引用，對象是通過application類的靜態(tài)方法instance創(chuàng)建的误趴。instance方法創(chuàng)建一個application類對象霹琼，并返回其引用。由此實現一個單例模式凉当，每次調用app()僅創(chuàng)建一個對象枣申。
application& app() { return application::instance(); }
application& application::instance() { static application _app; return _app; }
main函數中出現的set_version和set_default_data_dir和set_default_config_dir均為簡單的成員函數，這里略過不寫看杭。
主要分析一下其他幾個函數：register_plugin忠藤、initialize、startup楼雹、exec模孩。
register_plugin函數是一個模板函數，功能是對插件進行注冊贮缅。注冊即創(chuàng)建一個插件對象榨咐，并保存在application對象的plugins變量里面。注冊插件的時候是需要注冊其依賴插件的谴供。比如p2p插件依賴于chain插件块茁，那么在注冊p2p插件時，也需要注冊chain插件桂肌。其中獲取請求插件数焊，采用了一個宏實現了遞歸獲取的方式，后續(xù)在plugins類中詳細說明崎场。
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(); // 比較重要的地方昌跌，調用的是plugins類中的函數，后續(xù)分析照雁。
return *plug;
}
initialize函數是一個變參模板函數蚕愤，功能是對插件進行初始化（調用每個插件的initialize方法）答恶。內部將變參參數初始化為一個vector向量，并調用initialize_impl函數來具體實現萍诱。
//application.hpp
template<typename... Plugin>
bool initialize(int argc, char** argv) {
return initialize_impl(argc, argv, {find_plugin<Plugin>()...});
}
//application.cpp 調用插件的initialize方法悬嗓。
for (auto plugin : autostart_plugins)
if (plugin != nullptr && plugin->get_state() == abstract_plugin::registered)
plugin->initialize(options);
startup函數很簡單，功能用來啟動初始化過的插件裕坊，內部調用每個插件的startup函數來啟動包竹。
for (auto plugin : initialized_plugins) plugin->startup();
exec函數使用了boost::asio::io_service io服務，在每個啟動的插件線程里使用異步io的地方籍凝，均使用的是application對象的io服務周瞎，exec函數創(chuàng)建了異步IO異常終止的信號，并對其做了資源釋放處理饵蒂。
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類
通過對application類的幾個函數的分析，發(fā)現初始化啟動插件真正的實現退盯，是通過插件自身的initialize方法和startup方法來實現的彼乌，下面主要分析其他四個類--插件類。這四個類可以用一個圖來表示：
其中abstract_plugin是虛基類渊迁，plugin是它的子類慰照，http_plugin是plugin的子類，http_plugin_impl包含在http_plugin中琉朽。即前三個類是繼承關系毒租，后面一個類是包含關系。
回到上面遺留的問題--“插件是如何注冊其依賴插件的”箱叁。
plug->register_dependencies();父類指針指向的是子類對象蝌衔，該方法在plugin類中實現。
virtual void register_dependencies() {
static_cast<Impl*>(this)->plugin_requires([&](auto& plug){});
}
plugin_requires函數并非Plugin類的成員函數蝌蹂，是其子類的成員函數噩斟，所以父類指針需要轉換為子類指針，才可以調用孤个。該函數由一個宏來實現剃允，并實現了遞歸調用。(BOOST_PP_SEQ_FOR_EACH宏的作用齐鲤，將第三個參數序列分別與第二個參數進行按照第一個參數的方式進行拼接斥废，)
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 ) \
}
//-----------------------------------------展開結果-------------------------------------------
//宏展開：
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函數為http_plugin類的成員函數，參數為一個lambda表達式给郊。調用過程為static_cast<Impl*>(this)->plugin_requires([&](auto& plug){});牡肉，傳入的表達式為[&](auto& plug){}。
所以調用此表達式淆九，參數為appbase::app().register_plugin<chain_plugin>()统锤。使用宏的方式實現成員函數的遞歸調用毛俏，之前沒有遇到過這種寫法，很奇怪饲窿。
再來看abstract_plugin類煌寇，此類很簡單，代碼很少逾雄，實現了插件的初始化阀溶、啟動、停止等幾個虛方法鸦泳，是一個虛基類银锻。具體代碼均有其派生類的多態(tài)實現，所以下面分析另外三個類做鹰。
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各個插件的父類，保存了插件的狀態(tài)（注冊誊垢、啟動等）掉弛，實現了初始化症见、啟動等接口喂走，內部邏輯是通過子類來實現的。
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類（同級插件：http_plugin芋肠、chain_plugin等）
net_plugin類是plugin類的子類，該類主要實現了p2p插件的插件配置遵蚜、初始化帖池、啟動、停止吭净、廣播區(qū)塊的方法睡汹，但其內部實現均是通過的net_plugin_impl類的方法來完成的，net_plugin類包含一個net_plugin_impl類的實例（每個插件都是類似的結構）寂殉。
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 初始化插件囚巴，其本質是實例化net_plugin_impl。my為net_plugin_impl類對象的指針友扰。
void net_plugin::plugin_initialize( const variables_map& options ) {
ilog("Initialize net plugin");
try {
// 讀取配置信息彤叉，初始化net_plugin_imul 對象的成員變量
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函數啟動了一個p2p節(jié)點網絡。包括1村怪、設置監(jiān)聽循環(huán)秽浇，對其他節(jié)點發(fā)送過來的消息進行響應。2甚负、根據配置文件中的seed節(jié)點信息柬焕，連接到其他節(jié)點审残，并發(fā)送消息請求，同步區(qū)塊等消息（詳細筆記寫在下一篇）击喂。通信用到的消息類型共分為如下幾種：
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è)務的具體實現。也是最復雜的一個類懂昂，下一篇筆記重點寫下net插件的學習過程介时。
net_plugin_impl類通信使用的是boost::asio異步通信的庫。該類成員變量包括了當前連接的p2p節(jié)點對象凌彬、區(qū)塊同步管理對象沸柔、鏈id、節(jié)點id铲敛、網絡通信用的相關變量褐澎。
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é)點 指針集合
bool done = false;
unique_ptr< sync_manager > sync_master; // 區(qū)塊同步管理類指針
unique_ptr< dispatch_manager > dispatcher;
.......
}
net_plugin插件的詳細內容，下一篇筆記詳細寫伐蒋。
