Page MenuHomeFreeBSD

ithread(9): update top-level description
ClosedPublic

Authored by mhorne on Dec 15 2021, 5:26 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Jun 15, 12:03 PM
Unknown Object (File)
May 12 2024, 10:29 AM
Unknown Object (File)
May 10 2024, 11:37 AM
Unknown Object (File)
May 10 2024, 11:37 AM
Unknown Object (File)
May 10 2024, 11:36 AM
Unknown Object (File)
May 10 2024, 11:36 AM
Unknown Object (File)
Mar 17 2024, 11:28 AM
Unknown Object (File)
Mar 13 2024, 12:32 AM

Details

Summary

The ithread has been subsumed by the 'interrupt event' object, so
update the description to reflect this by describing an interrupt event
and its contents. We've also moved on from having a single handler
function to the split filter-and-handler model. Explain the purpose and
constraints of these two handlers.

Diff Detail

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

Event Timeline

Looking for content review primarily before wording/grammer/formatting.

share/man/man9/ithread.9
76–78 ↗(On Diff #100087)

line breaks here are weird.

pauamma_gundo.com added inline comments.
share/man/man9/ithread.9
129 ↗(On Diff #100087)

Typo for "intr"?

mhorne marked 2 inline comments as done.

Rebase. Handle feedback, rework text describing locks and sleeping, and add subsections to organize the description somewhat.

jhb added inline comments.
share/man/man9/intr_event.9
92
107

I think you want to be careful here about the phrase "interrupt handler" to avoid ambiguity. Here I think you mean the threaded handler?

114

Not sure if you want to clarify that you can't call malloc at all in a filter?

This revision is now accepted and ready to land.Sep 30 2022, 9:05 PM

Other than these nits (and bumping .Dd), English in this LGTM.

share/man/man9/intr_event.9
81
96
107

Seconded.

114

The clearer, the better.

mhorne marked 7 inline comments as done.

Update Handler Constraints to address review comments.
Avoid referring to "filter" and "handler" functions as "callbacks".

I discovered that the filter and threaded routines are described in detail
already in bus_setup_intr(9). I think the overlap is acceptable, however.

This revision now requires review to proceed.Oct 6 2022, 5:58 PM

Small further tweaks, mainly, clarify that filters are executed in a critical section.

bcr added a subscriber: bcr.

OK from manpages.

jhb added inline comments.
share/man/man9/intr_event.9
114

Suggestion: s/disallowed/not permitted/? (Not a strong preference either way though)

121–122

You could maybe just say "non-sleepable locks"

This revision is now accepted and ready to land.Oct 7 2022, 5:58 PM
pauamma_gundo.com added inline comments.
share/man/man9/intr_event.9
114

"forbidden" feels more less stilted than "disallowed" and less likely to be misread by missing "not" than "not permitted".

121–122

Seconded.

124

"should", not "must"?

128

Or "later, outside (mumble) context".

This revision now requires changes to proceed.Oct 9 2022, 7:36 AM
mhorne marked 5 inline comments as done.

Handle feedback.

English LGTM. Can't say beyond that.

This revision is now accepted and ready to land.Oct 9 2022, 7:07 PM
This revision was automatically updated to reflect the committed changes.