构建DragonOS
1.写在前面
无论您采用后文中的何种方式来编译DragonOS,您必须先按照本小节中的步骤,初始化您的开发环境。
开始之前,您需要一台运行Linux或MacOS的计算机,并且处理器架构为X86-64.
对于Linux发行版,建议使用Ubuntu22、Debian、Arch Linux这样的,仓库软件版本较新的发行版,这能为您减少很多麻烦。
1.1 下载DragonOS的源代码
假设您的计算机上已经安装了git,您可以通过以下命令,获得DragonOS的最新的源代码:
git clone https://github.com/DragonOS-Community/DragonOS
cd DragonOS
警告
DragonOS的源代码托管在Github上,但是,由于Github在国内的访问速度较慢。可能出现克隆失败的情况,这时只要重试即可。
当然,我们建议您在github上绑定您的电脑的ssh公钥, 然后通过以下命令来克隆代码,防止频繁出现git clone、pull、push失败的情况。
git clone git@github.com:DragonOS-Community/DragonOS.git
2.使用一键初始化脚本进行安装(推荐)
我们提供了一键初始化脚本,可以一键安装,只需要在控制台运行以下命令:
cd tools
bash bootstrap.sh # 这里请不要加上sudo, 因为需要安装的开发依赖包是安装在用户环境而非全局环境
备注
一键配置脚本目前只支持以下系统:
Ubuntu/Debian/Deepin/UOS 等基于Debian的衍生版本
欢迎您为其他的系统完善构建脚本!
如果一键初始化脚本能够正常运行,并输出最终的“祝贺”界面(如下所示),请关闭当前终端,然后重新打开。
|-----------Congratulations!---------------|
| |
| 你成功安装了DragonOS所需的依赖项! |
| |
| 请关闭当前终端, 并重新打开一个终端 |
| 然后通过以下命令运行: |
| |
| make run |
| |
|------------------------------------------|
接着,请直接跳到编译命令讲解进行阅读!
3.手动安装
3.1 依赖清单
如果自动安装脚本不能支持您的操作系统,那么您需要手动安装依赖程序。以下是依赖项的清单:
在以下依赖项中,除了docker-ce
和Rust及其工具链
以外,其他的都能通过系统自带的包管理器进行安装。关于docker以及rust的安装,请看后文。
docker-ce
llvm-dev
libclang-dev
clang
gcc-multilib
qemu qemu-system qemu-kvm
build-essential
fdisk
lsb-release
git
dosfstools
Rust以及其工具链
请留意,若您的Linux系统是在虚拟机中运行的,还请您在您的VMware/Virtual Box虚拟机的处理器设置选项卡中,开启Intel VT-x或AMD-V选项,否则,DragonOS将无法运行。
备注
在某些Linux发行版的软件仓库中构建的Qemu可能由于版本过低而不兼容DragonOS,如果遇到这种问题,请卸载Qemu,并采用编译安装的方式重新安装Qemu
在该地址下载Qemu源代码: https://download.qemu.org/
解压后进入源代码目录,然后执行下列命令:
# 安装编译依赖项
sudo apt install -y autoconf automake autotools-dev curl libmpc-dev libmpfr-dev libgmp-dev \
gawk build-essential bison flex texinfo gperf libtool patchutils bc \
zlib1g-dev libexpat-dev pkg-config libglib2.0-dev libpixman-1-dev libsdl2-dev \
git tmux python3 python3-pip ninja-build
./configure --enable-kvm
make -j 8
sudo make install
# 编译安装完成
请注意,编译安装的QEMU,将通过VNC模式进行链接,因此,您还需要在您的计算机上安装VNC viewer以连接至QEMU虚拟机。
3.3 安装Rust
警告
【常见误区】:如果您打算采用docker进行编译,尽管docker镜像中已经安装了Rust编译环境,但是,为了能够在VSCode中使用Rust-Analyzer进行代码提示,以及make clean
命令能正常运行,您的客户机上仍然需要安装rust环境。
您可以在控制台输入以下命令,安装rust。
# 这两行用于换源,加速Rust的安装过程
export RUSTUP_DIST_SERVER=https://mirrors.ustc.edu.cn/rust-static
export RUSTUP_UPDATE_ROOT=https://mirrors.ustc.edu.cn/rust-static/rustup
# 安装Rust
curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly
# 把Rustup加到环境变量
echo "export PATH=\"\$HOME/.cargo/bin:\$PATH\"" >> ~/.bashrc
source ~/.cargo/env
source "$HOME/.cargo/env"
# 更换cargo的索引源
touch ~/.cargo/config
echo -e "[source.crates-io] \n \
registry = \"https://github.com/rust-lang/crates.io-index\" \n \
\n \
replace-with = 'dragonos-gitee' \n \
[source.dragonos-gitee] \n \
registry = \"https://gitee.com/DragonOS/crates.io-index.git\" \n \
" > ~/.cargo/config
# 安装DragonOS所需的工具链
cargo install cargo-binutils
rustup toolchain install nightly
rustup default nightly
rustup component add rust-src
rustup component add llvm-tools-preview
rustup target add x86_64-unknown-none
# Rust安装完成
至此,公共依赖项已经安装完成,您可以根据自己的需要,阅读后续章节
关于编译命令的用法,请见:编译命令讲解
4.从Docker构建(不推荐)
DragonOS发布了一个Docker编译环境,便于开发者运行DragonOS。但是,由于编码过程仍需要在客户机上进行,因此,您需要在客户机上安装Rust编译环境。
本节假设以下操作均在Linux下进行。
4.2 创建磁盘镜像
首先,您需要使用tools文件夹下的create_hdd_image.sh,创建一块虚拟磁盘镜像。您需要在tools文件夹下运行此命令。
bash create_hdd_image.sh
5.其他注意事项
5.1 创建磁盘镜像
首先,您需要使用普通用户权限运行tools/create_hdd_image.sh
,为DragonOS创建一块磁盘镜像文件。该脚本会自动完成创建磁盘镜像的工作,并将其移动到bin/
目录下。
请注意,由于权限问题,请务必使用普通用户权限运行此脚本。(运行后,需要提升权限时,系统可能会要求您输入密码)
6.编译命令讲解
本地编译,不运行:
make all -j 您的CPU核心数
本地编译,并写入磁盘镜像,不运行:
make build
本地编译,写入磁盘镜像,并在QEMU中运行:
make run
Docker编译,并写入磁盘镜像,:
make docker
Docker编译,写入磁盘镜像,并在QEMU中运行:
make run-docker
不编译,直接从已有的磁盘镜像启动:
make qemu
清理编译产生的文件:
make clean
编译文档:
make docs
(需要手动安装sphinx以及docs下的requirements.txt
中的依赖)清理文档:
make clean-docs
备注
如果您需要在vnc中运行DragonOS,请在上述命令后加上-vnc
后缀。如:make run-vnc