NetBSD/sys/rump
pooka 6e46c1395e Make dma_tag_t a bit more useful.
XXX: this header should definitely not exist, but given that it does,
let's use it to make life easier.  The implication of its existence is
that x86 port rump kernel components are not ABI-compatible with kernel
modules which use bus_space/bus_dma.  I'm not sure if anyone is interested
in that...
2013-09-22 20:51:18 +00:00
..
dev Move the bus_dma implementation that works only with ugenhc into the 2013-09-19 17:55:22 +00:00
fs why does rump have to have its own private build system? 2013-07-20 20:43:09 +00:00
include Make dma_tag_t a bit more useful. 2013-09-22 20:51:18 +00:00
kern COMPAT_60 for rump kernels. 2013-07-16 19:07:54 +00:00
librump use ioconf for mainbus 2013-09-20 16:49:00 +00:00
net NPF: G/C n-code in favour of BPF byte-code. Delete lots of code, mmm! 2013-09-19 01:49:07 +00:00
ldscript_sun.rump Generate support for sun ld. 2013-03-15 12:13:07 +00:00
ldscript.rump
linksyms_sun.c Generate support for sun ld. 2013-03-15 12:13:07 +00:00
listsrcdirs Pull in all of sys/dev (i.e. don't skip pci/ and microcode/). 2013-09-19 16:16:03 +00:00
Makefile
Makefile.rump RUMPCOMP_USEROBJ -> RUMPOBJ_NORENAME 2013-09-03 19:57:02 +00:00
README.dirs
sunldgen.sh Support generating support for Sun ld. 2013-03-15 12:12:16 +00:00
TODO Update a bit. yay, this file isn't completely append-only! 2013-01-08 13:45:28 +00:00

	$NetBSD: README.dirs,v 1.12 2013/01/08 13:12:26 pooka Exp $


The following is a quick rundown of the current directory structure.
First, components in the kernel namespace, i.e. compiled with -D_KERNEL

sys/rump/librump - rump kernel base and factions
  /rumpkern	- kernel core, e.g. syscall, interrupt and lock support

  /rumpdev	- device support, e.g. autoconf subsystem
  /rumpnet	- networking support and sockets layer
  /rumpvfs	- file system support

sys/rump/include
  /machine - used for architectures where the rump kernel ABI is not yet the
	     same as the kernel module ABI.  will eventually disappear
	     completely
  /rump    - kernel headers installed to userspace

sys/rump/dev - device components, e.g. audio, raidframe, usb drivers

sys/rump/fs - file system components
  /lib/lib${fs}  - kernel file system code

sys/rump/net - networking components
  /lib/libnet	  - subroutines from sys/net, e.g. route and if_ethersubr
  /lib/libnetinet - TCP/IP
  /lib/libvirtif  - a virtual interface which uses host tap(4) to shovel
		    packets.  This is used by netinet and if_ethersubr.
  /lib/libshmif   - a virtual interface which uses a memory mapped file
		    as an ethernet bus.  works completely unprivileged.
  /lib/libsockin  - implements PF_INET using host kernel sockets.  This is
		    mutually exclusive with net, netinet and virtif.



The rest are out-of-kernel components (i.e. no -D_KERNEL).

hypercall interface:
src/lib/librumpuser
  The "rumpuser" hypercall interfaces are used by a rump kernel to
  access host resources.

remote client interface:
src/lib/librumpclient
  The rumpclient library provides remote access to rump kernel servers.

system call hijacking:
src/lib/librumphijack
  The rumphijack library allows intercepting system calls and redirecting
  them to a rump kernel server instead of the host kernel.  In other
  words, it allows existing binaries to request indicated services from
  a rump kernel instead of from the host kernel.

Users:
src/lib
  /libp2k  - puffs-to-vfs adaption layer, userspace namespace
  /libukfs - user kernel file system, a library to access file system
	     images (or devices) directly in userspace without going
	     through a system call and puffs.  It provides a slightly
	     higher interface than syscalls.

src/usr.sbin/puffs
  rump_$fs - userspace file system daemons using the kernel fs code

src/share/examples/rump
  Various examples detailing use of rump kernels in different scenarios.
  These are provided source-only.