Page MenuHomeFreeBSD
Differential D29637

vnode_pager_setsize.9: Some clarifications on the manpage
ClosedPublic
Actions

Authored by khng on Apr 8 2021, 7:38 AM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Jan 24, 5:10 PM
Unknown Object (File)
Wed, Jan 22, 5:25 PM
Unknown Object (File)
Wed, Jan 22, 3:08 PM
Unknown Object (File)
Tue, Jan 21, 9:18 AM
Unknown Object (File)
Sat, Jan 18, 10:22 PM
Unknown Object (File)
Sat, Jan 18, 10:20 PM
Unknown Object (File)
Sat, Jan 18, 5:44 PM
Unknown Object (File)
Sat, Jan 18, 5:37 PM
View All Files
Subscribers
bcr
imp

Details

Reviewers
kib
bcr
philip
Group Reviewers
manpages
Commits
rG75f7db7c11fe: vnode_pager_setsize.9: Some clarifications on the manpage
rG17db2ae5b520: vnode_pager_setsize.9: Some clarifications on the manpage
rGb77f5f5553e8: vnode_pager_setsize.9: Some clarifications on the manpage
Summary

A number of changes:

  • Clarifies the locking rules when calling the routine.
  • Correct the description regarding the content range to be purged.
  • Document the effects on page fault handler.

MFC after: 3 days
MFC with: 86a52e262a6f
Sponsored by: The FreeBSD Foundation

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

khng created this revision.Apr 8 2021, 7:38 AM
Herald added a reviewer: manpages. · View Herald TranscriptApr 8 2021, 7:38 AM
Herald added a subscriber: imp. · View Herald Transcript
Harbormaster completed remote builds in B38397: Diff 87002.Apr 8 2021, 7:38 AM
khng requested review of this revision.Apr 8 2021, 7:38 AM
bcr accepted this revision.Apr 8 2021, 7:41 AM
bcr added a subscriber: bcr.

OK from manpages. For this content change, you need to bump the .Dd to the date of the commit.
Thanks!

This revision is now accepted and ready to land.Apr 8 2021, 7:41 AM
khng updated this revision to Diff 87003.Apr 8 2021, 7:44 AM

.Dd updates and add document the direction from old EOF to new EOF as well.

This revision now requires review to proceed.Apr 8 2021, 7:44 AM
Harbormaster completed remote builds in B38398: Diff 87003.Apr 8 2021, 7:44 AM
bcr accepted this revision.Apr 8 2021, 7:56 AM

Ah, even better now. Good to go!

This revision is now accepted and ready to land.Apr 8 2021, 7:56 AM
kib added inline comments.Apr 8 2021, 4:49 PM
share/man/man9/vnode_pager_setsize.9
43–44

'Content purged from cache' is a vague slang, we usually formulate it in terms of 'pages removes from the object queue', and then you can clarify what happens with pages fully contained in the range, and what with the partial page.

48

Arguably, this sentence is not an implementation note, but a good herald description of the function.

50

I do not understand this paragraph at all.

56–57

will be zeroed if it exists resident.

khng updated this revision to Diff 87065.Apr 8 2021, 7:23 PM

Updates.

This revision now requires review to proceed.Apr 8 2021, 7:23 PM
Harbormaster completed remote builds in B38427: Diff 87065.Apr 8 2021, 7:23 PM
bcr accepted this revision as: manpages.Apr 8 2021, 8:00 PM

OK for this newer version of the manpage.

kib added a comment.Apr 8 2021, 8:16 PM

Also, your updates still miss the _main_ point of the function, that is, to define which part of oversized file mapping causes SIGBUS.

share/man/man9/vnode_pager_setsize.9
43–44

There are at least two object sizes for OBJT_VNODE, one is the size in pages, and another in bytes. I am not sure it makes much sense to try to articulate that assigning byte size to page size requires some arithmetic.

49

This sentence is technically correct but sounds foreign even for me non-native.

51

What are you trying to say there? Page chunks at EOF are marked invalid, invalid cannot be dirty.

55

vm object allocated

khng updated this revision to Diff 87083.Apr 8 2021, 9:50 PM

Updated. Document the behavior around page faults as well.

Harbormaster completed remote builds in B38437: Diff 87083.Apr 8 2021, 9:50 PM
khng updated this revision to Diff 87085.Apr 8 2021, 9:52 PM

Wording around page fault behavior.

Harbormaster completed remote builds in B38438: Diff 87085.Apr 8 2021, 9:52 PM
khng marked 3 inline comments as done.Apr 8 2021, 9:53 PM
kib added inline comments.Apr 8 2021, 10:10 PM
share/man/man9/vnode_pager_setsize.9
43–44

s/useful for use/must be used/

... to implement truncation if filesystem allocated vm_object.

44

... zeroed and marked invalid...

khng updated this revision to Diff 87090.Apr 8 2021, 10:21 PM

Wording.

Harbormaster completed remote builds in B38442: Diff 87090.Apr 8 2021, 10:21 PM
kib accepted this revision.Apr 8 2021, 10:32 PM
This revision is now accepted and ready to land.Apr 8 2021, 10:32 PM
khng added a reviewer: philip.Apr 8 2021, 11:54 PM
philip accepted this revision.Apr 9 2021, 12:12 AM

Approved by: philip (mentor)

Closed by commit rGb77f5f5553e8: vnode_pager_setsize.9: Some clarifications on the manpage (authored by khng). · Explain WhyApr 11 2021, 6:48 AM
This revision was automatically updated to reflect the committed changes.
khng marked an inline comment as done and an inline comment as not done.
khng added a commit: rGb77f5f5553e8: vnode_pager_setsize.9: Some clarifications on the manpage.
khng added a commit: rG17db2ae5b520: vnode_pager_setsize.9: Some clarifications on the manpage.Apr 27 2021, 8:45 AM
khng added a commit: rG75f7db7c11fe: vnode_pager_setsize.9: Some clarifications on the manpage.Sep 3 2021, 6:48 PM

Revision Contents
Changeset List

PathSize
share/
man/
man9/
41 lines

Diff 87236

View Options

share/man/man9/vnode_pager_setsize.9

Loading...