Go to file
rsc c1b100e930 nits 2007-08-28 18:23:48 +00:00
.cvsignore New formatting scripts. 2006-09-05 15:50:55 +00:00
BUGS tweaks 2007-08-22 06:20:10 +00:00
Makefile oops 2007-08-28 17:48:44 +00:00
Notes nit in console interrupts 2006-09-07 00:00:33 +00:00
README not first anymore 2007-08-24 20:28:21 +00:00
asm.h wrap long lines 2006-09-06 19:08:14 +00:00
bio.c formatting 2007-08-28 05:00:53 +00:00
bootasm.S cmain -> bootmain 2007-08-28 13:01:10 +00:00
bootmain.c fix offsets 2007-08-28 18:04:43 +00:00
bootother.S more cmain -> bootmain 2007-08-28 18:02:49 +00:00
buf.h Another attempt at the bio.c comment. 2007-08-27 14:09:30 +00:00
cat.c nit 2007-08-28 04:13:24 +00:00
console.c nits 2007-08-28 18:23:48 +00:00
cuth delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
defs.h replace setjmp/longjmp with swtch 2007-08-28 12:48:33 +00:00
dev.h Change dev read/write functions 2007-08-28 17:49:49 +00:00
dot-bochsrc update 2006-07-26 10:17:39 +00:00
echo.c Remove puts in favor of printf. 2007-08-24 20:03:40 +00:00
elf.h clumsy blank pages to make some files align better 2007-08-28 05:00:39 +00:00
exec.c oops 2007-08-28 02:39:40 +00:00
fcntl.h nit 2007-08-28 04:13:24 +00:00
file.c remove _ from pipe; be like file 2007-08-28 04:22:35 +00:00
file.h Remove struct uinode. 2007-08-24 20:54:23 +00:00
forktest.c test that fork fails gracefully 2007-08-24 20:20:23 +00:00
fs.c Change dev read/write functions 2007-08-28 17:49:49 +00:00
fs.h comment nits 2007-08-24 19:52:49 +00:00
fsvar.h nits 2007-08-28 18:23:48 +00:00
grep.c add grep; add lost echo 2007-08-28 04:26:34 +00:00
ide.c nits 2007-08-28 18:23:48 +00:00
init.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
initcode.S Rename main0 to main. 2007-08-27 23:32:16 +00:00
ioapic.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
kalloc.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
kbd.c Move keyboard code into kbd.c; add backspace handling. 2007-08-28 03:28:13 +00:00
kbd.h formatting; split kbd constants into kbd.h 2007-08-14 19:31:16 +00:00
kill.c add kill 2007-08-08 08:50:23 +00:00
lapic.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
ln.c add ln 2007-08-22 05:54:55 +00:00
ls.c Remove puts in favor of printf. 2007-08-24 20:03:40 +00:00
main.c nits 2007-08-28 18:23:48 +00:00
mkdir.c more comments 2006-09-07 14:12:30 +00:00
mkfs.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
mmu.h formatting 2007-08-14 19:41:38 +00:00
mp.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
mp.h Simplify MP hardware code. 2007-08-27 22:53:31 +00:00
param.h simplify ide queuing 2007-08-24 19:32:36 +00:00
picirq.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
pipe.c formatting 2007-08-28 05:00:53 +00:00
pr.pl runoff changes 2006-09-08 13:53:18 +00:00
printf.c handle printf("%s\n", 0) 2007-08-28 04:15:35 +00:00
proc.c nit 2007-08-28 12:52:14 +00:00
proc.h replace setjmp/longjmp with swtch 2007-08-28 12:48:33 +00:00
rm.c fix error message 2007-08-08 09:30:58 +00:00
runoff nits 2007-08-28 18:23:48 +00:00
runoff.list replace setjmp/longjmp with swtch 2007-08-28 12:48:33 +00:00
runoff.spec nits 2007-08-28 05:01:04 +00:00
runoff1 PDF at http://am.lcs.mit.edu/~rsc/xv6.pdf 2007-08-22 06:01:32 +00:00
sh.c never returns! 2007-08-28 05:19:45 +00:00
show1 PDF at http://am.lcs.mit.edu/~rsc/xv6.pdf 2007-08-22 06:01:32 +00:00
sign.pl spacing fixes: no tabs, 2-space indents (for rtm) 2006-09-06 17:04:06 +00:00
spinlock.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
spinlock.h clumsy blank pages to make some files align better 2007-08-28 05:00:39 +00:00
stat.h more comments 2006-09-07 14:12:30 +00:00
string.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
swtch.S replace setjmp/longjmp with swtch 2007-08-28 12:48:33 +00:00
syscall.c make code match comment 2007-08-27 23:53:50 +00:00
syscall.h Replace yield system call with sleep. 2007-08-27 13:34:35 +00:00
sysfile.c remove _ from pipe; be like file 2007-08-28 04:22:35 +00:00
sysproc.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
timer.c rename 8253pit.c to timer.c 2007-08-28 04:40:58 +00:00
toc.ftr nits 2007-08-28 18:23:48 +00:00
toc.hdr nits 2007-08-28 18:23:48 +00:00
trap.c nits 2007-08-28 18:23:48 +00:00
trapasm.S nits 2007-08-28 18:23:48 +00:00
traps.h typo 2007-08-08 08:27:32 +00:00
types.h align 2007-08-24 20:27:47 +00:00
ulib.c Remove puts in favor of printf. 2007-08-24 20:03:40 +00:00
umalloc.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
user.h add struct stat decl 2007-08-28 04:20:25 +00:00
usertests.c test that fork fails gracefully 2007-08-24 20:20:23 +00:00
usys.S Replace yield system call with sleep. 2007-08-27 13:34:35 +00:00
vectors.pl PDF at http://am.lcs.mit.edu/~rsc/xv6.pdf 2007-08-22 06:01:32 +00:00
wc.c clean up Makefile; add wc 2007-08-28 04:20:40 +00:00
x86.h nits 2007-08-27 12:48:20 +00:00
xv6-rev0.tar.gz dist tarball 2006-09-08 15:44:42 +00:00
xv6.pdf sent to printer - CTC job 6955 40 copies 2006-09-08 15:55:26 +00:00
xv6.ps a copy of xv6.pdf that can be sent to turkey and duplexes correctly 2006-09-08 16:19:26 +00:00
zombie.c delete unnecessary #include lines 2007-08-27 23:26:33 +00:00

