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 August 7, 2001 30.Dt VM_PAGE_GRAB 9 31.Os 32.Sh NAME 33.Nm vm_page_grab 34.Nd "returns a page from an object" 35.Sh SYNOPSIS 36.In sys/param.h 37.In vm/vm.h 38.In vm/vm_page.h 39.Ft vm_page_t 40.Fn vm_page_grab "vm_object_t object" "vm_pindex_t pindex" "int allocflags" 41.Sh DESCRIPTION 42The 43.Fn vm_page_grab 44function returns the page at 45.Fa pindex 46from the given object. 47If the page exists and is busy, 48.Fn vm_page_grab 49will sleep while waiting for it. 50If the page does not exist, it is allocated. 51.Pp 52If 53.Dv VM_ALLOC_RETRY 54is not set in 55.Fa allocflags 56and the function sleeps, either getting the page from the object 57or while allocating it, 58.Dv NULL 59is returned. 60.Sh RETURN VALUES 61If successful, 62.Fn vm_page_grab 63returns the page; otherwise, 64.Dv NULL 65is returned. 66.Sh SEE ALSO 67.Xr vm_page_alloc 9 68.Sh AUTHORS 69This manual page was written by 70.An Chad David Aq davidc@acns.ab.ca . 71