Differential D27194 Diff 83384 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

.\"

.\" 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 January 26, 2021

.Dt VNODE_PAGER_PURGE_RANGE 9

.Os

.Sh NAME

.Nm vnode_pager_purge_range

.Nd "invalidate the content of the given range in bytes from cache"

.Sh SYNOPSIS

.In vm/vm_extern.h

.Ft void

.Fn vnode_pager_purge_range "struct vnode *vp" "vm_ooffset_t startoff" "vm_ooffset_t endoff"

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.

.Sh DESCRIPTION

.Nm

invalidates content of the cache covered by the given range from the

rpokalaUnsubmitted

Done

.Nm
invalidates contents of the cache ...

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

specified vnode

.Fa vp .

The range to be purged is

.Eo [

.Fa startoff , endoff

.Ec ) .

Affected pages within the specified range will be tossed away.

rpokalaUnsubmitted

Done

"Affected"

rpokala: "Affected"

.Sh IMPLEMENTATION NOTES

Within the specified range,

in case

.Fa startoff

.Fa endoff

is not aligned to page boundaries,

partial-page area will be zeroed.

In partial-page area,

for content occupying whole blocks within block

rpokalaUnsubmitted

Done

for content occupying whole blocks within block

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

boundaries,

the dirty bits for the corresponding blocks will be cleared.

alcUnsubmitted

Done

Replace "operation" by "affected".

alc: Replace "operation" by "affected".

.Sh LOCKING

Writer lock of the VM object of

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:

.Fa vp

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:

will be held within the function.

.Sh SEE ALSO

.Xr vnode 9

.Sh HISTORY

The

alcUnsubmitted

Done

.Fa end

- is not aligned to page boundaries,

+ is not aligned to a page boundary,

partial-page area is zeroed.

alc:

.Nm

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:

manual page first appeared in

.Fx 14 .

.Sh AUTHORS

This

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:

manual page was written by

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