LunaixOS Project

LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有浓重个人风格的操作系统。开发过程以视频教程形式在Bilibili呈现：《从零开始自制操作系统系列》。

当前进度以及支持的功能

该操作系统支持x86架构，运行在保护模式中，采用宏内核架构，目前仅支持单核心。内存结构采用经典的3:1划分，即低3GiB为用户地址空间（0x400000 ~ 0xBFFFFFFF），内核地址空间重映射至高1GiB（0xC0000000 ~ 0xFFFFFFFF）。内存的详细布局可参考LunaixOS内存地图

在下述列表中，则列出目前所支持的所用功能和特性。列表项按照项目时间戳进行升序排列。

使用Multiboot进行引导启动
APIC/IOAPIC作为中断管理器和计时器
ACPI
虚拟内存
内存管理与按需分页（Demand Paging）
键盘输入
多进程
47个常见的Linux/POSIX系统调用（附录1）
用户模式
信号机制
PCI 3.0
PCIe 1.1 (WIP)
Serial ATA AHCI
文件系统
- 虚拟文件系统
- ISO9660
  - 原生
  - Rock Ridge拓展 (WIP)
远程GDB串口调试 (COM1@9600Bd)

已经测试过的环境：

QEMU (>=7.0.0)
Bochs（SATA功能不支持）
Virtualbox
Dell G3 3779

目录结构


lunaix-os	LunaixOS源代码
slides	视频中所用的幻灯片和补充材料
reference-material	标准，技术文档和参考文献

编译与构建

构建该项目需要满足以下条件：

gcc (目标平台: i686-elf)
binutils
make
xorriso
grub-mkrescue

注意：gcc不能是本机自带的，必须要从源码编译，并配置目标平台为：i686-elf，以进行交叉编译。配置过程可参考附录二：编译gcc作为交叉编译器。

假若条件满足，那么可以直接执行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目录

※：由于在-O2模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。

运行以及Issue

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

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。

在大多数情况下，我都会尽量保证本机运行无误后，push到仓库中。同时，该系统是经过虚拟机和真机测试。如果发现在使用make all之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考附录3：Issue的提交

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

问题#1： QEMU下8042控制器提示找不到

这是QEMU配置ACPI时的一个bug，在7.0.0版中修复了。

问题#2：多进程运行时，偶尔会出现General Protection错误

这很大概率是出现了竞态条件。虽然是相当不可能的。但如果出现了，还是请提issue。

问题#3：Bochs无法运行，提示找不到AHCI控制器

正常，因为Bochs不支持SATA。请使用QEMU或VirtualBox。

参考教程

没有！！ 本教程以及该操作系统均为原创，没有基于任何市面上现行的操作系统开发教程，且并非是基于任何的开源内核的二次开发。

为了制作LunaixOS，作者耗费大量时间和精力钻研技术文档，手册，理论书籍以及现行工业标准，从而尽量保证了知识的一手性。（这样一来，读者和听众们也算是拿到了二手的知识，而不是三手，四手，甚至n手的知识）。

大部分的文档和标准可以在上述的reference-material中找到。

当然，您也可以参考以下列表来了解现阶段的LunaixOS都使用了哪些资料（本列表会随着开发进度更新）：

手册，标准，技术文档

Intel 64 and IA-32 Architecture Software Developer's Manual (Full Volume Bundle)
ACPI Specification (version 6.4)
IBM PC/AT Technical Reference
IBM VGA/XGA Technical Reference
82093AA I/O Advanced Programmable Controller (IOAPIC) (Datasheet)
MC146818A (Datasheet)
Intel 500 Series Chipset Family Platform Controller Hub (Datasheet - Volume 2)
PCI Local Bus Specification, Revision 3.0
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
SCSI Command Reference Manual
ATA/ATAPI Command Set - 3 (ACS-3)
ECMA-119 (ISO9660)
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 - 杂七杂八的参考，很多过来人的经验。作者主要用于上古资料查询以及收集；技术文献，手册，标准的粗略总结；以及开发环境/工具链的搭建。
FreeVGA - 98年的资源！关于VGA编程技术的宝藏网站。
GNU CC 和 GNU LD 的官方文档。
PCI Lookup - PCI设备编号查询

其他

Linux Manual - 用于查询*nix API的一些具体行为。

附录1：支持的系统调用

Unix/Linux/POSIX

sleep(3)
wait(2)
waitpid(2)
fork(2)
getpid(2)
getppid(2)
getpgid(2)
setpgid(2)
brk(2)
sbrk(2)
_exit(2)
sigreturn(2)
sigprocmask(2)
signal(2)
kill(2)
sigpending(2)
sigsuspend(2)
read(2)
write(2)
open(2)
close(2)
mkdir(2)※
lseek(2)
readdir(2)
readlink(2)※
readlinkat(2)※
rmdir(2)※
unlink(2)※
unlinkat(2)※
link(2)※
fsync(2)※
dup(2)
dup2(2)
symlink(2)※
chdir(2)
fchdir(2)
getcwd(2)
rename(2)※
mount(2)
unmount (a.k.a umount(2))※
getxattr(2)※
setxattr(2)※
fgetxattr(2)※
fsetxattr(2)※
ioctl(2)
getpgid(2)
setpgid(2)

