share/man/man9/vm_page_rename.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_RENAME 9
  31 .Os
  32 .Sh NAME
  33 .Nm vm_page_rename
  34 .Nd "move a page"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In vm/vm.h
  38 .In vm/vm_page.h
  39 .Ft void
  40 .Fo vm_page_rename
  41 .Fa "vm_page_t m"
  42 .Fa "vm_object_t new_object"
  43 .Fa "vm_pindex_t new_pindex"
  44 .Fc
  45 .Sh DESCRIPTION
  46 The
  47 .Fn vm_page_rename
  48 function removes a page from one object, and adds it to another
  49 at the given page index.
  50 The page is added to the given object, and is removed from the
  51 object that is currently associated with.
  52 If the page is currently on the cache queue it will be deactivated
  53 unless it is wired or unmanaged, in which case the deactivation will
  54 fail.
  55 The entire page is marked as dirty after the move.
  56 .Pp
  57 The arguments to
  58 .Fn vm_page_rename
  59 are:
  60 .Bl -tag -width ".Fa new_object"
  61 .It Fa m
  62 The page to move.
  63 .It Fa new_object
  64 The object the page should be inserted into.
  65 .It Fa new_pindex
  66 The page index into
  67 .Fa new_object
  68 at which the new page should be inserted.
  69 .El
  70 .Sh AUTHORS
  71 This manual page was written by
  72 .An Chad David Aq davidc@acns.ab.ca .