Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

some minor updates and reality-checks

This commit is contained in:
pooka 2014-02-14 01:11:04 +00:00
parent 177c2413c9
commit 51b406fe68
1 changed files with 12 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
lib/libukfs/ukfs.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: ukfs.3,v 1.12 2013/07/20 21:39:57 wiz Exp $ .\" $NetBSD: ukfs.3,v 1.13 2014/02/14 01:11:04 pooka Exp $
.\" .\"
.\" Copyright (c) 2008 Antti Kantee. All rights reserved. .\" Copyright (c) 2008 Antti Kantee. All rights reserved.
.\" .\"
@ -23,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd November 22, 2009 .Dd February 13, 2014
.Dt UKFS 3 .Dt UKFS 3
.Os .Os
.Sh NAME .Sh NAME
@ -44,17 +44,17 @@ requires no special kernel support apart from standard POSIX functionality.
As As
.Nm .Nm
is built upon is built upon
.Xr rump 3 , .Xr rump 3
all kernel file systems which are supported by rump are available. kernels, all kernel file systems which are supported by rump kernels
It allows to write utilities for accessing file systems without having are available. It allows to write utilities for accessing file systems
to duplicate file system internals knowledge already present in kernel without having to duplicate file system internals knowledge already
file system drivers. present in kernel file system drivers.
.Pp .Pp
.Nm .Nm
provides a high-level pathname based interface for accessing file systems. provides a high-level pathname based interface for accessing file systems.
If a lower level interface it desired, If a lower level interface it desired,
.Xr rump 3 .Xr rump 3
should be used directly. kernels should be used directly.
However, much like system calls, the interfaces of However, much like system calls, the interfaces of
.Nm , .Nm ,
are self-contained and require no tracking and release of resources. are self-contained and require no tracking and release of resources.
@ -91,7 +91,7 @@ is used at runtime to dynamically load a library which contains a
file system module. file system module.
For this to succeed, the For this to succeed, the
.Xr rump 3 .Xr rump 3
library and the module targetted must be compiled with compatible kernel kernel and the module targetted must be compiled with compatible kernel
versions and the application must be dynamically linked. versions and the application must be dynamically linked.
Additionally, since this routine does not handle dependencies, all the Additionally, since this routine does not handle dependencies, all the
dependencies of the library must be loaded beforehand. dependencies of the library must be loaded beforehand.
@ -101,7 +101,7 @@ for success.
.Fn ukfs_modload_dir .Fn ukfs_modload_dir
loads all loads all
.Xr rump 3 .Xr rump 3
file system modules in directory kernel file system components in directory
.Fa dirname . .Fa dirname .
It looks for libraries which begin with It looks for libraries which begin with
.Pa librumpfs_ .Pa librumpfs_
@ -316,13 +316,5 @@ first appeared in
.An Antti Kantee Aq Mt pooka@cs.hut.fi .An Antti Kantee Aq Mt pooka@cs.hut.fi
.Sh NOTES .Sh NOTES
.Nm .Nm
should be considered experimental technology and may change without warning. was an early attempt at an interface for kernel file systems
.Sh BUGS running in userspace.
On Linux, dynamically linked binaries can include support for only
one file system due to restrictions with the dynamic linker.
If more are desired, they must be loaded at runtime using
.Fn ukfs_modload .
Even though
.Nx
does not have this restriction, portable programs should load all
file system drivers dynamically.