xref: /csrg-svn/lib/libc/gen/getvfsbyname.3 (revision 68720)
1*68720Smckusick.\" Copyright (c) 1995
2*68720Smckusick.\"	The Regents of the University of California.  All rights reserved.
3*68720Smckusick.\"
4*68720Smckusick.\" %sccs.include.redist.man%
5*68720Smckusick.\"
6*68720Smckusick.\"     @(#)getvfsbyname.3	8.1 (Berkeley) 04/03/95
7*68720Smckusick.\"
8*68720Smckusick.Dd
9*68720Smckusick.Dt KVM_GETVFSBYNAME 3
10*68720Smckusick.Os
11*68720Smckusick.Sh NAME
12*68720Smckusick.Nm kvm_getvfsbyname
13*68720Smckusick.Nd get information about a filesystem
14*68720Smckusick.Sh SYNOPSIS
15*68720Smckusick.Fd #include <sys/types.h>
16*68720Smckusick.Fd #include <sys/mount.h>
17*68720Smckusick.Fd #include <kvm.h>
18*68720Smckusick.br
19*68720Smckusick.Ft int
20*68720Smckusick.Fn kvm_getvfsbyname "const char *name" "struct vfsconf *vfc"
21*68720Smckusick.Sh DESCRIPTION
22*68720SmckusickThe
23*68720Smckusick.Fn kvm_getvfsbyname
24*68720Smckusickfunction provides access to information about a
25*68720Smckusickfilesystem module that is configured in the kernel.
26*68720SmckusickIf successful,
27*68720Smckusickthe requested filesystem
28*68720Smckusick.Fa vfsconf
29*68720Smckusickis returned in the location pointed to by
30*68720Smckusick.Nm vfc .
31*68720SmckusickThe fields in a
32*68720Smckusick.Dq Li struct vfsconf
33*68720Smckusickare defined as follows:
34*68720Smckusick.Pp
35*68720Smckusick.Bl -tag -compact -width vfc_refcount
36*68720Smckusick.It vfc_name
37*68720Smckusickthe name of the filesystem
38*68720Smckusick.It vfc_index
39*68720Smckusickthe filesystem type number assigned by the kernel
40*68720Smckusick.It vfc_refcount
41*68720Smckusickthe number of active mount points using the filesystem
42*68720Smckusick.It vfc_flags
43*68720Smckusickflag bits that are used to initialize a new mount point
44*68720Smckusickusing the filesystem
45*68720Smckusick.El
46*68720Smckusick.Sh RETURN VALUES
47*68720SmckusickIf the call to
48*68720Smckusick.Nm getvfsbyname
49*68720Smckusickis successful, 0 is returned.
50*68720SmckusickOtherwise \-1 is returned and
51*68720Smckusick.Va errno
52*68720Smckusickis set appropriately.
53*68720Smckusick.Sh ERRORS
54*68720SmckusickThe following errors may be reported:
55*68720Smckusick.Bl -tag -width Er
56*68720Smckusick.It Bq Er EFAULT
57*68720SmckusickThe
58*68720Smckusick.Fa vfc
59*68720Smckusickpointer contains an invalid address.
60*68720Smckusick.It Bq Er ENOENT
61*68720SmckusickThe
62*68720Smckusick.Fa name
63*68720Smckusickspecifies a filesystem that is unknown or not configured in the kernel.
64*68720Smckusick.Sh SEE ALSO
65*68720Smckusick.Xr sysctl 1 ,
66*68720Smckusick.Xr mount 2 ,
67*68720Smckusick.Xr sysctl 3 ,
68*68720Smckusick.Xr mount 8
69*68720Smckusick.Sh HISTORY
70*68720SmckusickA variant of the
71*68720Smckusick.Fn getvfsbyname
72*68720Smckusickfunction first appeared in FreeBSD 2.0.
73