README

xv6 is a re-implementation of Dennis Ritchie's and Ken Thompson's Unix
Version 6 (v6).  xv6 loosely follows the structure and style of v6,
but is implemented for a modern x86-based multiprocessor using ANSI C.

ACKNOWLEDGEMENTS

xv6 is inspired by John Lions' Commentary on UNIX 6th Edition (Peer
to Peer Communications; ISBN: 1-57398-013-7; 1st edition (June 14,
2000)). See also http://pdos.csail.mit.edu/6.828/2007/v6.html, which
provides pointers to on-line resources for v6.

xv6 borrows code from the following sources:
    JOS (asm.h, elf.h, mmu.h, bootasm.S, ide.c, console.c, and others)
    Plan 9 (bootother.S, mp.h, mp.c, ioapic.h, lapic.c)
    FreeBSD (ioapic.c)
    NetBSD (console.c)

The following people made contributions:
    Russ Cox (context switching, locking)
    Cliff Frey (MP)
    Xiao Yu (MP)

The code in the files that constitute xv6 is
Copyright 2006-2007 Frans Kaashoek, Robert Morris, and Russ Cox.

ERROR REPORTS

If you spot errors or have suggestions for improvement, please send
email to Frans Kaashoek and Robert Morris
({kaashoek,rtm}@csail.mit.edu). 

BUIDLING AND RUNNING XV6

To build xv6 on an x86 ELF machine (like Linux or FreeBSD), run "make".
On non-x86 or non-ELF machines (like OS X, even on x86), you will
need to install a cross-compiler gcc suite capable of producing x86 ELF
binaries.  See http://pdos.csail.mit.edu/6.828/2007/tools.html.
Then run "make TOOLPREFIX=i386-jos-elf-".

To run xv6, you can use Bochs or QEMU, both PC simulators.  Bochs makes
debugging easier, but QEMU is much faster. 
To run in Bochs, run "make bochs" and then type "c" at the bochs prompt.
To run in QEMU, run "make qemu".  Both log the xv6 screen output to 
standard output.

To create a typeset version of the code, run "make xv6.pdf".
This requires the "mpage" text formatting utility.
See http://www.mesa.nl/pub/mpage/.