xref: /xv6-public/README (revision 792d83ca)
1xv6 is a re-implementation of Dennis Ritchie's and Ken Thompson's Unix
2Version 6 (v6).  xv6 loosely follows the structure and style of v6,
3but is implemented for a modern x86-based multiprocessor using ANSI C.
4
5ACKNOWLEDGMENTS
6
7xv6 is inspired by John Lions's Commentary on UNIX 6th Edition (Peer
8to Peer Communications; ISBN: 1-57398-013-7; 1st edition (June 14,
92000)). See also http://pdos.csail.mit.edu/6.828/2012/v6.html, which
10provides pointers to on-line resources for v6.
11
12xv6 borrows code from the following sources:
13    JOS (asm.h, elf.h, mmu.h, bootasm.S, ide.c, console.c, and others)
14    Plan 9 (entryother.S, mp.h, mp.c, lapic.c)
15    FreeBSD (ioapic.c)
16    NetBSD (console.c)
17
18The following people have made contributions:
19    Russ Cox (context switching, locking)
20    Cliff Frey (MP)
21    Xiao Yu (MP)
22    Nickolai Zeldovich
23    Austin Clements
24
25In addition, we are grateful for the patches contributed by Greg
26Price, Yandong Mao, and Hitoshi Mitake.
27
28The code in the files that constitute xv6 is
29Copyright 2006-2012 Frans Kaashoek, Robert Morris, and Russ Cox.
30
31ERROR REPORTS
32
33If you spot errors or have suggestions for improvement, please send
34email to Frans Kaashoek and Robert Morris (kaashoek,rtm@csail.mit.edu).
35
36BUILDING AND RUNNING XV6
37
38To build xv6 on an x86 ELF machine (like Linux or FreeBSD), run "make".
39On non-x86 or non-ELF machines (like OS X, even on x86), you will
40need to install a cross-compiler gcc suite capable of producing x86 ELF
41binaries.  See http://pdos.csail.mit.edu/6.828/2012/tools.html.
42Then run "make TOOLPREFIX=i386-jos-elf-".
43
44To run xv6, you can use the Bochs or QEMU PC simulators. Bochs makes
45debugging easier, but QEMU is much faster. To run in Bochs, run "make
46bochs" and then type "c" at the bochs prompt. To run in QEMU, run
47"make qemu".
48
49To create a typeset version of the code, run "make xv6.pdf".  This
50requires the "mpage" utility.  See http://www.mesa.nl/pub/mpage/.
51