diff options
author | alfred <alfred@FreeBSD.org> | 2001-12-02 02:13:35 +0000 |
---|---|---|
committer | alfred <alfred@FreeBSD.org> | 2001-12-02 02:13:35 +0000 |
commit | 686c6d137f35735b4d160e2c7dce11fdb60729c8 (patch) | |
tree | 0340d823cf466eac3b31c7e3861154583e96f5e3 /share/man/man9/vm_page_grab.9 | |
parent | f1ae0d570ce0554a7fd92b6a47cfc37137eb11a7 (diff) | |
download | FreeBSD-src-686c6d137f35735b4d160e2c7dce11fdb60729c8.zip FreeBSD-src-686c6d137f35735b4d160e2c7dce11fdb60729c8.tar.gz |
Add manpages describing various vfs and vm APIs.
Submitted by: Chad David <davidc@acns.ab.ca>
Diffstat (limited to 'share/man/man9/vm_page_grab.9')
-rw-r--r-- | share/man/man9/vm_page_grab.9 | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/share/man/man9/vm_page_grab.9 b/share/man/man9/vm_page_grab.9 new file mode 100644 index 0000000..05f880b --- /dev/null +++ b/share/man/man9/vm_page_grab.9 @@ -0,0 +1,70 @@ +.\" +.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice(s), this list of conditions and the following disclaimer as +.\" the first lines of this file unmodified other than the possible +.\" addition of one or more copyright notices. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice(s), this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY +.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +.\" DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd August 7, 2001 +.Dt VM_PAGE_GRAB 9 +.Os +.Sh NAME +.Nm vm_page_grab +.Nd "returns a page from an object" +.Sh SYNOPSIS +.In sys/param.h +.In vm/vm.h +.In vm/vm_page.h +.Ft vm_page_t +.Fn vm_page_grab "vm_object_t object" "vm_pindex_t pindex" "int allocflags" +.Sh DESCRIPTION +The +.Fn vm_page_grab +function returns the page at +.Fa pindex +from the given object. +If the page exists and is busy +.Fn vm_page_grab +will sleep while waiting for it. +If the page does not exists it is allocated. +.Pp +If +.Dv VM_ALLOC_RETRY +is not set in +.Fa allocflags +and the function sleeps, either getting the page from the object +or while allocating it, +.Dv NULL +is returned. +.Sh RETURN VALUES +If successful +.Fn vm_page_grab +return the page; otherwise, +.Dv NULL +is returned. +.Sh SEE ALSO +.Xr vm_page_alloc 9 +.Sh AUTHORS +This man page was written by +.An Chad David Aq davidc@acns.ab.ca . |