DragonOS/docs/introduction/build_system.md
LoGin 40fe15e095
新的内存管理模块 (#303)
  实现了具有优秀架构设计的新的内存管理模块,对内核空间和用户空间的内存映射、分配、释放、管理等操作进行了封装,使得内核开发者可以更加方便地进行内存管理。

  内存管理模块主要由以下类型的组件组成:

- **硬件抽象层(MemoryManagementArch)** - 提供对具体处理器架构的抽象,使得内存管理模块可以在不同的处理器架构上运行
- **页面映射器(PageMapper)**- 提供对虚拟地址和物理地址的映射,以及页表的创建、填写、销毁、权限管理等操作。分为两种类型:内核页表映射器(KernelMapper)和用户页表映射器(位于具体的用户地址空间结构中)
- **页面刷新器(PageFlusher)** - 提供对页表的刷新操作(整表刷新、单页刷新、跨核心刷新)
- **页帧分配器(FrameAllocator)** - 提供对页帧的分配、释放、管理等操作。具体来说,包括BumpAllocator、BuddyAllocator
- **小对象分配器** - 提供对小内存对象的分配、释放、管理等操作。指的是内核里面的SlabAllocator (SlabAllocator的实现目前还没有完成)
- **MMIO空间管理器** - 提供对MMIO地址空间的分配、管理操作。(目前这个模块待进一步重构)
- **用户地址空间管理机制** - 提供对用户地址空间的管理。
    - VMA机制 - 提供对用户地址空间的管理,包括VMA的创建、销毁、权限管理等操作
    - 用户映射管理 - 与VMA机制共同作用,管理用户地址空间的映射
- **系统调用层** - 提供对用户空间的内存管理系统调用,包括mmap、munmap、mprotect、mremap等
- **C接口兼容层** - 提供对原有的C代码的接口,是的C代码能够正常运行。


除上面的新增内容以外,其它的更改内容:
- 新增二进制加载器,以及elf的解析器
- 解决由于local_irq_save、local_irq_restore函数的汇编不规范导致影响栈行为的bug。
- 解决local_irq_save未关中断的错误。
- 修复sys_gettimeofday对timezone参数的处理的bug

---------

Co-authored-by: kong <kongweichao@dragonos.org>
2023-07-22 16:27:02 +08:00

8.7 KiB
Raw Blame History

(_build_dragonos)=

构建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

:::{warning} 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, 因为需要安装的开发依赖包是安装在用户环境而非全局环境

:::{note} 一键配置脚本目前只支持以下系统:

  • Ubuntu/Debian/Deepin/UOS 等基于Debian的衍生版本

欢迎您为其他的系统完善构建脚本! :::

如果一键初始化脚本能够正常运行,并输出最终的“祝贺”界面(如下所示),请关闭当前终端,然后重新打开。

|-----------Congratulations!---------------|
|                                          |
|   你成功安装了DragonOS所需的依赖项!          |
|                                          |
|   请关闭当前终端, 并重新打开一个终端          |
|   然后通过以下命令运行:                     |
|                                          |
|                make run                  |
|                                          |
|------------------------------------------|

接着,请直接跳到{ref}编译命令讲解 <_build_system_command>进行阅读!

3.手动安装

3.1 依赖清单

  如果自动安装脚本不能支持您的操作系统,那么您需要手动安装依赖程序。以下是依赖项的清单:

  在以下依赖项中,除了docker-ceRust及其工具链以外其他的都能通过系统自带的包管理器进行安装。关于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将无法运行。

:::{note}

在某些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.2 安装Docker

您可以在docker官网下载安装docker-ce.

详细信息请转到: https://docs.docker.com/engine/install/

3.3 安装Rust

:::{warning} 【常见误区】如果您打算采用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安装完成

至此,公共依赖项已经安装完成,您可以根据自己的需要,阅读后续章节

关于编译命令的用法,请见:{ref}编译命令讲解 <_build_system_command>

4.从Docker构建不推荐

DragonOS发布了一个Docker编译环境便于开发者运行DragonOS。但是由于编码过程仍需要在客户机上进行因此您需要在客户机上安装Rust编译环境。

本节假设以下操作均在Linux下进行。

4.1 安装qemu虚拟机

在本节中我们建议您采用命令行安装qemu

sudo apt install -y qemu qemu-system qemu-kvm

4.2 创建磁盘镜像

首先您需要使用tools文件夹下的create_hdd_image.sh创建一块虚拟磁盘镜像。您需要在tools文件夹下运行此命令。

bash create_hdd_image.sh

4.3 运行DragonOS

如果不出意外的话这将是运行DragonOS的最后一步。您只需要在DragonOS的根目录下方执行以下命令即可运行DragonOS。

make run-docker

稍等片刻DragonOS将会被运行。

在qemu虚拟机被启动后我们需要在控制台输入字母c,然后回车。这样,虚拟机就会开始执行。

:::{note}

  1. 首次编译时由于需要下载Rust相关的索引几百MB大小因此需要一定的时间请耐心等候
  2. 输入命令可能需要加上sudo :::

关于编译命令的用法,请见:{ref}编译命令讲解 <_build_system_command>

5.其他注意事项

5.1 创建磁盘镜像

  首先,您需要使用普通用户权限运行tools/create_hdd_image.sh为DragonOS创建一块磁盘镜像文件。该脚本会自动完成创建磁盘镜像的工作并将其移动到bin/目录下。   请注意,由于权限问题,请务必使用普通用户权限运行此脚本。(运行后,需要提升权限时,系统可能会要求您输入密码)

5.2 编译、运行DragonOS

  1. 安装编译及运行环境
  2. 进入DragonOS文件夹
  3. 输入make run即可编译并写入磁盘镜像,并运行

在qemu虚拟机被启动后我们需要在控制台输入字母c,然后回车。这样,虚拟机就会开始执行。

:::{note} 首次编译时由于需要下载Rust相关的索引几百MB大小因此需要一定的时间请耐心等候 :::

关于编译命令的用法,请见:{ref}编译命令讲解 <_build_system_command>

(_build_system_command)=

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

:::{note} 如果您需要在vnc中运行DragonOS请在上述命令后加上-vnc后缀。如:make run-vnc :::