Unifying the Lunaix's Physical Memory Model (#28)

[lunaix-os.git] / README.md

diff --git a/README.md b/README.md
index 6e528bdf04a982a0af8c92c7bdda11d759542f1c..49ec98fd42589a2198aad2456fb1c77d3054cdaa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 如果有意研读LunaixOS的内核代码和其中的设计，以下资料可能会对此有用。
 
++ [最新的LunaixOS源代码分析教程](docs/tutorial/0-教程介绍和环境搭建.md)
 + [内核虚拟内存的详细布局](docs/img/lunaix-os-mem.png)
 + [LunaixOS启动流程概览](docs/img/boot_sequence.jpeg)
 + LunaixOS总体架构概览（WIP）
@@ -30,7 +31,7 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 + 虚拟内存
 + 内存管理与按需分页
 + 键盘输入
-+ å¤\9aè¿\9bç¨\8b
++ è¿\9bç¨\8b模å\9e\8b
 + 54个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
 + 用户模式
 + 信号机制
@@ -49,6 +50,7 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 + 通用图形设备抽象层
   + 标准VGA实现
 + 虚拟终端设备接口（兼容 POSIX.1-2008）
++ 线程模型
 
 已经测试过的环境：
 
@@ -108,6 +110,24 @@ make CX_PREFIX=i686-linux-gnu- all
 
 **※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
 
+### 4.4 设置内核启动参数
+
+在 make 的时候通过`CMDLINE`变量可以设置内核启动参数列表。该列表可以包含多个参数，通过一个或多个空格来分割。每个参数可以为键值对 `<key>=<val>` 或者是开关标志位 `<flag>`。目前 Lunaix 支持以下参数：
+
++ `console=<dev>` 设置系统终端的输入输出设备（tty设备）。其中 `<dev>` 是设备文件路径 （注意，这里的设备文件路径是针对Lunaix，而非Linux）。关于LunaixOS设备文件系统的介绍可参考 Lunaix Wiki（WIP）
+
+如果`CMDLINE`未指定，则将会载入默认参数：
+
+```
+console=/dev/ttyFB0
+```
+
+其中，`/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`，无需作任何的转换）
+
 ## 5. 运行，分支以及 Issue
 
 ### 5.1 虚拟磁盘（非必须）
@@ -156,7 +176,10 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 
 + `vmrs [pid]` 列举进程`<pid>`的内存区域图（Memory Regions），如果`<pid>`未指定，则默认为正在运行的进程（smp=1）。
 + `proc [pid]` 打印进程`<pid>`的进程控制块状态，如果`<pid>`未指定，则默认为正在运行的进程（smp=1）。
-+ `proc_table` 列举所有非终止的进程以及他们的状态。
++ `sched <threads | procs> [-l]` 查看调度器信息，接受两个参数：
+  + `threads` 打印所有依然在调度器中有注册的线程
+  + `procs` 打印所有依然在调度器中有注册的进程
+  + 可选开关 `-l` 决定是否以长列表打印（更详细的信息）
 
 该插件可以通过运行以下命令来进行安装：
 
@@ -213,9 +236,9 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 
 + 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)`
@@ -271,14 +294,14 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 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`
-5. `pollctl`
 
 ( **※**：该系统调用暂未经过测试 )