From: Minep Date: Sat, 12 Nov 2022 20:07:19 +0000 (+0000) Subject: update readme X-Git-Url: https://scm.lunaixsky.com/lunaix-os.git/commitdiff_plain/1e54f1850eda97e3b41c302b72c07a1f9cc4d637?ds=sidebyside update readme add materials related to ISO9660 file system --- diff --git a/README.md b/README.md index cdeecbe..da02130 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ 简体中文 | English

-# LunaixOS Project +# LunaixOS Project + LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有浓重个人风格的操作系统。开发过程以视频教程形式在Bilibili呈现：[《从零开始自制操作系统系列》](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337)。 ## 当前进度以及支持的功能 @@ -28,7 +29,11 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有 + PCI 3.0 + PCIe 1.1 (WIP) + Serial ATA AHCI -+ 文件系统 (WIP) ++ 文件系统 + + 虚拟文件系统 + + ISO9660 + + 原生 + + Rock Ridge拓展 (WIP) + 远程GDB串口调试 (COM1@9600Bd) 已经测试过的环境： @@ -40,11 +45,11 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有 ## 目录结构 -| | | -|-----|------| -| [lunaix-os](lunaix-os/) | LunaixOS源代码 | -| [slides](slides/) | 视频中所用的幻灯片和补充材料 | -| [reference-material](reference-material/)| 标准，技术文档和参考文献 | +| | | +| ----------------------------------------- | ---------------------------- | +| [lunaix-os](lunaix-os/) | LunaixOS源代码 | +| [slides](slides/) | 视频中所用的幻灯片和补充材料 | +| [reference-material](reference-material/) | 标准，技术文档和参考文献 | ## 编译与构建 @@ -61,16 +66,16 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有 假若条件满足，那么可以直接执行`make all`进行构建，完成后可在生成的`build`目录下找到可引导的iso。 本项目支持的make命令： -| 命令 | 用途 | -|---|---| -| `make all` | 构建镜像（`-O2`，但禁用CSE相关的优化项 **※** ） | -| `make instable` | 构建镜像（`-O2`，开启CSE相关优化） | -| `make all-debug` | 构建适合调试用的镜像（`-Og`） | -| `make run` | 使用QEMU运行build目录下的镜像| -| `make debug-qemu` | 构建并使用QEMU进行调试 | -| `make debug-bochs` | 构建并使用Bochs进行调试 | -| `make debug-qemu-vscode` | 用于vscode整合 | -| `make clean` | 删除build目录 | +| 命令 | 用途 | +| ------------------------ | ----------------------------------------------- | +| `make all` | 构建镜像（`-O2`，但禁用CSE相关的优化项 **※** ） | +| `make instable` | 构建镜像（`-O2`，开启CSE相关优化） | +| `make all-debug` | 构建适合调试用的镜像（`-Og`） | +| `make run` | 使用QEMU运行build目录下的镜像 | +| `make debug-qemu` | 构建并使用QEMU进行调试 | +| `make debug-bochs` | 构建并使用Bochs进行调试 | +| `make debug-qemu-vscode` | 用于vscode整合 | +| `make clean` | 删除build目录 | **※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。** @@ -85,6 +90,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M 如果你想要使用别的磁盘镜像，需要修改`configs/make-debug-tool` 找到这一行： + ``` -drive id=disk,file="machine/disk0.vdi",if=none \ ``` @@ -97,11 +103,11 @@ qemu-img create -f vdi machine/disk0.vdi 128M 下面列出一些可能会出现的问题。 -#### 问题#1： QEMU下8042控制器提示找不到。 +#### 问题#1： QEMU下8042控制器提示找不到 这是QEMU配置ACPI时的一个bug，在7.0.0版中修复了。 -#### 问题#2：多进程运行时，偶尔会出现General Protection错误。 +#### 问题#2：多进程运行时，偶尔会出现General Protection错误 这很大概率是出现了竞态条件。虽然是相当不可能的。但如果出现了，还是请提issue。 @@ -120,6 +126,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M 当然，您也可以参考以下列表来了解现阶段的LunaixOS都使用了哪些资料（本列表会随着开发进度更新）： #### 手册，标准，技术文档 + + [Intel 64 and IA-32 Architecture Software Developer's Manual (Full Volume Bundle)](https://www.intel.com/content/www/us/en/developer/articles/technical/intel-sdm.html) + [ACPI Specification (version 6.4)](https://uefi.org/sites/default/files/resources/ACPI_Spec_6_4_Jan22.pdf) + IBM PC/AT Technical Reference @@ -131,31 +138,37 @@ qemu-img create -f vdi machine/disk0.vdi 128M + PCI Express Base Specification, Revision 1.1 + 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 ++ Serial ATA: High Speed Serialized AT Attachment, Revision 3.2 + SCSI Command Reference Manual + ATA/ATAPI Command Set - 3 (ACS-3) ++ [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) **免责声明：PCI相关的标准最终解释权归PCI-SIG所有。此处提供的副本仅供个人学习使用。任何商用目的须向PCI-SIG购买。** #### 理论书籍 + + *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） #### 网站 + + [OSDev](https://wiki.osdev.org/Main_Page) - 杂七杂八的参考，很多过来人的经验。作者主要用于上古资料查询以及收集；技术文献，手册，标准的粗略总结；以及开发环境/工具链的搭建。 + [FreeVGA](http://www.osdever.net/FreeVGA/home.htm) - 98年的资源！关于VGA编程技术的宝藏网站。 + GNU CC 和 GNU LD 的官方文档。 + [PCI Lookup](https://www.pcilookup.com/) - PCI设备编号查询 #### 其他 -+ Linux Manual - 用于查询*nix API的一些具体行为。 ++ Linux Manual - 用于查询*nix API的一些具体行为。 ## 附录1：支持的系统调用 **Unix/Linux/POSIX** + 1. `sleep(3)` 1. `wait(2)` 1. `waitpid(2)` @@ -200,7 +213,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M 2. `setxattr(2)`※ 2. `fgetxattr(2)`※ 2. `fsetxattr(2)`※ -2. `ioctl(2)`※ +2. `ioctl(2)` 2. `getpgid(2)` 2. `setpgid(2)` @@ -209,6 +222,7 @@ qemu-img create -f vdi machine/disk0.vdi 128M 1. `yield` 2. `geterrno` 3. `realpathat` +4. `syslog` ( **※**：该系统调用暂未经过测试 ) @@ -216,9 +230,10 @@ qemu-img create -f vdi machine/disk0.vdi 128M 注意，gcc需要从源码构建，并配置为交叉编译器，即目标平台为`i686-elf`。你可以使用本项目提供的[自动化脚本](slides/c0-workspace/gcc-build.sh)，这将会涵盖gcc和binutils源码的下载，配置和编译（没什么时间去打磨脚本，目前只知道在笔者的Ubuntu系统上可以运行）。 -**推荐**手动编译。以下编译步骤搬运自：https://wiki.osdev.org/GCC_Cross-Compiler +**推荐**手动编译。以下编译步骤搬运自： **首先安装构建依赖项：** + ```bash sudo apt update &&\ apt install -y \ @@ -232,10 +247,12 @@ sudo apt update &&\ ``` **开始编译：** + 1. 获取[gcc](https://ftp.gnu.org/gnu/gcc/)和[binutils](https://ftp.gnu.org/gnu/binutils)源码 2. 解压，并在同级目录为gcc和binutil新建专门的build文件夹 现在假设你的目录结构如下： + ``` + folder + gcc-src @@ -247,25 +264,31 @@ sudo apt update &&\ 3. 确定gcc和binutil安装的位置，并设置环境变量：`export PREFIX=<安装路径>` 然后设置PATH： `export PATH="$PREFIX/bin:$PATH"` 4. 设置目标平台：`export TARGET=i686-elf` 5. 进入`binutils-build`进行配置 + ```bash ../binutils-src/configure --target="$TARGET" --prefix="$PREFIX" \ - --with-sysroot --disable-nls --disable-werror + --with-sysroot --disable-nls --disable-werror ``` + 然后 `make && make install` 6. 确保上述的`binutils`已经正常安装：执行：`which i686-elf-as`，应该会给出一个位于你安装目录下的路径。 6. 进入`gcc-build`进行配置 + ```bash ../gcc-src/configure --target="$TARGET" --prefix="$PREFIX" \ - --disable-nls --enable-languages=c,c++ --without-headers + --disable-nls --enable-languages=c,c++ --without-headers ``` + 然后编译安装（取决性能，大约10~20分钟）： + ```bash make all-gcc &&\ make all-target-libgcc &&\ make install-gcc &&\ make install-target-libgcc ``` + 8. 验证安装：执行`i686-elf-gcc -dumpmachine`，输出应该为：`i686-elf` **将新编译好的GCC永久添加到`PATH`环境变量** @@ -283,6 +306,7 @@ make all-gcc &&\ 由于目前LunaixOS没有一个完善强大的内核追踪功能。假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。 最好提供： + + 可用于复现问题的描述和指引（如Lunaix运行平台的软硬件配置） + 错误症状描述 + （如可能）运行截图 @@ -305,4 +329,4 @@ LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM ### GDB调试注意事项 -在调试中，请避免使用`info stack`，`bt`或者任何涉及 **栈展开（Stack Unwinding）** 或者 **栈回溯（Stack Backtracing）** 的指令。否则，LunaixOS很有可能会出现 **不可预料的行为** 。 \ No newline at end of file +在调试中，请避免使用`info stack`，`bt`或者任何涉及 **栈展开（Stack Unwinding）** 或者 **栈回溯（Stack Backtracing）** 的指令。否则，LunaixOS很有可能会出现 **不可预料的行为** 。 diff --git a/docs/README_en.md b/docs/README_en.md index 2a115ca..be03432 100644 --- a/docs/README_en.md +++ b/docs/README_en.md @@ -6,16 +6,16 @@ 简体中文 | English

