xref: /freebsd/share/man/man9/vn_isdisk.9 (revision cbb3ec25236ba72f91cbdf23f8b78b9d1af0cedf)
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.Dd June 28, 2021
28.Dt VN_ISDISK 9
29.Os
30.Sh NAME
31.Nm vn_isdisk
32.Nd "checks if a vnode represents a disk"
33.Sh SYNOPSIS
34.In sys/param.h
35.In sys/vnode.h
36.Ft bool
37.Fn vn_isdisk "struct vnode *vp"
38.Ft bool
39.Fn vn_isdisk_error "struct vnode *vp" "int *errp"
40.Sh DESCRIPTION
41The
42.Fn vn_isdisk
43and
44.Fn vn_isdisk_error
45functions check to see if
46.Fa vp
47represents a disk.
48In order for
49.Fa vp
50to be a disk,
51it must be a character device,
52.Va v_rdev
53must be valid, and the
54.Vt cdevsw
55entry's
56.Va flags
57must have
58.Dv D_DISK
59set.
60.Pp
61The arguments are:
62.Bl -tag -width ".Fa errp"
63.It Fa vp
64The vnode to check.
65.It Fa errp
66An integer pointer to store the error number in if the call fails.
67.El
68.Sh RETURN VALUES
69If the vnode represents a disk, true is returned; otherwise, false
70is returned and
71.Fa errp
72will contain the error number.
73.Sh AUTHORS
74This manual page was written by
75.An Chad David Aq Mt davidc@acns.ab.ca .
76