feat: rename(2), mount(2) and unmount(2)

[lunaix-os.git] / README.md

diff --git a/README.md b/README.md
index caaf720458c02d206db2fb39663e42f632cdcc95..ebaf251be08bcc551e433941d279924012145205 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,12 +22,13 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 + 内存管理与按需分页（Demand Paging）
 + 键盘输入
 + 多进程
-+ 17个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
++ 40个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
 + 用户模式
 + 信号机制
 + PCI 3.0
 + PCIe 1.1 (WIP)
-+ Serial ATA AHCI (WIP)
++ Serial ATA AHCI
++ 文件系统 (WIP)
 
 ## 目录结构
 
@@ -64,6 +65,23 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 ## 运行以及Issue
 
+运行该操作系统需要一个虚拟磁盘镜像，可以使用如下命令快速创建一个：
+
+```bash
+qemu-img create -f vdi machine/disk0.vdi 128M
+```
+
+如果你想要使用别的磁盘镜像，需要修改`configs/make-debug-tool`
+
+找到这一行：
+```
+-drive id=disk,file="machine/disk0.vdi",if=none \
+```
+
+然后把`machine/disk0.vdi`替换成你的磁盘路径。
+
+有很多办法去创建一个虚拟磁盘，比如[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)
 
 下面列出一些可能会出现的问题。
@@ -76,6 +94,14 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 这很大概率是出现了竞态条件。虽然是相当不可能的。但如果出现了，还是请提issue。
 
+#### 问题#3：Bochs运行时，提示找不到AHCI控制器
+
+正常，**因为Bochs不支持SATA**。请使用QEMU或VirtualBox。
+
+#### 问题#4：键盘的上下方向键（用于滚屏）在VirtualBox下有时不好使
+
+可以试试`Shift+<方向键>`，这个问题的解决需要重写键盘驱动的状态机。我会找时间去做，毕竟这不是燃眉之急。
+
 ## 参考教程
 
 **没有！！** 本教程以及该操作系统均为原创，没有基于任何市面上现行的操作系统开发教程，且并非是基于任何的开源内核的二次开发。
@@ -99,6 +125,8 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 + PCI Firmware Specification, Revision 3.0
 + Serial ATA - Advanced Host Controller Interface (AHCI), Revision 1.3.1
 + Serial ATA: HIgh Speed Serialized AT Attachment, Revision 3.2
++ SCSI Command Reference Manual
++ ATA/ATAPI Command Set - 3 (ACS-3)
 
 **免责声明：PCI相关的标准最终解释权归PCI-SIG所有。此处提供的副本仅供个人学习使用。任何商用目的须向PCI-SIG购买。**
 
@@ -138,14 +166,39 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 1. `kill(2)`
 1. `sigpending(2)`
 1. `sigsuspend(2)`
+2. `read(2)`
+2. `write(2)`
+2. `open(2)`
+2. `close(2)`
+2. `mkdir(2)`
+2. `lseek(2)`
+2. `readdir(2)`
+2. `readlink(2)`
+2. `readlinkat(2)`
+2. `rmdir(2)`
+2. `unlink(2)`
+2. `unlinkat(2)`
+2. `link(2)`
+2. `fsync(2)`
+2. `dup(2)`
+2. `dup2(2)`
+2. `symlink(2)`
+2. `chdir(2)`
+2. `fchdir(2)`
+2. `getcwd(2)`
+2. `rename(2)`
+2. `mount(2)`
+2. `unmount` (a.k.a `umount(2)`)
 
 ### LunaixOS自有
 
 1. `yield`
+2. `geterrno`
+3. `realpathat`
 
 ## 附录2：编译gcc作为交叉编译器<a id="appendix2"></a>
 
-注意，gcc需要从源码构建，并配置为交叉编译器，即目标平台为`i686-elf`。你可以使用本项目提供的自动化脚本，这将会涵盖gcc和binutils源码的下载，配置和编译（不能保证全平台可用，目前只试过在Ubuntu系统上可以运行）。
+注意，gcc需要从源码构建，并配置为交叉编译器，即目标平台为`i686-elf`。你可以使用本项目提供的[自动化脚本](slides/c0-workspace/gcc-build.sh)，这将会涵盖gcc和binutils源码的下载，配置和编译（没什么时间去打磨脚本，目前只知道在笔者的Ubuntu系统上可以运行）。
 
 **推荐**手动编译。以下编译步骤搬运自：https://wiki.osdev.org/GCC_Cross-Compiler 
 
@@ -199,9 +252,22 @@ make all-gcc &&\
 ```
 8. 验证安装：执行`i686-elf-gcc -dumpmachine`，输出应该为：`i686-elf`
 
+**将新编译好的GCC永久添加到`PATH`环境变量**
+
+虽然这是一个常识性的操作，但考虑到许多人都会忽略这一个额外的步骤，在这里特此做出提示。
+
+要想实现这一点，只需要在shell的配置文件的末尾添加：`export PATH="<上述的安装路径>/bin:$PATH"`。
+
+这个配置文件是取决于你使用的shell，如zsh就是`${HOME}/.zshrc`，bash则是`${HOME}/.bashrc`；或者你嫌麻烦的，懒得区分，你也可以直接修改全局的`/etc/profile`文件，一劳永逸（但不推荐这样做）。
+
+至于其他的情况，由于这个步骤其实在网上是随处可查的，所以就不在这里赘述了。
+
 ## 附录3：Issue的提交<a id="appendix3"></a>
 
+由于目前LunaixOS没有一个完善强大的内核追踪功能。假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。
+
 最好提供：
++ 可用于复现问题的描述和指引（如Lunaix运行平台的软硬件配置）
 + 错误症状描述
 + （如可能）运行截图
 + 错误消息（如果给出）