feat: IO polling for file descriptor
[lunaix-os.git] / README.md
index b8111ec62efaaafcb6479f0773c93335af58ffad..2be89a9ce2df8d75b37a59e76d1c8372b95cd119 100644 (file)
--- a/README.md
+++ b/README.md
 
 LunaixOS - 一个简单的,详细的,POSIX兼容的(但愿!),带有浓重个人风格的操作系统。开发过程以视频教程形式在Bilibili呈现:[《从零开始自制操作系统系列》](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337)。
 
+## 一些实用资源
+
+如果有意研读LunaixOS的内核代码和其中的设计,以下资料可能会对此有用。
+
++ [内核虚拟内存的详细布局](docs/img/lunaix-os-mem.png)
++ [LunaixOS启动流程概览](docs/img/boot_sequence.jpeg)
++ LunaixOS总体架构概览(WIP)
+
 ## 当前进度以及支持的功能
 
-该操作系统支持x86架构,运行在保护模式中,采用宏内核架构,目前仅支持单核心。内存结构采用经典的3:1划分,即低3GiB为用户地址空间(0x400000 ~ 0xBFFFFFFF),内核地址空间重映射至高1GiB(0xC0000000 ~ 0xFFFFFFFF)。内存的详细布局可参考[LunaixOS内存地图](docs/img/lunaix-os-mem.png)
+该操作系统支持x86架构,运行在保护模式中,采用宏内核架构,目前仅支持单核心。架构与内核的解耦合工作正在进行中。
 
 在下述列表中,则列出目前所支持的所用功能和特性。列表项按照项目时间戳进行升序排列。
 
@@ -23,7 +31,7 @@ LunaixOS - 一个简单的,详细的,POSIX兼容的(但愿!),带有
 + 内存管理与按需分页(Demand Paging)
 + 键盘输入
 + 多进程
