比特币源码研读之十四

由于近期比较忙,所以源码研读系列更新较之前有点慢,但不管怎么样源码研读系列将会继续写下去的,保证每周至少有一篇,这样才能源码研读的持续性。

自从开始对比特币源码进行研读之后,在看比特币相关的技术文章时,让我可以很清晰地理解文章中提到的一些专业术语,比如前几天看到的segwit、setwit2x以及比特币实行setwit后要修改的DNSSeed,这些术语我都能联想到其所在源码位置以及其底层实现。有种内行看门道的感觉,所以,更加坚定了我继续坚持进行源码研读的信心。

话不多说,让我们继续源码研读的征程。同时再次希望大家在看我文章时能提出宝贵意见,一起讨论一起进步。

本文将继续开展应用程序参数交互源码部分(AppInitParameterInteraction)的研读与分析。

比特币源码研读之十四_第1张图片

本文主要涉及的源码文件包括:

src/bitcond.cpp、src/init.h、src/init.cpp、src/util.h、src/util.cpp、src/validation.h、src/RPC/register.h、src/rpc/blockchain.cpp、src/rpc/net.cpp、src/rpc/misc.cpp、src/rpc/mining.cpp、src/rpc/ rawtransaction.cpp、src/wallet/rpcwallet.cpp

一、区块裁剪

区块裁剪处理的标识参数为“prune”,该参数我们已在《比特币源码研读之十》的“区块修剪参数处理”中进行了详细描述,其主要是针对默克尔树(Merkle Tree)来说的,所以整个修剪用得很贴切,可以直观地看出prune是对树上的节点进行修剪。其修剪的对象又是谁呢?从回答中我们可以看出其修剪对象有2种:

(1)一种是所有输出都被花费的叶子节点(交易);

(2)另一种是节点包含的所有子节点均已被修剪。

根据以上分析我们可以看出修剪的目的是为了节省存储空间。

《比特币源码研读之十》中程序只是解析prune参数,并与txindex参数进行冲突判断,因为二者不能同时设置,具体内容可参见第十篇文章。

我们通过其注释可以知道区块裁剪是针对预先设定的存储容量来进行的,即根据客户端所在计算机中的存储情况进行设定,如果超过了设定值,将进行区块裁剪,以防超过设定值,并且该设定值为MiB单位。其注释如下:

block pruning; get the amount of disk space (in MiB) to allot for block & undo files

区块裁剪操作根据其prune参数的值进行处理的流程如图所示。

比特币源码研读之十四_第2张图片

(1)首先是获取prune参数值并赋值给nPruneArg,通过GetArg函数我们可以知道其默认值为0;

(2)判断nPruneArg是否为小于0,此时程序将出错,并退出,因为我们知道如果nPruneArg小于0,表示不会为区块提供存储空间了,程序将无法正常工作,这显然是不合理的,所以程序直接退出是合理的;

(3)如果nPruneArg大于0,则计算该值所对应的字节数,其计算公式为

nPruneTarget = (uint64_t) nPruneArg * 1024 * 1024;

(4)此处判断prune是否为1,如果为1则转入第5步中,反之则进入第6步;

(5)此处为prune== 1的情况,在该情况下程序不会自动对区块进行裁剪,需要我们通过RPC命令pruneblockchain对相应区块进行裁剪,同时因为是手动裁剪,也就没有裁剪限定值一说了,所以程序将其设置为最大值,并且设置裁剪模式为true,即fPruneMode=true,其中fPruneMode为全局变量,其在src/validation.h中声明,并在src/validation.cpp中定义,其默认值为false,即不进行裁剪;

(6)此处为prune不等于1的情况,在该情况下首先判断设定的裁剪值是否小于程序默认设置的用于存储区块的最小硬盘存储空间MIN_DISK_SPACE_FOR_BLOCK_FILES,该值在src/validation.h中定义,其定义如下:

static const uint64_tMIN_DISK_SPACE_FOR_BLOCK_FILES = 550 * 1024 * 1024;

从其定义我们可以看出,为区块设定的最小存储空间为550MiB,所以我们设置的-prune参数的值必须大于等于550才能让程序正常运行,除非像(5)中设置为1。如果nPruneTarget>=550,程序将继续正常运行,并且PruneMode将设置为true。

以上就是区块裁剪参数的具体处理过程,在此处完成裁剪信息的设置后,程序将在后面根据这些信息进行有效地开展区块裁剪操作。

二、RPC命令注册

