Go to file
Austin Clements b0170c4b82 GDB utilities 2009-11-23 17:47:57 -05:00
web more doc tweaks 2009-07-12 18:33:37 -07:00
.cvsignore update .cvsignore 2008-10-15 04:54:24 +00:00
.gdbinit.tmpl Use the symbol file 2009-09-20 23:08:36 -04:00
.gitignore ignore .gitignore 2009-09-15 17:21:02 -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
LucidaSans-Typewriter83 add nice font 2008-08-20 18:00:24 +00:00
Makefile Add the test we used in lecture to creash the IDE system when the 2009-11-23 17:27:26 -05:00
Notes nit in console interrupts 2006-09-07 00:00:33 +00:00
README undo 2009-07-12 15:28:14 -04:00
TRICKS more doc tweaks 2009-07-12 18:33:37 -07:00
asm.h continuous quality management 2007-08-31 19:55:27 +00:00
bio.c group locks into structs they protect. 2009-05-31 05:12:21 +00:00
bootasm.S bootasm cleanup 2009-07-11 19:15:32 -07:00
bootmain.c xv6: boot loader adjustments 2009-03-08 21:41:30 +00:00
bootother.S shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
buf.h Another attempt at the bio.c comment. 2007-08-27 14:09:30 +00:00
cat.c more consistent spacing 2007-08-28 18:32:08 +00:00
console.c Handle backspace on serial input and output better. Better solutions are welcome. 2009-09-30 22:32:50 -04:00
cuth delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
defs.h Remove memcpy prototypes at Russ' request to prevent code from calling 2009-10-07 13:06:55 -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 shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
exec.c assorted fixes: 2009-08-30 23:02:08 -07:00
fcntl.h nit 2007-08-28 04:13:24 +00:00
file.c shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
file.h shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
forktest.c test that fork fails gracefully 2007-08-24 20:20:23 +00:00
fs.c Comment typo 2009-10-24 21:31:01 -04:00
fs.h drop NADDRS and INDIRECT; too many names 2009-05-31 00:59:37 +00: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 assorted fixes: 2009-08-30 23:02:08 -07:00
init.c group locks into structs they protect. 2009-05-31 05:12:21 +00:00
initcode.S rearrangements and cleanup for text 2009-07-11 19:26:01 -07:00
ioapic.c trap cleanup 2009-07-11 19:24:56 -07:00
kalloc.c rearrangements and cleanup for text 2009-07-11 19:26:01 -07: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
kill.c tab police 2009-05-31 00:39:17 +00:00
lapic.c lapic: disable microdelay because it makes Bochs slow 2009-09-02 10:06:37 -07: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 another attempt at cpu-local variables. 2009-09-02 10:07:59 -07:00
mkdir.c more consistent spacing 2007-08-28 18:32:08 +00:00
mkfs.c drop NADDRS and INDIRECT; too many names 2009-05-31 00:59:37 +00:00
mmu.h assorted fixes: 2009-08-30 23:02:08 -07:00
mp.c assorted fixes: 2009-08-30 23:02:08 -07: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 shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
pipe.c assorted fixes: 2009-08-30 23:02:08 -07: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
proc.c nit in comment 2009-09-20 20:19:58 -04:00
proc.h fine-tune comment 2009-10-07 17:42:14 -04:00
rm.c more consistent spacing 2007-08-28 18:32:08 +00:00
runoff shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
runoff.list add uart.c 2009-09-15 19:15:48 -04:00
runoff.spec shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
runoff1 remove //DOC in the right place 2009-07-12 19:07:30 -07:00
sh.c clumsy cd 2007-08-30 18:30:26 +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
sleep1.p Model verifying that wakeup really 2007-10-12 04:21:04 +00:00
spinlock.c assorted fixes: 2009-08-30 23:02:08 -07:00
spinlock.h assorted fixes: 2009-08-30 23:02:08 -07:00
spinp Model verifying that wakeup really 2007-10-12 04:21:04 +00:00
stat.h move T_DIR etc into stat.h; move type up 2009-05-31 00:26:10 +00:00
stressfs.c Add the test we used in lecture to creash the IDE system when the 2009-11-23 17:27:26 -05:00
string.c Remove memcpy prototypes at Russ' request to prevent code from calling 2009-10-07 13:06:55 -04:00
swtch.S initproc, usegment, swtch tweaks 2009-07-11 19:28:29 -07:00
symlink.patch symlink implementation 2007-08-30 18:36:38 +00:00
syscall.c assorted fixes: 2009-08-30 23:02:08 -07:00
syscall.h Replace yield system call with sleep. 2007-08-27 13:34:35 +00:00
sysfile.c assorted fixes: 2009-08-30 23:02:08 -07:00
sysproc.c assorted fixes: 2009-08-30 23:02:08 -07:00
timer.c shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
toc.ftr assorted fixes: 2009-08-30 23:02:08 -07:00
toc.hdr nits 2007-08-28 18:23:48 +00:00
trap.c formatting tweaks 2009-09-03 00:46:15 -07:00
trapasm.S initproc, usegment, swtch tweaks 2009-07-11 19:28:29 -07:00
traps.h s/IRQ_OFFSET/T_IRQ0/: it's a trap number, not an irq number. 2009-07-11 18:17:32 -07:00
types.h align 2007-08-24 20:27:47 +00:00
uart.c shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
ulib.c xv6: use stosb for memset 2009-03-08 21:38:30 +00:00
umalloc.c spaces around else for rtm 2007-08-28 18:37:41 +00:00
user.h Remove memcpy prototypes at Russ' request to prevent code from calling 2009-10-07 13:06:55 -04:00
usertests.c group locks into structs they protect. 2009-05-31 05:12:21 +00:00
usys.S usys.S: put before init.c, STUB -> SYSCALL 2009-05-31 02:14:04 +00:00
vectors.pl sync with c; .text is implied 2009-05-31 01:00:38 +00:00
wc.c more consistent spacing 2007-08-28 18:32:08 +00:00
x86.h can set just %gs now. 2009-09-02 10:09:34 -07:00
xv6-rev0.tar.gz dist tarball 2006-09-08 15:44:42 +00:00
xv6-rev1.tar.gz DO NOT MAIL: xv6-rev1 2007-08-30 14:11:21 +00:00
xv6-rev2.tar.gz Add MIT license file; update xv6-rev2.tar.gz with LICENSE. 2009-05-26 16:58:33 +00:00
xv6-rev3.tar.gz add .gdbinit.tmpl to dist 2009-09-15 19:15:59 -04:00
xv6.pdf new pdf 2009-09-03 00:46:28 -07:00
xv6.ps new pdf 2009-09-03 00:46:28 -07: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/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, 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). 

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/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/.