5. 节点源码编译

标签：可执行程序 开发手册 预编译程序 源码编译 编译教程

重要

相关软件和环境版本说明！请查看

注解

  • FISCO BCOS支持在Linux，macOS和银河麒麟操作系统上编译; Linux和麒麟系统编译二进制时，要求gcc版本不小于10; macOS系统编译二进制时，要求clang版本不小于12.0

  • FISCO BCOS 3.x支持带有Apple Silicon的macOS编译，编译步骤与x86_64相同。

  • FISCO BCOS 3.x的编译依赖rust环境，编译源码前请先安装rust环境

  • 源码编译适合于有丰富开发经验的用户，编译过程中需要下载依赖库，请保持网络畅通

  • FISCO BCOS会同时编译出Air版本和Pro版本的二进制

FSICO-BCOS使用通用CMake构建系统生成特定平台的构建文件，这意味着无论您使用什么操作系统工作流都非常相似：

  1. 安装构建工具和依赖包（依赖于平台）

  2. 从FISCO BCOS克隆代码

  3. 运行cmake生成构建文件并编译

1. 安装依赖

  • Ubuntu

推荐使用Ubuntu 22.04版本。

sudo apt update
sudo apt install -y wget python3-dev git curl zip unzip tar
sudo apt install -y --no-install-recommends clang make build-essential cmake libssl-dev zlib1g-dev ca-certificates libgmp-dev flex bison patch libzstd-dev ninja-build pkg-config autoconf


# 安装rust
curl https://sh.rustup.rs -sSf | bash -s -- -y
source $HOME/.cargo/env

  • CentOS

推荐使用CentOS7以上版本。

sudo yum install -y epel-release centos-release-scl flex bison patch gmp-static
sudo yum install -y devtoolset-10 devtoolset-11 llvm-toolset-7 rh-perl530-perl cmake3 zlib-devel ccache lcov python-devel python3-devel

# 更新git至2.17以上
sudo yum reinstall -y https://packages.endpointdev.com/rhel/7/os/x86_64/endpoint-repo.x86_64.rpm
sudo yum install -y git 

# 安装rust
curl https://sh.rustup.rs -sSf | bash -s -- -y
source $HOME/.cargo/env

  • macOS

# 安装xcode开发工具，若已经安装可略过
xcode-select --install

brew install git zstd wget gmp
# 安装rust
curl https://sh.rustup.rs -sSf | bash -s -- -y
source $HOME/.cargo/env

  • kylinOS

# 安装依赖
sudo yum update
sudo yum install -y wget curl tar 
sudo yum install -y build-essential clang flex bison patch glibc-static glibc-devel libzstd-devel libmpc cpp 

# 查看gcc版本，若gcc版本低于10，安装版本高于10的gcc
gcc -v

# 查看cmake版本，是否大于等于3.14，若不满足，安装符合要求的cmake版本
cmake --version

2. 克隆代码

# 创建源码编译目录
mkdir -p ~/fisco && cd ~/fisco

# 克隆代码
git clone https://github.com/FISCO-BCOS/FISCO-BCOS.git

# 若因为网络问题导致长时间无法执行上面的命令，请尝试下面的命令：
git clone https://gitee.com/FISCO-BCOS/FISCO-BCOS.git

# 切换到源码目录
cd FISCO-BCOS

3. 编译

编译完的Air版本二进制位于FISCO-BCOS/build/fisco-bcos-air/fisco-bcos-air路径。

编译会产生Pro版本的Rpc服务、Gateway服务、Executor服务以及节点服务对应的所有二进制,路径如下：

  • Rpc服务：FISCO-BCOS/build/fisco-bcos-tars-service/RpcService/main/BcosRpcService

  • Gateway服务：FISCO-BCOS/build/fisco-bcos-tars-service/GatewayService/main/BcosGatewayService

  • Executor服务：FISCO-BCOS/build/fisco-bcos-tars-service/ExecutorService/main/BcosExecutorService

  • 区块链节点服务：FISCO-BCOS/build/fisco-bcos-tars-service/NodeService/main/BcosNodeService、FISCO-BCOS/build/fisco-bcos-tars-service/NodeService/main/BcosMaxNodeService

若编译过程中从GitHub拉取依赖太慢，可执行以下方式加速：

  • 使用GitHub镜像（推荐）

执行如下命令使用https://ghproxy.com/https://github.com/替代https://github.com/加速依赖下载：

$ cat > ~/.gitconfig << EOF
[url "https://ghproxy.com/https://github.com/"]
        insteadOf = https://github.com/