-# The LunaixOS Project +# The LunaixOS Project + LunaixOS - A simple (yet naive), POSIX-complaint (hopefully!), operating system from scratch. This is started for educational & learning purpose, for my online video tutorial on OS development **in Chinese**：[*Do It Yourself an Operating System*](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337). ## Features -This operating system is a macro-kernel, has its root in Intel's x86 platform and its ecosystem. It runs in protected mode and uses 4GiB addressing with two-level paging mechanism. It does not have x86_64 variant and does not support multi-core machine. +This operating system is a macro-kernel, has its root in Intel's x86 platform and its ecosystem. It runs in protected mode and uses 4GiB addressing with two-level paging mechanism. It does not have x86_64 variant and does not support multi-core machine. The virtual address space is divided into two parts, that is, 3GiB for user space (0x400000 ~ 0xBFFFFFFF) and 1GiB for kernel space (0xC0000000 ~ 0xFFFFFFFF). Such paradigm is a common practicing found in major operating systems, for example x86_32 version of Linux and Windows. For a more detailed arrangement of memory in LunaixOS, please refer to [LunaixOS Virtual Memory Mappings](img/lunaix-os-mem.png). - The following list presents all features it does have in current stage. + Multiboot for bootstrapping @@ -31,9 +31,13 @@ The following list presents all features it does have in current stage. + PCI 3.0 + PCIe 1.1 (WIP) + Serial ATA AHCI -+ Virtual File System ++ File System + + Virtual File System + + ISO9660 + + Original + + Rock Ridge Extension (WIP) + GDB Remote debugger (via UART) - + The OS has been tested in the following environments, including both virtual and bare-metal. + QEMU (>=7.0.0) @@ -101,7 +105,7 @@ To maximize the value of this section, we will provide some FAQ below that hopef This is a issue related to misconfiguration of ACPI table in QEMU, and has been addressed in version 7.0.0. -#### Q2: General Protection exception get triggered. +#### Q2: General Protection exception get triggered It is possible a race condition result from multiprogramming. This is not possible in current stage, and we however encourage you to report in case of it. @@ -132,30 +136,35 @@ The following list also enumerated such materials the author has used: + PCI Express Base Specification, Revision 1.1 + 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 ++ Serial ATA: High Speed Serialized AT Attachment, Revision 3.2 + SCSI Command Reference Manual + ATA/ATAPI Command Set - 3 (ACS-3) ++ [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) **DISCLAIMER: All rights of PCI-related specification is reserved by PCI-SIG. It is provided ONLY for learning purpose. Any commercial use should purchase a copy from PCI-SIG** #### Textbook + + *Computer System - A Programmer's Perspective Third Edition* (Bryant, R & O'Hallaron, D), a.k.a. CS:APP + *Modern Operating System* (Tanenbaum, A) +#### Website -#### Website + [OSDev](https://wiki.osdev.org/Main_Page) - For material gathering. + [FreeVGA](http://www.osdever.net/FreeVGA/home.htm) - For VGA references. + GNU CC & LD online documentation. + [PCI Lookup](https://www.pcilookup.com/) - For device look up #### Others -+ Linux Manual - For learning the system call behavior on real machine. ++ Linux Manual - For learning the system call behavior on real machine. ## Appendix 1: Supported System Call **Unix/Linux/POSIX** + 1. `sleep(3)` 1. `wait(2)` 1. `waitpid(2)` diff --git a/reference-material/ECMA-119_4th_edition_june_2019.pdf b/reference-material/ECMA-119_4th_edition_june_2019.pdf new file mode 100644 index 0000000..935c2d9 Binary files /dev/null and b/reference-material/ECMA-119_4th_edition_june_2019.pdf differ diff --git a/reference-material/Rockridge.pdf b/reference-material/Rockridge.pdf new file mode 100644 index 0000000..21501ee Binary files /dev/null and b/reference-material/Rockridge.pdf differ diff --git a/reference-material/SUSP-112.pdf b/reference-material/SUSP-112.pdf new file mode 100644 index 0000000..5a43434 Binary files /dev/null and b/reference-material/SUSP-112.pdf differ