NetBSD/sys/rump
2016-03-23 21:38:51 +00:00
..
dev nuke a few missed -Ifactiondir CPPFLAGSitions. 2016-01-26 23:41:15 +00:00
fs elide vax compiler bug. 2016-03-23 21:38:51 +00:00
include Allocate struct cpu_info dynamically. Saves quite a lot of BSS in the 2016-02-08 18:18:19 +00:00
kern Put the kernelside rump kernel headers into <rump-sys> instead of 2016-01-26 23:12:14 +00:00
librump Align the message buffer. The kernel routines normally are used only 2016-03-08 14:30:48 +00:00
net Introduce softint-based if_input 2016-02-09 08:32:07 +00:00
share workaround bin/49481 2014-12-16 15:33:22 +00:00
ldscript_sun.rump Generate support for sun ld. 2013-03-15 12:13:07 +00:00
ldscript.rump domains are attached by module(-like) constructors, so no need to 2014-04-23 17:05:18 +00:00
linksyms_sun.c Generate support for sun ld. 2013-03-15 12:13:07 +00:00
listsrcdirs Add uname to rump sources 2015-07-07 12:40:13 +00:00
Makefile Move rump kernel man pages from various sources to sys/rump 2014-11-09 17:39:37 +00:00
Makefile.rump describe => rumpdescribe 2015-11-15 13:50:10 +00:00
makerumpsyscalls.sh "rump_private.h" -> <rump-sys/kern.h> 2016-01-26 23:24:55 +00:00
README.compileopts Move librumpuser compile-time options into the librumpuser source 2016-01-25 00:24:23 +00:00
README.dirs Update a bit. 2013-01-08 13:12:26 +00:00
rump.sysmap regen 2015-06-18 15:19:50 +00:00
sunldgen.sh Support generating support for Sun ld. 2013-03-15 12:12:16 +00:00
TODO Remove solved item. 2015-09-08 12:14:20 +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.