xref: /freebsd/share/man/man9/vn_isdisk.9 (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1.\"
2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. 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(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25.\" DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd June 28, 2021
30.Dt VN_ISDISK 9
31.Os
32.Sh NAME
33.Nm vn_isdisk
34.Nd "checks if a vnode represents a disk"
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/vnode.h
38.Ft bool
39.Fn vn_isdisk "struct vnode *vp"
40.Ft bool
41.Fn vn_isdisk_error "struct vnode *vp" "int *errp"
42.Sh DESCRIPTION
43The
44.Fn vn_isdisk
45and
46.Fn vn_isdisk_error
47functions check to see if
48.Fa vp
49represents a disk.
50In order for
51.Fa vp
52to be a disk,
53it must be a character device,
54.Va v_rdev
55must be valid, and the
56.Vt cdevsw
57entry's
58.Va flags
59must have
60.Dv D_DISK
61set.
62.Pp
63The arguments are:
64.Bl -tag -width ".Fa errp"
65.It Fa vp
66The vnode to check.
67.It Fa errp
68An integer pointer to store the error number in if the call fails.
69.El
70.Sh RETURN VALUES
71If the vnode represents a disk, true is returned; otherwise, false
72is returned and
73.Fa errp
74will contain the error number.
75.Sh AUTHORS
76This manual page was written by
77.An Chad David Aq Mt davidc@acns.ab.ca .
78