跳到主要内容

从源码构建 Starcoin

快速开始​

  1. 克隆源代码到本地
git clone https://github.com/starcoinorg/starcoin.git
cd starcoin
  1. 设置构建环境
./scripts/dev_setup.sh
  1. 使用 Cargo 构建

注意：这里提供两个版本（debug、release）的构建方法，debug 版本用于开发环境，release 版本用于生产环境。

如果要正式使用，请使用 release 版本，debug 版本和 release 版本之间的性能有数量级差异。

（1）构建 debug 版本

cargo build

（2）构建 release 版本

cargo build --release
  1. 目标文件

编译结束后，可在 target 目录下找到相应的 starcoin 程序。

  • debug 版本在 target/debug/starcoin 目录下
  • release 版本在 target/release/starcoin 目录下

问题排查​

Windows​

如果在 Windows 的编译过程中出现以下错误信息：

'Unable to find libclang: "couldn't find any valid shared libraries matching: ['clang.dll', 'libclang.dll'], set the `LIBCLANG_PATH` environment variable to a path where one of these files can be found (invalid: [])"'

这是因为没有设置 LIBCLANG_PATH 环境变量。

解决方案：

将 LIBCLANG_PATH 的值设置为 LLVM 编译工具集的 bin 目录。

根据你的具体安装位置来设置，例如：

C:\Program Files\LLVM\bin

WSL​

Q1:​

使用 WSL2 进行编译可能会出现下面的报错信息：

error: linking with `cc` failed: exit status: 1

这是因为 WSL2 的交换内存（swap）未设置，或者小于 WSL2 的最大内存。

解决方案：

  • 打开 Windows 资源管理器，在地址栏输入 %UserProfile% 回车。
  • 在该目录下创建一个文件，名字为 .wslconfig
  • 写入内容示例如下：（根据自己电脑实际分配，务必使 swap 大于等于 memory）
    [wsl2]
    memory=2GB
    swap=4GB
  • 在 cmd 执行 wsl --shutdown 关闭 WSL2，再重新打开即可。

Q2:​

为什么我的编译时间这么久？

这种情况通常会在电脑配置比较低的用户身上出现，下面提供两个可行的建议：

  1. 升级电脑配置。

  2. 控制 Cargo 编译时的 job 数量。

对于低配置机器来说，控制核心数是大幅提高编译效率的关键。例如：

cargo build -j 1

具体的测试案例，请参见 [bug] Excessive swap may result in slower builds #70 中的讨论。

CentOS​

如果操作系统是 CentOS，则需要使用如下命令，单独安装相关开发工具：

yum install -y openssl-devel                    # 安装openssl
yum install -y centos-release-scl               # 安装centos-release-scl
yum install -y devtoolset-7                     # 安装开发工具
scl enable devtoolset-7 bash                    # 激活开发工具

# 下面的这两步，会删除错误链接的 llvm-private 包，但同样会导致 GUI 登录不了，
# 如果使用命令行，则不影响。
# 慎重，如果要使用 GUI 系统，则这下面的操作很危险！
rpm -qa | grep "llvm-private"                   # 查找包含 llvm-private 的包
rpm -e --nodeps llvm-private-6.0.1-2.el7.x86_64 # 卸载查找到的包，实际找到的可能和示例不同

Ubuntu​

Q1:​

普通用户执行 ./script/dev_setup.sh 时会报权限错误，因此要加上 sudo 命令（sudo ./script/dev_setup.sh -ypt），因此又会出现另外一个问题，如下所示的错误：

./script/dev_setup.sh：line 155：mpm：command not found

mpm 明明已经配置好了环境变量，执行 mpm --version 也正常，但执行 sudo mpm --version 时会报错：

sudo：mpm：command not found

原因：

Linux 系统中在使用 sudo 执行命令时是为当前用户赋予临时的 root 权限，考虑到安全性等相关问题，sudo 执行命令时会重置 PATH，此时 PATH 中是不包含用户配置的很多命令的路径的。所以会发现 sudo 执行命令时可能存在找不到的情况。

解决方案：

使用 sudo vim /etc/sudoers 进行修改，找到 secure_path 这一行，在其中追加 mpm 的路径即可（和配置环境变量的 mpm 路径一致，也是用 : 追加），然后通过 :wq! 保存即可。

