README.dirs revision 1.11 
1	$NetBSD: README.dirs,v 1.11 2010/05/11 11:58:14 pooka Exp $
2
3
4The following is a quick rundown of the current directory structure.
5First, components in the kernel namespace, i.e. compiled with -D_KERNEL
6
7sys/rump/librump - kernel runtime emulation
8  /rumpkern	- kernel core, e.g. syscall, interrupt and lock support
9
10  /rumpcrypto	- kernel cryptographic routines
11  /rumpdev	- device support, e.g. autoconf subsystem
12  /rumpnet	- networking support and sockets layer
13  /rumpvfs	- file system support
14
15sys/rump/include
16  /machine - used for architectures where the rump ABI is not yet the
17	     same as the kernel module ABI.  will eventually disappear
18	     completely
19  /rump    - rump headers installed to userspace
20
21sys/rump/dev - device components, e.g. audio, raidframe, usb drivers
22
23sys/rump/fs - file system components
24  /lib/lib${fs}  - kernel file system code
25
26sys/rump/net - networking components
27  /lib/libnet	  - subroutines from sys/net, e.g. route and if_ethersubr
28  /lib/libnetinet - TCP/IP
29  /lib/libvirtif  - a virtual interface which uses host tap(4) to shovel
30		    packets.  This is used by netinet and if_ethersubr.
31  /lib/libsockin  - implements PF_INET using host kernel sockets.  This is
32		    mutually exclusive with net, netinet and virtif.
33
34
35
36The rest are out-of-kernel components (i.e. no -D_KERNEL)
37related to rump.
38
39hypercall interface:
40src/lib/librumpuser
41  The "rumpuser" set of interfaces is used by rump to communicate
42  with the host.
43
44Users:
45src/lib
46  /libp2k  - puffs-to-vfs adaption layer, userspace namespace
47  /libukfs - user kernel file system, a library to access file system
48	     images (or devices) directly in userspace without going
49	     through a system call and puffs.  It provides a slightly
50	     higher interface than pure rump syscalls.
51
52src/usr.sbin/puffs
53  rump_$fs - userspace file system daemons using the kernel fs code
54
55src/share/examples/rump
56  Various examples detailing use of rump in different scenarios.
57  These are provided source-only.
58