Differential D27194 Diff 93148 share/man/man9/vnode_pager_purge_range.9

Changeset View

Standalone View

View Options

share/man/man9/vnode_pager_purge_range.9

This file was added.

.\"

.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD

.\"

.\" This manual page was written by Ka Ho Ng under sponsorship from

.\" the FreeBSD Foundation.

.\"

.\" Redistribution and use in source and binary forms, with or without

.\" modification, are permitted provided that the following conditions

.\" are met:

.\" 1. Redistributions of source code must retain the above copyright

.\" notice, this list of conditions and the following disclaimer.

.\" 2. Redistributions in binary form must reproduce the above copyright

.\" notice, this list of conditions and the following disclaimer in the

.\" documentation and/or other materials provided with the distribution.

.\"

.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND

.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE

.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

.\" SUCH DAMAGE.

.\"

.Dd August 2, 2021

.Dt VNODE_PAGER_PURGE_RANGE 9

.Os

.Sh NAME

.Nm vnode_pager_purge_range

.Nd "invalidate the cached contents within the given byte range"

.Sh SYNOPSIS

alcUnsubmitted

Done

I would suggest "invalidate the cached contents within the given byte range" here and below.

alc: I would suggest "invalidate the cached contents within the given byte range" here and below.

khngAuthorUnsubmitted

Done

That sounds better to me.

khng: That sounds better to me.

.In sys/param.h

.In vm/vm.h

.In vm/vm_extern.h

rpokalaUnsubmitted

Done

.Nm
invalidates contents of the cache ...

rpokala: ``` .Nm invalidates contents of the cache ... ```

.Ft void

.Fo vnode_pager_purge_range

.Fa "struct vnode *vp"

.Fa "vm_ooffset_t start"

.Fa "vm_ooffset_t end"

.Fc

.Sh DESCRIPTION

rpokalaUnsubmitted

Done

"Affected"

rpokala: "Affected"

.Nm

invalidates the cached contents within the given byte range from the

specified vnode

.Fa vp .

The range to be purged is

.Eo [

.Fa start , end

.Ec ) .

If the

.Fa end

rpokalaUnsubmitted

Done

for content occupying whole blocks within block

rpokala: ``` for content occupying whole blocks within block ```

parameter is the value zero, the affected range starts from

.Fa start

alcUnsubmitted

Done

Replace "operation" by "affected".

alc: Replace "operation" by "affected".

continues to the end of the object.

Pages within the specified range will be removed from the object's queue.

alcUnsubmitted

Done

.Fa start

- to the end of the object.

+ and continues to the end of the object.

Pages within the specified range will be removed from the object queue.

alc:

alcUnsubmitted

Done

to the end of the object.

- Pages within the specified range will be removed from the object queue.

+ Pages within the specified range will be removed from the object's queue.

.Fa start

alc:

.Fa start

.Fa end

is not aligned to a page boundary, the invalidated part of the page is zeroed.

.Pp

alcUnsubmitted

Done

.Fa end

- is not aligned to page boundaries,

+ is not aligned to a page boundary,

partial-page area is zeroed.

alc:

In case the vnode

alcUnsubmitted

Done

is not aligned to page boundaries,

- partial-page area is zeroed.

+ the invalidated part of the page is zeroed.

.Pp

In case the vnode

alc:

.Fa vp

does not have a VM object allocated, the effect of calling this function is a

no-op.

.Sh LOCKS

alcUnsubmitted

Done

.Fa vp

- does not have a VM object allocated, the effect of calling this function is no-op.

+ does not have a VM object allocated, the effect of calling this function is a no-op.

.Sh LOCKS

alc:

The vnode should be locked on entry and will still be locked on exit.

.Sh SEE ALSO

.Xr vnode 9

.Sh HISTORY

The

.Nm

manual page first appeared in

.Fx 14 .

.Sh AUTHORS

This

manual page was written by

.An Ka Ho Ng Aq Mt khng@FreeBSD.org .