WSL2-Linux-Kernel/drivers/lguest
Linus Torvalds fb9fc39517 Merge branch 'xen-upstream' of git://git.kernel.org/pub/scm/linux/kernel/git/jeremy/xen
* 'xen-upstream' of git://git.kernel.org/pub/scm/linux/kernel/git/jeremy/xen:
  xfs: eagerly remove vmap mappings to avoid upsetting Xen
  xen: add some debug output for failed multicalls
  xen: fix incorrect vcpu_register_vcpu_info hypercall argument
  xen: ask the hypervisor how much space it needs reserved
  xen: lock pte pages while pinning/unpinning
  xen: deal with stale cr3 values when unpinning pagetables
  xen: add batch completion callbacks
  xen: yield to IPI target if necessary
  Clean up duplicate includes in arch/i386/xen/
  remove dead code in pgtable_cache_init
  paravirt: clean up lazy mode handling
  paravirt: refactor struct paravirt_ops into smaller pv_*_ops
2007-10-17 11:10:11 -07:00
..
Kconfig lguest should depend on CONFIG_FUTEX 2007-08-23 21:23:33 -07:00
Makefile lguest: documentation I: Preparation 2007-07-26 11:35:16 -07:00
README lguest: documentation I: Preparation 2007-07-26 11:35:16 -07:00
core.c paravirt: refactor struct paravirt_ops into smaller pv_*_ops 2007-10-16 11:51:29 -07:00
hypercalls.c Provide timespec to guests rather than jiffies clock. 2007-07-28 19:54:33 -07:00
interrupts_and_traps.c Fix lguest page-pinning logic ("lguest: bad stack page 0xc057a000") 2007-08-30 09:58:22 -07:00
io.c lguest: documentation VII: FIXMEs 2007-07-26 11:35:17 -07:00
lg.h Provide timespec to guests rather than jiffies clock. 2007-07-28 19:54:33 -07:00
lguest.c Merge branch 'xen-upstream' of git://git.kernel.org/pub/scm/linux/kernel/git/jeremy/xen 2007-10-17 11:10:11 -07:00
lguest_asm.S fix modules oopsing in lguest guests 2007-09-25 08:51:04 -07:00
lguest_bus.c paravirt: refactor struct paravirt_ops into smaller pv_*_ops 2007-10-16 11:51:29 -07:00
lguest_user.c lguest: documentation IV: Launcher 2007-07-26 11:35:17 -07:00
page_tables.c lguest: documentation VII: FIXMEs 2007-07-26 11:35:17 -07:00
segments.c lguest: Fix Malicious Guest GDT Host Crash 2007-08-09 08:14:56 -07:00
switcher.S lguest: Fix Malicious Guest GDT Host Crash 2007-08-09 08:14:56 -07:00

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.