search

Minep / lunaix-os

A simple (yet naive), POSIX-compliant (hopefully!) operating system from scratch!
MIT License
496 stars 57 forks source link

readme

简体中文 | English

The LunaixOS Project

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

1. 一些实用资源

如果有意研读 Lunaix 内核代码和其中的设计，或欲开始属于自己的OS开发之道，以下资料可能会对此有用。

2. 当前进度以及支持的功能

Lunaix内核具有支持多种不同的指令集架构的能力，目前支持如下：

Lunaix全部特性一览：

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

4. 编译与构建

！如果想要立刻构建并运行，请参考4.7！

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

4.1 使用 GNU CC 工具链

正如同大多数内核一样，Lunaix 是一个混合了 C 和汇编的产物。这就意味着你得要使用一些标准的C编译器来构建Lunaix。在这里，我推荐使用 GNU CC 工具链来进行构建。因为Lunaix 在编写时使用了大量的GNU CC 相关编译器属性修饰 (__attribute__) 。假若使用其他工具链，如LLVM，我对此就不能做出任何保证了。

如果你使用的是基于 x86 指令集的Linux系统，不论是64位还是32位，其本机自带的gcc就足以编译Lunaix。 当然了，如果说你的平台是其他非x86的，你也可以指定使用某个针对x86_32的gcc套件来进行交叉编译——在make时通过CX_PREFIX变量来指定gcc套件的前缀。如下例所示，我们可以在任意平台上，如risc-v，单独使用一个面向x86_32的gcc来进行交叉编译：

make CX_PREFIX=i686-linux-gnu- all

4.2 Docker镜像

对于开发环境，本项目也提供了Docker镜像封装。开箱即用，无需配置，非常适合懒人或惜时者。详细使用方法请转到：Lunaix OSDK项目。

4.3 构建选项

本项目支持的make命令： 命令 用途
make all 构建内核ELF镜像
make rootfs 构建根文件系统镜像，将会封装usr/下的程序
make clean 删除构建缓存，用于重新构建
make config 配置Lunaix

与make命令配套的环境变量，Lunaix的makefile会自动检测这些环境变量，以更改构建行为

4.4 Lunaix的功能配置

Lunaix是一个可配置的内核，允许用户在编译前选择应当包含或移除的功能。

使用make config来进行基于命令行的交互配置。采用TUI呈现，效果类似于menuconfig.

如果因为某种原因，TUI界面无法呈现，那么将会默认使用shell形式的呈现：

所有的配置项按照类似于文件树的形式组织，如单个配置项为一个“文件”，多个配置项组成的配置组为一个目录，呈现形式为方括号[]包裹起来的项目。在提示符中输入usage并回车可以查看具体的使用方法。

一个最常用的配置可能就是architecture_support/arch了，也就是配置Lunaix所面向的指令集。比如，编译一个在x86_64平台上运行的Lunaix，在提示符中输入（注意等号两侧的空格，这是不能省略的）：

/architecture_support/arch = x86_64

之后输入exit保存并退出。而后正常编译。

4.5 设置内核参数

在 make 的时候通过CMDLINE变量可以设置内核启动参数列表。该列表可以包含多个参数，通过一个或多个空格来分割。每个参数可以为键值对 <key>=<val> 或者是开关标志位 <flag>。目前 Lunaix 支持以下参数：

如果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，无需作任何的转换）

4.6 Lunaix的启动

由于 Lunaix 的定位是内核。为了避免太多的编译时的前置要求，同时为了提高灵活性，我们移除了iso文件的封装功能。目前的 Lunaix 将只会编译出一个 ELF 格式的二进制文件。用户可以根据自己的喜好，使用的不同的方式，不同的 bootloader 来引导 Lunaix.

为了能够使得 Lunaix 能够正确的启动，用户必须设置以下内核参数：

4.7 测试与体验 Lunaix