[http]
        sslVerify = false
EOF

  • 修改DNS和Host

修改DNS主机，或者在Host加上GitHub的直连IP，可以大概率改善访问速度。可以参考SwitchHosts等工具。

  • 配置vcpkg代理

export X_VCPKG_ASSET_SOURCES=x-azurl,http://106.15.181.5/

3.1 Ubuntu

推荐使用Ubuntu 22.04。

# 进入源码目录
cd ~/fisco/FISCO-BCOS

# 创建编译目录
mkdir -p build && cd build
cmake -DBUILD_STATIC=ON .. || cat *.log

# 若编译依赖过程中遇到了vcpkg失败的问题，请根据报错提示查看错误日志
# 若为网络原因可按照上文提示配置vcpkg代理

# 编译源码(高性能机器可添加-j4使用4核加速编译)
make -j4

# 生成tgz包
rm -rf fisco-bcos-tars-service/*.tgz && make tar

3.2 CentOS

推荐版本不小于CentOS 7。

linux x86_64

# 使用gcc10
source /opt/rh/devtoolset-10/enable
source /opt/rh/rh-perl530/enable
export LIBCLANG_PATH=/opt/rh/llvm-toolset-7/root/lib64/
source /opt/rh/llvm-toolset-7/enable

# 进入源码编译目录
cd ~/fisco/FISCO-BCOS
mkdir -p build && cd build
cmake3 -DBUILD_STATIC=ON .. || cat *.log

# 若编译依赖过程中遇到了vcpkg失败的问题，请根据报错提示查看错误日志
# 若为网络原因可按照上文提示配置vcpkg代理

# 高性能机器可添加-j4使用4核加速编译
make -j4
# 生成tgz包
rm -rf fisco-bcos-tars-service/*.tgz && make tar

aarch64

# 安装devtoolset-10
yum install -y devtoolset-10

# 使用gcc10
source /opt/rh/devtoolset-10/enable
export LIBCLANG_PATH=/opt/rh/llvm-toolset-7.0/root/lib64/
source /opt/rh/llvm-toolset-7.0/enable

# 进入源码编译目录
cd ~/fisco/FISCO-BCOS
mkdir -p build && cd build
cmake3 -DBUILD_STATIC=ON .. || cat *.log

# 若编译依赖过程中遇到了vcpkg失败的问题，请根据报错提示查看错误日志
# 若为网络原因可按照上文提示配置vcpkg代理

# 高性能机器可添加-j4使用4核加速编译
make -j4
# 生成tgz包
rm -rf fisco-bcos-tars-service/*.tgz && make tar

3.3 macOS

推荐xcode11以上版本。

# 进入源码编译目录
cd ~/fisco/FISCO-BCOS
mkdir -p build && cd build
cmake -DBUILD_STATIC=ON ..|| cat *.log

# 若编译依赖过程中遇到了vcpkg失败的问题，请根据报错提示查看错误日志
# 若为网络原因可按照上文提示配置vcpkg代理

# 若执行以上过程报错，请尝试执行如下命令指定SDKROOT
#rm -rf CMakeCache.txt && export SDKROOT=$(xcrun --sdk macosx --show-sdk-path) && CC=/usr/bin/clang CXX=/usr/bin/clang++ cmake ..

# 高性能机器可添加-j8使用8核加速编译
make -j4

# 生成tgz包
rm -rf fisco-bcos-tars-service/*.tgz && make tar

3.4 kylinOS

# 导入clang编译文件
export LIBCLANG_PATH=/usr/lib64/

# 进入源码编译目录
cd ~/fisco/FISCO-BCOS
mkdir -p build && cd build
cmake3 -DBUILD_STATIC=ON .. || cat *.log

# 若编译依赖过程中遇到了vcpkg失败的问题，请根据报错提示查看错误日志
# 若为网络原因可按照上文提示配置vcpkg代理

# 高性能机器可添加-j4使用4核加速编译
make -j4
# 生成tgz包
rm -rf fisco-bcos-tars-service/*.tgz && make tar

编译选项说明

  • – FULLNODE 编译全节点，默认开启

  • – WITH_LIGHTNODE 编译轻节点，默认开启

  • – WITH_TIKV 编译TIKV，默认开启

  • – WITH_TARS_SERVICES 编译TARS服务，默认开启

  • – WITH_SM2_OPTIMIZE 开启SM2性能优化，默认开启

  • – WITH_CPPSDK 编译C++SDK，默认开启

  • – WITH_BENCHMARK 编译性能测试程序，默认开启