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 # The LunaixOS Project
  10
  11 LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有浓重个人风格的操作系统。开发过程以视频教程形式在Bilibili呈现：[《从零开始自制操作系统系列》](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337)。
  12
  13 ## 1. 一些实用资源
  14
  15 如果有意研读LunaixOS的内核代码和其中的设计，以下资料可能会对此有用。
  16
  17 + [最新的LunaixOS源代码分析教程](docs/tutorial/0-教程介绍和环境搭建.md)
  18 + [内核虚拟内存的详细布局](docs/img/lunaix-os-mem.png)
  19 + [LunaixOS启动流程概览](docs/img/boot_sequence.jpeg)
  20 + LunaixOS总体架构概览（WIP）
  21
  22 ## 2. 当前进度以及支持的功能
  23
  24 该操作系统支持x86架构，运行在保护模式中，采用宏内核架构，目前仅支持单核心。架构与内核的解耦合工作正在进行中。
  25
  26 在下述列表中，则列出目前所支持的所用功能和特性。列表项按照项目时间戳进行升序排列。
  27
  28 + 使用Multiboot进行引导启动
  29 + APIC/IOAPIC作为中断管理器和计时器
  30 + ACPI
  31 + 虚拟内存
  32 + 内存管理与按需分页
  33 + 键盘输入
  34 + 多进程
  35 + 54个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
  36 + 用户模式
  37 + 信号机制
  38 + PCI 3.0
  39 + PCIe 1.1 (WIP)
  40 + Serial ATA AHCI
  41 + 文件系统
  42   + 虚拟文件系统
  43   + ISO9660
  44     + 原生
  45     + Rock Ridge拓展
  46 + 远程GDB串口调试 (COM1@9600Bd)
  47 + 用户程序加载与执行
  48 + 动态链接 (WIP)
  49 + 通用设备抽象层
  50 + 通用图形设备抽象层
  51   + 标准VGA实现
  52 + 虚拟终端设备接口（兼容 POSIX.1-2008）
  53
  54 已经测试过的环境：
  55
  56 + QEMU (>=7.0.0)
  57 + Bochs（SATA功能不支持）
  58 + Virtualbox
  59 + Dell G3 3779
  60
  61 ## 3. 目录结构
  62
  63 |                                           |                              |
  64 | ----------------------------------------- | ---------------------------- |
  65 | [lunaix-os](lunaix-os/)                   | LunaixOS源代码               |
  66 | [slides](slides/)                         | 视频中所用的幻灯片和补充材料 |
  67 | [reference-material](reference-material/) | 标准，技术文档和参考文献     |
  68
  69 ## 4. 编译与构建
  70
  71 构建该项目需要满足以下条件：
  72
  73 + gcc 工具链
  74 + make
  75 + xorriso
  76 + grub-mkrescue
  77
  78 ### 4.1 使用 GNU CC 工具链
  79
  80 正如同大多数OS一样，LunaixOS 是一个混合了 C 和汇编的产物。这就意味着你得要使用一些标准的C编译器来构建Lunaix。在这里，我推荐使用 GNU CC 工具链来进行构建。至于其他的工具链，如llvm，也可以去尝试，但对此我就不能作任何的保证了。
  81
  82 如果你使用的是基于 x86 指令集的Linux系统，不论是64位还是32位，**其本机自带的gcc就足以编译Lunaix**。 当然了，如果说你的平台是其他非x86的，你也可以指定使用某个针对x86_32的gcc套件来进行交叉编译——在`make`时通过`CX_PREFIX`变量来指定gcc套件的前缀。如下例所示，我们可以在任意平台上，如risc-v，单独使用一个面向x86_32的gcc来进行交叉编译：
  83
  84 ```
  85 make CX_PREFIX=i686-linux-gnu- all
  86 ```
  87
  88 由于目前Lunaix仅支持x86_32微架构， `CX_PREFIX` 指向的gcc必须具有针对x86_32架构进行交叉编译的能力。
  89
  90 ### 4.2 Docker镜像
  91
  92 对于开发环境，本项目也提供了Docker镜像封装。开箱即用，无需配置，非常适合懒人或惜时者。详细使用方法请转到：[Lunaix OSDK项目](https://github.com/Minep/os-devkit)。
  93
  94 ### 4.3 构建选项
  95
  96 假若条件满足，那么可以直接执行`make all`进行构建，完成后可在生成的`build`目录下找到可引导的iso。
  97
  98 本项目支持的make命令：
  99 | 命令                     | 用途                                            |
 100 | ------------------------ | ----------------------------------------------- |
 101 | `make all`               | 构建镜像（`-O2`，但禁用CSE相关的优化项 **※** ） |
 102 | `make instable`          | 构建镜像（`-O2`，开启CSE相关优化）              |
 103 | `make all-debug`         | 构建适合调试用的镜像（`-Og`）                   |
 104 | `make run`               | 使用QEMU运行build目录下的镜像                   |
 105 | `make debug-qemu`        | 构建并使用QEMU进行调试                          |
 106 | `make debug-bochs`       | 构建并使用Bochs进行调试                         |
 107 | `make debug-qemu-vscode` | 用于vscode整合                                  |
 108 | `make clean`             | 删除build目录                                   |
 109
 110 **※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
 111
 112 ## 5. 运行，分支以及 Issue
 113
 114 ### 5.1 虚拟磁盘（非必须）
 115
 116 你可以绑定一个虚拟磁盘镜像，可以使用如下命令快速创建一个：
 117
 118 ```bash
 119 qemu-img create -f vdi machine/disk0.vdi 128M
 120 ```
 121
 122 如果你想要使用别的磁盘镜像，需要修改`configs/make-debug-tool`
 123
 124 找到这一行：
 125
 126 ```
 127 -drive id=disk,file="machine/disk0.vdi",if=none \
 128 ```
 129
 130 然后把`machine/disk0.vdi`替换成你的磁盘路径。
 131
 132 有很多办法去创建一个虚拟磁盘，比如[qemu-img](https://qemu-project.gitlab.io/qemu/system/images.html)。
 133
 134 ### 5.2 代码稳定性
 135
 136 主分支一般是稳定的。因为在大多数情况下，我都会尽量保证本机运行无误后，push到该分支中。至于其他的分支，则是作为标记或者是开发中的功能。前者标记用分支一般会很快删掉；后者开发分支不能保证稳定性，这些分支的代码有可能没有经过测试，但可以作为Lunaix当前开发进度的参考。
 137
 138 该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)
 139
 140 下面列出一些可能会出现的问题。
 141
 142 #### 问题#1： QEMU下8042控制器提示找不到
 143
 144 这是QEMU配置ACPI时的一个bug，在7.0.0版中修复了。
 145
 146 #### 问题#2：多进程运行时，偶尔会出现General Protection错误
 147
 148 这很大概率是出现了竞态条件。虽然是相当不可能的。但如果出现了，还是请提issue。
 149
 150 #### 问题#3：Bochs无法运行，提示找不到AHCI控制器
 151
 152 正常，**因为Bochs不支持SATA**。请使用QEMU或VirtualBox。
 153
 154 ## 6. 调试 Lunaix 内核
 155
 156 除了[附录4：串口GDB远程调试](#appendix4)描述的一种用于实机调试的方式以外。LunaixOS还提供了LunaDBG调试套件。这是一个GDB客户端插件，包含了对GDB原生命令集的一些扩充，主要用于改善与简化内核调试的过程。目前包含以下几个命令：
 157
 158 + `vmrs [pid]` 列举进程`<pid>`的内存区域图（Memory Regions），如果`<pid>`未指定，则默认为正在运行的进程（smp=1）。
 159 + `proc [pid]` 打印进程`<pid>`的进程控制块状态，如果`<pid>`未指定，则默认为正在运行的进程（smp=1）。
 160 + `proc_table` 列举所有非终止的进程以及他们的状态。
 161
 162 该插件可以通过运行以下命令来进行安装：
 163
 164 ```shell
 165 ./scripts/gdb/install_lunadbg
 166 ```
 167
 168 ## 7. 参考教程
 169
 170 **没有！！** 本教程以及该操作系统均为原创，没有基于任何市面上现行的操作系统开发教程，且并非是基于任何的开源内核的二次开发。
 171
 172 为了制作LunaixOS，作者耗费大量时间和精力钻研技术文档，手册，理论书籍以及现行工业标准，从而尽量保证了知识的一手性。（这样一来，读者和听众们也算是拿到了二手的知识，而不是三手，四手，甚至n手的知识）。
 173
 174 大部分的文档和标准可以在上述的[reference-material](reference-material/)中找到。
 175
 176 当然，您也可以参考以下列表来了解现阶段的LunaixOS都使用了哪些资料（本列表会随着开发进度更新）：
 177
 178 #### 手册，标准，技术文档
 179
 180 + [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)
 181 + [ACPI Specification (version 6.4)](https://uefi.org/sites/default/files/resources/ACPI_Spec_6_4_Jan22.pdf)
 182 + IBM PC/AT Technical Reference
 183 + IBM VGA/XGA Technical Reference
 184 + 82093AA I/O Advanced Programmable Controller (IOAPIC) (Datasheet)
 185 + MC146818A (Datasheet)
 186 + Intel 500 Series Chipset Family Platform Controller Hub (Datasheet - Volume 2)
 187 + PCI Local Bus Specification, Revision 3.0
 188 + PCI Express Base Specification, Revision 1.1
 189 + PCI Firmware Specification, Revision 3.0
 190 + Serial ATA - Advanced Host Controller Interface (AHCI), Revision 1.3.1
 191 + Serial ATA: High Speed Serialized AT Attachment, Revision 3.2
 192 + SCSI Command Reference Manual
 193 + ATA/ATAPI Command Set - 3 (ACS-3)
 194 + [ECMA-119 (ISO9660)](https://www.ecma-international.org/publications-and-standards/standards/ecma-119/)
 195 + Rock Ridge Interchange Protocol (RRIP: IEEE P1282)
 196 + System Use Sharing Protocol (SUSP: IEEE P1281)
 197 + Tool Interface Standard (TIS) Portable Formats Specification (Version 1.1)
 198
 199 **免责声明：PCI相关的标准最终解释权归PCI-SIG所有。此处提供的副本仅供个人学习使用。任何商用目的须向PCI-SIG购买。**
 200
 201 #### 理论书籍
 202
 203 + *Computer System - A Programmer's Perspective Third Edition (CS:APP)* (Bryant, R & O'Hallaron, D)
 204 + *Modern Operating System* (Tanenbaum, A)
 205
 206 #### 网站
 207
 208 + [OSDev](https://wiki.osdev.org/Main_Page) - 杂七杂八的参考，很多过来人的经验。作者主要用于上古资料查询以及收集；技术文献，手册，标准的粗略总结；以及开发环境/工具链的搭建。
 209 + [FreeVGA](http://www.osdever.net/FreeVGA/home.htm) - 98年的资源！关于VGA编程技术的宝藏网站。
 210 + GNU CC 和 GNU LD 的官方文档。
 211 + [PCI Lookup](https://www.pcilookup.com/) - PCI设备编号查询
 212
 213 #### 其他
 214
 215 + Linux Manual - 用于查询*nix API的一些具体行为。
 216
 217 ## 附录1：支持的系统调用<a id="appendix1"></a>
 218
 219 **Unix/Linux/POSIX**
 220
 221 1. `sleep(3)`
 222 1. `wait(2)`
 223 1. `waitpid(2)`
 224 1. `fork(2)`
 225 1. `getpid(2)`
 226 1. `getppid(2)`
 227 1. `getpgid(2)`
 228 1. `setpgid(2)`
 229 1. `brk(2)`
 230 1. `sbrk(2)`
 231 1. `_exit(2)`
 232 1. `sigreturn(2)`
 233 1. `sigprocmask(2)`
 234 1. `sigaction(2)`
 235 1. `kill(2)`
 236 1. `sigpending(2)`
 237 1. `sigsuspend(2)`
 238 2. `read(2)`
 239 2. `write(2)`
 240 2. `open(2)`
 241 2. `close(2)`
 242 2. `mkdir(2)`
 243 2. `lseek(2)`
 244 2. `readdir(2)`
 245 2. `readlink(2)`
 246 2. `readlinkat(2)`
 247 2. `rmdir(2)`※
 248 2. `unlink(2)`※
 249 2. `unlinkat(2)`※
 250 2. `link(2)`※
 251 2. `fsync(2)`※
 252 2. `dup(2)`
 253 2. `dup2(2)`
 254 2. `symlink(2)`
 255 2. `chdir(2)`
 256 2. `fchdir(2)`
 257 2. `getcwd(2)`
 258 2. `rename(2)`※
 259 2. `mount(2)`
 260 2. `unmount` (a.k.a `umount(2)`)※
 261 2. `getxattr(2)`※
 262 2. `setxattr(2)`※
 263 2. `fgetxattr(2)`※
 264 2. `fsetxattr(2)`※
 265 2. `ioctl(2)`
 266 2. `getpgid(2)`
 267 2. `setpgid(2)`
 268 2. `mmap(2)`
 269 2. `munmap(2)`
 270 2. `execve(2)`
 271 3. `poll(2)` (via `pollctl`)
 272 3. `epoll_create(2)` (via `pollctl`)
 273 3. `epoll_ctl(2)` (via `pollctl`)
 274 3. `epoll_wait(2)` (via `pollctl`)
 275
 276 **LunaixOS自有**
 277
 278 1. `yield`
 279 2. `geterrno`
 280 3. `realpathat`
 281 4. `syslog`
 282 5. `pollctl`
 283
 284 ( **※**：该系统调用暂未经过测试 )
 285
 286 ## 附录2：Issue的提交<a id="appendix3"></a>
 287
 288 假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。
 289
 290 + 可用于复现问题的描述和指引（如Lunaix运行平台的软硬件配置）
 291 + 错误症状描述
 292 + LunaixOS在panic时打印的调试信息（如无法复制，可以截图）
 293
 294 ## 附录3：串口GDB远程调试<a id="appendix4"></a>
 295
 296 **（该功能正在重构，目前不可用）**
 297
 298 LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM1在9600波特率上与之建立链接。但是，在将GDB与内核链接起来之前，还需要让内核处在调试模式下。
 299
 300 要进入调试模式，需要往串口（波特率如上）写入字节串 `0x40` `0x63` `0x6D` `0x63`。此时，如果屏幕底部出现一条品红色背景的`DEBUG` 字样，那么就说明LunaixOS已处在调试模式下。
 301
 302 注意，在这个时候，LunaixOS会开始在`COM1`上监听GDB协议信息，并且暂停一切的活动（如调度，以及对外部中断的一切响应）。用户此时需要将GDB与其挂载，并使用GDB的工作流来指示内核下一步的动作。
 303
 304 在目前，为了防止代码过于臃肿，LunaixOS实现的是GDB远程协议要求的最小服务端命令子集：`g`, `G`, `p`, `P`, `Q`, `S`, `k`, `?`, `m`, `M`, `X`。足以满足大部分的调试需求。
 305
 306 当结束调试的时候，请使用GDB的`kill`指令进行连接的断开。注意，这个指令会使得LunaixOS恢复所有暂停的活动，进入正常的运行序列，但并不会退出调试模式。GDB的挂载请求依然在LunaixOS中享有最高优先权。如果需要退出调试模式，需要往串口写入字节串：`0x40` `0x79` `0x61` `0x79`。