xref: /freebsd/lib/libc/gen/getvfsbyname.3 (revision 2a4a1db342263067035ce69a4017c645da63455d)
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.\" $FreeBSD$
34.\"
35.Dd May 4, 1995
36.Dt GETVFSBYNAME 3
37.Os
38.Sh NAME
39.Nm getvfsbyname
40.Nd get information about a filesystem
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In sys/param.h
45.In sys/mount.h
46.Ft int
47.Fn getvfsbyname "const char *name" "struct vfsconf *vfc"
48.Sh DESCRIPTION
49The
50.Fn getvfsbyname
51function provides access to information about a
52filesystem module that is configured in the kernel.
53If successful,
54the requested filesystem
55.Fa vfsconf
56is returned in the location pointed to by
57.Fa vfc .
58The fields in a
59.Dq Li struct vfsconf
60are defined as follows:
61.Pp
62.Bl -tag -compact -width vfc_refcount
63.It vfc_name
64the name of the filesystem
65.It vfc_typenum
66the filesystem type number assigned by the kernel
67.It vfc_refcount
68the number of active mount points using the filesystem
69.It vfc_flags
70flag bits as described in
71.Xr getvfsent 3
72.El
73.Sh RETURN VALUES
74.Rv -std getvfsbyname
75.Sh ERRORS
76The following errors may be reported:
77.Bl -tag -width Er
78.It Bq Er EFAULT
79The
80.Fa vfc
81pointer contains an invalid address.
82.It Bq Er ENOENT
83The
84.Fa name
85specifies a filesystem that is unknown or not configured in the kernel.
86.El
87.Sh SEE ALSO
88.Xr mount 2 ,
89.Xr getvfsent 3 ,
90.Xr sysctl 3 ,
91.Xr mount 8 ,
92.Xr sysctl 8
93.Sh HISTORY
94A variant of the
95.Fn getvfsbyname
96function first appeared in
97.Fx 2.0 .
98