Go to file
Frans Kaashoek d10d324e79 Remove sys_init syscall
Invoke initlog from forkret on first user process
2011-08-22 20:05:15 -04:00
web web: rev5 2011-02-19 21:21:49 -05: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 Russ's fix for panic remap 2011-04-28 08:01:36 -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 Update make clean 2011-08-15 20:32:04 -04:00
Notes nit in console interrupts 2006-09-07 00:00:33 +00:00
README Make Austin happier 2011-08-15 20:21:14 -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 a few nits 2010-07-23 12:52:50 -04:00
bootasm.S One definition of several macros and constants 2011-08-08 13:30:08 -04:00
bootmain.c bootloader reads into a physical address (not a virtual address) 2011-08-17 20:52:28 -04: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 Map kernel high 2011-07-29 07:31:27 -04:00
cuth delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
data.S Russ's fix for panic remap 2011-04-28 08:01:36 -04:00
defs.h Clean up memlayout.h 2011-08-16 15:47:22 -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 Avoid "boot" in xv6 2011-08-15 20:11:13 -04:00
entryother.S Avoid "boot" in xv6 2011-08-15 20:11:13 -04:00
exec.c Make elf proghdr fields match what objdump prints 2011-08-17 20:23:36 -04:00
fcntl.h nit 2007-08-28 04:13:24 +00:00
file.c avoid deadlock by calling begin_trans() before locking any inodes 2011-08-15 12:44:20 -04:00
file.h shuffle and tweak for formatting. 2009-08-08 01:07:30 -07:00
forktest.c Initial version of single-cpu xv6 with page tables 2010-07-02 14:51:53 -04:00
fs.c make dirlookup and dirlink more similar 2011-08-19 13:30:57 -04:00
fs.h Dirt simple logging 2011-07-27 20:35:46 -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 Map kernel high 2011-07-29 07:31:27 -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 delete dead code 2011-08-21 21:14:29 -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 oops 2011-08-07 12:30:34 -04:00
kill.c tab police 2009-05-31 00:39:17 +00:00
lapic.c Clean up memlayout.h 2011-08-16 15:47:22 -04:00
ln.c add ln 2007-08-22 05:54:55 +00:00
log.c Only commit log to disk if something was written in to it. 2011-08-15 14:12:35 -04:00
ls.c Remove puts in favor of printf. 2007-08-24 20:03:40 +00:00
main.c Remove sys_init syscall 2011-08-22 20:05:15 -04:00
memide.c missing file memide.c 2011-01-11 13:54:23 -05:00
memlayout.h Switch back to #define for PHYSTOP. Using the E820 to retrieve the memory map is too complicated (must be done in 16-bit real-mode, probably enlarged bootblock beyond 512 bytes, and a #define requires less explanation). 2011-08-16 20:23:17 -04:00
mkdir.c more consistent spacing 2007-08-28 18:32:08 +00:00
mkfs.c Dirt simple logging 2011-07-27 20:35:46 -04:00
mmu.h Clean up memlayout.h 2011-08-16 15:47:22 -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 make new code like old code 2011-01-11 13:01:13 -05: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 Remove sys_init syscall 2011-08-22 20:05:15 -04:00
proc.h Avoid "boot" in xv6 2011-08-15 20:11:13 -04:00
rm.c more consistent spacing 2007-08-28 18:32:08 +00:00
runoff Remove unused nop_pause function. 2010-09-02 14:08:45 -04:00
runoff.list Update list of files to include in printout 2011-08-15 20:28:28 -04:00
runoff.spec xv6: formatting, cleanup, rev5 (take 2) 2011-02-19 21:17:55 -05: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 Map kernel high 2011-07-29 07:31:27 -04: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 make new code like old code 2011-01-11 13:01:13 -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 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 sys_init syscall 2011-08-22 20:05:15 -04:00
syscall.h Remove sys_init syscall 2011-08-22 20:05:15 -04:00
sysfile.c avoid deadlock by calling begin_trans() before locking any inodes 2011-08-15 12:44:20 -04: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 xv6: formatting, cleanup, rev5 (take 2) 2011-02-19 21:17:55 -05: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 make dirlookup and dirlink more similar 2011-08-19 13:30:57 -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 Switch back to #define for PHYSTOP. Using the E820 to retrieve the memory map is too complicated (must be done in 16-bit real-mode, probably enlarged bootblock beyond 512 bytes, and a #define requires less explanation). 2011-08-16 20:23:17 -04:00
wc.c more consistent spacing 2007-08-28 18:32:08 +00:00
x86.h Map kernel high 2011-07-29 07:31:27 -04: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-rev4.tar.gz Rev 4 2010-09-03 15:47:28 -04:00
xv6-rev5.pdf xv6: formatting, cleanup, rev5 2011-02-19 21:16:54 -05:00
xv6-rev5.tar.gz rebuild xv6-rev5.tar.gz 2011-02-28 09:32:54 -05: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)
    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-2011 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".

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