share/man/man9/vm_page_io.9

   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 17, 2001
  30 .Dt VM_PAGE_IO_START 9
  31 .Os
  32 .Sh NAME
  33 .Nm vm_page_io_start ,
  34 .Nm vm_page_io_finish
  35 .Nd "ready or unready a page for I/O"
  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_io_start "vm_page_t m"
  42 .Ft void
  43 .Fn vm_page_io_finish "vm_page_t m"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn vm_page_io_start
  47 function prepares the page for I/O by incrementing its busy flag by one.
  48 .Pp
  49 The
  50 .Fn vm_page_io_finish
  51 function lowers the busy count on the page by one, if the resulting busy
  52 count is zero, a
  53 .Xr wakeup 9
  54 will be issued if the page has been marked
  55 .Dv VPO_WANTED .
  56 A page is typically marked
  57 .Dv VPO_WANTED
  58 by a thread to register its interest in
  59 the page to either complete I/O or becoming available for general use.
  60 .Sh AUTHORS
  61 .An -nosplit
  62 This manual page was written by
  63 .An Chad David Aq davidc@acns.ab.ca
  64 and
  65 .An Alfred Perlstein Aq alfred@FreeBSD.org .