xref: /netbsd-src/sys/rump/README.dirs (revision 50728e7823a76d5bd1a7bfa3a4eac400269b1339)
1	$NetBSD: README.dirs,v 1.8 2008/12/31 13:18:06 pooka Exp $
2
3    Runnable Userspace Meta Programs
4
5Quick rundown of the current directory structure:
6
7sys/rump/librump - kernel runtime emulation
8  /rumpkern - kernel core, e.g. syscall, interrupt and lock support
9  /rumpnet  - networking support and sockets layer
10  /rumpuser - userspace namespace support for previous, *NO* -D_KERNEL
11	      provides e.g. malloc() and some syscalls
12  /rumpvfs  - file system support
13
14sys/rump/include
15  /machine - used for architectures where the rump ABI is not yet the
16	     same as the kernel module ABI.  will eventually disappear
17	     completely
18  /rump    - rump headers installed to userspace
19
20sys/rump/fs - file system rumps
21  /lib/lib${fs}  - kernel file system code compiled out of /sys with -D_KERNEL
22
23sys/rump/net - networking rumps
24  /lib/libnet	  - subroutines from sys/net, e.g. route and if_ethersubr
25  /lib/libnetinet - TCP/IP
26  /lib/libvirtif  - a virtual interface which uses host tap(4) to shovel
27		    packets.  This is used by netinet and if_ethersubr.
28  /lib/libsockin  - implements PF_INET using host kernel sockets.  This is
29		    mutually exclusive with net, netinet and virtif.
30
31Users:
32src/lib
33  /libp2k  - puffs-to-vfs adaption layer, userspace namespace
34  /libukfs - user kernel file system, a library to access file system
35	     images (or devices) directly in userspace without going
36	     through a system call and puffs
37
38src/usr.sbin/puffs
39  rump_$fs - userspace file system daemons using the kernel fs code
40