feat: fstat now handle symbolic link

[lunaix-os.git] / README.md

diff --git a/README.md b/README.md
index c3c7cddcaf3c5286219b63aecf5d15a7977338bd..064c6bee504a742e24e0f461083e585933fa73c2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,16 +3,24 @@
 </p>
 
 <p align="center">
 </p>
 
 <p align="center">

-  <span>简体中文</span> | <a href="docs/README_en.md">English</a>
+  <a href="#lunaixos-project">简体中文</a> | <a href="docs/README_en.md">English</a>

 </p>
 
 # LunaixOS Project
 
 LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有浓重个人风格的操作系统。开发过程以视频教程形式在Bilibili呈现：[《从零开始自制操作系统系列》](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337)。
 
 </p>
 
 # LunaixOS Project
 
 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）
 + 键盘输入
 + 多进程
 + 内存管理与按需分页（Demand Paging）
 + 键盘输入
 + 多进程

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

 + 用户模式
 + 信号机制
 + PCI 3.0
 + 用户模式
 + 信号机制
 + PCI 3.0


@@ -33,8 +41,10 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
   + 虚拟文件系统
   + ISO9660
     + 原生
   + 虚拟文件系统
   + ISO9660
     + 原生

-    + Rock Ridge拓展 (WIP)
+    + Rock Ridge拓展

 + 远程GDB串口调试 (COM1@9600Bd)
 + 远程GDB串口调试 (COM1@9600Bd)

++ 用户程序加载与执行
++ 动态链接 (WIP)

 
 已经测试过的环境：
 
 
 已经测试过的环境：
 


@@ -53,6 +63,8 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 ## 编译与构建
 
 
 ## 编译与构建
 

+### 环境搭建
+

 构建该项目需要满足以下条件：
 
 + gcc (目标平台: i686-elf)
 构建该项目需要满足以下条件：
 
 + gcc (目标平台: i686-elf)


@@ -63,6 +75,12 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 **注意：gcc不能是本机自带的，必须要从源码编译，并配置目标平台为：`i686-elf`，以进行交叉编译。配置过程可参考[附录二：编译gcc作为交叉编译器](#appendix2)。**
 
 
 **注意：gcc不能是本机自带的，必须要从源码编译，并配置目标平台为：`i686-elf`，以进行交叉编译。配置过程可参考[附录二：编译gcc作为交叉编译器](#appendix2)。**
 

+### Docker镜像
+
+对于开发环境，本项目也提供了Docker镜像封装。开箱即用，无需配置，非常适合懒人或惜时者。详细使用方法请转到：[Lunaix OSDK项目](https://github.com/Minep/os-devkit)。
+
+### 构建选项
+

 假若条件满足，那么可以直接执行`make all`进行构建，完成后可在生成的`build`目录下找到可引导的iso。
 
 本项目支持的make命令：
 假若条件满足，那么可以直接执行`make all`进行构建，完成后可在生成的`build`目录下找到可引导的iso。
 
 本项目支持的make命令：


@@ -79,7 +97,7 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 **※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
 
 
 **※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
 

-## 运行以及Issue
+## 运行，分支以及Issue

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


@@ -99,7 +117,9 @@ 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到仓库中。同时，该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)
+主分支一般是稳定的。因为在大多数情况下，我都会尽量保证本机运行无误后，push到该分支中。至于其他的分支，则是作为标记或者是开发中的功能。前者标记用分支一般会很快删掉；后者开发分支不能保证稳定性，这些分支的代码有可能没有经过测试，但可以作为Lunaix当前开发进度的参考。
+
+该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)

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


@@ -144,6 +164,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购买。**
 


@@ -182,7 +203,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)`


@@ -190,11 +211,11 @@ 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. `readlink(2)`
+2. `readlinkat(2)`

 2. `rmdir(2)`※
 2. `unlink(2)`※
 2. `unlinkat(2)`※
 2. `rmdir(2)`※
 2. `unlink(2)`※
 2. `unlinkat(2)`※


@@ -202,7 +223,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 2. `fsync(2)`※
 2. `dup(2)`
 2. `dup2(2)`
 2. `fsync(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)`


@@ -216,8 +237,9 @@ 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. `mmap(2)`
+2. `munmap(2)`
+2. `execve(2)`

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