LunaixOS自有

yield
geterrno
realpathat
syslog

( ※：该系统调用暂未经过测试 )

附录2：编译gcc作为交叉编译器

注意，gcc需要从源码构建，并配置为交叉编译器，即目标平台为i686-elf。你可以使用本项目提供的自动化脚本，这将会涵盖gcc和binutils源码的下载，配置和编译（没什么时间去打磨脚本，目前只知道在笔者的Ubuntu系统上可以运行）。

推荐手动编译。以下编译步骤搬运自：https://wiki.osdev.org/GCC_Cross-Compiler

首先安装构建依赖项：

sudo apt update &&\
     apt install -y \
        build-essential \
        bison\
        flex\
        libgmp3-dev\
        libmpc-dev\
        libmpfr-dev\
        texinfo

开始编译：

获取gcc和binutils源码
解压，并在同级目录为gcc和binutil新建专门的build文件夹

现在假设你的目录结构如下：

+ folder
  + gcc-src
  + binutils-src
  + gcc-build
  + binutils-build

确定gcc和binutil安装的位置，并设置环境变量：export PREFIX=<安装路径> 然后设置PATH： export PATH="$PREFIX/bin:$PATH"
设置目标平台：export TARGET=i686-elf
进入binutils-build进行配置

../binutils-src/configure --target="$TARGET" --prefix="$PREFIX" \
 --with-sysroot --disable-nls --disable-werror

然后 make && make install

确保上述的binutils已经正常安装：执行：which i686-elf-as，应该会给出一个位于你安装目录下的路径。
进入gcc-build进行配置

../gcc-src/configure --target="$TARGET" --prefix="$PREFIX" \
 --disable-nls --enable-languages=c,c++ --without-headers

然后编译安装（取决性能，大约10~20分钟）：

make all-gcc &&\
 make all-target-libgcc &&\
 make install-gcc &&\
 make install-target-libgcc

验证安装：执行i686-elf-gcc -dumpmachine，输出应该为：i686-elf

将新编译好的GCC永久添加到PATH环境变量

虽然这是一个常识性的操作，但考虑到许多人都会忽略这一个额外的步骤，在这里特此做出提示。

要想实现这一点，只需要在shell的配置文件的末尾添加：export PATH="<上述的安装路径>/bin:$PATH"。

这个配置文件是取决于你使用的shell，如zsh就是${HOME}/.zshrc，bash则是${HOME}/.bashrc；或者你嫌麻烦的，懒得区分，你也可以直接修改全局的/etc/profile文件，一劳永逸（但不推荐这样做）。

至于其他的情况，由于这个步骤其实在网上是随处可查的，所以就不在这里赘述了。

附录3：Issue的提交

由于目前LunaixOS没有一个完善强大的内核追踪功能。假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。

最好提供：

可用于复现问题的描述和指引（如Lunaix运行平台的软硬件配置）
错误症状描述
（如可能）运行截图
错误消息（如果给出）
寄存器状态的dump
（如可能）提供错误发生时，EIP附近的指令（精确到函数）。如果使用make all-debug，会提供build/kdump.txt，你可以在这里面定位。或者也可以直接objdump
（如可能）虚拟内存映射信息（QEMU下可使用info mem查看）。

附录4：串口GDB远程调试

LunaixOS内核集成了最基本的GDB远程调试服务器。可通过串口COM1在9600波特率上与之建立链接。但是，在将GDB与内核链接起来之前，还需要让内核处在调试模式下。

要进入调试模式，需要往串口（波特率如上）写入字节串 0x40 0x63 0x6D 0x63。此时，如果屏幕底部出现一条品红色背景的DEBUG 字样，那么就说明LunaixOS已处在调试模式下。

注意，在这个时候，LunaixOS会开始在COM1上监听GDB协议信息，并且暂停一切的活动（如调度，以及对外部中断的一切响应）。用户此时需要将GDB与其挂载，并使用GDB的工作流来指示内核下一步的动作。

在目前，为了防止代码过于臃肿，LunaixOS实现的是GDB远程协议要求的最小服务端命令子集：g, G, p, P, Q, S, k, ?, m, M, X。足以满足大部分的调试需求。

当结束调试的时候，请使用GDB的kill指令进行连接的断开。注意，这个指令会使得LunaixOS恢复所有暂停的活动，进入正常的运行序列，但并不会退出调试模式。GDB的挂载请求依然在LunaixOS中享有最高优先权。如果需要退出调试模式，需要往串口写入字节串：0x40 0x79 0x61 0x79。

GDB调试注意事项

在调试中，请避免使用info stack，bt或者任何涉及 栈展开（Stack Unwinding） 或者 栈回溯（Stack Backtracing） 的指令。否则，LunaixOS很有可能会出现 不可预料的行为 。

pihaz / lunaix-os