Fix: stale dnode caching instance cause locked-up upon accessing (#52)

[lunaix-os.git] / README.md
diff --git a/README.md b/README.md

index cbfa713e1657bf57fdfcfac3acb62c93f66cdc6a..2fce0e930afba9188b2fa2db0a1344ce7d921bc5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,44 +6,84 @@
    <a href="#lunaixos-project">简体中文</a> | <a href="docs/README_en.md">English</a>
  </p>
  
    <a href="#lunaixos-project">简体中文</a> | <a href="docs/README_en.md">English</a>
  </p>
  
-# LunaixOS Project
+# The LunaixOS Project
  
  
-LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有浓重个人风格的操作系统。开发过程以视频教程形式在Bilibili呈现：[《从零开始自制操作系统系列》](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337)。
+LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有浓重个人风格的操作系统，由 Lunaix 内核驱动。开发过程以视频教程形式在Bilibili呈现：[《从零开始自制操作系统系列》](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337)。
  
  
-## 当前进度以及支持的功能
+## 1. 一些实用资源
  
  
-该操作系统支持x86架构，运行在保护模式中，采用宏内核架构，目前仅支持单核心。内存结构采用经典的3:1划分，即低3GiB为用户地址空间（0x400000 ~ 0xBFFFFFFF），内核地址空间重映射至高1GiB（0xC0000000 ~ 0xFFFFFFFF）。内存的详细布局可参考[LunaixOS内存地图](docs/img/lunaix-os-mem.png)
+如果有意研读 Lunaix 内核代码和其中的设计，或欲开始属于自己的OS开发之道，以下资料可能会对此有用。
  
  
-在下述列表中，则列出目前所支持的所用功能和特性。列表项按照项目时间戳进行升序排列。
++ [内核文档（Luna's Tour）](docs/lunaix-internal.md)
++ [LunaixOS源代码分析教程](docs/tutorial/0-教程介绍和环境搭建.md)
++ [作者修改的QEMU](https://github.com/Minep/qemu) (添加了一些额外用于调试的功能)
+
+## 2. 当前进度以及支持的功能
+
+Lunaix内核具有支持多种不同的指令集架构的能力，目前支持如下：
+
++ x86_32
++ x86_64
+
+Lunaix全部特性一览：
  
  + 使用Multiboot进行引导启动
  
  + 使用Multiboot进行引导启动
+  + Multiboot 1
+  + Multiboot 2 (WIP)
  + APIC/IOAPIC作为中断管理器和计时器
  + ACPI
  + 虚拟内存
  + APIC/IOAPIC作为中断管理器和计时器
  + ACPI
  + 虚拟内存
-+ 内存管理与按需分页（Demand Paging）
-+ 键盘输入
-+ 多进程
-+ 47个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
-+ 用户模式
+  + 架构中性设计
+  + 按需分页
+  + Copy-on-Write
++ 内存管理
++ 进程模型
++ 61个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
++ 用户/内核态隔离
  + 信号机制
  + PCI 3.0
  + PCIe 1.1 (WIP)
  + 信号机制
  + PCI 3.0
  + PCIe 1.1 (WIP)
-+ Serial ATA AHCI
-+ 文件系统
++ 块设备IO与驱动
+  + 块IO通用缓存池
+  + Serial ATA AHCI
+    + ATA设备
+    + ATAPI封装的SCSI协议
++ 文件系统（POSIX.1-2008, section 5 & 10）
    + 虚拟文件系统
    + 虚拟文件系统
+  + 内核态文件系统（twifs, Lunaix自己的sysfs）
+  + 设备文件系统（devfs, Lunaix自己的udev）
+  + 进程文件系统（procfs）
    + ISO9660
    + ISO9660
-    + 原生
-    + Rock Ridge拓展 (WIP)
+    + ECMA-119
+    + IEEE P1282（Rock Ridge拓展）
+  + ext2
+    + Revision 0
+    + Revision 1 （额外特性不支持）
  + 远程GDB串口调试 (COM1@9600Bd)
  + 远程GDB串口调试 (COM1@9600Bd)
-
-已经测试过的环境：
-
-+ QEMU (>=7.0.0)
-+ Bochs（SATA功能不支持）
-+ Virtualbox
-+ Dell G3 3779
-
-## 目录结构
++ 用户程序加载与执行
++ 通用设备抽象层
+  + 架构中性的设备支持位于：`lunaix-os/hal`
+    + 16550 UART
+    + ACPI （不完全实现）
+  + 架构耦合的设备支持位于：`lunaix-os/arch/<ARCH>/hal`
+    + x86
+      + APIC/IOAPIC 组合
+      + MC146818 RTC
+      + i8042 PS/2
+      + RNG（使用`rdrand`）
+  + [Devicetree](https://www.devicetree.org/)
++ 通用图形设备抽象层 (Draft)
+  + 参考：`lunaix-os/hal/gfxa`
++ 虚拟终端设备接口（POSIX.1-2008, section 11）
+  + 参考：`lunaix-os/hal/term`
++ 线程模型
+  + 用户线程支持（pthread系列）
+  + 内核线程支持
++ 抢占式内核设计
+  + 内核态上下文切换
+  + 内核态异常挂起/死锁自动检测机制
+
+## 3. 目录结构
  
  |                                           |                              |
  | ----------------------------------------- | ---------------------------- |
  
  |                                           |                              |
  | ----------------------------------------- | ---------------------------- |
@@ -51,81 +91,148 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
  | [slides](slides/)                         | 视频中所用的幻灯片和补充材料 |
  | [reference-material](reference-material/) | 标准，技术文档和参考文献     |
  
  | [slides](slides/)                         | 视频中所用的幻灯片和补充材料 |
  | [reference-material](reference-material/) | 标准，技术文档和参考文献     |
  
-## 编译与构建
+## 4. 编译与构建
  
  
-### 环境搭建
+**！如果想要立刻构建并运行，请参考4.7！**
  
  构建该项目需要满足以下条件：
  
  
  构建该项目需要满足以下条件：
  
-+ gcc (目标平台: i686-elf)
-+ binutils
++ gcc 工具链
  + make
  + xorriso
  + grub-mkrescue
  
  + make
  + xorriso
  + grub-mkrescue
  
-**注意：gcc不能是本机自带的，必须要从源码编译，并配置目标平台为：`i686-elf`，以进行交叉编译。配置过程可参考[附录二：编译gcc作为交叉编译器](#appendix2)。**
+### 4.1 使用 GNU CC 工具链
  
  
-### Docker镜像
+正如同大多数内核一样，Lunaix 是一个混合了 C 和汇编的产物。这就意味着你得要使用一些标准的C编译器来构建Lunaix。在这里，我推荐使用 GNU CC 工具链来进行构建。因为Lunaix 在编写时使用了大量的GNU CC 相关编译器属性修饰 (`__attribute__`) 。假若使用其他工具链，如LLVM，我对此就不能做出任何保证了。
  
  
-å¯¹äº\8eå¼\80å\8f\91ç\8e¯å¢\83ï¼\8cæ\9c¬é¡¹ç\9b®ä¹\9fæ\8f\90ä¾\9bäº\86Dockeré\95\9cå\83\8få°\81è£\85ã\80\82å¼\80ç®±å\8d³ç\94¨ï¼\8cæ\97 é\9c\80é\85\8dç½®ï¼\8cé\9d\9eå¸¸é\80\82å\90\88æ\87\92äººæ\88\96æ\83\9cæ\97¶è\80\85ã\80\82è¯¦ç»\86ä½¿ç\94¨æ\96¹æ³\95è¯·è½¬å\88°ï¼\9a[Lunaix OSDKé¡¹ç\9b®](https://github.com/Minep/os-devkit)ã\80\82
+å¦\82æ\9e\9cä½ ä½¿ç\94¨ç\9a\84æ\98¯å\9fºäº\8e x86 æ\8c\87ä»¤é\9b\86ç\9a\84Linuxç³»ç»\9fï¼\8cä¸\8dè®ºæ\98¯64ä½\8dè¿\98æ\98¯32ä½\8dï¼\8c**å\85¶æ\9c¬æ\9cºè\87ªå¸¦ç\9a\84gccå°±è¶³ä»¥ç¼\96è¯\91Lunaix**ã\80\82 å½\93ç\84¶äº\86ï¼\8cå¦\82æ\9e\9cè¯´ä½ ç\9a\84å¹³å\8f°æ\98¯å\85¶ä»\96é\9d\9ex86ç\9a\84ï¼\8cä½ ä¹\9få\8f¯ä»¥æ\8c\87å®\9aä½¿ç\94¨æ\9f\90ä¸ªé\92\88å¯¹x86_32ç\9a\84gccå¥\97ä»¶æ\9d¥è¿\9bè¡\8cäº¤å\8f\89ç¼\96è¯\91â\80\94â\80\94å\9c¨`make`æ\97¶é\80\9aè¿\87`CX_PREFIX`å\8f\98é\87\8fæ\9d¥æ\8c\87å®\9agccå¥\97ä»¶ç\9a\84å\89\8dç¼\80ã\80\82å¦\82ä¸\8bä¾\8bæ\89\80ç¤ºï¼\8cæ\88\91ä»¬å\8f¯ä»¥å\9c¨ä»»æ\84\8få¹³å\8f°ä¸\8aï¼\8cå¦\82risc-vï¼\8cå\8d\95ç\8b¬ä½¿ç\94¨ä¸\80ä¸ªé\9d¢å\90\91x86_32ç\9a\84gccæ\9d¥è¿\9bè¡\8cäº¤å\8f\89ç¼\96è¯\91ï¼\9a
  
  
-### 构建选项
+```
+make CX_PREFIX=i686-linux-gnu- all
+```
  
  
-假若条件满足，那么可以直接执行`make all`进行构建，完成后可在生成的`build`目录下找到可引导的iso。
+### 4.2 Docker镜像
+
+对于开发环境，本项目也提供了Docker镜像封装。开箱即用，无需配置，非常适合懒人或惜时者。详细使用方法请转到：[Lunaix OSDK项目](https://github.com/Minep/os-devkit)。
+
+### 4.3 构建选项
  
  本项目支持的make命令：
  | 命令                     | 用途                                            |
  | ------------------------ | ----------------------------------------------- |
  
  本项目支持的make命令：
  | 命令                     | 用途                                            |
  | ------------------------ | ----------------------------------------------- |
-| `make all`               | 构建镜像（`-O2`，但禁用CSE相关的优化项 **※** ） |
-| `make instable`          | 构建镜像（`-O2`，开启CSE相关优化）              |
-| `make all-debug`         | 构建适合调试用的镜像（`-Og`）                   |
-| `make run`               | 使用QEMU运行build目录下的镜像                   |
-| `make debug-qemu`        | 构建并使用QEMU进行调试                          |
-| `make debug-bochs`       | 构建并使用Bochs进行调试                         |
-| `make debug-qemu-vscode` | 用于vscode整合                                  |
-| `make clean`             | 删除build目录                                   |
+| `make all`               | 构建内核ELF镜像 |
+| `make rootfs`            | 构建根文件系统镜像，将会封装`usr/`下的程序        |
+| `make clean`             | 删除构建缓存，用于重新构建               |
+| `make config`            | 配置Lunaix                                   |
+
+与make命令配套的环境变量，Lunaix的makefile会自动检测这些环境变量，以更改构建行为
+
++ `MODE={debug|release}` 使用debug模式构建（-Og）或者release模式（-O2）
++ `ARCH=<isa>` 为指定的指令集架构编译Lunaix。 所使用的配置选项均为选定架构默认，该环境变量
+  存在的目的就是方便用户进行快速编译，而无需钻研Lunaix的种种配置项。
  
  
-**※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
+### 4.4 Lunaix的功能配置
  
  
-## 运行以及Issue
+Lunaix是一个可配置的内核，允许用户在编译前选择应当包含或移除的功能。
  
  
-运行该操作系统需要一个虚拟磁盘镜像，可以使用如下命令快速创建一个：
+使用`make config`来进行基于命令行的交互配置。采用TUI呈现，效果类似于menuconfig.
  
  
-```bash
-qemu-img create -f vdi machine/disk0.vdi 128M
+如果因为某种原因，TUI界面无法呈现，那么将会默认使用shell形式的呈现：
+
+所有的配置项按照类似于文件树的形式组织，如单个配置项为一个“文件”，多个配置项组成的配置组为一个目录，呈现形式为方括号`[]`包裹起来的项目。在提示符中输入`usage`并回车可以查看具体的使用方法。
+
+一个最常用的配置可能就是`architecture_support/arch`了，也就是配置Lunaix所面向的指令集。比如，编译一个在x86_64平台上运行的Lunaix，在提示符中输入（**注意等号两侧的空格，这是不能省略的**）：
+
+```
+/architecture_support/arch = x86_64
  ```
  
  ```
  
-如果你想要使用别的磁盘镜像，需要修改`configs/make-debug-tool`
+之后输入`exit`保存并退出。而后正常编译。
  
  
-找到这一行：
+### 4.5 设置内核参数
+
+在 make 的时候通过`CMDLINE`变量可以设置内核启动参数列表。该列表可以包含多个参数，通过一个或多个空格来分割。每个参数可以为键值对 `<key>=<val>` 或者是开关标志位 `<flag>`。目前 Lunaix 支持以下参数：
+
++ `console=<dev>` 设置系统终端的输入输出设备（tty设备）。其中 `<dev>` 是设备文件路径 （注意，这里的设备文件路径是针对Lunaix，而非Linux）。关于LunaixOS设备文件系统的介绍可参考 Lunaix Wiki（WIP）
++ （参考 4.6）
+
+如果`CMDLINE`未指定，则将会载入默认参数：
  
  ```
  
  ```
--drive id=disk,file="machine/disk0.vdi",if=none \
+console=/dev/ttyFB0
  ```
  
  ```
  
-然后把`machine/disk0.vdi`替换成你的磁盘路径。
+其中，`/dev/ttyFB0` 指向基于VGA文本模式的tty设备，也就是平时启动QEMU时看到的黑色窗口。
+
+当然，读者也可以使用 `/dev/ttyS0` 来作为默认tty设备，来验证 Lunaix 的灵活性与兼容性。该路径指向第一个串口设备。可以通过telnet协议在`12345`端口上进行访问——端口号可以自行修改QEMU启动参数（位于：`makeinc/qemu.mkinc`）来变更。
+
+**注意：** 根据操作系统和键盘布局的不同，telnet客户端对一些关键键位的映射（如退格，回车）可能有所差别（如某些版本的Linux会将退格键映射为`0x7f`，也就是ASCII的`<DEL>`字符，而非我们熟知`0x08`）。如果读者想要通过串口方式把玩Lunaix，请修改`usr/init/init.c`里面的终端初始化代码，将`VERASE`设置为正确的映射（修改方式可以参考 POSIX termios 的使用方式。由于Lunaix的终端接口的实现是完全兼容POSIX的，读者可以直接去查阅Linux自带的帮助`man termios`，无需作任何的转换）
+
+
+### 4.6 Lunaix的启动
+
+由于 Lunaix 的定位是内核。为了避免太多的编译时的前置要求，同时为了提高灵活性，我们移除了iso文件的封装功能。目前的 Lunaix 将只会编译出一个 ELF 格式的二进制文件。用户可以根据自己的喜好，使用的不同的方式，不同的 bootloader 来引导 Lunaix. 
+
+为了能够使得 Lunaix 能够正确的启动，用户必须设置以下内核参数：
  
  
-有很多办法去创建一个虚拟磁盘，比如[qemu-img](https://qemu-project.gitlab.io/qemu/system/images.html)。
++ `rootfs=` 指明根目录设备，值为设备文件路径，指向包含根文件系统的磁盘设备，如`/dev/block/sda`。 Lunaix将会在启动之后自动挂在该文件系统到根目录。缺少此选项 Lunaix 将会拒绝启动，并进入 kernel panic （在 Lunaix 的世界里，这个被称之为 Nightmare Moon arrival ）
++ `init=` 指明 init 程序的位置，该程序必须放在 `rootfs` 中。改选项为可选设置，其默认值为 `/init`。  init 程序是 Lunaix 在启动后所运行的第一个程序。
  
  
-在大多数情况下，我都会尽量保证本机运行无误后，push到仓库中。同时，该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)
+### 4.7 测试与体验 Lunaix
  
  
-下面列出一些可能会出现的问题。
  
  
-#### 问题#1： QEMU下8042控制器提示找不到
+想要快速体验，请跟随以下步骤：
  
  
-这是QEMU配置ACPI时的一个bug，在7.0.0版中修复了。
+1. 决定一个你想要体验的架构，如 `x86_64`。 （支持：`x86_64`, `i386`）为了叙述方便，这个架构在下文被指代为`<arch>`
+2. 检查你是否安装了： `qemu-system-<arch>`，`gdb`，`python3`，`telnet`，`gcc`
+3. 运行 `make ARCH=<arch> user` 来编译自带的用户程序
+4. 运行 `make ARCH=<arch> rootfs` 来打包根文件系统镜像。（需要本机系统支持 `dd`，`mkfs.ext2`, `mount -o loop`, `mktemp`）
+5. 运行 `ARCH=<arch> live_debug.sh` 来启动
  
  
-#### 问题#2：多进程运行时，偶尔会出现General Protection错误
+该脚本自动按照默认的选项构建Lunaix，而后调用 `scripts/qemu.py` 根据配置文件生成QEMU启动参数（配置文件位于`scripts/qemus/`）
  
  
-这很大概率是出现了竞态条件。虽然是相当不可能的。但如果出现了，还是请提issue。
+由于该脚本的主要用途是方便作者进行调试，所以在QEMU窗口打开后还需要进行以下动作：
  
  
-#### 问题#3：Bochs无法运行，提示找不到AHCI控制器
+1. 使用telnet连接到`localhost:12345`，这里是Lunaix进行标准输入输出所使用的UART映射（QEMU为guest提供UART实现，并将其利用telnet协议重定向到宿主机）
+2. 在GDB窗口中输入`c`然后回车，此时Lunaix开始运行。这样做的目的是允许在QEMU进行模拟前，事先打好感兴趣的断点。
  
  
-正常，**因为Bochs不支持SATA**。请使用QEMU或VirtualBox。
+## 5. 运行，分支以及 Issue
+
+### 5.1 代码稳定性
+
+主分支一般是稳定的。因为在大多数情况下，我都会尽量保证本机运行无误后，push到该分支中。所有正在开发的功能请参考当前活跃的Pull Request。
+
+如果主分支的运行出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)
+
+## 6. 调试 Lunaix 内核
+
+除了[附录4：串口GDB远程调试](#appendix4)描述的一种用于实机调试的方式以外。LunaixOS还提供了LunaDBG调试套件。这是一个GDB客户端插件，包含了对GDB原生命令集的一些扩充，主要用于改善与简化内核调试的过程。目前包含以下几个命令：
+
++ `vmrs [pid]` 列举进程`<pid>`的内存区域图（Memory Regions），如果`<pid>`未指定，则默认为正在运行的进程（smp=1）。
++ `proc [pid]` 打印进程`<pid>`的进程控制块状态，如果`<pid>`未指定，则默认为正在运行的进程（smp=1）。
++ `sched <threads | procs> [-l]` 查看调度器信息，接受两个参数：
+  + `threads` 打印所有依然在调度器中有注册的线程
+  + `procs` 打印所有依然在调度器中有注册的进程
+  + 可选开关 `-l` 决定是否以长列表打印（更详细的信息）
+
+该插件可以通过运行以下命令来进行安装：
+
+```shell
+./scripts/gdb/install_lunadbg
+```
  
  
-## 参考教程
+## 7. 参考教程
  
  
-**没有！！** 本教程以及该操作系统均为原创，没有基于任何市面上现行的操作系统开发教程，且并非是基于任何的开源内核的二次开发。
+#### 没有！！
+
+本教程以及该操作系统的所有的架构设计与实现**均为原创**。
+
+对此，作者可以保证，该项目是做到了三个 “没有”：
+
++ **没有** 参考任何现行的，关于操作系统开发的，教程或书籍。
++ **没有** 参考任何开源内核的源代码（包括Linux）
++ **没有** 基于任何开源内核的二次开发行为。
  
  为了制作LunaixOS，作者耗费大量时间和精力钻研技术文档，手册，理论书籍以及现行工业标准，从而尽量保证了知识的一手性。（这样一来，读者和听众们也算是拿到了二手的知识，而不是三手，四手，甚至n手的知识）。
  
  
  为了制作LunaixOS，作者耗费大量时间和精力钻研技术文档，手册，理论书籍以及现行工业标准，从而尽量保证了知识的一手性。（这样一来，读者和听众们也算是拿到了二手的知识，而不是三手，四手，甚至n手的知识）。
  
@@ -152,6 +259,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M
  + [ECMA-119 (ISO9660)](https://www.ecma-international.org/publications-and-standards/standards/ecma-119/)
  + Rock Ridge Interchange Protocol (RRIP: IEEE P1282)
  + System Use Sharing Protocol (SUSP: IEEE P1281)
  + [ECMA-119 (ISO9660)](https://www.ecma-international.org/publications-and-standards/standards/ecma-119/)
  + Rock Ridge Interchange Protocol (RRIP: IEEE P1282)
  + System Use Sharing Protocol (SUSP: IEEE P1281)
++ Tool Interface Standard (TIS) Portable Formats Specification (Version 1.1)
  
  **免责声明：PCI相关的标准最终解释权归PCI-SIG所有。此处提供的副本仅供个人学习使用。任何商用目的须向PCI-SIG购买。**
  
  
  **免责声明：PCI相关的标准最终解释权归PCI-SIG所有。此处提供的副本仅供个人学习使用。任何商用目的须向PCI-SIG购买。**
  
@@ -159,12 +267,10 @@ qemu-img create -f vdi machine/disk0.vdi 128M
  
  + *Computer System - A Programmer's Perspective Third Edition (CS:APP)* (Bryant, R & O'Hallaron, D)
  + *Modern Operating System* (Tanenbaum, A)
  
  + *Computer System - A Programmer's Perspective Third Edition (CS:APP)* (Bryant, R & O'Hallaron, D)
  + *Modern Operating System* (Tanenbaum, A)
-+ 《汇编语言》（王爽） - 用于入门Intel语法的x86汇编（对于AT&T语法，推荐阅读CS:APP）
-+ ~~《微机原理与接口技术》 - 用于大致了解x86架构的微机体系（更加细致的了解可以阅读Intel Manual）~~ （已过时，推荐阅读CS:APP）
  
  #### 网站
  
  
  #### 网站
  
-+ [OSDev](https://wiki.osdev.org/Main_Page) - 杂七杂八的参考，很多过来人的经验。作者主要用于上古资料查询以及收集；技术文献，手册，标准的粗略总结；以及开发环境/工具链的搭建。
++ [OSDev](https://wiki.osdev.org/Main_Page) - 适合快速入门，和一些文档手册的总结。
  + [FreeVGA](http://www.osdever.net/FreeVGA/home.htm) - 98年的资源！关于VGA编程技术的宝藏网站。
  + GNU CC 和 GNU LD 的官方文档。
  + [PCI Lookup](https://www.pcilookup.com/) - PCI设备编号查询
  + [FreeVGA](http://www.osdever.net/FreeVGA/home.htm) - 98年的资源！关于VGA编程技术的宝藏网站。
  + GNU CC 和 GNU LD 的官方文档。
  + [PCI Lookup](https://www.pcilookup.com/) - PCI设备编号查询
@@ -173,9 +279,9 @@ qemu-img create -f vdi machine/disk0.vdi 128M
  
  + Linux Manual - 用于查询*nix API的一些具体行为。
  
  
  + Linux Manual - 用于查询*nix API的一些具体行为。
  
-## 附录1：支持的系统调用<a id="appendix1"></a>
+## 附录1：实现的 POSIX 系统接口 <a id="appendix1"></a>
  
  
-**Unix/Linux/POSIX**
+LunaixOS 提供对以下POSIX的系统接口的实现。内核定义的系统调用号可以参考 [LunaixOS系统调用表](docs/lunaix-syscall-table.md) 。
  
  1. `sleep(3)`
  1. `wait(2)`
  
  1. `sleep(3)`
  1. `wait(2)`
@@ -190,7 +296,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M
  1. `_exit(2)`
  1. `sigreturn(2)`
  1. `sigprocmask(2)`
  1. `_exit(2)`
  1. `sigreturn(2)`
  1. `sigprocmask(2)`
-1. `signal(2)`
+1. `sigaction(2)`
  1. `kill(2)`
  1. `sigpending(2)`
  1. `sigsuspend(2)`
  1. `kill(2)`
  1. `sigpending(2)`
  1. `sigsuspend(2)`
@@ -198,19 +304,19 @@ qemu-img create -f vdi machine/disk0.vdi 128M
  2. `write(2)`
  2. `open(2)`
  2. `close(2)`
  2. `write(2)`
  2. `open(2)`
  2. `close(2)`
-2. `mkdir(2)`※
+2. `mkdir(2)`
  2. `lseek(2)`
  2. `readdir(2)`
  2. `lseek(2)`
  2. `readdir(2)`
-2. `readlink(2)`※
-2. `readlinkat(2)`※
-2. `rmdir(2)`※
-2. `unlink(2)`※
-2. `unlinkat(2)`※
+2. `readlink(2)`
+2. `readlinkat(2)`
+2. `rmdir(2)`
+2. `unlink(2)`
+2. `unlinkat(2)`
  2. `link(2)`※
  2. `link(2)`※
-2. `fsync(2)`※
+2. `fsync(2)`
  2. `dup(2)`
  2. `dup2(2)`
  2. `dup(2)`
  2. `dup2(2)`
-2. `symlink(2)`※
+2. `symlink(2)`
  2. `chdir(2)`
  2. `fchdir(2)`
  2. `getcwd(2)`
  2. `chdir(2)`
  2. `fchdir(2)`
  2. `getcwd(2)`
@@ -224,106 +330,35 @@ qemu-img create -f vdi machine/disk0.vdi 128M
  2. `ioctl(2)`
  2. `getpgid(2)`
  2. `setpgid(2)`
  2. `ioctl(2)`
  2. `getpgid(2)`
  2. `setpgid(2)`
+2. `mmap(2)`
+2. `munmap(2)`
+2. `execve(2)`
+3. `poll(2)` (via `pollctl`)
+3. `epoll_create(2)` (via `pollctl`)
+3. `epoll_ctl(2)` (via `pollctl`)
+3. `epoll_wait(2)` (via `pollctl`)
+4. `pthread_create`
+4. `pthread_self`
+4. `pthread_exit`
+4. `pthread_join`
+4. `pthread_kill`
+4. `pthread_detach`
+4. `pthread_sigmask`
  
  
-**LunaixOS自有**
-
-1. `yield`
-2. `geterrno`
-3. `realpathat`
-4. `syslog`
  
  ( **※**：该系统调用暂未经过测试 )
  
  
  ( **※**：该系统调用暂未经过测试 )
  
-## 附录2：编译gcc作为交叉编译器<a id="appendix2"></a>
-
-注意，gcc需要从源码构建，并配置为交叉编译器，即目标平台为`i686-elf`。你可以使用本项目提供的[自动化脚本](slides/c0-workspace/gcc-build.sh)，这将会涵盖gcc和binutils源码的下载，配置和编译（没什么时间去打磨脚本，目前只知道在笔者的Ubuntu系统上可以运行）。
-
-**推荐**手动编译。以下编译步骤搬运自：<https://wiki.osdev.org/GCC_Cross-Compiler>
-
-**首先安装构建依赖项：**
-
-```bash
-sudo apt update &&\
-     apt install -y \
-        build-essential \
-        bison\
-        flex\
-        libgmp3-dev\
-        libmpc-dev\
-        libmpfr-dev\
-        texinfo
-```
-
-**开始编译：**
-
-1. 获取[gcc](https://ftp.gnu.org/gnu/gcc/)和[binutils](https://ftp.gnu.org/gnu/binutils)源码
-2. 解压，并在同级目录为gcc和binutil新建专门的build文件夹
-
-现在假设你的目录结构如下：
-
-```
-+ folder
-  + gcc-src
-  + binutils-src
-  + gcc-build
-  + binutils-build
-```
-
-3. 确定gcc和binutil安装的位置，并设置环境变量：`export PREFIX=<安装路径>` 然后设置PATH： `export PATH="$PREFIX/bin:$PATH"`
-4. 设置目标平台：`export TARGET=i686-elf`
-5. 进入`binutils-build`进行配置
-
-```bash
-../binutils-src/configure --target="$TARGET" --prefix="$PREFIX" \
- --with-sysroot --disable-nls --disable-werror
-```
-
-然后 `make && make install`
-
-6. 确保上述的`binutils`已经正常安装：执行：`which i686-elf-as`，应该会给出一个位于你安装目录下的路径。
-6. 进入`gcc-build`进行配置
-
-```bash
-../gcc-src/configure --target="$TARGET" --prefix="$PREFIX" \
- --disable-nls --enable-languages=c,c++ --without-headers
-```
-
-然后编译安装（取决性能，大约10~20分钟）：
-
-```bash
-make all-gcc &&\
- make all-target-libgcc &&\
- make install-gcc &&\
- make install-target-libgcc
-```
-
-8. 验证安装：执行`i686-elf-gcc -dumpmachine`，输出应该为：`i686-elf`
-
-**将新编译好的GCC永久添加到`PATH`环境变量**
+## 附录2：Issue的提交<a id="appendix3"></a>
  
  
-虽然这是一个常识性的操作，但考虑到许多人都会忽略这一个额外的步骤，在这里特此做出提示。
-
-要想实现这一点，只需要在shell的配置文件的末尾添加：`export PATH="<上述的安装路径>/bin:$PATH"`。
-
-这个配置文件是取决于你使用的shell，如zsh就是`${HOME}/.zshrc`，bash则是`${HOME}/.bashrc`；或者你嫌麻烦的，懒得区分，你也可以直接修改全局的`/etc/profile`文件，一劳永逸（但不推荐这样做）。
-
-至于其他的情况，由于这个步骤其实在网上是随处可查的，所以就不在这里赘述了。
-
-## 附录3：Issue的提交<a id="appendix3"></a>
-
-由于目前LunaixOS没有一个完善强大的内核追踪功能。假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。
-
-最好提供：
+假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。
  
  + 可用于复现问题的描述和指引（如Lunaix运行平台的软硬件配置）
  + 错误症状描述
  
  + 可用于复现问题的描述和指引（如Lunaix运行平台的软硬件配置）
  + 错误症状描述
-+ （如可能）运行截图
-+ 错误消息（如果给出）
-+ 寄存器状态的dump
-+ （如可能）提供错误发生时，EIP附近的指令（精确到函数）。如果使用`make all-debug`，会提供`build/kdump.txt`，你可以在这里面定位。或者也可以直接`objdump`
-+ （如可能）虚拟内存映射信息（QEMU下可使用`info mem`查看）。
++ LunaixOS在panic时打印的调试信息（如无法复制，可以截图）
+
+## 附录3：串口GDB远程调试<a id="appendix4"></a>
  
  
-## 附录4：串口GDB远程调试
+**（该功能正在重构，目前不可用）**
  
  LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM1在9600波特率上与之建立链接。但是，在将GDB与内核链接起来之前，还需要让内核处在调试模式下。
  
  
  LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM1在9600波特率上与之建立链接。但是，在将GDB与内核链接起来之前，还需要让内核处在调试模式下。
  
@@ -334,7 +369,3 @@ LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM
  在目前，为了防止代码过于臃肿，LunaixOS实现的是GDB远程协议要求的最小服务端命令子集：`g`, `G`, `p`, `P`, `Q`, `S`, `k`, `?`, `m`, `M`, `X`。足以满足大部分的调试需求。
  
  当结束调试的时候，请使用GDB的`kill`指令进行连接的断开。注意，这个指令会使得LunaixOS恢复所有暂停的活动，进入正常的运行序列，但并不会退出调试模式。GDB的挂载请求依然在LunaixOS中享有最高优先权。如果需要退出调试模式，需要往串口写入字节串：`0x40` `0x79` `0x61` `0x79`。
  在目前，为了防止代码过于臃肿，LunaixOS实现的是GDB远程协议要求的最小服务端命令子集：`g`, `G`, `p`, `P`, `Q`, `S`, `k`, `?`, `m`, `M`, `X`。足以满足大部分的调试需求。
  
  当结束调试的时候，请使用GDB的`kill`指令进行连接的断开。注意，这个指令会使得LunaixOS恢复所有暂停的活动，进入正常的运行序列，但并不会退出调试模式。GDB的挂载请求依然在LunaixOS中享有最高优先权。如果需要退出调试模式，需要往串口写入字节串：`0x40` `0x79` `0x61` `0x79`。
-
-### GDB调试注意事项
-
-在调试中，请避免使用`info stack`，`bt`或者任何涉及 **栈展开（Stack Unwinding）** 或者 **栈回溯（Stack Backtracing）** 的指令。否则，LunaixOS很有可能会出现 **不可预料的行为** 。