Merge branch 'master' into iso-9660

[lunaix-os.git] / README.md

diff --git a/README.md b/README.md
index 35db0861698924676755b8b6bfdcee12ee1bb9ed..cdeecbe60280b3467a1cff844d9ca3e0d2e05640 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,13 +22,21 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 + 内存管理与按需分页（Demand Paging）
 + 键盘输入
 + 多进程
 + 内存管理与按需分页（Demand Paging）
 + 键盘输入
 + 多进程

-+ 44个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
++ 47个常见的Linux/POSIX系统调用（[附录1](#appendix1)）

 + 用户模式
 + 信号机制
 + PCI 3.0
 + PCIe 1.1 (WIP)
 + Serial ATA AHCI
 + 文件系统 (WIP)
 + 用户模式
 + 信号机制
 + PCI 3.0
 + PCIe 1.1 (WIP)
 + Serial ATA AHCI
 + 文件系统 (WIP)

++ 远程GDB串口调试 (COM1@9600Bd)
+
+已经测试过的环境：
+
++ QEMU (>=7.0.0)
++ Bochs（SATA功能不支持）
++ Virtualbox
++ Dell G3 3779

 
 ## 目录结构
 
 
 ## 目录结构
 


@@ -55,7 +63,8 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 本项目支持的make命令：
 | 命令 | 用途 |
 |---|---|
 本项目支持的make命令：
 | 命令 | 用途 |
 |---|---|

-| `make all` | 构建镜像（`-O2`） |
+| `make all` | 构建镜像（`-O2`，但禁用CSE相关的优化项 **※** ） |
+| `make instable` | 构建镜像（`-O2`，开启CSE相关优化） |

 | `make all-debug` | 构建适合调试用的镜像（`-Og`） |
 | `make run` | 使用QEMU运行build目录下的镜像|
 | `make debug-qemu` | 构建并使用QEMU进行调试 |
 | `make all-debug` | 构建适合调试用的镜像（`-Og`） |
 | `make run` | 使用QEMU运行build目录下的镜像|
 | `make debug-qemu` | 构建并使用QEMU进行调试 |


@@ -63,6 +72,8 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 | `make debug-qemu-vscode` | 用于vscode整合 |
 | `make clean` | 删除build目录 |
 
 | `make debug-qemu-vscode` | 用于vscode整合 |
 | `make clean` | 删除build目录 |
 

+**※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
+

 ## 运行以及Issue
 
 运行该操作系统需要一个虚拟磁盘镜像，可以使用如下命令快速创建一个：
 ## 运行以及Issue
 
 运行该操作系统需要一个虚拟磁盘镜像，可以使用如下命令快速创建一个：


@@ -82,7 +93,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 
 有很多办法去创建一个虚拟磁盘，比如[qemu-img](https://qemu-project.gitlab.io/qemu/system/images.html)。
 
 
 有很多办法去创建一个虚拟磁盘，比如[qemu-img](https://qemu-project.gitlab.io/qemu/system/images.html)。
 

-在大多数情况下，我都会尽量保证本机运行无误后，push到仓库中。同时，该系统是经过本机测试，能够在Bochs，QEMU (`= 7.0`)，VirtualBox下正常的运行（暂时没试过真机）。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)
+在大多数情况下，我都会尽量保证本机运行无误后，push到仓库中。同时，该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)

 
 下面列出一些可能会出现的问题。
 
 
 下面列出一些可能会出现的问题。
 


@@ -94,7 +105,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 
 这很大概率是出现了竞态条件。虽然是相当不可能的。但如果出现了，还是请提issue。
 
 
 这很大概率是出现了竞态条件。虽然是相当不可能的。但如果出现了，还是请提issue。
 

-#### 问题#3：Bochs运行时，提示找不到AHCI控制器
+#### 问题#3：Bochs无法运行，提示找不到AHCI控制器

 
 正常，**因为Bochs不支持SATA**。请使用QEMU或VirtualBox。
 
 
 正常，**因为Bochs不支持SATA**。请使用QEMU或VirtualBox。
 


@@ -189,6 +200,9 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 2. `setxattr(2)`※
 2. `fgetxattr(2)`※
 2. `fsetxattr(2)`※
 2. `setxattr(2)`※
 2. `fgetxattr(2)`※
 2. `fsetxattr(2)`※

+2. `ioctl(2)`※
+2. `getpgid(2)`
+2. `setpgid(2)`

 
 **LunaixOS自有**
 
 
 **LunaixOS自有**
 


@@ -275,4 +289,20 @@ make all-gcc &&\
 + 错误消息（如果给出）
 + 寄存器状态的dump
 + （如可能）提供错误发生时，EIP附近的指令（精确到函数）。如果使用`make all-debug`，会提供`build/kdump.txt`，你可以在这里面定位。或者也可以直接`objdump`
 + 错误消息（如果给出）
 + 寄存器状态的dump
 + （如可能）提供错误发生时，EIP附近的指令（精确到函数）。如果使用`make all-debug`，会提供`build/kdump.txt`，你可以在这里面定位。或者也可以直接`objdump`

-+ （如可能）虚拟内存映射信息（QEMU下可使用`info mem`查看）。
\ No newline at end of file
++ （如可能）虚拟内存映射信息（QEMU下可使用`info mem`查看）。
+
+## 附录4：串口GDB远程调试
+
+LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM1在9600波特率上与之建立链接。但是，在将GDB与内核链接起来之前，还需要让内核处在调试模式下。
+
+要进入调试模式，需要往串口（波特率如上）写入字节串 `0x40` `0x63` `0x6D` `0x63`。此时，如果屏幕底部出现一条品红色背景的`DEBUG` 字样，那么就说明LunaixOS已处在调试模式下。
+
+注意，在这个时候，LunaixOS会开始在`COM1`上监听GDB协议信息，并且暂停一切的活动（如调度，以及对外部中断的一切响应）。用户此时需要将GDB与其挂载，并使用GDB的工作流来指示内核下一步的动作。
+
+在目前，为了防止代码过于臃肿，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很有可能会出现 **不可预料的行为** 。
\ No newline at end of file