sys/rump/README.dirs

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