Derek解读Bytom源码-启动与停止

作者：derek ## 简介 github地址：https://github.com/bytom/bytom gitee地址：https://gitee.com/bytomblockchain/bytom 本章介绍bytom代码启动、节点初始化、及停止的过程 > 作者使用macos操作系统，其他平台也大同小异 > golang version: 1.8 ## 预备工作 ### 编译安装 详细步骤见官方 [bytom install](https://github.com/bytom/bytom) ### 设置debug日志输出 开启debug输出文件、函数、行号等详细信息 ``` export bytom_debug=debug ``` ### 初始化并启动bytomd 初始化 ``` ./bytomd init --chain_id testnet ``` bytomd目前支持两种网络，这里我们使用测试网 mainnet：主网 testnet：测试网 启动bytomd ``` ./bytomd node --mining --prof_laddr=":8011" ``` --prof_laddr=":8080" // 开启pprof输出性能指标 访问：http://127.0.0.1:8080/debug/pprof/ ## bytomd init初始化 入口函数 ** cmd/bytomd/main.go ** ``` func init() { log.setformatter(&log.textformatter{fulltimestamp: true, disablecolors: true}) // if environment variable bytom_debug is not empty, // then add the hook to logrus and set the log level to debug if os.getenv("bytom_debug") != "" { log.addhook(contexthook{}) log.setlevel(log.debuglevel) } } func main() { cmd := cli.preparebasecmd(commands.rootcmd, "tm", os.expandenv(config.defaultdatadir())) cmd.execute() } ``` init函数会在main执行之前做初始化操作，可以看到init中bytomd加载bytom_debug变量来设置debug日志输出 command cli传参初始化 bytomd的cli解析使用[cobra](https://github.com/spf13/cobra)库 ** cmd/bytomd/commands ** * cmd/bytomd/commands/root.go 初始化--root传参。bytomd存储配置、keystore、数据的root目录。在macos下，默认路径是~/library/bytom/ * cmd/bytomd/commands/init.go 初始化--chain_id传参。选择网络类型，在启动bytomd时我们选择了testnet也就是测试网络 * cmd/bytomd/commands/version.go 初始化version传参 * cmd/bytomd/commands/run_node.go 初始化node节点运行时所需要的传参 初始化默认配置 用户传参只有一部分参数，那节点所需的其他参数需要从默认配置中加载。 ** cmd/bytomd/commands/root.go ** ``` var ( config = cfg.defaultconfig() ) ``` 在root.go中有一个config全局变量加载了node所需的所有默认参数 ``` // default configurable parameters. func defaultconfig() *config { return &config{ baseconfig: defaultbaseconfig(), // node基础相关配置 p2p: defaultp2pconfig(), // p2p网络相关配置 wallet: defaultwalletconfig(), // 钱包相关配置 auth: defaultrpcauthconfig(), // 验证相关配置 web: defaultwebconfig(), // web相关配置 } } ``` 后面的文章会一一介绍每个配置的作用 ## bytomd 守护进程启动与退出 ** cmd/bytomd/commands/run_node.go ** ``` func runnode(cmd *cobra.command, args []string) error { // create & start node n := node.newnode(config) if _, err := n.start(); err != nil { return fmt.errorf("failed to start node: %v", err) } else { log.withfield("nodeinfo", n.syncmanager().switch().nodeinfo()).info("started node") } // trap signal, run forever. n.runforever() return nil } ``` runnode函数有三步操作： node.newnode：初始化node运行环境 n.start：启动node n.runforever：监听退出信号，收到ctrl+c操作则退出node。在linux中守进程一般监听sigterm信号(ctrl+c)作为退出守护进程的信号 ### 初始化node运行环境 在bytomd中有五个db数据库存储在--root参数下的data目录 * accesstoken.db // 存储token相关信息(钱包访问控制权限) * trusthistory.db // 存储p2p网络同步相关信息 * txdb.db // 存储交易相关信息 * txfeeds.db // * wallet.db // 存储钱包相关信息 ** node/node.go ** ``` func newnode(config *cfg.config) *node { ctx := context.background() initactivenetparams(config) // get store 初始化txdb数据库 txdb := dbm.newdb("txdb", config.dbbackend, config.dbdir()) store := leveldb.newstore(txdb) // 初始化accesstoken数据库 tokendb := dbm.newdb("accesstoken", config.dbbackend, config.dbdir()) accesstokens := accesstoken.newstore(tokendb) // 初始化event事件调度器，也叫任务调度器。一个任务可以被多次调用 // make event switch eventswitch := types.neweventswitch() _, err := eventswitch.start() if err != nil { cmn.exit(cmn.fmt("failed to start switch: %v", err)) } // 初始化交易池 txpool := protocol.newtxpool() chain, err := protocol.newchain(store, txpool) if err != nil { cmn.exit(cmn.fmt("failed to create chain structure: %v", err)) } var accounts *account.manager = nil var assets *asset.registry = nil var wallet *w.wallet = nil var txfeed *txfeed.tracker = nil // 初始化txfeeds数据库 txfeeddb := dbm.newdb("txfeeds", config.dbbackend, config.dbdir()) txfeed = txfeed.newtracker(txfeeddb, chain) if err = txfeed.prepare(ctx); err != nil { log.withfield("error", err).error("start txfeed") return nil } // 初始化keystore hsm, err := pseudohsm.new(config.keysdir()) if err != nil { cmn.exit(cmn.fmt("initialize hsm failed: %v", err)) } // 初始化钱包，默认wallet是开启状态 if !config.wallet.disable { walletdb := dbm.newdb("wallet", config.dbbackend, config.dbdir()) accounts = account.newmanager(walletdb, chain) assets = asset.newregistry(walletdb, chain) wallet, err = w.newwallet(walletdb, accounts, assets, hsm, chain) if err != nil { log.withfield("error", err).error("init newwallet") } // clean up expired utxo reservations periodically. go accounts.expirereservations(ctx, expirereservationsperiod) } newblockch := make(chan *bc.hash, maxnewblockchsize) // 初始化网络节点同步管理 syncmanager, _ := netsync.newsyncmanager(config, chain, txpool, newblockch) // 初始化pprof，pprof用于输出性能指标，需要制定--prof_laddr参数来开启，在文章开头我们已经开启该功能 // run the profile server profilehost := config.proflistenaddress if profilehost != "" { // profiling bytomd programs.see (https://blog.golang.org/profiling-go-programs) // go tool pprof http://profilehose/debug/pprof/heap go func() { http.listenandserve(profilehost, nil) }() } // 初始化节点，填充节点所需的所有参数环境 node := &node{ config: config, syncmanager: syncmanager, evsw: eventswitch, accesstokens: accesstokens, wallet: wallet, chain: chain, txfeed: txfeed, miningenable: config.mining, } // 初始化挖矿 node.cpuminer = cpuminer.newcpuminer(chain, accounts, txpool, newblockch) node.miningpool = miningpool.newminingpool(chain, accounts, txpool, newblockch) node.baseservice = *cmn.newbaseservice(nil, "node", node) return node } ``` 目前bytomd只支持cpu挖矿，所以在代码中只有cpuminer的初始化信息 ### 启动node ** node/node.go ** ``` // lanch web broser or not func lanchwebbroser() { log.info("launching system browser with :", webaddress) if err := browser.open(webaddress); err != nil { log.error(err.error()) return } } func (n *node) initandstartapiserver() { n.api = api.newapi(n.syncmanager, n.wallet, n.txfeed, n.cpuminer, n.miningpool, n.chain, n.config, n.accesstokens) listenaddr := env.string("listen", n.config.apiaddress) env.parse() n.api.startserver(*listenaddr) } func (n *node) onstart() error { if n.miningenable { n.cpuminer.start() } n.syncmanager.start() n.initandstartapiserver() if !n.config.web.closed { lanchwebbroser() } return nil } ``` onstart() 启动node进程如下： * 启动挖矿功能 * 启动p2p网络同步 * 启动http协议的apiserver服务 * 打开浏览器访问bytond的交易页面 ### 停止node bytomd在启动时执行了n.runforever()函数，该函数是由tendermint框架启动了监听信号的功能： ** vendor/github.com/tendermint/tmlibs/common/os.go ** ``` func trapsignal(cb func()) { c := make(chan os.signal, 1) signal.notify(c, os.interrupt, syscall.sigterm) go func() { for sig := range c { fmt.printf("captured %v, exiting...\n", sig) if cb != nil { cb() } os.exit(1) } }() select {} } ``` trapsignal函数监听了sigterm信号，bytomd才能成为不退出的守护进程。只有当触发了ctrl+c或kill bytomd_pid才能终止bytomd进程退出。退出时bytomd执行如下操作 ** node/node.go ** ``` func (n *node) onstop() { n.baseservice.onstop() if n.miningenable { n.cpuminer.stop() } n.syncmanager.stop() log.info("stopping node") // todo: gracefully disconnect from peers. } ``` bytomd会将挖矿功能停止，p2p网络停止等操作。