-+ 50个常见的Linux/POSIX系统调用([附录1](#appendix1))
++ 54个常见的Linux/POSIX系统调用([附录1](#appendix1))
 + 用户模式
 + 信号机制
 + PCI 3.0
@@ -33,8 +41,13 @@ LunaixOS - 一个简单的,详细的,POSIX兼容的(但愿!),带有
   + 虚拟文件系统
   + ISO9660
     + 原生
-    + Rock Ridge拓展 (WIP)
+    + Rock Ridge拓展
 + 远程GDB串口调试 (COM1@9600Bd)
++ 用户程序加载与执行
++ 动态链接 (WIP)
++ 通用设备抽象层
++ 通用图形设备抽象层
+  + 标准VGA实现
 
 已经测试过的环境:
 
@@ -87,7 +100,7 @@ LunaixOS - 一个简单的,详细的,POSIX兼容的(但愿!),带有
 
 **※:由于在`-O2`模式下,GCC会进行CSE优化,这导致LunaixOS会出现一些非常奇怪、离谱的bug,从而影响到基本运行。具体原因有待调查。**
 
-## 运行以及Issue
+## 运行,分支以及 Issue
 
 运行该操作系统需要一个虚拟磁盘镜像,可以使用如下命令快速创建一个:
 
@@ -107,7 +120,9 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 
 有很多办法去创建一个虚拟磁盘,比如[qemu-img](https://qemu-project.gitlab.io/qemu/system/images.html)。
 
-在大多数情况下,我都会尽量保证本机运行无误后,push到仓库中。同时,该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后,虚拟机中运行报错,则一般是编译器优化问题。这个问题笔者一般很快就会修复,如果你使用别的版本的gcc(笔者版本11.2),出现了此问题,欢迎提issue。请参考[附录3:Issue的提交](#appendix3)
+主分支一般是稳定的。因为在大多数情况下,我都会尽量保证本机运行无误后,push到该分支中。至于其他的分支,则是作为标记或者是开发中的功能。前者标记用分支一般会很快删掉;后者开发分支不能保证稳定性,这些分支的代码有可能没有经过测试,但可以作为Lunaix当前开发进度的参考。
+
+该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后,虚拟机中运行报错,则一般是编译器优化问题。这个问题笔者一般很快就会修复,如果你使用别的版本的gcc(笔者版本11.2),出现了此问题,欢迎提issue。请参考[附录3:Issue的提交](#appendix3)
 
 下面列出一些可能会出现的问题。
 
@@ -123,6 +138,20 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 
 正常,**因为Bochs不支持SATA**。请使用QEMU或VirtualBox。
 
+## 调试 Lunaix 内核
+
+除了[附录4:串口GDB远程调试](#appendix4)描述的一种用于实机调试的方式以外。LunaixOS还提供了LunaDBG调试套件。这是一个GDB客户端插件,包含了对GDB原生命令集的一些扩充,主要用于改善与简化内核调试的过程。目前包含以下几个命令:
+
++ `vmrs [pid]` 列举进程`<pid>`的内存区域图(Memory Regions),如果`<pid>`未指定,则默认为正在运行的进程(smp=1)。
++ `proc [pid]` 打印进程`<pid>`的进程控制块状态,如果`<pid>`未指定,则默认为正在运行的进程(smp=1)。
++ `proc_table` 列举所有非终止的进程以及他们的状态。
+
+该插件可以通过运行以下命令来进行安装:
+
+```shell
+./scripts/gdb/install_lunadbg
+```
+
 ## 参考教程
 
 **没有!!** 本教程以及该操作系统均为原创,没有基于任何市面上现行的操作系统开发教程,且并非是基于任何的开源内核的二次开发。
@@ -160,8 +189,6 @@ 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)
-+ 《汇编语言》(王爽) - 用于入门Intel语法的x86汇编(对于AT&T语法,推荐阅读CS:APP)
-+ ~~《微机原理与接口技术》 - 用于大致了解x86架构的微机体系(更加细致的了解可以阅读Intel Manual)~~ (已过时,推荐阅读CS:APP)
 
 #### 网站
 
@@ -191,7 +218,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 1. `_exit(2)`
 1. `sigreturn(2)`
 1. `sigprocmask(2)`
-1. `signal(2)`
+1. `sigaction(2)`
 1. `kill(2)`
 1. `sigpending(2)`
 1. `sigsuspend(2)`
@@ -202,8 +229,8 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 2. `mkdir(2)`
 2. `lseek(2)`
 2. `readdir(2)`
-2. `readlink(2)`
-2. `readlinkat(2)`
+2. `readlink(2)`
+2. `readlinkat(2)`
 2. `rmdir(2)`※
 2. `unlink(2)`※
 2. `unlinkat(2)`※
@@ -211,7 +238,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 2. `fsync(2)`※
 2. `dup(2)`
 2. `dup2(2)`
-2. `symlink(2)`
+2. `symlink(2)`
 2. `chdir(2)`
 2. `fchdir(2)`
 2. `getcwd(2)`
@@ -228,6 +255,10 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 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`)
 
 **LunaixOS自有**
 
@@ -235,6 +266,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 2. `geterrno`
 3. `realpathat`
 4. `syslog`
+5. `pollctl`
 
 ( **※**:该系统调用暂未经过测试 )
 
@@ -327,7 +359,7 @@ make all-gcc &&\
 + (如可能)提供错误发生时,EIP附近的指令(精确到函数)。如果使用`make all-debug`,会提供`build/kdump.txt`,你可以在这里面定位。或者也可以直接`objdump`
 + (如可能)虚拟内存映射信息(QEMU下可使用`info mem`查看)。
 
-## 附录4:串口GDB远程调试
+## 附录4:串口GDB远程调试<a id="appendix4"></a>
 
 LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM1在9600波特率上与之建立链接。但是,在将GDB与内核链接起来之前,还需要让内核处在调试模式下。