1.\" Copyright (c) 1995 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.Dd August 16, 2018 29.Dt GETVFSBYNAME 3 30.Os 31.Sh NAME 32.Nm getvfsbyname 33.Nd get information about a file system 34.Sh LIBRARY 35.Lb libc 36.Sh SYNOPSIS 37.In sys/param.h 38.In sys/mount.h 39.Ft int 40.Fn getvfsbyname "const char *name" "struct xvfsconf *vfc" 41.Sh DESCRIPTION 42The 43.Fn getvfsbyname 44function provides access to information about a 45file system module that is configured in the kernel. 46If successful, 47the requested file system 48.Fa xvfsconf 49is returned in the location pointed to by 50.Fa vfc . 51The fields in a 52.Dq Li struct xvfsconf 53are defined as follows: 54.Pp 55.Bl -tag -compact -width vfc_refcount 56.It vfc_name 57the name of the file system 58.It vfc_typenum 59the file system type number assigned by the kernel 60.It vfc_refcount 61the number of active mount points using the file system 62.It vfc_flags 63flag bits, as described below 64.El 65.Pp 66The flags are defined as follows: 67.Pp 68.Bl -tag -width VFCF_DELEGADMIN -compact 69.It Dv VFCF_STATIC 70statically compiled into kernel 71.It Dv VFCF_NETWORK 72may get data over the network 73.It Dv VFCF_READONLY 74writes are not implemented 75.It Dv VFCF_SYNTHETIC 76data does not represent real files 77.It Dv VFCF_LOOPBACK 78aliases some other mounted FS 79.It Dv VFCF_UNICODE 80stores file names as Unicode 81.It Dv VFCF_JAIL 82can be mounted from within a jail if 83.Va allow.mount 84and 85.Va allow.mount.<vfc_name> 86jail parameters are set 87.It Dv VFCF_DELEGADMIN 88supports delegated administration if 89.Va vfs.usermount 90sysctl is set to 91.Dv 1 92.El 93.Sh RETURN VALUES 94.Rv -std getvfsbyname 95.Sh ERRORS 96The following errors may be reported: 97.Bl -tag -width Er 98.It Bq Er ENOENT 99The 100.Fa name 101argument 102specifies a file system that is unknown or not configured in the kernel. 103.El 104.Sh SEE ALSO 105.Xr jail 2 , 106.Xr mount 2 , 107.Xr sysctl 3 , 108.Xr jail 8 , 109.Xr mount 8 , 110.Xr sysctl 8 111.Sh HISTORY 112A variant of the 113.Fn getvfsbyname 114function first appeared in 115.Fx 2.0 . 116