1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
[](https://builds.sr.ht/~shrik3/rustubs/commits/master/x86_64.yml?)
# RuStuBS: a rust tutorial operating system inspired by OOStuBS.
This is a toy bare metal operation system implemented in Rust. Apologies for my
shitty code, I'm a rust beginner.
**Status / Roadmap**
- [ ] GDB support (qemu stub)
- [X] Basic code structure
- [X] Build minimal iso image
- [X] bootable using grub
- [X] Setting up CGA display, print something (hello world)
- [X] Intigrate print into rust println! etc.
- [X] Keyboard controller and input handler
- [?] Interrupt handler (WIP)
- linked list for plugbox
- implement plugbox
- interrupt handler code for kbd
- input buffer
- [ ] intrrupt sync
- split upper/lower half of handlers
- [ ] Threading
- stack allocator (could be trivial)
- define context
- implement switch/toc code
- [ ] Scheduler (single CPU)
- DS
- [ ] Timer Interrupt
- [ ] Synchronization Primitives
- implement waiting/wakeup
- [ ] asm! Wrappers for basic instructions
Beyond the original StuBS
- [ ] Task Descriptor structures
- [ ] Paging: PMA and paging structures
- [ ] Paging: pagefault handler
- [ ] user heap and mmap
- [ ] Upperhalf Kernel
- [ ] Address Space for each Process
- [ ] in memory FS
- [ ] user library
- [ ] syscall
- [ ] aarch64 support
## Build
Please take a look at the CI manifest:
`.builds/x86_64.yml`
**build dependencies**
- rust toolchain: `nightly-x86_64-unknown-linux-gnu`
- `cargo xbuild`, install with:
```
$ cargo install xbuild
```
- `rustfmt`, this should be shipped with your rust/cargo installation. If not,
install with
```
$ cargo install rustfmt
```
- `GNU ld (GNU Binutils)`
- `nasm`
- `xorriso` and `grub` to create bootdisk image.
- `Gnu Make`
**general dependencies:**
- `qemu-system-x86_64` (optional for simulation)
**Add rust sources**
- We use `no_std` in the rust build. To use the `core` components, you need to
add the rust sources by running e.g. `rustup component add rust-src`
**build and run**
- simply run `make`, you will get `bootdisk.iso`, which you can use to boot a
bare metal
- use `make qemu` to load and test the iso image with qemu
**troubleshooting**
- cargo xbuild hangs: try updating the default toolchain and rebuilding xbuild.
- `ld (Gnu Binutils) <=2.39` do not support `--no-warn-rwx-segments` flag. If
that's your case, remove it from the `LDFLAGS` in `Makefile`
- `grub-mkrescue` fails if you don't have the `piglatin` locale available.
Either pick one locale you have, or remove the `--locale` option for
`grub-mkrescue` in `Makefile`. (If you don't specify one locale, all will be
installed, resulting in a unnecessarily huge image).
## Structure
```
.
├── boot # early boot/startup code
├── defs # specs for target arch, linking and compiler
├── docs # namely
├── isofiles # assets for the grub generated iso
├── src # main source code
```
# License & Copyright:
This project is licensed under **EUPL 1.2.**. See `LICENSE` and `ATTRIBUTIONS`.
**Notes on OOStuBS**
The OOStuBS, which this project takes inspirations from, doesn't allow
re-distribution without written consent from its copyright holders. This project
contains some small pieces of boilerplate code and comments from OOStuBS (such
as initializing the GDT). These are generic enough that the OOStuBS copyright
shouldn't apply (also see below for details). Also I'll gradually get rid of
such snippets.
# Remarks
**Relationship w. OOStuBS**
This project is inspired by OOStuBS. It started as a mere copy, but the path
quickly diverged.
> The third stage masks the absence of a profound reality, where the sign
> pretends to be a faithful copy, but it is a copy with no original. Signs and
> images claim to represent something real, but no representation is taking
> place and arbitrary images are merely suggested as things which they have no
> relationship to. -- Baudrillard, Jean (1981). Simulacres et simulation
- This project DOES NOT try to complete and/or disclose the solutions to OOStuBS
lab assignments. (There are indeed overlapping parts, but it would be the same
amount of difficulty, if not more difficult, to read, understand and
translate rust code into the OOStuBS CPP code, than to read manuals and write
CPP code yourself).
- This project DOES NOT aim to be a 1:1 port. (i.e. do the same thing but in
rust).
- The "OO" (objekt orientiert) aspect is torn. The OOP concept creates an illusion
that "data" and "code" magically belong to "object", which is never the case.
I personally prefer NOT to use too much OOP in system programming.
**Relationship w. [rstubs](https://www.sra.uni-hannover.de/Lehre/WS23/L_BST/rdoc/rstubs/)**
NONE. This project has nothing to do the Uni Hannover rstubs project, a OOStuBS
spin-off written in rust. As a matter of fact, I didn't know its existence until
I accidentally came across it recently. People come up with similar ideas, it
happens.
**Why not projects like [blog_os](https://os.phil-opp.com/)?**
firstly, because it's my own practice. "What I can't create, I don't understand".
Secondly, the newest revision of *blog_os* can only be booted with BIOS, not
UEFI. And the complexity (e.g. the sartup.s) is hidden behind the `bootimage`,
I feel necessary to go through the painful part.
**Your code sucks**
yes.
**Helper docs**
x86_64 calling conventions
https://aaronbloomfield.github.io/pdr/book/x86-64bit-ccc-chapter.pdf
Rust inline asm
https://rust-lang.github.io/rfcs/2873-inline-asm.html
asm Syntax : (we use nasm in assembly and .intel_syntax noprefix in rust asm)
https://en.wikipedia.org/wiki/X86_assembly_language#Syntax
naming conventions
https://rust-lang.github.io/api-guidelines/naming.html
Makefile Cheatsheet:
https://devhints.io/makefile
AT Keyboard Controller:
https://homepages.cwi.nl/~aeb/linux/kbd/scancodes-8.html
PS/2 Keyboard Controller:
https://wiki.osdev.org/PS/2_Keyboard
TU Dresden OSC labs (the baseline for this project):
https://tu-dresden.de/ing/informatik/sya/professur-fuer-betriebssysteme/studium/vorlesungen/betriebssystembau/lab-tasks
Unwinding the stack the hard way
https://lesenechal.fr/en/linux/unwinding-the-stack-the-hard-way
|
