xref: /freebsd/share/man/man9/vm_page_wire.9 (revision b9f654b163bce26de79705e77b872427c9f2afa1)
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 July 13, 2001
30.Dt VM_PAGE_WIRE 9
31.Os
32.Sh NAME
33.Nm vm_page_wire ,
34.Nm vm_page_unwire
35.Nd "wire and unwire pages"
36.Sh SYNOPSIS
37.In sys/param.h
38.In vm/vm.h
39.In vm/vm_page.h
40.Ft void
41.Fn vm_page_wire "vm_page_t m"
42.Ft void
43.Fn vm_page_unwire "vm_page_t m" "int activate"
44.Sh DESCRIPTION
45The
46.Fn vm_page_wire
47function increments the wire count on a page, and removes it from
48whatever queue it is on.
49.Pp
50The
51.Fn vm_page_unwire
52function releases one of the wirings on the page.
53When
54.Va write_count
55reaches zero the page is placed back onto either the active queue
56(if
57.Fa activate
58is non-zero) or onto the inactive queue (if
59.Fa activate
60is zero).
61If the page is unmanaged
62.Dv ( PG_UNMANAGED
63is set) then the page is left on
64.Dv PQ_NONE .
65.Sh AUTHORS
66This manual page was written by
67.An Chad David Aq Mt davidc@acns.ab.ca .
68