chore: corrections on readme and add disclaimer on copyrighted spec.
[lunaix-os.git] / README.md
1 <p align="center">
2   <img width="auto" src="docs/img/lunaix-os-logo.png">
3 </p>
4
5 <p align="center">
6   <span>简体中文</span> | <a href="docs/README_en.md">English</a>
7 </p>
8
9 # LunaixOS Project 
10 LunaixOS - 一个简单的,详细的,POSIX兼容的(但愿!),带有浓重个人风格的操作系统。开发过程以视频教程形式在Bilibili呈现:[《从零开始自制操作系统系列》](https://space.bilibili.com/12995787/channel/collectiondetail?sid=196337)。
11
12 ## 当前进度以及支持的功能
13
14 该操作系统支持x86架构,运行在保护模式中,采用宏内核架构,目前仅支持单核心。内存结构采用经典的3:1划分,即低3GiB为用户地址空间(0x400000 ~ 0xBFFFFFFF),内核地址空间重映射至高1GiB(0xC0000000 ~ 0xFFFFFFFF)。内存的详细布局可参考[LunaixOS内存地图](docs/img/lunaix-os-mem.png)
15
16 在下述列表中,则列出目前所支持的所用功能和特性。列表项按照项目时间戳进行升序排列。
17
18 + 使用Multiboot进行引导启动
19 + APIC/IOAPIC作为中断管理器和计时器
20 + ACPI
21 + 虚拟内存
22 + 内存管理与按需分页(Demand Paging)
23 + 键盘输入
24 + 多进程
25 + 17个常见的Linux/POSIX系统调用([附录1](#appendix1))
26 + 用户模式
27 + 信号机制
28 + PCI 3.0
29 + PCIe 1.1 (WIP)
30
31 ## 目录结构
32
33 | | |
34 |-----|------|
35 | [lunaix-os](lunaix-os/) | LunaixOS源代码 |
36 | [slides](slides/) | 视频中所用的幻灯片和补充材料 |
37 | [reference-material](reference-material/)| 标准,技术文档和参考文献 |
38
39 ## 参考教程
40
41 **没有!!** 本教程以及该操作系统均为原创,没有基于任何市面上现行的操作系统开发教程,且并非是基于任何的开源内核的二次开发。
42
43 为了制作LunaixOS,作者耗费大量时间和精力钻研技术文档,手册,理论书籍以及现行工业标准,从而尽量保证了知识的一手性。(这样一来,读者和听众们也算是拿到了二手的知识,而不是三手,四手,甚至n手的知识)。
44
45 大部分的文档和标准可以在上述的[reference-material](reference-material/)中找到。
46
47 当然,您也可以参考以下列表来了解现阶段的LunaixOS都使用了哪些资料(本列表会随着开发进度更新):
48
49 #### 手册,标准,技术文档
50 + [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)
51 + [ACPI Specification (version 6.4)](https://uefi.org/sites/default/files/resources/ACPI_Spec_6_4_Jan22.pdf)
52 + IBM PC/AT Technical Reference
53 + IBM VGA/XGA Technical Reference
54 + 82093AA I/O Advanced Programmable Controller (IOAPIC) (Datasheet)
55 + MC146818A (Datasheet)
56 + Intel 500 Series Chipset Family Platform Controller Hub (Datasheet - Volume 2)
57 + PCI Local Bus Specification, Revision 3.0
58 + PCI Express Base Specification, Revision 1.1
59 + PCI Firmware Specification, Revision 3.0
60
61 **免责声明:PCI相关的标准最终解释权归PCI-SIG所有。此处提供的副本仅供个人学习使用。任何商用目的须向PCI-SIG购买。**
62
63 #### 理论书籍
64 + *Computer System - A Programmer's Perspective Third Edition (CS:APP)* (Bryant, R & O'Hallaron, D)
65 + *Modern Operating System* (Tanenbaum, A)
66 + 《汇编语言》(王爽) - 用于入门Intel语法的x86汇编(对于AT&T语法,推荐阅读CS:APP)
67 + ~~《微机原理与接口技术》 - 用于大致了解x86架构的微机体系(更加细致的了解可以阅读Intel Manual)~~ (已过时,推荐阅读CS:APP)
68
69 #### 网站
70 + [OSDev](https://wiki.osdev.org/Main_Page) - 杂七杂八的参考,很多过来人的经验。作者主要用于上古资料查询以及收集;技术文献,手册,标准的粗略总结;以及开发环境/工具链的搭建。
71 + [FreeVGA](http://www.osdever.net/FreeVGA/home.htm) - 98年的资源!关于VGA编程技术的宝藏网站。
72 + GNU CC 和 GNU LD 的官方文档。
73 + [PCI Lookup](https://www.pcilookup.com/) - PCI设备编号查询
74
75 #### 其他
76 + Linux Manual - 用于查询*nix API的一些具体行为。
77
78
79 ## 附录1:支持的系统调用<a id="appendix1"></a>
80
81 ### Unix/Linux/POSIX
82 1. `sleep(3)`
83 1. `wait(2)`
84 1. `waitpid(2)`
85 1. `fork(2)`
86 1. `getpid(2)`
87 1. `getppid(2)`
88 1. `getpgid(2)`
89 1. `setpgid(2)`
90 1. `brk(2)`
91 1. `sbrk(2)`
92 1. `_exit(2)`
93 1. `sigreturn(2)`
94 1. `sigprocmask(2)`
95 1. `signal(2)`
96 1. `kill(2)`
97 1. `sigpending(2)`
98 1. `sigsuspend(2)`
99
100 ### LunaixOS自有
101
102 1. `yield`