此后，你再执行 sudo mpm 相关命令时，提示找不到的错误就不会出现了。

Q2:​

在更新包依赖的时候，apt-get 运行报错，无法获得锁。

Reading package lists... Done
Installing ca-certificates......
Installing ca-certificates.
E: Could not get lock /var/lib/dpkg/lock-frontend - open (11: Resource temporarily unavailable)
E: Unable to acquire the dpkg frontend lock (/var/lib/dpkg/lock-frontend), is another process using it?

解决方案：

先查看是否有 apt-get 这个程序在运行

ps aux|grep apt-get

如果发现存在这样的程序在运行那么就 kill 掉，否则执行如下命令(直接删除锁文件)

sudo rm /var/lib/dpkg/lock-frontend
sudo rm /var/lib/dpkg/lock
sudo rm /var/cache/apt/archives/lock

Q3:​

Debian Packager的问题，dpkg 安装被中断。

E: dpkg was interrupted, you must manually run 'sudo dpkg --configure -a' to correct the problem.

解决办法：

执行如下命令

sudo dpkg --configure -a

然后，再执行如下命令：

sudo apt-get update 
sudo apt-get upgrade

如果上述操作依然不行的话，直接删除重新更新。即：

sudo rm /var/lib/dpkg/updates/* 
sudo apt-get update 
sudo apt-get upgrade

保守的操作的话，可以选择如下操作：

sudo mv /var/lib/dpkg/info/ /var/lib/dpkg/info_old/
sudo mkdir /var/lib/dpkg/info/
sudo apt-get update

sudo apt-get -f install
   
sudo mv /var/lib/dpkg/info/* /var/lib/dpkg/info_old/
sudo rm -rf /var/lib/dpkg/info
sudo mv /var/lib/dpkg/info_old/ /var/lib/dpkg/info/

Q4:​

dev_setup.sh 脚本执行成功后，但执行 boogie /version 提示命令未找到。

.......Installation finished successfully.
Installing boogie
You can invoke the tool using the following command: boogie
Tool 'boogie' (version '2.9.6') was successfully installed.
Finished installing all dependencies.

You should now be able to build the project by running:
    mpm package build
    mpm package prove
starcoin$ boogie /version
Command 'boogie' not found, but can be installed with:

sudo apt install boogie

原因：

环境变量配置未生效。

解决办法：

执行如下命令即可：

source ~/.profile

常见问题排查​

Q1:​

使用 Cargo 编译时出现如下错误信息：

error: linker cc not found | = note: No such file or directory (os error 2)

这是因为 Cargo 找不到 cc 编译器程序（连接器）来编译给定的应用程序。

由于 Rust 还没有包含它自己的链接器，通常我们需要安装一个 C 编译器，如：gcc 和 cmake 等编译工具。

解决方案：

  • 要在 Ubuntu 上安装 gcc，只需运行，build-essential 包含了编译开发所需的基本工具集：
sudo apt install build-essential
  • 要在 Arch Linux 上安装 Cmake，请启用 [Extra] 存储库并运行：
sudo pacman -S gcc cmake
  • 在 Fedora、RHEL、CentOS：
sudo dnf install gcc cmake

Q2:​

  • 若出现 Could not find directory of OpenSSL installation 的报错信息，则需要安装 OpenSSL 库。
  • 若出现 Unable to find libclang: "the `libclang` shared library at /usr/lib64/clang-private/libclang.so.6.0" 字样错误，则可能是 llvm-private 的原因，解决方法是卸载它：
    rpm -qa | grep "llvm-private" # 查找包含 llvm-private 的包
    rpm -e --nodeps llvm-private-6.0.1-2.el7.x86_64 # 卸载查找到的包
  • 每次编译出错后，解决后，需要 cargo clean，清除之前已编译的目标文件，再重新编译。

GitHub 网络问题​

如果在开始构建时出现以下错误消息：

error: failed to get `xxx` as a dependency of package `...`
...
...
  fatal: couldn't find remote ref HEAD

您可能需要为 GitHub 设置代理服务器：

git config --global http.https://github.com.proxy [protocol://][user[:password]@]proxyhost[:port]