Vision

This project's vision is to help every student read all the code of a teaching operating system.

With only 2000 lines of code, egos-2000 implements every component of an operating system for education. It can run on RISC-V boards and the QEMU software emulator.

# The cloc utility is used to count the lines of code.
> cloc egos-2000 --exclude-ext=md,txt,toml,json  # excluding text files
...
github.com/AlDanial/cloc v 1.94  T=0.05 s (949.3 files/s, 62349.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
C                               31            423            509           1600
C/C++ Header                     9             63             99            259
Assembly                         3             15             49             92
make                             1             15              4             49
-------------------------------------------------------------------------------
SUM:                            44            516            661           2000 (exactly!)
-------------------------------------------------------------------------------

Earth and Grass Operating System

The egos part of egos-2000 is named after its three-layer architecture.

• The earth layer implements hardware-specific abstractions.
  • tty and disk device interface
  • timer and memory management interface
• The grass layer implements hardware-independent abstractions.
  • process control block and system call interface
• The application layer implements file system, shell and user commands.

The definitions of struct earth and struct grass in header file egos.h specify the layer interface. Please read USAGES.md for running egos-2000 and the instruction set manual for the RISC-V privileged ISA.

Acknowledgements

Many thanks to Meta for a Facebook fellowship. Many thanks to Robbert van Renesse, Lorenzo Alvisi, Shan Lu, Hakim Weatherspoon and Christopher Batten for their support. Many thanks to all the CS5411/4411 students at Cornell University over the years for helping improve this course. Many thanks to Cheng Tan for providing valuable feedback and using egos-2000 in CS6640 at Northeastern University. Many thanks to Brandon Fusi for porting to the Allwinner's D1 chip using Sipeed's Lichee RV64 compute module.

For any questions, please contact Yunhao Zhang.