share/man/man9/pmap_zero_page.9

   1 .\"
   2 .\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd July 21, 2003
  29 .Dt PMAP_ZERO 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_zero_page ,
  33 .Nm pmap_zero_area ,
  34 .Nm pmap_zero_idle
  35 .Nd zero-fill a page using machine-dependent optimizations
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In vm/vm.h
  39 .In vm/pmap.h
  40 .Ft void
  41 .Fn pmap_zero_page "vm_page_t m"
  42 .Ft void
  43 .Fn pmap_zero_page_area "vm_page_t m" "int off" "int size"
  44 .Ft void
  45 .Fn pmap_zero_page_idle "vm_page_t m"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn pmap_zero_page
  49 function zero-fills an entire page using machine-dependent optimizations.
  50 The
  51 .Fn pmap_zero_page_area
  52 function is used to zero-fill an area of a page.
  53 The range specified must not cross a page boundary; it must be contained
  54 entirely within a single page.
  55 .Pp
  56 The
  57 .Fn pmap_zero_page_idle
  58 interface is used by the
  59 .Nm vm_pagezero
  60 process.
  61 The system-wide
  62 .Va Giant
  63 lock should not be required to be held in order to call this interface.
  64 .Sh IMPLEMENTATION NOTES
  65 This function is required to be implemented for each architecture supported by
  66 .Fx .
  67 .Sh SEE ALSO
  68 .Xr bzero 3 ,
  69 .Xr pmap 9
  70 .Sh AUTHORS
  71 This manual page was written by
  72 .An Bruce M Simpson Aq bms@spc.org .