1.\" 2.\" Copyright (c) 2013 Antonio Huete Jimenez <tuxillo@quantumachine.net> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. The name of the author may not be used to endorse or promote products 14.\" derived from this software without specific prior written permission 15.\" 16.\" THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26.\" 27.\" 28.Dd September 5, 2013 29.Dt DIRFS 5 30.Os 31.Sh NAME 32.Nm dirfs 33.Nd "pseudo-filesystem for vkernel" 34.Sh SYNOPSIS 35To compile this driver into the vkernel, 36place the following line in your 37vkernel configuration file: 38.Bd -ragged -offset indent 39.Cd "options DIRFS" 40.Ed 41.Pp 42Actually this driver does not provide a loadable module. 43.Pp 44In 45.Xr fstab 5 : 46.Bd -literal -compact 47/usr/src /mnt dirfs rw 0 0 48.Ed 49.Sh DESCRIPTION 50.Nm 51was born from the idea of providing an easy way for 52.Xr vkernel 7 53to access host's directories without any sort of configuration as it would be 54needed by NFS for example. 55.Pp 56It runs directly in the vkernel's 57.Xr VFS 9 58code, as any other regular filesystem but it uses syscalls to retrieve the 59information needed for every operation requested. 60.Pp 61It should be noted that when the vkernel is run by a regular user, the 62operations 63.Nm 64can perform on the mounted host directory are bound to the permissions of 65the aforementioned user. 66.Pp 67Multiple 68.Nm 69mounts are allowed. 70.Sh EXAMPLES 71To mount a 72.Nm 73memory file system: 74.Pp 75.Dl "mount -t dirfs /usr/src /mnt" 76.Sh SEE ALSO 77.Xr fstab 5 , 78.Xr mount_dirfs 8 , 79.Sh HISTORY 80The 81.Nm 82driver first appeared in 83.Dx 3.5 . 84.Sh AUTHORS 85.An -nosplit 86The 87.Nm 88vkernel implementation was written from the scratch by 89.An Antonio Huete Jimenez Aq Mt tuxillo@quantumachine.net 90.Pp 91Numerous fixes and pointers by 92.An Matthew Dillon Aq Mt dillon@apollo.backplane.com 93.Pp 94This manual page was written by 95.An Antonio Huete Jimenez Aq Mt tuxillo@quantumachine.net 96.Sh BUGS 97Currently there is no locking on file descriptors between the host 98and the vkernel. 99This means that there might be problems with concurrent accesses to the same 100file. 101.Pp 102There is no support for hardlinks in 103.Nm 104yet. 105