README.md

   1 <p align="center">
   2   <img width="auto" src="docs/img/lunaix-os-logo.png">
   3 </p>
   4
   5 <p align="center">
   6   <a href="#lunaixos-project">简体中文</a> | <a href="docs/README_en.md">English</a>
   7 </p>
   8
   9 # LunaixOS Project
  10
  11 LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有浓重个人风格的操作系统。开发过程以视频教程形式在Bilibili呈现：[《从零开始自制操作系统系列》](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337)。
  12
  13 ## 当前进度以及支持的功能
  14
  15 该操作系统支持x86架构，运行在保护模式中，采用宏内核架构，目前仅支持单核心。内存结构采用经典的3:1划分，即低3GiB为用户地址空间（0x400000 ~ 0xBFFFFFFF），内核地址空间重映射至高1GiB（0xC0000000 ~ 0xFFFFFFFF）。内存的详细布局可参考[LunaixOS内存地图](docs/img/lunaix-os-mem.png)
  16
  17 在下述列表中，则列出目前所支持的所用功能和特性。列表项按照项目时间戳进行升序排列。
  18
  19 + 使用Multiboot进行引导启动
  20 + APIC/IOAPIC作为中断管理器和计时器
  21 + ACPI
  22 + 虚拟内存
  23 + 内存管理与按需分页（Demand Paging）
  24 + 键盘输入
  25 + 多进程
  26 + 50个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
  27 + 用户模式
  28 + 信号机制
  29 + PCI 3.0
  30 + PCIe 1.1 (WIP)
  31 + Serial ATA AHCI
  32 + 文件系统
  33   + 虚拟文件系统
  34   + ISO9660
  35     + 原生
  36     + Rock Ridge拓展 (WIP)
  37 + 远程GDB串口调试 (COM1@9600Bd)
  38
  39 已经测试过的环境：
  40
  41 + QEMU (>=7.0.0)
  42 + Bochs（SATA功能不支持）
  43 + Virtualbox
  44 + Dell G3 3779
  45
  46 ## 目录结构
  47
  48 |                                           |                              |
  49 | ----------------------------------------- | ---------------------------- |
  50 | [lunaix-os](lunaix-os/)                   | LunaixOS源代码               |
  51 | [slides](slides/)                         | 视频中所用的幻灯片和补充材料 |
  52 | [reference-material](reference-material/) | 标准，技术文档和参考文献     |
  53
  54 ## 编译与构建
  55
  56 ### 环境搭建
  57
  58 构建该项目需要满足以下条件：
  59
  60 + gcc (目标平台: i686-elf)
  61 + binutils
  62 + make
  63 + xorriso
  64 + grub-mkrescue
  65
  66 **注意：gcc不能是本机自带的，必须要从源码编译，并配置目标平台为：`i686-elf`，以进行交叉编译。配置过程可参考[附录二：编译gcc作为交叉编译器](#appendix2)。**
  67
  68 ### Docker镜像
  69
  70 对于开发环境，本项目也提供了Docker镜像封装。开箱即用，无需配置，非常适合懒人或惜时者。详细使用方法请转到：[Lunaix OSDK项目](https://github.com/Minep/os-devkit)。
  71
  72 ### 构建选项
  73
  74 假若条件满足，那么可以直接执行`make all`进行构建，完成后可在生成的`build`目录下找到可引导的iso。
  75
  76 本项目支持的make命令：
  77 | 命令                     | 用途                                            |
  78 | ------------------------ | ----------------------------------------------- |
  79 | `make all`               | 构建镜像（`-O2`，但禁用CSE相关的优化项 **※** ） |
  80 | `make instable`          | 构建镜像（`-O2`，开启CSE相关优化）              |
  81 | `make all-debug`         | 构建适合调试用的镜像（`-Og`）                   |
  82 | `make run`               | 使用QEMU运行build目录下的镜像                   |
  83 | `make debug-qemu`        | 构建并使用QEMU进行调试                          |
  84 | `make debug-bochs`       | 构建并使用Bochs进行调试                         |
  85 | `make debug-qemu-vscode` | 用于vscode整合                                  |
  86 | `make clean`             | 删除build目录                                   |
  87
  88 **※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
  89
  90 ## 运行以及Issue
  91
  92 运行该操作系统需要一个虚拟磁盘镜像，可以使用如下命令快速创建一个：
  93
  94 ```bash
  95 qemu-img create -f vdi machine/disk0.vdi 128M
  96 ```
  97
  98 如果你想要使用别的磁盘镜像，需要修改`configs/make-debug-tool`
  99
 100 找到这一行：
 101
 102 ```
 103 -drive id=disk,file="machine/disk0.vdi",if=none \
 104 ```
 105
 106 然后把`machine/disk0.vdi`替换成你的磁盘路径。
 107
 108 有很多办法去创建一个虚拟磁盘，比如[qemu-img](https://qemu-project.gitlab.io/qemu/system/images.html)。
 109
 110 在大多数情况下，我都会尽量保证本机运行无误后，push到仓库中。同时，该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)
 111
 112 下面列出一些可能会出现的问题。
 113
 114 #### 问题#1： QEMU下8042控制器提示找不到
 115
 116 这是QEMU配置ACPI时的一个bug，在7.0.0版中修复了。
 117
 118 #### 问题#2：多进程运行时，偶尔会出现General Protection错误
 119
 120 这很大概率是出现了竞态条件。虽然是相当不可能的。但如果出现了，还是请提issue。
 121
 122 #### 问题#3：Bochs无法运行，提示找不到AHCI控制器
 123
 124 正常，**因为Bochs不支持SATA**。请使用QEMU或VirtualBox。
 125
 126 ## 参考教程
 127
 128 **没有！！** 本教程以及该操作系统均为原创，没有基于任何市面上现行的操作系统开发教程，且并非是基于任何的开源内核的二次开发。
 129
 130 为了制作LunaixOS，作者耗费大量时间和精力钻研技术文档，手册，理论书籍以及现行工业标准，从而尽量保证了知识的一手性。（这样一来，读者和听众们也算是拿到了二手的知识，而不是三手，四手，甚至n手的知识）。
 131
 132 大部分的文档和标准可以在上述的[reference-material](reference-material/)中找到。
 133
 134 当然，您也可以参考以下列表来了解现阶段的LunaixOS都使用了哪些资料（本列表会随着开发进度更新）：
 135
 136 #### 手册，标准，技术文档
 137
 138 + [Intel 64 and IA-32 Architecture Software Developer's Manual (Full Volume Bundle)](https://www.intel.com/content/www/us/en/developer/articles/technical/intel-sdm.html)
 139 + [ACPI Specification (version 6.4)](https://uefi.org/sites/default/files/resources/ACPI_Spec_6_4_Jan22.pdf)
 140 + IBM PC/AT Technical Reference
 141 + IBM VGA/XGA Technical Reference
 142 + 82093AA I/O Advanced Programmable Controller (IOAPIC) (Datasheet)
 143 + MC146818A (Datasheet)
 144 + Intel 500 Series Chipset Family Platform Controller Hub (Datasheet - Volume 2)
 145 + PCI Local Bus Specification, Revision 3.0
 146 + PCI Express Base Specification, Revision 1.1
 147 + PCI Firmware Specification, Revision 3.0
 148 + Serial ATA - Advanced Host Controller Interface (AHCI), Revision 1.3.1
 149 + Serial ATA: High Speed Serialized AT Attachment, Revision 3.2
 150 + SCSI Command Reference Manual
 151 + ATA/ATAPI Command Set - 3 (ACS-3)
 152 + [ECMA-119 (ISO9660)](https://www.ecma-international.org/publications-and-standards/standards/ecma-119/)
 153 + Rock Ridge Interchange Protocol (RRIP: IEEE P1282)
 154 + System Use Sharing Protocol (SUSP: IEEE P1281)
 155 + Tool Interface Standard (TIS) Portable Formats Specification (Version 1.1)
 156
 157 **免责声明：PCI相关的标准最终解释权归PCI-SIG所有。此处提供的副本仅供个人学习使用。任何商用目的须向PCI-SIG购买。**
 158
 159 #### 理论书籍
 160
 161 + *Computer System - A Programmer's Perspective Third Edition (CS:APP)* (Bryant, R & O'Hallaron, D)
 162 + *Modern Operating System* (Tanenbaum, A)
 163 + 《汇编语言》（王爽） - 用于入门Intel语法的x86汇编（对于AT&T语法，推荐阅读CS:APP）
 164 + ~~《微机原理与接口技术》 - 用于大致了解x86架构的微机体系（更加细致的了解可以阅读Intel Manual）~~ （已过时，推荐阅读CS:APP）
 165
 166 #### 网站
 167
 168 + [OSDev](https://wiki.osdev.org/Main_Page) - 杂七杂八的参考，很多过来人的经验。作者主要用于上古资料查询以及收集；技术文献，手册，标准的粗略总结；以及开发环境/工具链的搭建。
 169 + [FreeVGA](http://www.osdever.net/FreeVGA/home.htm) - 98年的资源！关于VGA编程技术的宝藏网站。
 170 + GNU CC 和 GNU LD 的官方文档。
 171 + [PCI Lookup](https://www.pcilookup.com/) - PCI设备编号查询
 172
 173 #### 其他
 174
 175 + Linux Manual - 用于查询*nix API的一些具体行为。
 176
 177 ## 附录1：支持的系统调用<a id="appendix1"></a>
 178
 179 **Unix/Linux/POSIX**
 180
 181 1. `sleep(3)`
 182 1. `wait(2)`
 183 1. `waitpid(2)`
 184 1. `fork(2)`
 185 1. `getpid(2)`
 186 1. `getppid(2)`
 187 1. `getpgid(2)`
 188 1. `setpgid(2)`
 189 1. `brk(2)`
 190 1. `sbrk(2)`
 191 1. `_exit(2)`
 192 1. `sigreturn(2)`
 193 1. `sigprocmask(2)`
 194 1. `signal(2)`
 195 1. `kill(2)`
 196 1. `sigpending(2)`
 197 1. `sigsuspend(2)`
 198 2. `read(2)`
 199 2. `write(2)`
 200 2. `open(2)`
 201 2. `close(2)`
 202 2. `mkdir(2)`
 203 2. `lseek(2)`
 204 2. `readdir(2)`
 205 2. `readlink(2)`※
 206 2. `readlinkat(2)`※
 207 2. `rmdir(2)`※
 208 2. `unlink(2)`※
 209 2. `unlinkat(2)`※
 210 2. `link(2)`※
 211 2. `fsync(2)`※
 212 2. `dup(2)`
 213 2. `dup2(2)`
 214 2. `symlink(2)`※
 215 2. `chdir(2)`
 216 2. `fchdir(2)`
 217 2. `getcwd(2)`
 218 2. `rename(2)`※
 219 2. `mount(2)`
 220 2. `unmount` (a.k.a `umount(2)`)※
 221 2. `getxattr(2)`※
 222 2. `setxattr(2)`※
 223 2. `fgetxattr(2)`※
 224 2. `fsetxattr(2)`※
 225 2. `ioctl(2)`
 226 2. `getpgid(2)`
 227 2. `setpgid(2)`
 228 2. `mmap(2)`
 229 2. `munmap(2)`
 230 2. `execve(2)`
 231
 232 **LunaixOS自有**
 233
 234 1. `yield`
 235 2. `geterrno`
 236 3. `realpathat`
 237 4. `syslog`
 238
 239 ( **※**：该系统调用暂未经过测试 )
 240
 241 ## 附录2：编译gcc作为交叉编译器<a id="appendix2"></a>
 242
 243 注意，gcc需要从源码构建，并配置为交叉编译器，即目标平台为`i686-elf`。你可以使用本项目提供的[自动化脚本](slides/c0-workspace/gcc-build.sh)，这将会涵盖gcc和binutils源码的下载，配置和编译（没什么时间去打磨脚本，目前只知道在笔者的Ubuntu系统上可以运行）。
 244
 245 **推荐**手动编译。以下编译步骤搬运自：<https://wiki.osdev.org/GCC_Cross-Compiler>
 246
 247 **首先安装构建依赖项：**
 248
 249 ```bash
 250 sudo apt update &&\
 251      apt install -y \
 252         build-essential \
 253         bison\
 254         flex\
 255         libgmp3-dev\
 256         libmpc-dev\
 257         libmpfr-dev\
 258         texinfo
 259 ```
 260
 261 **开始编译：**
 262
 263 1. 获取[gcc](https://ftp.gnu.org/gnu/gcc/)和[binutils](https://ftp.gnu.org/gnu/binutils)源码
 264 2. 解压，并在同级目录为gcc和binutil新建专门的build文件夹
 265
 266 现在假设你的目录结构如下：
 267
 268 ```
 269 + folder
 270   + gcc-src
 271   + binutils-src
 272   + gcc-build
 273   + binutils-build
 274 ```
 275
 276 3. 确定gcc和binutil安装的位置，并设置环境变量：`export PREFIX=<安装路径>` 然后设置PATH： `export PATH="$PREFIX/bin:$PATH"`
 277 4. 设置目标平台：`export TARGET=i686-elf`
 278 5. 进入`binutils-build`进行配置
 279
 280 ```bash
 281 ../binutils-src/configure --target="$TARGET" --prefix="$PREFIX" \
 282  --with-sysroot --disable-nls --disable-werror
 283 ```
 284
 285 然后 `make && make install`
 286
 287 6. 确保上述的`binutils`已经正常安装：执行：`which i686-elf-as`，应该会给出一个位于你安装目录下的路径。
 288 6. 进入`gcc-build`进行配置
 289
 290 ```bash
 291 ../gcc-src/configure --target="$TARGET" --prefix="$PREFIX" \
 292  --disable-nls --enable-languages=c,c++ --without-headers
 293 ```
 294
 295 然后编译安装（取决性能，大约10~20分钟）：
 296
 297 ```bash
 298 make all-gcc &&\
 299  make all-target-libgcc &&\
 300  make install-gcc &&\
 301  make install-target-libgcc
 302 ```
 303
 304 8. 验证安装：执行`i686-elf-gcc -dumpmachine`，输出应该为：`i686-elf`
 305
 306 **将新编译好的GCC永久添加到`PATH`环境变量**
 307
 308 虽然这是一个常识性的操作，但考虑到许多人都会忽略这一个额外的步骤，在这里特此做出提示。
 309
 310 要想实现这一点，只需要在shell的配置文件的末尾添加：`export PATH="<上述的安装路径>/bin:$PATH"`。
 311
 312 这个配置文件是取决于你使用的shell，如zsh就是`${HOME}/.zshrc`，bash则是`${HOME}/.bashrc`；或者你嫌麻烦的，懒得区分，你也可以直接修改全局的`/etc/profile`文件，一劳永逸（但不推荐这样做）。
 313
 314 至于其他的情况，由于这个步骤其实在网上是随处可查的，所以就不在这里赘述了。
 315
 316 ## 附录3：Issue的提交<a id="appendix3"></a>
 317
 318 由于目前LunaixOS没有一个完善强大的内核追踪功能。假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。
 319
 320 最好提供：
 321
 322 + 可用于复现问题的描述和指引（如Lunaix运行平台的软硬件配置）
 323 + 错误症状描述
 324 + （如可能）运行截图
 325 + 错误消息（如果给出）
 326 + 寄存器状态的dump
 327 + （如可能）提供错误发生时，EIP附近的指令（精确到函数）。如果使用`make all-debug`，会提供`build/kdump.txt`，你可以在这里面定位。或者也可以直接`objdump`
 328 + （如可能）虚拟内存映射信息（QEMU下可使用`info mem`查看）。
 329
 330 ## 附录4：串口GDB远程调试
 331
 332 LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM1在9600波特率上与之建立链接。但是，在将GDB与内核链接起来之前，还需要让内核处在调试模式下。
 333
 334 要进入调试模式，需要往串口（波特率如上）写入字节串 `0x40` `0x63` `0x6D` `0x63`。此时，如果屏幕底部出现一条品红色背景的`DEBUG` 字样，那么就说明LunaixOS已处在调试模式下。
 335
 336 注意，在这个时候，LunaixOS会开始在`COM1`上监听GDB协议信息，并且暂停一切的活动（如调度，以及对外部中断的一切响应）。用户此时需要将GDB与其挂载，并使用GDB的工作流来指示内核下一步的动作。
 337
 338 在目前，为了防止代码过于臃肿，LunaixOS实现的是GDB远程协议要求的最小服务端命令子集：`g`, `G`, `p`, `P`, `Q`, `S`, `k`, `?`, `m`, `M`, `X`。足以满足大部分的调试需求。
 339
 340 当结束调试的时候，请使用GDB的`kill`指令进行连接的断开。注意，这个指令会使得LunaixOS恢复所有暂停的活动，进入正常的运行序列，但并不会退出调试模式。GDB的挂载请求依然在LunaixOS中享有最高优先权。如果需要退出调试模式，需要往串口写入字节串：`0x40` `0x79` `0x61` `0x79`。
 341
 342 ### GDB调试注意事项
 343
 344 在调试中，请避免使用`info stack`，`bt`或者任何涉及 **栈展开（Stack Unwinding）** 或者 **栈回溯（Stack Backtracing）** 的指令。否则，LunaixOS很有可能会出现 **不可预料的行为** 。