xv6 is a modern re-implementation of Sixth Edition Unix in ANSI C for multiprocessor x86/x86_64 systems.
Go to file
Frans Kaashoek c440b5cd97 Use static assert instead of _LP64 (thanks Eddie!) 2012-09-10 21:58:18 -04:00
.cvsignore update .cvsignore 2008-10-15 04:54:24 +00:00
.dir-locals.el Setting indent-tabs-mode nil everywhere is dangerous 2011-09-05 15:22:16 -04:00
.gdbinit.tmpl Use the symbol file 2009-09-20 23:08:36 -04:00
.gitignore Sync up clean and gitignore better 2011-09-05 15:21:40 -04:00
BUGS sh 2007-09-05 15:55:43 +00:00
LICENSE Add MIT license file; update xv6-rev2.tar.gz with LICENSE. 2009-05-26 16:58:33 +00:00
Makefile Remove -m32 flag from native gcc compiler 2012-09-07 17:39:04 -04:00
Notes nit in console interrupts 2006-09-07 00:00:33 +00:00
README nits 2012-08-28 14:11:23 -04:00
TRICKS more doc tweaks 2009-07-12 18:33:37 -07:00
asm.h add some comments 2010-08-05 21:16:55 -04:00
bio.c don't let dirty blocks be evicted from cache! 2011-10-14 10:23:23 -04:00
bootasm.S comment nits 2011-09-12 14:27:14 -04:00
bootmain.c Make the ELF entry point a physical address 2011-09-04 15:51:46 -04:00
buf.h Revert "Introduce and use sleeplocks instead of BUSY flags" 2011-08-29 17:18:40 -04:00
cat.c more consistent spacing 2007-08-28 18:32:08 +00:00
console.c Remove unused 'state' variable that broke the build in recent gcc's 2011-09-07 16:39:27 -04:00
cuth delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
defs.h Merge branch 'master' of git+ssh://amsterdam.csail.mit.edu/home/am0/6.828/xv6 2012-08-22 20:20:17 -04:00
dot-bochsrc make bochsrc work for bochs 2.2.6 2008-09-03 14:10:47 +00:00
echo.c Remove puts in favor of printf. 2007-08-24 20:03:40 +00:00
elf.h Make elf proghdr fields match what objdump prints 2011-08-17 20:23:36 -04:00
entry.S more regular kmap[] and description 2011-09-13 12:28:45 -04:00
entryother.S Fix stale comments in entryother.S 2011-09-04 15:56:16 -04:00
exec.c Remove unused argument to setupkvm (thanks to Peter Froehlich) 2012-08-22 20:19:37 -04:00
fcntl.h nit 2007-08-28 04:13:24 +00:00
file.c don't let dirty blocks be evicted from cache! 2011-10-14 10:23:23 -04:00
file.h clarify some FS comments 2011-10-11 06:41:37 -04:00
forktest.c Initial version of single-cpu xv6 with page tables 2010-07-02 14:51:53 -04:00
fs.c more FS comment clarification 2011-10-11 10:11:53 -04:00
fs.h clarify some FS comments 2011-10-11 06:41:37 -04:00
gdbutil GDB utilities 2009-11-23 17:47:57 -05:00
grep.c add grep; add lost echo 2007-08-28 04:26:34 +00:00
ide.c make the book happy 2012-08-28 14:41:08 -04:00
init.c group locks into structs they protect. 2009-05-31 05:12:21 +00:00
initcode.S Remove sys_init syscall 2011-08-22 20:05:15 -04:00
ioapic.c trap cleanup 2009-07-11 19:24:56 -07:00
kalloc.c eliminate enter_alloc -- use kalloc for everything 2011-09-13 13:14:52 -04:00
kbd.c be consistent: no underscores in function names 2009-03-08 22:07:13 +00:00
kbd.h formatting; split kbd constants into kbd.h 2007-08-14 19:31:16 +00:00
kernel.ld Nuke data.S, since we do have a custom linker script. 2011-09-02 14:51:55 -04:00
kill.c tab police 2009-05-31 00:39:17 +00:00
lapic.c Remove unused argument from lapicinit (thanks to Peter Froehlich) 2012-08-22 20:13:43 -04:00
ln.c add ln 2007-08-22 05:54:55 +00:00
log.c don't let dirty blocks be evicted from cache! 2011-10-14 10:23:23 -04:00
ls.c Remove puts in favor of printf. 2007-08-24 20:03:40 +00:00
main.c Remove unused argument from lapicinit (thanks to Peter Froehlich) 2012-08-22 20:13:43 -04:00
memide.c missing file memide.c 2011-01-11 13:54:23 -05:00
memlayout.h more regular kmap[] and description 2011-09-13 12:28:45 -04:00
mkdir.c more consistent spacing 2007-08-28 18:32:08 +00:00
mkfs.c Use static assert instead of _LP64 (thanks Eddie!) 2012-09-10 21:58:18 -04:00
mmu.h Fix layout issues for printed version 2011-09-01 10:25:20 -04:00
mp.c Avoid "boot" in xv6 2011-08-15 20:11:13 -04:00
mp.h Simplify MP hardware code. 2007-08-27 22:53:31 +00:00
param.h log write() data 2011-08-12 09:25:39 -04:00
picirq.c Get rid of the blank page in picirq.c. It misaligs things now. 2010-09-02 18:36:06 -04:00
pipe.c Revert "Introduce and use sleeplocks instead of BUSY flags" 2011-08-29 17:18:40 -04:00
pr.pl remove //DOC in the right place 2009-07-12 19:07:30 -07:00
printf.c spaces around else for rtm 2007-08-28 18:37:41 +00:00
printpcs Various fixes and improvements to printpcs 2012-08-24 14:51:52 -04:00
proc.c Remove unused argument to setupkvm (thanks to Peter Froehlich) 2012-08-22 20:19:37 -04:00
proc.h junk 2012-08-28 12:57:05 -04:00
rm.c more consistent spacing 2007-08-28 18:32:08 +00:00
runoff Fetch nice font from font branch, if possible 2011-09-07 12:38:24 -04:00
runoff.list Remove data.S from runoff, too 2011-09-02 14:52:53 -04:00
runoff.spec Note about the meaning of sheet1 in runoff.spec 2011-09-05 21:52:50 -04:00
runoff1 xv6: formatting, cleanup, rev5 (take 2) 2011-02-19 21:17:55 -05:00
sh.c move jkstack to main.c 2010-08-05 14:15:03 -04: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
sleep1.p Model verifying that wakeup really 2007-10-12 04:21:04 +00:00
spinlock.c Revert "Introduce and use sleeplocks instead of BUSY flags" 2011-08-29 17:18:40 -04:00
spinlock.h Revert "Introduce and use sleeplocks instead of BUSY flags" 2011-08-29 17:18:40 -04:00
spinp Model verifying that wakeup really 2007-10-12 04:21:04 +00:00
stat.h junk 2012-08-28 12:57:05 -04:00
stressfs.c Update stressfs to trigger race now the logging code serializes writes 2011-09-27 12:59:47 -04:00
string.c Use stosl in memset; makes boot time bearable 2011-09-01 10:41:27 -04:00
swtch.S move jkstack to main.c 2010-08-05 14:15:03 -04:00
symlink.patch symlink implementation 2007-08-30 18:36:38 +00:00
syscall.c Remove left-over from some logging plan making complete syscalls atomic 2012-08-22 20:28:58 -04:00
syscall.h Remove left-over from some logging plan making complete syscalls atomic 2012-08-22 20:28:58 -04:00
sysfile.c Make fetchint and fetchstr use proc instead of taking a struct proc 2012-02-17 23:20:13 -05:00
sysproc.c Avoid "boot" in xv6 2011-08-15 20:11:13 -04:00
timer.c shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
toc.ftr Update index example in TOC footer 2011-09-02 16:30:20 -04:00
toc.hdr nits 2007-08-28 18:23:48 +00:00
trap.c Map kernel high 2011-07-29 07:31:27 -04:00
trapasm.S One definition of several macros and constants 2011-08-08 13:30:08 -04:00
traps.h kill TLB shoot down code 2010-07-28 14:38:05 -04:00
types.h some cleanup 2010-07-25 20:30:21 -04:00
uart.c shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
ulib.c make new code like old code 2011-01-11 13:01:13 -05:00
umalloc.c make new code like old code 2011-01-11 13:01:13 -05:00
user.h make new code like old code 2011-01-11 13:01:13 -05:00
usertests.c Fix compile error on newer gcc's 2011-09-30 15:28:33 -04:00
usys.S uptime() sys call for benchmarking 2010-08-11 14:34:45 -04:00
vectors.pl sync with c; .text is implied 2009-05-31 01:00:38 +00:00
vm.c nits 2012-08-28 14:11:23 -04:00
wc.c junk 2012-08-28 12:57:05 -04:00
x86.h Remove unused x86.h definitions 2011-09-02 14:52:13 -04: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.

ACKNOWLEDGMENTS

xv6 is inspired by John Lions's 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/2012/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 (entryother.S, mp.h, mp.c, lapic.c)
    FreeBSD (ioapic.c)
    NetBSD (console.c)

The following people have made contributions:
    Russ Cox (context switching, locking)
    Cliff Frey (MP)
    Xiao Yu (MP)
    Nickolai Zeldovich
    Austin Clements

In addition, we are grateful for the patches contributed by Greg
Price, Yandong Mao, and Hitoshi Mitake.

The code in the files that constitute xv6 is
Copyright 2006-2012 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). 

BUILDING 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/2012/tools.html.
Then run "make TOOLPREFIX=i386-jos-elf-".

To run xv6, you can use the Bochs or QEMU 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".

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