1(_build_dragonos)= 2# 构建DragonOS 3 4## 1.写在前面 5 6  无论您采用后文中的何种方式来编译DragonOS，您必须先按照本小节中的步骤，初始化您的开发环境。 7 8  开始之前，您需要一台运行Linux或MacOS的计算机，并且处理器架构为X86-64. 9 10  对于Linux发行版，建议使用Ubuntu22、Debian、Arch Linux这样的，仓库软件版本较新的发行版，这能为您减少很多麻烦。 11 12### 1.1 下载DragonOS的源代码 13 14使用https克隆： 15 16```shell 17git clone https://github.com/DragonOS-Community/DragonOS.git 18cd DragonOS 19# 使用镜像源更新子模块 20make update-submodules-by-mirror 21``` 22 23为了方便后续的开发，我们建议您使用ssh克隆（请先配置好github的SSH Key），以避免由于网络问题导致的克隆失败： 24 25 26使用ssh克隆（请先配置好github的SSH Key）： 27 28```shell 29# 使用ssh克隆 30git clone git@github.com:DragonOS-Community/DragonOS.git 31cd DragonOS 32# 使用镜像源更新子模块 33make update-submodules-by-mirror 34``` 35 36## 2.使用一键初始化脚本进行安装（推荐） 37 38 39  我们提供了一键初始化脚本，可以一键安装，只需要在控制台运行以下命令： 40 41```shell 42cd DragonOS 43cd tools 44bash bootstrap.sh # 这里请不要加上sudo, 因为需要安装的开发依赖包是安装在用户环境而非全局环境 45``` 46 47:::{note} 48一键配置脚本目前只支持以下系统： 49 50- Ubuntu/Debian/Deepin/UOS 等基于Debian的衍生版本 51- Gentoo 由于Gentoo系统的特性 当gentoo出现USE或循环依赖问题时 请根据emerge提示信息进行对应的处理 官方的依赖处理实例[GentooWiki](https://wiki.gentoo.org/wiki/Handbook:AMD64/Full/Working/zh-cn#.E5.BD.93_Portage_.E6.8A.A5.E9.94.99.E7.9A.84.E6.97.B6.E5.80.99) 52 53欢迎您为其他的系统完善构建脚本！ 54::: 55 56**如果一键初始化脚本能够正常运行，并输出最终的“祝贺”界面(如下所示)，请关闭当前终端，然后重新打开。** 57 58 59```shell 60|-----------Congratulations!---------------| 61| | 62| 你成功安装了DragonOS所需的依赖项! | 63| | 64| 请关闭当前终端, 并重新打开一个终端 | 65| 然后通过以下命令运行: | 66| | 67| make run | 68| | 69|------------------------------------------| 70``` 71 72**接着，请直接跳到{ref}`编译命令讲解 <_build_system_command>`进行阅读！** 73 74## 3.手动安装 75 76### 3.1 依赖清单 77 78  如果自动安装脚本不能支持您的操作系统，那么您需要手动安装依赖程序。以下是依赖项的清单： 79 80  在以下依赖项中，除了`docker-ce`和`Rust及其工具链`以外，其他的都能通过系统自带的包管理器进行安装。关于docker以及rust的安装，请看后文。 81 82- docker-ce 83- llvm-dev 84- libclang-dev 85- clang 86- gcc-multilib 87- qemu qemu-system qemu-kvm 88- build-essential 89- fdisk 90- lsb-release 91- git 92- dosfstools 93- unzip 94- Rust以及其工具链 95 96**请留意，若您的Linux系统是在虚拟机中运行的，还请您在您的VMware/Virtual Box虚拟机的处理器设置选项卡中，开启Intel VT-x或AMD-V选项，否则，DragonOS将无法运行。** 97 98:::{note} 99 100 101*在某些Linux发行版的软件仓库中构建的Qemu可能由于版本过低而不兼容DragonOS，如果遇到这种问题，请卸载Qemu，并采用编译安装的方式重新安装Qemu* 102 103在该地址下载Qemu源代码： https://download.qemu.org/ 104 105解压后进入源代码目录，然后执行下列命令： 106 107```shell 108# 安装编译依赖项 109sudo apt install -y autoconf automake autotools-dev curl libmpc-dev libmpfr-dev libgmp-dev \ 110 gawk build-essential bison flex texinfo gperf libtool patchutils bc \ 111 zlib1g-dev libexpat-dev pkg-config libglib2.0-dev libpixman-1-dev libsdl2-dev \ 112 git tmux python3 python3-pip ninja-build 113 114./configure --enable-kvm 115make -j 8 116sudo make install 117# 编译安装完成 118``` 119请注意，编译安装的QEMU，将通过VNC模式进行链接，因此，您还需要在您的计算机上安装VNC viewer以连接至QEMU虚拟机。 120::: 121 122### 3.2 安装Docker 123 124  您可以在docker官网下载安装docker-ce. 125 126> 详细信息请转到： [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) 127 128### 3.3 安装Rust 129 130:::{warning} 131**【常见误区】**：如果您打算采用docker进行编译，尽管docker镜像中已经安装了Rust编译环境，但是，为了能够在VSCode中使用Rust-Analyzer进行代码提示，以及`make clean`命令能正常运行，您的客户机上仍然需要安装rust环境。 132::: 133 134  您可以在控制台输入以下命令，安装rust。 135 136```shell 137# 这两行用于换源，加速Rust的安装过程 138export RUSTUP_DIST_SERVER=https://mirrors.ustc.edu.cn/rust-static 139export RUSTUP_UPDATE_ROOT=https://mirrors.ustc.edu.cn/rust-static/rustup 140# 安装Rust 141curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly 142# 把Rustup加到环境变量 143echo "export PATH=\"\$HOME/.cargo/bin:\$PATH\"" >> ~/.bashrc 144source ~/.cargo/env 145source "$HOME/.cargo/env" 146 147# 更换cargo的索引源 148touch ~/.cargo/config 149echo -e "[source.crates-io] \n \ 150registry = \"https://github.com/rust-lang/crates.io-index\" \n \ 151\n \ 152replace-with = 'dragonos-gitee' \n \ 153[source.dragonos-gitee] \n \ 154registry = \"https://gitee.com/DragonOS/crates.io-index.git\" \n \ 155" > ~/.cargo/config 156 157# 安装DragonOS所需的工具链 158cargo install cargo-binutils 159rustup toolchain install nightly 160rustup default nightly 161rustup component add rust-src 162rustup component add llvm-tools-preview 163rustup target add x86_64-unknown-none 164# Rust安装完成 165``` 166 167**至此，公共依赖项已经安装完成，您可以根据自己的需要，阅读后续章节** 168 169**关于编译命令的用法，请见：{ref}`编译命令讲解 <_build_system_command>`** 170 171## 4.从Docker构建（不推荐） 172 173  DragonOS发布了一个Docker编译环境，便于开发者运行DragonOS。但是，由于编码过程仍需要在客户机上进行，因此，您需要在客户机上安装Rust编译环境。 174 175  本节假设以下操作均在Linux下进行。 176 177 178### 4.1 安装qemu虚拟机 179 180  在本节中，我们建议您采用命令行安装qemu： 181 182```shell 183sudo apt install -y qemu qemu-system qemu-kvm 184``` 185 186### 4.2 创建磁盘镜像 187 188  首先，您需要使用tools文件夹下的create_hdd_image.sh，创建一块虚拟磁盘镜像。您需要在tools文件夹下运行此命令。 189 190```shell 191bash create_hdd_image.sh 192``` 193 194### 4.3 运行DragonOS 195 196  如果不出意外的话，这将是运行DragonOS的最后一步。您只需要在DragonOS的根目录下方，执行以下命令，即可运行DragonOS。 197 198```shell 199make run-docker 200``` 201 202  稍等片刻，DragonOS将会被运行。 203 204  在qemu虚拟机被启动后，我们需要在控制台输入字母`c`，然后回车。这样，虚拟机就会开始执行。 205 206:::{note} 2071. 首次编译时，由于需要下载Rust相关的索引（几百MB大小），因此需要一定的时间，请耐心等候！ 2082. 输入命令可能需要加上sudo 209::: 210 211**关于编译命令的用法，请见：{ref}`编译命令讲解 <_build_system_command>`** 212 213## 5.其他注意事项 214 215### 5.1 创建磁盘镜像 216 217  首先，您需要使用**普通用户**权限运行`tools/create_hdd_image.sh`，为DragonOS创建一块磁盘镜像文件。该脚本会自动完成创建磁盘镜像的工作，并将其移动到`bin/`目录下。 218  请注意，由于权限问题，请务必使用**普通用户**权限运行此脚本。（运行后，需要提升权限时，系统可能会要求您输入密码） 219 220 221### 5.2 编译、运行DragonOS 222 2231. 安装编译及运行环境 2242. 进入DragonOS文件夹 2253. 输入`make run`即可编译并写入磁盘镜像，并运行 226 227 228  在qemu虚拟机被启动后，我们需要在控制台输入字母`c`，然后回车。这样，虚拟机就会开始执行。 229 230:::{note} 231首次编译时，由于需要下载Rust相关的索引（几百MB大小），因此需要一定的时间，请耐心等候！ 232::: 233 234**关于编译命令的用法，请见：{ref}`编译命令讲解 <_build_system_command>`** 235 236(_build_system_command)= 237## 6.编译命令讲解 238 239- 本地编译，不运行: `make all -j 您的CPU核心数` 240- 本地编译，并写入磁盘镜像，不运行: `make build` 241- 本地编译，写入磁盘镜像，并在QEMU中运行: `make run` 242- Docker编译，并写入磁盘镜像,: `make docker` 243- Docker编译，写入磁盘镜像，并在QEMU中运行: `make run-docker` 244- 不编译，直接从已有的磁盘镜像启动: `make qemu` 245- 清理编译产生的文件: `make clean` 246- 编译文档: `make docs` （需要手动安装sphinx以及docs下的`requirements.txt`中的依赖） 247- 清理文档: `make clean-docs` 248- 格式化代码: `make fmt` 249 250:::{note} 251如果您需要在vnc中运行DragonOS，请在上述命令后加上`-vnc`后缀。如：`make run-vnc` 252 253qemu虚拟机将在5900端口监听vnc连接。您可以使用vnc viewer或者Remmina连接至qemu虚拟机。 254::: 255 256## 7. 为riscv64编译 257 258由于目前DragonOS尚未完全移植到riscv64，因此编译需要这样做： 259 2601. 修改`env.mk`和`.vscode/settings.json` 261 262把`env.mk`里面的`ARCH`的值改为`riscv64`，并且在`setting.json`里面注释`"rust-analyzer.cargo.target": "x86_64-unknown-none",`，改为启用riscv64的那行。 263 2642. 重启rust-analyzer 265 2663. 清理编译缓存 267 268由于x86_64和riscv64架构差异，可能存在缓存导致的编译问题，确保运行前先清理缓存。 269 270```shell 271make clean 272``` 273 2744. 为riscv64编译并运行 275 276```shell 277# 下载DragonStub 278git submodule update --init --recursive --force 279 280make run 281``` 282 283请注意，由于是在控制台运行qemu，当你想要退出的时候，输入`Ctrl+A`然后按`X`即可。 284