xv6-cs450

Go to file

rsc 2c88030df0 dist tarball		2006-09-08 15:44:42 +00:00
.cvsignore	New formatting scripts.	2006-09-05 15:50:55 +00:00
8253pit.c	xv6 style	2006-09-08 14:41:18 +00:00
asm.h	wrap long lines	2006-09-06 19:08:14 +00:00
bio.c	debugging help	2006-09-07 16:54:28 +00:00
bootasm.S	shorten	2006-09-08 15:31:23 +00:00
bootmain.c	wrap long lines	2006-09-06 19:08:14 +00:00
bootother.S	wrap long lines	2006-09-06 19:08:14 +00:00
buf.h	some comment changes	2006-09-08 14:36:44 +00:00
cat.c	standardize various * conventions	2006-09-06 17:27:19 +00:00
console.c	debugging rearrangements	2006-09-07 16:52:13 +00:00
defs.h	unnecessary struct jmpbuf	2006-09-08 15:31:18 +00:00
dev.h	remove _ prefixes	2006-09-07 13:08:23 +00:00
dot-bochsrc	update	2006-07-26 10:17:39 +00:00
echo.c	i/o redirection in sh	2006-08-23 01:09:24 +00:00
elf.h	more comments	2006-09-07 14:12:30 +00:00
fcntl.h	low-level keyboard input (not hooked up to /dev yet)	2006-08-10 02:07:10 +00:00
file.c	stop using fd to name files	2006-09-08 13:44:42 +00:00
file.h	fd.* -> file.*	2006-09-06 18:40:28 +00:00
fs.c	some comment changes	2006-09-08 14:36:44 +00:00
fs.h	tweak fs.h spacing; add comment	2006-09-08 14:31:17 +00:00
fsvar.h	comments	2006-09-07 15:31:33 +00:00
ide.c	move ide_intr lower	2006-09-08 14:33:27 +00:00
init.c	some comment changes	2006-09-08 14:36:44 +00:00
ioapic.c	formatting nits	2006-09-08 15:14:43 +00:00
ioapic.h	wrap long lines	2006-09-06 19:08:14 +00:00
kalloc.c	some comment changes	2006-09-08 14:36:44 +00:00
lapic.c	formatting nits	2006-09-08 15:14:43 +00:00
ls.c	remove _ prefixes	2006-09-07 13:08:23 +00:00
main.c	formatting nits	2006-09-08 15:14:43 +00:00
Makefile	dist rules	2006-09-08 14:41:06 +00:00
mkdir.c	more comments	2006-09-07 14:12:30 +00:00
mkfs.c	quiet	2006-09-08 13:44:56 +00:00
mmu.h	better comment	2006-09-07 16:54:15 +00:00
mp.c	nit	2006-09-08 15:15:44 +00:00
mp.h	wrap long lines	2006-09-06 19:08:14 +00:00
Notes	nit in console interrupts	2006-09-07 00:00:33 +00:00
param.h	struct fd -> struct file	2006-09-06 18:38:56 +00:00
picirq.c	fix ide, pit interfaces	2006-09-07 15:29:54 +00:00
pipe.c	stop using fd to name files	2006-09-08 13:44:42 +00:00
pr.pl	runoff changes	2006-09-08 13:53:18 +00:00
printf.c	no /* */ comments	2006-09-06 17:50:20 +00:00
proc.c	move growproc up higher	2006-09-08 14:26:51 +00:00
proc.h	more comments	2006-09-07 14:12:30 +00:00
README	minor makefile fixes for printing	2006-09-07 21:03:13 +00:00
rm.c	standardize various * conventions	2006-09-06 17:27:19 +00:00
runoff	tweaks	2006-09-08 14:40:59 +00:00
runoff.list	run without lapic and ioapic, if they are not present	2006-09-07 01:37:58 +00:00
runoff1	tweaks	2006-09-08 14:40:59 +00:00
setjmp.S	make setjmp fit on one page	2006-09-08 14:20:43 +00:00
sh.c	more simplifying	2006-09-07 03:16:15 +00:00
sign.pl	spacing fixes: no tabs, 2-space indents (for rtm)	2006-09-06 17:04:06 +00:00
spinlock.c	make lines shorter	2006-09-08 15:18:58 +00:00
spinlock.h	more comments	2006-09-07 14:12:30 +00:00
stat.h	more comments	2006-09-07 14:12:30 +00:00
string.c	standardize various * conventions	2006-09-06 17:27:19 +00:00
syscall.c	refactor syscall code	2006-09-07 14:13:26 +00:00
syscall.h	refactor syscall code	2006-09-07 14:13:26 +00:00
sysfile.c	fix ide, pit interfaces	2006-09-07 15:29:54 +00:00
sysproc.c	refactor syscall code	2006-09-07 14:13:26 +00:00
toc.ftr	fix toc example	2006-09-08 15:39:24 +00:00
toc.hdr	runoff changes	2006-09-08 13:53:18 +00:00
trap.c	tweak	2006-09-08 15:34:04 +00:00
trapasm.S	standardize various * conventions	2006-09-06 17:27:19 +00:00
traps.h	more comments	2006-09-07 14:12:30 +00:00
types.h	uint32_t -> uint &c	2006-07-20 09:07:53 +00:00
ulib.c	break single-line if statements	2006-09-06 17:57:47 +00:00
umalloc.c	standardize various * conventions	2006-09-06 17:27:19 +00:00
user.h	standardize various * conventions	2006-09-06 17:27:19 +00:00
usertests.c	fix tests	2006-09-07 20:06:08 +00:00
usys.S	standardize various * conventions	2006-09-06 17:27:19 +00:00
vectors.pl	no /* */ comments	2006-09-06 17:50:20 +00:00
x86.h	more comments	2006-09-07 14:12:30 +00:00
xv6-rev0.tar.gz	dist tarball	2006-09-08 15:44:42 +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/2006/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 are 
Copyright 2006 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).  This version is the very first one,
so don't be surprised if there are errors or the code is unclear.

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