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. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)kvm_getvfsbyname.3 8.3 (Berkeley) 5/4/95 33.\" 34.Dd May 4, 1995 35.Dt GETVFSBYNAME 3 36.Os 37.Sh NAME 38.Nm getvfsbyname 39.Nd get information about a filesystem 40.Sh SYNOPSIS 41.Fd #include <sys/param.h> 42.Fd #include <sys/mount.h> 43.Ft int 44.Fn getvfsbyname "const char *name" "struct vfsconf *vfc" 45.Sh DESCRIPTION 46The 47.Fn getvfsbyname 48function provides access to information about a 49filesystem module that is configured in the kernel. 50If successful, 51the requested filesystem 52.Fa vfsconf 53is returned in the location pointed to by 54.Fa vfc . 55The fields in a 56.Dq Li struct vfsconf 57are defined as follows: 58.Pp 59.Bl -tag -compact -width vfc_refcount 60.It vfc_name 61the name of the filesystem 62.It vfc_typenum 63the filesystem type number assigned by the kernel 64.It vfc_refcount 65the number of active mount points using the filesystem 66.It vfc_flags 67flag bits that are used to initialize a new mount point 68using the filesystem 69.El 70.Sh RETURN VALUES 71If the call to 72.Nm getvfsbyname 73is successful, 0 is returned. 74Otherwise \-1 is returned and 75.Va errno 76is set appropriately. 77.Sh ERRORS 78The following errors may be reported: 79.Bl -tag -width Er 80.It Bq Er EFAULT 81The 82.Fa vfc 83pointer contains an invalid address. 84.It Bq Er ENOENT 85The 86.Fa name 87specifies a filesystem that is unknown or not configured in the kernel. 88.Sh SEE ALSO 89.Xr sysctl 1 , 90.Xr mount 2 , 91.Xr sysctl 3 , 92.Xr mount 8 93.Sh HISTORY 94A variant of the 95.Fn getvfsbyname 96function first appeared in 97.Fx 2.0 . 98