2 .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
34 .Nd "allocate a page for a"
41 .Fn vm_page_alloc "vm_object_t object" "vm_pindex_t pindex" "int req"
45 function allocates a page at
49 It is assumed that a page has not already been allocated at
51 The page returned is inserted into the object, unless
60 .Bl -tag -width ".Fa object"
62 The VM object to allocate the page for.
69 The index into the object at which the page should be inserted.
71 The bitwise-inclusive OR of a class and any optional flags indicating
72 how the page should be allocated.
74 Exactly one of the following classes must be specified:
75 .Bl -tag -width ".Dv VM_ALLOC_INTERRUPT"
76 .It Dv VM_ALLOC_NORMAL
77 The page should be allocated with no special treatment.
78 .It Dv VM_ALLOC_SYSTEM
79 The page can be allocated if the cache is empty and the free
80 page count is above the interrupt reserved water mark.
81 This flag should be used only when the system really needs the page.
82 .It Dv VM_ALLOC_INTERRUPT
84 is being called during an interrupt.
85 A page will be returned successfully if the free page count is greater
89 The optional flags are:
90 .Bl -tag -width ".Dv VM_ALLOC_NOBUSY"
91 .It Dv VM_ALLOC_NOBUSY
92 The returned page will not be exclusive busy.
93 .It Dv VM_ALLOC_NODUMP
94 The returned page will not be included in any kernel core dumps
95 regardless of whether or not it is mapped in to KVA.
97 Do not associate the allocated page with a vm object.
101 .It Dv VM_ALLOC_SBUSY
102 The returned page will be shared busy.
103 .It Dv VM_ALLOC_WIRED
104 The returned page will be wired.
106 Indicate a preference for a pre-zeroed page.
107 There is no guarantee that the returned page will be zeroed, but it
110 flag set if it is zeroed.
116 that was allocated is returned if successful; otherwise,
120 The pager process is always upgraded to
123 .Dv VM_ALLOC_INTERRUPT
126 This manual page was written by
127 .An Chad David Aq Mt davidc@acns.ab.ca .