README 2.25 KB
Newer Older
HOFMANN MICHAEL's avatar
HOFMANN MICHAEL committed
1
try toto branch 
2
3
4
5
NOTE: we have stopped maintaining the x86 version of xv6, and switched
our efforts to the RISC-V version
(https://github.com/mit-pdos/xv6-riscv.git)

rtm's avatar
nits    
rtm committed
6
7
8
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.
kaashoek's avatar
kaashoek committed
9

rtm's avatar
rtm committed
10
ACKNOWLEDGMENTS
kaashoek's avatar
kaashoek committed
11

rsc's avatar
nits    
rsc committed
12
xv6 is inspired by John Lions's Commentary on UNIX 6th Edition (Peer
rtm's avatar
nits    
rtm committed
13
to Peer Communications; ISBN: 1-57398-013-7; 1st edition (June 14,
Frans Kaashoek's avatar
Frans Kaashoek committed
14
2000)). See also https://pdos.csail.mit.edu/6.828/, which
rtm's avatar
nits    
rtm committed
15
provides pointers to on-line resources for v6.
kaashoek's avatar
kaashoek committed
16

rtm's avatar
nits    
rtm committed
17
18
xv6 borrows code from the following sources:
    JOS (asm.h, elf.h, mmu.h, bootasm.S, ide.c, console.c, and others)
19
    Plan 9 (entryother.S, mp.h, mp.c, lapic.c)
kaashoek's avatar
kaashoek committed
20
    FreeBSD (ioapic.c)
rtm's avatar
nits    
rtm committed
21
    NetBSD (console.c)
kaashoek's avatar
kaashoek committed
22

Frans Kaashoek's avatar
Frans Kaashoek committed
23
24
25
26
27
The following people have made contributions: Russ Cox (context switching,
locking), Cliff Frey (MP), Xiao Yu (MP), Nickolai Zeldovich, and Austin
Clements.

We are also grateful for the bug reports and patches contributed by Silas
Frans Kaashoek's avatar
x    
Frans Kaashoek committed
28
29
30
31
Boyd-Wickizer, Anton Burtsev, Cody Cutler, Mike CAT, Tej Chajed, eyalz800,
Nelson Elhage, Saar Ettinger, Alice Ferrazzi, Nathaniel Filardo, Peter
Froehlich, Yakir Goaron,Shivam Handa, Bryan Henry, Jim Huang, Alexander
Kapshuk, Anders Kaseorg, kehao95, Wolfgang Keller, Eddie Kohler, Austin
Frans Kaashoek's avatar
Frans Kaashoek committed
32
Liew, Imbar Marinescu, Yandong Mao, Matan Shabtay, Hitoshi Mitake, Carmi
Frans Kaashoek's avatar
x    
Frans Kaashoek committed
33
34
35
36
Merimovich, Mark Morrissey, mtasm, Joel Nider, Greg Price, Ayan Shafqat,
Eldar Sehayek, Yongming Shen, Cam Tenny, tyfkda, Rafael Ubal, Warren
Toomey, Stephen Tu, Pablo Ventura, Xi Wang, Keiichi Watanabe, Nicolas
Wolovick, wxdao, Grant Wu, Jindong Zhang, Icenowy Zheng, and Zou Chang Wei.
Austin Clements's avatar
Austin Clements committed
37

rsc's avatar
rsc committed
38
The code in the files that constitute xv6 is
Frans Kaashoek's avatar
x    
Frans Kaashoek committed
39
Copyright 2006-2018 Frans Kaashoek, Robert Morris, and Russ Cox.
kaashoek's avatar
kaashoek committed
40
41
42

ERROR REPORTS

43
We don't process error reports (see note on top of this file).
kaashoek's avatar
kaashoek committed
44

rtm's avatar
rtm committed
45
BUILDING AND RUNNING XV6
rsc's avatar
rsc committed
46

47
48
49
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
Frans Kaashoek's avatar
Frans Kaashoek committed
50
x86 ELF binaries (see https://pdos.csail.mit.edu/6.828/).
51
Then run "make TOOLPREFIX=i386-jos-elf-". Now install the QEMU PC
HOFMANN MICHAEL's avatar
HOFMANN MICHAEL committed
52
simulator and run "make qemu".