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