想要快速体验，请跟随以下步骤：

  1. 决定一个你想要体验的架构，如 x86_64。 （支持：x86_64, i386）为了叙述方便，这个架构在下文被指代为<arch>
  2. 检查你是否安装了： qemu-system-<arch>，gdb，python3，telnet，gcc
  3. 运行 make ARCH=<arch> user 来编译自带的用户程序
  4. 运行 make ARCH=<arch> rootfs 来打包根文件系统镜像。（需要本机系统支持 dd，mkfs.ext2, mount -o loop, mktemp）
  5. 运行 ARCH=<arch> live_debug.sh 来启动

该脚本自动按照默认的选项构建Lunaix，而后调用 scripts/qemu.py 根据配置文件生成QEMU启动参数（配置文件位于scripts/qemus/）

由于该脚本的主要用途是方便作者进行调试，所以在QEMU窗口打开后还需要进行以下动作：

  1. 使用telnet连接到localhost:12345，这里是Lunaix进行标准输入输出所使用的UART映射（QEMU为guest提供UART实现，并将其利用telnet协议重定向到宿主机）
  2. 在GDB窗口中输入c然后回车，此时Lunaix开始运行。这样做的目的是允许在QEMU进行模拟前，事先打好感兴趣的断点。

5. 运行，分支以及 Issue

5.1 代码稳定性

主分支一般是稳定的。因为在大多数情况下，我都会尽量保证本机运行无误后，push到该分支中。所有正在开发的功能请参考当前活跃的Pull Request。

如果主分支的运行出现了此问题，欢迎提issue。请参考附录3：Issue的提交

6. 调试 Lunaix 内核

除了附录4：串口GDB远程调试描述的一种用于实机调试的方式以外。LunaixOS还提供了LunaDBG调试套件。这是一个GDB客户端插件，包含了对GDB原生命令集的一些扩充，主要用于改善与简化内核调试的过程。目前包含以下几个命令：

该插件可以通过运行以下命令来进行安装：

./scripts/gdb/install_lunadbg

7. 参考教程

没有！！

本教程以及该操作系统的所有的架构设计与实现均为原创。

对此，作者可以保证，该项目是做到了三个 “没有”：

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

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

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

手册，标准，技术文档

免责声明：PCI相关的标准最终解释权归PCI-SIG所有。此处提供的副本仅供个人学习使用。任何商用目的须向PCI-SIG购买。

理论书籍

网站

其他

附录1：实现的 POSIX 系统接口

LunaixOS 提供对以下POSIX的系统接口的实现。内核定义的系统调用号可以参考 LunaixOS系统调用表 。

  1. sleep(3)
  2. wait(2)
  3. waitpid(2)
  4. fork(2)
  5. getpid(2)
  6. getppid(2)
  7. getpgid(2)
  8. setpgid(2)
  9. brk(2)
  10. sbrk(2)
  11. _exit(2)
  12. sigreturn(2)
  13. sigprocmask(2)
  14. sigaction(2)
  15. kill(2)
  16. sigpending(2)
  17. sigsuspend(2)
  18. read(2)
  19. write(2)
  20. open(2)
  21. close(2)
  22. mkdir(2)
  23. lseek(2)
  24. readdir(2)
  25. readlink(2)
  26. readlinkat(2)
  27. rmdir(2)
  28. unlink(2)
  29. unlinkat(2)
  30. link(2)※
  31. fsync(2)
  32. dup(2)
  33. dup2(2)
  34. symlink(2)
  35. chdir(2)
  36. fchdir(2)
  37. getcwd(2)
  38. rename(2)※
  39. mount(2)
  40. unmount (a.k.a umount(2))※
  41. getxattr(2)※
  42. setxattr(2)※
  43. fgetxattr(2)※
  44. fsetxattr(2)※
  45. ioctl(2)
  46. getpgid(2)
  47. setpgid(2)
  48. mmap(2)
  49. munmap(2)
  50. execve(2)
  51. poll(2) (via pollctl)
  52. epoll_create(2) (via pollctl)
  53. epoll_ctl(2) (via pollctl)
  54. epoll_wait(2) (via pollctl)
  55. pthread_create
  56. pthread_self
  57. pthread_exit
  58. pthread_join
  59. pthread_kill
  60. pthread_detach
  61. pthread_sigmask

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

附录2：Issue的提交

假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。

附录3：串口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。