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  假设您的计算机上已经安装了git，您可以通过以下命令，获得DragonOS的最新的源代码： 15 16```shell 17git clone https://github.com/DragonOS-Community/DragonOS 18cd DragonOS 19``` 20 21:::{warning} 22DragonOS的源代码托管在Github上，但是，由于Github在国内的访问速度较慢，因此，我们建议您在github上绑定您的电脑的**ssh公钥**， 23然后通过以下命令来克隆代码，防止频繁出现git clone、pull、push失败的情况。 24 25```shell 26git clone git@github.com:DragonOS-Community/DragonOS.git 27``` 28::: 29 30## 2.使用一键初始化脚本进行安装（推荐） 31 32 33  我们提供了一键初始化脚本，可以一键安装，只需要在控制台运行以下命令： 34 35```shell 36cd tools 37bash bootstrap.sh # 这里请不要加上sudo, 因为需要安装的开发依赖包是安装在用户环境而非全局环境 38``` 39 40:::{note} 41一键配置脚本目前只支持以下系统： 42 43- Ubuntu/Debian/Deepin/UOS 等基于Debian的衍生版本 44 45欢迎您为其他的系统完善构建脚本！ 46::: 47 48**如果一键初始化脚本能够正常运行，并输出最终的“祝贺”界面(如下所示)，请关闭当前终端，然后重新打开。** 49 50 51```shell 52|-----------Congratulations!---------------| 53| | 54| 你成功安装了DragonOS所需的依赖项! | 55| | 56| 请关闭当前终端, 并重新打开一个终端 | 57| 然后通过以下命令运行: | 58| | 59| make run | 60| | 61|------------------------------------------| 62``` 63 64**接着，请直接跳到{ref}`编译命令讲解 <_build_system_command>`进行阅读！** 65 66## 3.手动安装 67 68### 3.1 依赖清单 69 70  如果自动安装脚本不能支持您的操作系统，那么您需要手动安装依赖程序。以下是依赖项的清单： 71 72  在以下依赖项中，除了`docker-ce`和`Rust及其工具链`以外，其他的都能通过系统自带的包管理器进行安装。关于docker以及rust的安装，请看后文。 73 74- docker-ce 75- llvm-dev 76- libclang-dev 77- clang 78- gcc-multilib 79- qemu qemu-system qemu-kvm 80- build-essential 81- fdisk 82- lsb-release 83- git 84- dosfstools 85- Rust以及其工具链 86 87**请留意，若您的Linux系统是在虚拟机中运行的，还请您在您的VMware/Virtual Box虚拟机的处理器设置选项卡中，开启Intel VT-x或AMD-V选项，否则，DragonOS将无法运行。** 88 89:::{note} 90 91 92*在某些Linux发行版的软件仓库中构建的Qemu可能由于版本过低而不兼容DragonOS，如果遇到这种问题，请卸载Qemu，并采用编译安装的方式重新安装Qemu* 93 94在该地址下载Qemu源代码： https://download.qemu.org/ 95 96解压后进入源代码目录，然后执行下列命令： 97 98```shell 99# 安装编译依赖项 100sudo apt install -y autoconf automake autotools-dev curl libmpc-dev libmpfr-dev libgmp-dev \ 101 gawk build-essential bison flex texinfo gperf libtool patchutils bc \ 102 zlib1g-dev libexpat-dev pkg-config libglib2.0-dev libpixman-1-dev libsdl2-dev \ 103 git tmux python3 python3-pip ninja-build 104 105./configure --enable-kvm 106make -j 8 107sudo make install 108# 编译安装完成 109``` 110请注意，编译安装的QEMU，将通过VNC模式进行链接，因此，您还需要在您的计算机上安装VNC viewer以连接至QEMU虚拟机。 111::: 112 113### 3.2 安装Docker 114 115  您可以在docker官网下载安装docker-ce. 116 117> 详细信息请转到： [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) 118 119### 3.3 安装Rust 120 121:::{warning} 122**【常见误区】**：如果您打算采用docker进行编译，尽管docker镜像中已经安装了Rust编译环境，但是，为了能够在VSCode中使用Rust-Analyzer进行代码提示，以及`make clean`命令能正常运行，您的客户机上仍然需要安装rust环境。 123::: 124 125  您可以在控制台输入以下命令，安装rust。 126 127```shell 128# 这两行用于换源，加速Rust的安装过程 129export RUSTUP_DIST_SERVER=https://mirrors.ustc.edu.cn/rust-static 130export RUSTUP_UPDATE_ROOT=https://mirrors.ustc.edu.cn/rust-static/rustup 131# 安装Rust 132curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly 133# 把Rustup加到环境变量 134echo "export PATH=\"\$HOME/.cargo/bin:\$PATH\"" >> ~/.bashrc 135source ~/.cargo/env 136source "$HOME/.cargo/env" 137 138# 更换cargo的索引源 139touch ~/.cargo/config 140echo -e "[source.crates-io] \n \ 141registry = \"https://github.com/rust-lang/crates.io-index\" \n \ 142\n \ 143replace-with = 'dragonos-gitee' \n \ 144[source.dragonos-gitee] \n \ 145registry = \"https://gitee.com/DragonOS/crates.io-index.git\" \n \ 146" > ~/.cargo/config 147 148# 安装DragonOS所需的工具链 149cargo install cargo-binutils 150rustup toolchain install nightly 151rustup default nightly 152rustup component add rust-src 153rustup component add llvm-tools-preview 154rustup target add x86_64-unknown-none 155# Rust安装完成 156``` 157 158**至此，公共依赖项已经安装完成，您可以根据自己的需要，阅读后续章节** 159 160**关于编译命令的用法，请见：{ref}`编译命令讲解 <_build_system_command>`** 161 162## 4.从Docker构建（不推荐） 163 164  DragonOS发布了一个Docker编译环境，便于开发者运行DragonOS。但是，由于编码过程仍需要在客户机上进行，因此，您需要在客户机上安装Rust编译环境。 165 166  本节假设以下操作均在Linux下进行。 167 168 169### 4.1 安装qemu虚拟机 170 171  在本节中，我们建议您采用命令行安装qemu： 172 173```shell 174sudo apt install -y qemu qemu-system qemu-kvm 175``` 176 177### 4.2 创建磁盘镜像 178 179  首先，您需要使用tools文件夹下的create_hdd_image.sh，创建一块虚拟磁盘镜像。您需要在tools文件夹下运行此命令。 180 181```shell 182bash create_hdd_image.sh 183``` 184 185### 4.3 运行DragonOS 186 187  如果不出意外的话，这将是运行DragonOS的最后一步。您只需要在DragonOS的根目录下方，执行以下命令，即可运行DragonOS。 188 189```shell 190make run-docker 191``` 192 193  稍等片刻，DragonOS将会被运行。 194 195  在qemu虚拟机被启动后，我们需要在控制台输入字母`c`，然后回车。这样，虚拟机就会开始执行。 196 197:::{note} 1981. 首次编译时，由于需要下载Rust相关的索引（几百MB大小），因此需要一定的时间，请耐心等候！ 1992. 输入命令可能需要加上sudo 200::: 201 202**关于编译命令的用法，请见：{ref}`编译命令讲解 <_build_system_command>`** 203 204## 5.其他注意事项 205 206### 5.1 创建磁盘镜像 207 208  首先，您需要使用**普通用户**权限运行`tools/create_hdd_image.sh`，为DragonOS创建一块磁盘镜像文件。该脚本会自动完成创建磁盘镜像的工作，并将其移动到`bin/`目录下。 209  请注意，由于权限问题，请务必使用**普通用户**权限运行此脚本。（运行后，需要提升权限时，系统可能会要求您输入密码） 210 211 212### 5.2 编译、运行DragonOS 213 2141. 安装编译及运行环境 2152. 进入DragonOS文件夹 2163. 输入`make run`即可编译并写入磁盘镜像，并运行 217 218 219  在qemu虚拟机被启动后，我们需要在控制台输入字母`c`，然后回车。这样，虚拟机就会开始执行。 220 221:::{note} 222首次编译时，由于需要下载Rust相关的索引（几百MB大小），因此需要一定的时间，请耐心等候！ 223::: 224 225**关于编译命令的用法，请见：{ref}`编译命令讲解 <_build_system_command>`** 226 227(_build_system_command)= 228## 6.编译命令讲解 229 230- 本地编译，不运行: `make all -j 您的CPU核心数` 231- 本地编译，并写入磁盘镜像，不运行: `make build` 232- 本地编译，写入磁盘镜像，并在QEMU中运行: `make run` 233- Docker编译，并写入磁盘镜像,: `make docker` 234- Docker编译，写入磁盘镜像，并在QEMU中运行: `make run-docker` 235- 不编译，直接从已有的磁盘镜像启动: `make qemu` 236- 清理编译产生的文件: `make clean` 237- 编译文档: `make docs` （需要手动安装sphinx以及docs下的`requirements.txt`中的依赖） 238- 清理文档: `make clean-docs` 239 240:::{note} 241如果您需要在vnc中运行DragonOS，请在上述命令后加上`-vnc`后缀。如：`make run-vnc` 242::: 243