share/man/man9/vm_page_sleep_if_busy.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 13, 2001
  30 .Dt VM_PAGE_SLEEP_IF_BUSY 9
  31 .Os
  32 .Sh NAME
  33 .Nm vm_page_sleep_if_busy
  34 .Nd "wait for a busy page to become unbusy"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In vm/vm.h
  38 .In vm/vm_page.h
  39 .Ft int
  40 .Fn vm_page_sleep_if_busy "vm_page_t m" "int also_m_busy" "const char *wmesg"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn vm_page_sleep_if_busy
  44 function waits until the
  45 .Dv VPO_BUSY
  46 flag is cleared.
  47 If
  48 .Fa also_m_busy
  49 is non-zero, it also waits for
  50 .Fa m->busy
  51 to become zero.
  52 .Sh RETURN VALUES
  53 If
  54 .Fn vm_page_sleep_if_busy
  55 finds the page busy it returns
  56 .Dv TRUE .
  57 If not, it returns
  58 .Dv FALSE .
  59 Returning
  60 .Dv TRUE
  61 does not necessary mean that
  62 .Fn vm_page_sleep_if_busy
  63 slept, but only that
  64 .Fn splvm
  65 was called.
  66 .Sh AUTHORS
  67 This manual page was written by
  68 .An Chad David Aq davidc@acns.ab.ca .