Osdev Notes

IMPORTANT: The developmen has moved to codeberg: https://codeberg.org/dreamportdev/Osdev-Notes, github repository will be left as a mirror, although we will still keep an eye there, we appreciate if future PR will be done on Codeberg.

A book, originated as a collection of notes, intended to guide a reader through the steps of building an operating system kernel from scratch. Written while writing (and re-writing) our own kernels, each chapter covers a step of the process from selecting a bootloader to running a loaded ELF in userspace.

We hope you enjoy, and find something interesting here!

The content of this repository is also available as a printed book, it can be purchased via Lulu:

• Paperback: Click here
• Hardcover: Click Here

The latest-master release contains the PDF built from master.

You can reach us on

• Discord: https://discord.gg/NGasazGkqr
• FLuxer: https://fluxer.gg/8L9eRwcy

Current Chapters:

• Part 0: Introduction
  • Assumed Knowledge
  • About The Authors
• Part 1: Building & Boot Protocols
  • Building a Kernel
  • Bootloaders and Boot Protocols
  • Makefiles
  • Linker Scripts
  • Generating a Bootable Iso
• Part 2: Architecture and Basic Drivers
  • Overview
  • Hello World
  • A Higher Half Kernel
  • Global Descriptor Table
  • Interrupts
  • ACPI Tables
  • APIC
  • Timers
  • PS2 Keyboard Overview
  • PS2 Keyboard Interrupt Handling
  • PS2 Keyboard Driver implementation
• Part 3: Video Output
  • The Framebuffer
  • Drawing Text on Framebuffer
• Part 4: Memory Management
  • Overview
  • Physical Memory
  • Paging
  • Virtual Memory Manager
  • Heap Allocation
• Part 5: Scheduling
  • Overview
  • The Scheduler
  • Processes and Threads
  • Locks
• Part 6: Getting to Userspace
  • Overview
  • Switching Modes
  • Updated Interrupt Handling
  • System Calls
  • Example Syscall ABI
  • Resource Management
• Part 7: Inter-Process Communication
  • Overview
  • Shared Memory
  • Message Passing
• Part 8: File System
  • Overview
  • The Virtual File System
  • The Tar File System
• Part 9: Loading & Executing ELFs
  • Theory
  • Loading and Running
• Part 10: Going Beyond
• Extras: Appendices
  • General Troubleshooting
  • Tips and Tricks
  • C Language
  • Working With NASM
  • All About Cross Compilers
  • Debugging
  • Memory Protection
  • Useful Resources
  • Acknowledgments

Our Projects

• DreamOs64: 64-bit OS written from scratch by Ivan G.
• Northport: Another 64-bit OS with SMP, and riscv support! by Dean T.
• DreamOs: 32-bit OS written from scratch. This project is discontinued, but it still worth mentioning. Also by Ivan G.

Authors

• Ivan G (dreamos82) - Author and creator of these notes.
• Dean T (DeanoBurrito) - Author.

License

The contents (code, text and other assets) of this repository are licensed under the Creative Commons Attribution-NonCommercial 4.0 Public License, see the LICENSE file for the full text.

While not legal advice, this license can be summed up as:

• You are free to share (copy and redistribute) this material in any medium or format.
• Adapt (remix, transform and build upon) the material.

Under the following restrictions:

• You must give appropriate credit, provide a link to the license, and indicate if changes were made.
• You cannot use the material for commercial uses.

Note that no warranties of any kind are provided.