Personal patches to the xv6 kernel
Find a file
Frans Kaashoek ab0db651af Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times.
The x86-64 doesn't just add two levels to page tables to support 64 bit
addresses, but is a different processor. For example, calling conventions,
system calls, and segmentation are different from 32-bit x86. Segmentation is
basically gone, but gs/fs in combination with MSRs can be used to hold a
per-core pointer. In general, x86-64 is more straightforward than 32-bit
x86. The port uses code from sv6 and the xv6 "rsc-amd64" branch.

A summary of the changes is as follows:

- Booting: switch to grub instead of xv6's bootloader (pass -kernel to qemu),
because xv6's boot loader doesn't understand 64bit ELF files.  And, we don't
care anymore about booting.

- Makefile: use -m64 instead of -m32 flag for gcc, delete boot loader, xv6.img,
bochs, and memfs. For now dont' use -O2, since usertests with -O2 is bigger than
MAXFILE!

- Update gdb.tmpl to be for i386 or x86-64

- Console/printf: use stdarg.h and treat 64-bit addresses different from ints
  (32-bit)

- Update elfhdr to be 64 bit

- entry.S/entryother.S: add code to switch to 64-bit mode: build a simple page
table in 32-bit mode before switching to 64-bit mode, share code for entering
boot processor and APs, and tweak boot gdt.  The boot gdt is the gdt that the
kernel proper also uses. (In 64-bit mode, the gdt/segmentation and task state
mostly disappear.)

- exec.c: fix passing argv (64-bit now instead of 32-bit).

- initcode.c: use syscall instead of int.

- kernel.ld: load kernel very high, in top terabyte.  64 bits is a lot of
address space!

- proc.c: initial return is through new syscall path instead of trapret.

- proc.h: update struct cpu to have some scratch space since syscall saves less
state than int, update struct context to reflect x86-64 calling conventions.

- swtch: simplify for x86-64 calling conventions.

- syscall: add fetcharg to handle x86-64 calling convetions (6 arguments are
passed through registers), and fetchaddr to read a 64-bit value from user space.

- sysfile: update to handle pointers from user space (e.g., sys_exec), which are
64 bits.

- trap.c: no special trap vector for sys calls, because x86-64 has a different
plan for system calls.

- trapasm: one plan for syscalls and one plan for traps (interrupt and
exceptions). On x86-64, the kernel is responsible for switching user/kernel
stacks. To do, xv6 keeps some scratch space in the cpu structure, and uses MSR
GS_KERN_BASE to point to the core's cpu structure (using swapgs).

- types.h: add uint64, and change pde_t to uint64

- usertests: exit() when fork fails, which helped in tracking down one of the
bugs in the switch from 32-bit to 64-bit

- vectors: update to make them 64 bits

- vm.c: use bootgdt in kernel too, program MSRs for syscalls and core-local
state (for swapgs), walk 4 levels in walkpgdir, add DEVSPACETOP, use task
segment to set kernel stack for interrupts (but simpler than in 32-bit mode),
add an extra argument to freevm (size of user part of address space) to avoid
checking all entries till KERNBASE (there are MANY TB before the top 1TB).

- x86: update trapframe to have 64-bit entries, which is what the processor
pushes on syscalls and traps.  simplify lgdt and lidt, using struct desctr,
which needs the gcc directives packed and aligned.