比特币核心程序在src/RPC/register.h文件中实现了对RegisterAllCoreRPCCommands的定义与实现,在该函数中实现了区块链、P2P网络、挖矿、交易以及其他工具等模块的RPC命令的注册。该函数中包含的这些命令注册函数分别为:

static inline voidRegisterAllCoreRPCCommands(CRPCTable &t)

{

RegisterBlockchainRPCCommands(t);—区块链RPC命令注册

RegisterNetRPCCommands(t);—P2P网络RPC命令注册

RegisterMiscRPCCommands(t);—其他工具RPC命令注册

RegisterMiningRPCCommands(t);—挖矿RPC命令注册

RegisterRawTransactionRPCCommands(t);—交易PRC命令注册

}

下面我们分别来看每个RPC命令注册实现的具体位置:

(1)区块链RPC命令:在命令在src/rpc/blockchain.cpp中实现,其包含的RPC命令通过命令常量数组commands进行存储,具体包含的命令如下:

比特币源码研读之十四_第3张图片

该常量数组中的name项即为RPC命令,程序在RegisterBlockchainRPCCommands中通过对commands的遍历实现这些命令的添加,即为注册:

voidRegisterBlockchainRPCCommands(CRPCTable &t)

{

      for (unsigned int vcidx = 0; vcidx

      t.appendCommand(commands[vcidx].name,&commands[vcidx]);

}

(2)P2P网络RPC命令:在命令在src/rpc/net.cpp中实现,其包含的RPC命令也是通过命令常量数组commands进行存储,具体包含的命令如下:

比特币源码研读之十四_第4张图片

P2P网络RPC命令的注册方法与区块链的一致,其通过RegisterNetRPCCommands实现,具体实现如下:

void RegisterNetRPCCommands(CRPCTable &t)

{

for(unsigned int vcidx = 0; vcidx < ARRAYLEN(commands); vcidx++)

t.appendCommand(commands[vcidx].name, &commands[vcidx]);

}

(3)其他工具RPC命令:在命令在src/rpc/misc.cpp中实现,其包含的RPC命令通过命令常量数组commands进行存储,具体包含的命令如下:

比特币源码研读之十四_第5张图片

其他工具RPC命令的注册方法与区块链的一致,其通过RegisterMiscRPCCommands实现,具体实现代码与区块链的一致;

(4)挖矿RPC命令:在命令在src/rpc/mining.cpp中实现,其包含的RPC命令也是通过命令常量数组commands进行存储,具体包含的命令如下:

比特币源码研读之十四_第6张图片

挖矿RPC命令的注册方法与区块链的一致,其通过RegisterMiningRPCCommands实现,具体实现代码与区块链的一致;

(5)交易PRC命令:在命令在src/rpc/ rawtransaction.cpp中实现,其包含的RPC命令通过命令常量数组commands进行存储,具体包含的命令如下:

比特币源码研读之十四_第7张图片

交易RPC命令的注册方法与区块链的一致,其通过RegisterRawTransactionRPCCommands实现,具体实现代码与区块链的一致。

完成这些命令的注册后,后面是针对钱包RPC命令的注册,钱包命令是否注册是根据程序编译时是否包含钱包模块而定的,其判断条件为

#ifdef ENABLE_WALLET

即如果钱包功能打开,则需进行钱包RPC命令的注册,反之则不需要。钱包RPC命令注册在src/wallet/rpcwallet.cpp中实现,其实现方法与区块链是一样的,通过commands数组进行存储,然后在RegisterWalletRPCCommands函数中进行命令的注册。

说了这么多RPC命令的注册,那RPC命令是怎么用的呢?在哪可以用这些命令呢?这些命令是在比特币核心客户端中使用的,具体来说其在比特币核心的“Help(帮助)”菜单下的“Debug Window(调试窗口)”中使用,调试窗口界面如下:

比特币源码研读之十四_第8张图片

我们可在该调试窗口的命令框中输入相应的RPC命令,然后回车即可执行相应命令,调试窗口中将显示其执行结果。具体命令的运行大家可根据实际情况输入。如果临时不记得命令,可在输入框中输入help获取命令提示帮助。

以上即为本次研读内容,在本文我们分析了区块裁剪的处理以及比特币中各模块包含的RPC命令、命令注册以及命令的运行。希望对大家理解这块源码有帮助,也欢迎大家留言讨论。

区块链研习社源码研读班 菜菜子

你可能感兴趣的:(比特币源码研读之十四)