Rusty Russell 996ba96a97 lguest: Fix in/out emulation 14 years ago
..
x86 996ba96a97 lguest: Fix in/out emulation 14 years ago
Kconfig 6151658751 Correct occurrences of 14 years ago
Makefile 6151658751 Correct occurrences of 14 years ago
README f938d2c892 lguest: documentation I: Preparation 18 years ago
core.c 9f54288def lguest: update comments 14 years ago
hypercalls.c a91d74a3c4 lguest: update commentry 16 years ago
interrupts_and_traps.c 9f54288def lguest: update comments 14 years ago
lg.h 5dea1c88ed lguest: use a special 1:1 linear pagetable mode until first switch. 14 years ago
lguest_device.c 3c3ed482dc lguest: Simplify device initialization. 14 years ago
lguest_user.c 9f54288def lguest: update comments 14 years ago
page_tables.c 9f54288def lguest: update comments 14 years ago
segments.c 3e27249c84 lguest: fix bug in setting guest GDT entry 15 years ago

README

Welcome, friend reader, to lguest.

Lguest is an adventure, with you, the reader, as Hero. I can't think of many
5000-line projects which offer both such capability and glimpses of future
potential; it is an exciting time to be delving into the source!

But be warned; this is an arduous journey of several hours or more! And as we
know, all true Heroes are driven by a Noble Goal. Thus I offer a Beer (or
equivalent) to anyone I meet who has completed this documentation.

So get comfortable and keep your wits about you (both quick and humorous).
Along your way to the Noble Goal, you will also gain masterly insight into
lguest, and hypervisors and x86 virtualization in general.

Our Quest is in seven parts: (best read with C highlighting turned on)

I) Preparation
- In which our potential hero is flown quickly over the landscape for a
taste of its scope. Suitable for the armchair coders and other such
persons of faint constitution.

II) Guest
- Where we encounter the first tantalising wisps of code, and come to
understand the details of the life of a Guest kernel.

III) Drivers
- Whereby the Guest finds its voice and become useful, and our
understanding of the Guest is completed.

IV) Launcher
- Where we trace back to the creation of the Guest, and thus begin our
understanding of the Host.

V) Host
- Where we master the Host code, through a long and tortuous journey.
Indeed, it is here that our hero is tested in the Bit of Despair.

VI) Switcher
- Where our understanding of the intertwined nature of Guests and Hosts
is completed.

VII) Mastery
- Where our fully fledged hero grapples with the Great Question:
"What next?"

make Preparation!
Rusty Russell.