share/man/man9/VOP_GETPAGES.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 1996 Doug Rabson
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD: src/share/man/man9/VOP_GETPAGES.9,v 1.4.2.2 2001/12/17 11:30:18 ru Exp $
  30 .\" $DragonFly: src/share/man/man9/VOP_GETPAGES.9,v 1.3 2003/07/27 05:36:06 hmp Exp $
  31 .\"
  32 .Dd July 24, 1996
  33 .Os
  34 .Dt VOP_GETPAGES 9
  35 .Sh NAME
  36 .Nm VOP_GETPAGES ,
  37 .Nm VOP_PUTPAGES
  38 .Nd read or write VM pages from a file
  39 .Sh SYNOPSIS
  40 .In sys/param.h
  41 .In sys/vnode.h
  42 .In vm/vm.h
  43 .Ft int
  44 .Fn VOP_GETPAGES "struct vnode *vp" "vm_page_t *m" "int count" "int reqpage" "vm_ooffset_t offset"
  45 .Ft int
  46 .Fn VOP_PUTPAGES "struct vnode *vp" "vm_page_t *m" "int count" "int sync" "int *rtvals" "vm_ooffset_t offset"
  47 .Sh DESCRIPTION
  48 The arguments are:
  49 .Bl -tag -width reqpage
  50 .It Fa vp
  51 The file to access.
  52 .It Fa m
  53 A page ???
  54 .It Fa count
  55 How many pages to access.
  56 .It Fa sync
  57 Nonzero if the write should be synchronous.
  58 .It Fa rtvals
  59 ???
  60 .It Fa reqpage
  61 ???
  62 .It Fa offset
  63 Offset in the file to start accessing.
  64 .El
  65 .Pp
  66 Not quite sure about this one.
  67 .Sh RETURN VALUES
  68 Zero is returned on success, otherwise an error is returned.
  69 .Sh SEE ALSO
  70 .Xr vnode 9
  71 .Sh AUTHORS
  72 This man page was written by
  73 .An Doug Rabson .