Module Name:    src
Committed By:   pooka
Date:           Tue May 11 11:58:14 UTC 2010

Modified Files:
        src/sys/rump: README.dirs

Log Message:
update slightly


To generate a diff of this commit:
cvs rdiff -u -r1.10 -r1.11 src/sys/rump/README.dirs

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: src/sys/rump/README.dirs
diff -u src/sys/rump/README.dirs:1.10 src/sys/rump/README.dirs:1.11
--- src/sys/rump/README.dirs:1.10	Tue May 11 09:45:59 2010
+++ src/sys/rump/README.dirs	Tue May 11 11:58:14 2010
@@ -1,13 +1,11 @@
-	$NetBSD: README.dirs,v 1.10 2010/05/11 09:45:59 pooka Exp $
+	$NetBSD: README.dirs,v 1.11 2010/05/11 11:58:14 pooka Exp $
 
-    rump kernel support
 
-Quick rundown of the current directory structure:
+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 - kernel runtime emulation
   /rumpkern	- kernel core, e.g. syscall, interrupt and lock support
-  /rumpuser	- userspace namespace support for rump, *NO* -D_KERNEL
-		  provides e.g. malloc() and some syscalls
 
   /rumpcrypto	- kernel cryptographic routines
   /rumpdev	- device support, e.g. autoconf subsystem
@@ -20,10 +18,10 @@
 	     completely
   /rump    - rump headers installed to userspace
 
-sys/rump/dev - device components
+sys/rump/dev - device components, e.g. audio, raidframe, usb drivers
 
 sys/rump/fs - file system components
-  /lib/lib${fs}  - kernel file system code compiled out of /sys with -D_KERNEL
+  /lib/lib${fs}  - kernel file system code
 
 sys/rump/net - networking components
   /lib/libnet	  - subroutines from sys/net, e.g. route and if_ethersubr
@@ -33,12 +31,27 @@
   /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)
+related to rump.
+
+hypercall interface:
+src/lib/librumpuser
+  The "rumpuser" set of interfaces is used by rump to communicate
+  with the host.
+
 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
+	     through a system call and puffs.  It provides a slightly
+	     higher interface than pure rump 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 in different scenarios.
+  These are provided source-only.

Reply via email to