xref: /xv6-public/README (revision 4638cabf)
182537b71Srtmxv6 is a re-implementation of Dennis Ritchie's and Ken Thompson's Unix
282537b71SrtmVersion 6 (v6).  xv6 loosely follows the structure and style of v6,
382537b71Srtmbut is implemented for a modern x86-based multiprocessor using ANSI C.
4b52151e0Skaashoek
5bc54fa39SrtmACKNOWLEDGMENTS
62e898063Skaashoek
7f0400600Srscxv6 is inspired by John Lions's Commentary on UNIX 6th Edition (Peer
882537b71Srtmto Peer Communications; ISBN: 1-57398-013-7; 1st edition (June 14,
90f3d9d9dSFrans Kaashoek2000)). See also http://pdos.csail.mit.edu/6.828/2016/xv6.html, which
1082537b71Srtmprovides pointers to on-line resources for v6.
11b52151e0Skaashoek
1282537b71Srtmxv6 borrows code from the following sources:
1382537b71Srtm    JOS (asm.h, elf.h, mmu.h, bootasm.S, ide.c, console.c, and others)
1482bb0b56SAustin Clements    Plan 9 (entryother.S, mp.h, mp.c, lapic.c)
15801affcdSkaashoek    FreeBSD (ioapic.c)
1682537b71Srtm    NetBSD (console.c)
17801affcdSkaashoek
185bf3fbeeSFrans KaashoekThe following people have made contributions: Russ Cox (context switching,
195bf3fbeeSFrans Kaashoeklocking), Cliff Frey (MP), Xiao Yu (MP), Nickolai Zeldovich, and Austin
205bf3fbeeSFrans KaashoekClements.
21801affcdSkaashoek
225bf3fbeeSFrans KaashoekWe are also grateful for the bug reports and patches contributed by Silas
23164f4baeSFrans KaashoekBoyd-Wickizer, Anton Burtsev, Cody Cutler, Mike CAT, Tej Chajed, Nelson Elhage,
24164f4baeSFrans KaashoekSaar Ettinger, Alice Ferrazzi, Nathaniel Filardo, Peter Froehlich, Yakir Goaron,
25164f4baeSFrans KaashoekShivam Handa, Bryan Henry, Jim Huang, Alexander Kapshuk, Anders Kaseorg,
26164f4baeSFrans Kaashoekkehao95, Wolfgang Keller, Eddie Kohler, Austin Liew, Imbar Marinescu, Yandong
27164f4baeSFrans KaashoekMao, Hitoshi Mitake, Carmi Merimovich, Joel Nider, Greg Price, Ayan Shafqat,
28164f4baeSFrans KaashoekEldar Sehayek, Yongming Shen, Cam Tenny, Rafael Ubal, Warren Toomey, Stephen Tu,
29164f4baeSFrans KaashoekPablo Ventura, Xi Wang, Keiichi Watanabe, Nicolas Wolovick, Grant Wu, Jindong
30164f4baeSFrans KaashoekZhang, Icenowy Zheng, and Zou Chang Wei.
317b814133SAustin Clements
32fa1b3410SrscThe code in the files that constitute xv6 is
330f3d9d9dSFrans KaashoekCopyright 2006-2016 Frans Kaashoek, Robert Morris, and Russ Cox.
342e898063Skaashoek
352e898063SkaashoekERROR REPORTS
362e898063Skaashoek
37*4638cabfSRobert MorrisPlease send errors and suggestions to Frans Kaashoek and Robert Morris
38*4638cabfSRobert Morris(kaashoek,rtm@mit.edu). The main purpose of xv6 is as a teaching
39*4638cabfSRobert Morrisoperating system for MIT's 6.828, so we are more interested in
40*4638cabfSRobert Morrissimplifications and clarifications than new features.
41641e29c5Skaashoek
42bc54fa39SrtmBUILDING AND RUNNING XV6
434d33ef86Srsc
44*4638cabfSRobert MorrisTo build xv6 on an x86 ELF machine (like Linux or FreeBSD), run
45*4638cabfSRobert Morris"make". On non-x86 or non-ELF machines (like OS X, even on x86), you
46*4638cabfSRobert Morriswill need to install a cross-compiler gcc suite capable of producing
47*4638cabfSRobert Morrisx86 ELF binaries. See http://pdos.csail.mit.edu/6.828/2016/tools.html.
48*4638cabfSRobert MorrisThen run "make TOOLPREFIX=i386-jos-elf-". Now install the QEMU PC
49*4638cabfSRobert Morrissimulator and run "make qemu".
50