Page MenuHomeFreeBSD
Differential D27194

Add vnode_pager_purge_range(9) KPI
ClosedPublic
Actions

Authored by khng on Nov 12 2020, 4:31 PM.
Tags
None
Referenced Files
F136267617: D27194.id86181.diff
Sun, Nov 16, 11:07 PM
Unknown Object (File)
Sun, Nov 16, 2:33 PM
Unknown Object (File)
Sat, Nov 15, 11:27 PM
Unknown Object (File)
Sat, Nov 15, 10:02 AM
Unknown Object (File)
Fri, Nov 14, 1:46 PM
Unknown Object (File)
Fri, Nov 14, 6:00 AM
Unknown Object (File)
Fri, Nov 14, 12:43 AM
Unknown Object (File)
Tue, Nov 11, 10:34 PM
View All Files
Subscribers
delphij
emaste
gbe
lwhsu
markj
rpokala

Details

Reviewers
allanjude
imp
brooks
markj
kib
alc
Group Reviewers
manpages
Commits
rGde2e15295966: Add vnode_pager_purge_range(9) KPI
Summary

This KPI is created in addition to the existing vnode_pager_setsize(9)
KPI. The KPI is intended for file systems that are able to turn a range
of file into sparse range, also known as hole-punching.

Submitted by: Ka Ho Ng <khng@freebsdfoundation.org>
Sponsored by: The FreeBSD Foundation

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 36714
Build 33603: arc lint + arc unit

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
markj added inline comments.Jan 28 2021, 5:00 PM
sys/vm/vnode_pager.c
555 ↗(On Diff #83022)

Suppose (startoff & PAGE_MASK) != 0. Note that OFF_TO_IDX(startoff) == OFF_TO_IDX(startoff & ~PAGE_MASK). Finally suppose that the page at OFF_TO_IDX(startoff) is resident in the object. vm_object_page_remove() will free the page at this index, so we will throw away data that is outside the requested range. In other words, I believe this vm_page_grab() call will always return NULL.

624 ↗(On Diff #83022)

I think this block of code is asking to be moved into a subroutine, otherwise it is duplicated three times in this file.

khng updated this revision to Diff 83085.Jan 29 2021, 6:19 AM
  • Two fixes:
khng marked 2 inline comments as done.Jan 29 2021, 6:20 AM
Harbormaster completed remote builds in B36593: Diff 83085.Jan 29 2021, 6:20 AM
khng updated this revision to Diff 83087.Jan 29 2021, 7:51 AM
  • Minor changes in vnode_pager_purge_range to unnecessary vm_object_page_remove
Harbormaster completed remote builds in B36595: Diff 83087.Jan 29 2021, 7:52 AM
khng mentioned this in D28347: Add fspacectl(2), vn_deallocate(9) and VOP_DEALLOCATE(9)..Jan 29 2021, 7:54 AM
khng planned changes to this revision.Feb 1 2021, 7:16 AM
khng updated this revision to Diff 83206.Feb 1 2021, 10:02 AM
  • vnode_pager_purge_range fixes on non-existing page (m == NULL)
Harbormaster completed remote builds in B36644: Diff 83206.Feb 1 2021, 10:02 AM
khng updated this revision to Diff 83339.Feb 4 2021, 8:44 AM

Rebased on top of cb7cc72c546e0f87598961c3860e17391f42866c

Harbormaster completed remote builds in B36697: Diff 83339.Feb 4 2021, 8:44 AM
khng updated this revision to Diff 83384.Feb 5 2021, 6:44 AM

Rebased on top of freebsd/main

Harbormaster completed remote builds in B36713: Diff 83384.Feb 5 2021, 6:44 AM
khng updated this revision to Diff 83385.Feb 5 2021, 6:45 AM

Rebased onto D27194

  • Add fspacectl(2) and VOP_FDEALLOCATE(9).
  • Regen.
  • Wire up OpenZFS with VOP_DEALLOCATE(9)
Herald added a reviewer: brooks. · View Herald TranscriptFeb 5 2021, 6:45 AM
Herald added a subscriber: delphij. · View Herald Transcript
Harbormaster completed remote builds in B36714: Diff 83385.Feb 5 2021, 6:45 AM
khng updated this revision to Diff 83447.Feb 6 2021, 4:06 AM

Fixes cross-referencing D28347

  • Add vnode_pager_purge_range(9) KPI
  • vnode_pager_purge_range comments updated
  • Add vnode_pager_purge_range.9
  • vnode_pager_purge_range.9 linting and style fixes
  • Update wording
  • Two fixes:
  • Minor changes in vnode_pager_purge_range to unnecessary vm_object_page_remove
  • vnode_pager_purge_range fixes on non-existing page (m == NULL)
Harbormaster completed remote builds in B36747: Diff 83447.Feb 6 2021, 4:06 AM
khng updated this revision to Diff 83455.Feb 6 2021, 1:31 PM

Rebased on top of freebsd/main

  • Add vnode_pager_purge_range(9) KPI
  • vnode_pager_purge_range comments updated
  • Add vnode_pager_purge_range.9
  • vnode_pager_purge_range.9 linting and style fixes
  • Update wording
  • Two fixes:
  • Minor changes in vnode_pager_purge_range to unnecessary vm_object_page_remove
  • vnode_pager_purge_range fixes on non-existing page (m == NULL)
Harbormaster completed remote builds in B36752: Diff 83455.Feb 6 2021, 1:31 PM
khng updated this revision to Diff 84321.Feb 20 2021, 10:21 AM

Rebased

  • Add vnode_pager_purge_range(9) KPI
  • vnode_pager_purge_range comments updated
  • Add vnode_pager_purge_range.9
  • vnode_pager_purge_range.9 linting and style fixes
  • Update wording
  • Two fixes:
  • Minor changes in vnode_pager_purge_range to unnecessary vm_object_page_remove
  • vnode_pager_purge_range fixes on non-existing page (m == NULL)
Harbormaster completed remote builds in B37212: Diff 84321.Feb 20 2021, 10:21 AM
khng updated this revision to Diff 84385.Feb 21 2021, 8:43 AM

Updated to tools/tools/git/git-arc.sh workflow

  • cpucontrol(8): Fix display.
  • grep: fix null pattern and empty pattern file behavior
  • grep: turn off -w if -x is specified
  • Add vnode_pager_purge_range(9) KPI
  • vnode_pager_purge_range comments updated
  • Add vnode_pager_purge_range.9
  • vnode_pager_purge_range.9 linting and style fixes
  • Update wording
  • Two fixes:
  • Minor changes in vnode_pager_purge_range to unnecessary vm_object_page_remove
  • vnode_pager_purge_range fixes on non-existing page (m == NULL)
  • Add fspacectl(2) and VOP_FDEALLOCATE(9).
  • Regen.
  • Wire up OpenZFS with VOP_DEALLOCATE(9)
Harbormaster completed remote builds in B37239: Diff 84385.Feb 21 2021, 8:43 AM
khng updated this revision to Diff 84400.Feb 21 2021, 2:33 PM

Rebased

Harbormaster completed remote builds in B37243: Diff 84400.Feb 21 2021, 2:33 PM
khng updated this revision to Diff 84407.Feb 21 2021, 2:43 PM
khng mentioned this in D28833: Implement posix_fallocate(2) by fo_fspacectl..
khng mentioned this in D28834: Wire up OpenZFS with VOP_DEALLOCATE(9).

Rebased on top of the newest D27194.

Harbormaster completed remote builds in B37250: Diff 84407.Feb 21 2021, 2:44 PM
khng edited the summary of this revision. (Show Details)Feb 21 2021, 2:49 PM
khng removed a child revision: D27195: fzero(2) API, fo_fzero and VOP_DEALLOCATE(9).
khng updated this revision to Diff 86181.Mar 23 2021, 10:11 AM

Updated commit message.

Harbormaster completed remote builds in B38004: Diff 86181.Mar 23 2021, 10:11 AM
khng updated this revision to Diff 86243.Mar 24 2021, 10:18 AM

Manual: fix missing includes

Harbormaster completed remote builds in B38038: Diff 86243.Mar 24 2021, 10:18 AM
gbe accepted this revision as: manpages.Apr 18 2021, 11:22 AM
gbe added a subscriber: gbe.

LGTM for the man page part.

khng updated this revision to Diff 88244.Apr 27 2021, 8:01 AM

Changed wording.

Harbormaster completed remote builds in B38886: Diff 88244.Apr 27 2021, 8:01 AM
markj added reviewers: markj, kib, alc.Aug 2 2021, 6:57 PM
khng removed a child revision: D28347: Add fspacectl(2), vn_deallocate(9) and VOP_DEALLOCATE(9)..Aug 2 2021, 7:13 PM
khng planned changes to this revision.Aug 2 2021, 7:53 PM
khng updated this revision to Diff 93141.Aug 2 2021, 9:16 PM
  • Cleanups on naming
  • Handle case for a possible wraparound when start near the UINT64_MAX
  • Add 'end' == 0 support to allow cleaning the object all the way to the end
  • Manpage update due to 'end' == 0 support.
Harbormaster completed remote builds in B40812: Diff 93141.Aug 2 2021, 9:17 PM
alc added inline comments.Aug 2 2021, 9:48 PM
share/man/man9/vnode_pager_purge_range.9
35 ↗(On Diff #93141)

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

57 ↗(On Diff #93141)

Replace "operation" by "affected".

59 ↗(On Diff #93141)
60 ↗(On Diff #93141)
65 ↗(On Diff #93141)
66 ↗(On Diff #93141)
70 ↗(On Diff #93141)
khng updated this revision to Diff 93148.Aug 2 2021, 11:01 PM
khng marked 7 inline comments as done.

vnode_pager_purge_range.9: Wording fixes from alc@.

Harbormaster completed remote builds in B40816: Diff 93148.Aug 2 2021, 11:01 PM
khng added inline comments.Aug 2 2021, 11:01 PM
share/man/man9/vnode_pager_purge_range.9
35 ↗(On Diff #93141)

That sounds better to me.

kib added inline comments.Aug 2 2021, 11:23 PM
sys/vm/vnode_pager.c
436 ↗(On Diff #93148)

Assert that end > base, and that end <= PAGE_SIZE?

556 ↗(On Diff #93148)

'VM object in vnode' is usuall written as v_object.
The lock is not held, it is taken internally, but I am not sure why is this important for the caller to know.

OTOH, I expect that caller is required to own at least the vnode lock. This should be expressed by an assert.

569 ↗(On Diff #93148)

Could this line be unwrapped?

571 ↗(On Diff #93148)

() is excessive.

585 ↗(On Diff #93148)

Again, as with shm case, if there is no resident page but file does not have a hole in the partial page' range, you need to clear the data. If this is supposed to be handled by the caller (ie. by fs), then documentation must be very clear about it.

khng added inline comments.Aug 3 2021, 1:35 AM
sys/vm/vnode_pager.c
569 ↗(On Diff #93148)

Longer than 80/81 cols for this one to be unwrapped.

585 ↗(On Diff #93148)

This is supposed to be handled by the caller.

khng updated this revision to Diff 93175.Aug 3 2021, 3:36 PM
khng marked 5 inline comments as done.
  • Manpage updates.
  • styles.
  • asserts in the vnode_pager_subpage_purge function.
Harbormaster completed remote builds in B40829: Diff 93175.Aug 3 2021, 3:36 PM
kib accepted this revision.Aug 3 2021, 4:13 PM
kib added inline comments.
sys/vm/vnode_pager.c
569 ↗(On Diff #93175)

I wonder if you should require exclusive lock on the vnode.

This revision is now accepted and ready to land.Aug 3 2021, 4:13 PM
khng added inline comments.Aug 3 2021, 4:24 PM
sys/vm/vnode_pager.c
569 ↗(On Diff #93175)

It is for file systems allowing MNTK_SHARED_WRITES, such as zfs.

Closed by commit rGde2e15295966: Add vnode_pager_purge_range(9) KPI (authored by khng). · Explain WhyAug 5 2021, 3:24 PM
This revision was automatically updated to reflect the committed changes.
khng added a commit: rGde2e15295966: Add vnode_pager_purge_range(9) KPI.

Revision Contents
Changeset List

Diff 83385

View Options

lib/libc/sys/Symbol.map

Loading...
View Options

sys/bsm/audit_kevents.h

Loading...
View Options

sys/compat/freebsd32/freebsd32_misc.c

Loading...
View Options

sys/compat/freebsd32/freebsd32_proto.h

Loading...
View Options

sys/compat/freebsd32/freebsd32_syscall.h

Loading...
View Options

sys/compat/freebsd32/freebsd32_syscalls.c

Loading...
View Options

sys/compat/freebsd32/freebsd32_sysent.c

Loading...
View Options

sys/compat/freebsd32/freebsd32_systrace_args.c

Loading...
View Options

sys/compat/freebsd32/syscalls.master

Loading...
View Options

sys/contrib/openzfs/module/os/freebsd/zfs/zfs_vnops_os.c

Loading...
View Options

sys/contrib/openzfs/module/os/freebsd/zfs/zfs_znode.c

Loading...
View Options

sys/kern/init_sysent.c

Loading...
View Options

sys/kern/sys_generic.c

Loading...
View Options

sys/kern/syscalls.c

Loading...
View Options

sys/kern/syscalls.master

Loading...
View Options

sys/kern/systrace_args.c

Loading...
View Options

sys/kern/vfs_default.c

Loading...
View Options

sys/kern/vfs_vnops.c

Loading...
View Options

sys/kern/vnode_if.src

Loading...
View Options

sys/security/audit/audit_bsm.c

Loading...
View Options

sys/sys/fcntl.h

Loading...
View Options

sys/sys/file.h

Loading...
View Options

sys/sys/syscall.h

Loading...
View Options

sys/sys/syscall.mk

Loading...
View Options

sys/sys/syscallsubr.h

Loading...
View Options

sys/sys/sysproto.h

Loading...
View Options

sys/sys/unistd.h

Loading...
View Options

sys/sys/vnode.h

Loading...