TODO:
- use int32 instead of int?
- simplify curproc(). xv6 has per-cpu state again, but this time it must have it.
- avoid repetition in walkpgdir
- fix validateint() in usertests.c
- fix bugs (e.g., observed one a case of entering kernel with invalid gs or proc
2018-09-23 08:35:30 -04:00
.cvsignore update .cvsignore 2008-10-15 04:54:24 +00:00
.dir-locals.el Setting indent-tabs-mode nil everywhere is dangerous 2011-09-05 15:22:16 -04:00
.gdbinit.tmpl-i386 Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
.gdbinit.tmpl-x64 Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
.gitignore Sync up clean and gitignore better 2011-09-05 15:21:40 -04:00
asm.h Remove unused flags (thanks Wolfgang Keller) 2018-08-30 13:14:01 -04:00
bio.c nothing much 2017-08-09 14:16:55 -04:00
bootmain.c Remove trailing white space with: 2016-08-25 09:13:00 -04:00
buf.h Move retry loop/sleep/wakeup in bio.c into sleeping locks 2016-09-11 20:17:22 -04:00
BUGS sh 2007-09-05 15:55:43 +00:00
cat.c Check result of write (thans to Alexander Kapshuk <alexander.kapshuk@gmail) 2016-09-19 07:01:30 -04:00
console.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
cuth delete unnecessary #include lines 2007-08-27 23:26:33 +00:00
date.h coding style (per Jeremías Feltan <jeremias.feltan@gmail.com>) 2015-06-30 16:23:56 -04:00
defs.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -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 Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
entry.S Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
entryother.S Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
exec.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
fcntl.h nit 2007-08-28 04:13:24 +00:00
file.c stricter log consumption by write() 2017-10-24 08:49:31 -04:00
file.h fix runoff complaints about pagination and long lines 2017-08-29 14:11:59 -04:00
forktest.c thanks tyfkda 2018-08-31 09:21:19 -04:00
fs.c fix runoff complaints about pagination and long lines 2017-08-29 14:11:59 -04:00
fs.h Fix a few lines that runoff is complaining about that they are too long 2016-09-02 14:59:00 -04:00
gdbutil GDB utilities 2009-11-23 17:47:57 -05:00
grep.c Remove trailing white space with: 2016-08-25 09:13:00 -04:00
ide.c Commit to running on an SMP (perhaps with only 1 core). Remove most code 2017-08-09 07:44:51 -04:00
init.c group locks into structs they protect. 2009-05-31 05:12:21 +00:00
initcode.S Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
ioapic.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
kalloc.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -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 Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
kill.c Disentangle block size from the disk's sector size. Set block size to 1024 to show 2015-04-03 08:22:02 -04:00
lapic.c x 2018-08-30 14:47:07 -04:00
LICENSE x 2018-08-30 16:20:16 -04:00
ln.c add ln 2007-08-22 05:54:55 +00:00
log.c nothing much 2017-08-09 14:16:55 -04:00
ls.c Remove trailing white space with: 2016-08-25 09:13:00 -04:00
main.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
Makefile Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
memide.c Thanks to Jeehoon Kang <jeehoon.kang@sf.snu.ac.kr> 2017-01-30 20:01:33 -05:00
memlayout.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
mkdir.c more consistent spacing 2007-08-28 18:32:08 +00:00
mkfs.c Remove trailing white space with: 2016-08-25 09:13:00 -04:00
mmu.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
mp.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
mp.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
msr.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
Notes nit in console interrupts 2006-09-07 00:00:33 +00:00
param.h check blockno passed to idestart 2015-04-10 07:15:06 -04:00
picirq.c Commit to running on an SMP (perhaps with only 1 core). Remove most code 2017-08-09 07:44:51 -04:00
pipe.c Start of an experiment to remove the use of gs for cpu local variables. 2017-01-31 17:47:16 -05:00
pr.pl remove //DOC in the right place 2009-07-12 19:07:30 -07:00
printf.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
printpcs Various fixes and improvements to printpcs 2012-08-24 14:51:52 -04:00
proc.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
proc.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
README Update name 2018-09-02 08:33:55 -04:00
rm.c more consistent spacing 2007-08-28 18:32:08 +00:00
runoff Delete a patch 2018-08-30 15:45:16 -04:00
runoff.list thanks mtasm 2018-08-30 14:10:27 -04:00
runoff.spec Nice layout for a printout of the code 2014-08-29 17:06:49 -04:00
runoff1 xv6: formatting, cleanup, rev5 (take 2) 2011-02-19 21:17:55 -05:00
sh.c Remove trailing white space with: 2016-08-25 09:13:00 -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
sleeplock.c Because sleeplocks replaced B_BUSY the holding test can 2018-08-30 11:57:46 -04:00
sleeplock.h sleeplock files 2016-09-11 21:01:24 -04:00
spinlock.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
spinlock.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
spinp Model verifying that wakeup really 2007-10-12 04:21:04 +00:00
stat.h junk 2012-08-28 12:57:05 -04:00
stressfs.c Remove trailing white space with: 2016-08-25 09:13:00 -04:00
string.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
swtch.S Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
syscall.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
syscall.h Remove left-over from some logging plan making complete syscalls atomic 2012-08-22 20:28:58 -04:00
sysfile.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
sysproc.c Start of an experiment to remove the use of gs for cpu local variables. 2017-01-31 17:47:16 -05:00
toc.ftr Update index example in TOC footer 2011-09-02 16:30:20 -04:00
toc.hdr nits 2007-08-28 18:23:48 +00:00
trap.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
trapasm.S Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
traps.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
TRICKS use acquire/release to force order for pid=np->pid;np->state=RUNNING 2014-08-04 06:13:49 -04:00
types.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
uart.c Commit to running on an SMP (perhaps with only 1 core). Remove most code 2017-08-09 07:44:51 -04:00
ulib.c thanks tyfkda 2018-08-31 09:21:19 -04:00
umalloc.c make new code like old code 2011-01-11 13:01:13 -05:00
user.h thanks tyfkda 2018-08-31 09:21:19 -04:00
usertests.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
usys.S Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
vectors.pl Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
vm.c Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
wc.c junk 2012-08-28 12:57:05 -04:00
x86.h Checkpoint port of xv6 to x86-64. Passed usertests on 2 processors a few times. 2018-09-23 08:35:30 -04:00
zombie.c Remove trailing white space with: 2016-08-25 09:13:00 -04:00

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 https://pdos.csail.mit.edu/6.828/, 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 (entryother.S, mp.h, mp.c, lapic.c)
    FreeBSD (ioapic.c)
    NetBSD (console.c)

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
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
Liew, Imbar Marinescu, Yandong Mao, Matan Shabtay, Hitoshi Mitake, Carmi
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.

The code in the files that constitute xv6 is
Copyright 2006-2018 Frans Kaashoek, Robert Morris, and Russ Cox.

ERROR REPORTS

Please send errors and suggestions to Frans Kaashoek and Robert Morris
(kaashoek,rtm@mit.edu). The main purpose of xv6 is as a teaching
operating system for MIT's 6.828, so we are more interested in
simplifications and clarifications than new features.

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 https://pdos.csail.mit.edu/6.828/).
Then run "make TOOLPREFIX=i386-jos-elf-". Now install the QEMU PC
simulator and run "make qemu".