Differential D43947

Manual page for mq_getfd_np(2)
Needs ReviewPublic
Actions

Authored by unitrunker_gmail.com on Feb 17 2024, 6:21 AM.

Details

Reviewers

concussious.bugzilla_runbox.com

Group Reviewers

manpages

Summary

mq_getfd_np was made available in FreeBSD 11 with no documentation.

Under the hood - this function dereferences the mqd_t as a pointer to an int.

It's a simple function but needs guidance on what is safe usage for the returned file descriptor.

Please review - particularly the "Notes" section.

Test Plan

Ran the following to confirm behavior.

fork followed by fstat in both parent and child process (confirmed mqd_t and fd remain valid).
close before mq_close (not a good practice - see "Notes")
mq_close before close (also not a good practice - see "Notes")

Test program attached to bug 273230.
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=273230

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

unitrunker_gmail.com created this revision.Feb 17 2024, 6:21 AM

Herald added a subscriber: imp. · View Herald TranscriptFeb 17 2024, 6:21 AM

unitrunker_gmail.com requested review of this revision.Feb 17 2024, 6:21 AM

unitrunker_gmail.com edited the summary of this revision. (Show Details)

unitrunker_gmail.com added a reviewer: manpages.Feb 17 2024, 6:26 AM

unitrunker_gmail.com retitled this revision from Manual page for mq_getdf_np(2) to Manual page for mq_getfd_np(2).Feb 17 2024, 6:32 AM

concussious.bugzilla_runbox.com requested changes to this revision.Feb 17 2024, 10:00 PM

concussious.bugzilla_runbox.com added a subscriber: concussious.bugzilla_runbox.com.

concussious.bugzilla_runbox.com added inline comments.

lib/libsys/mq_getfd_np.2
2	Tried to put this at the very top but it didn't work out. https://man.freebsd.org/cgi/man.cgi?query=style&apropos=0&sektion=0&manpath=FreeBSD+
43	This doesn't need to be quoted
57	Why a blank line? .Pp?

This revision now requires changes to proceed.Feb 17 2024, 10:00 PM

pauamma_gundo.com added a subscriber: pauamma_gundo.com.Feb 18 2024, 10:33 PM

pauamma_gundo.com added inline comments.

lib/libsys/mq_getfd_np.2
53
63
65
74
86
87
92–94
116

sak_codered.rmta.org added a subscriber: sak_codered.rmta.org.Feb 19 2024, 4:09 AM

feedback from concussious
feedback from pauamma_gundo
trimmed some trailing blanks

unitrunker_gmail.com marked 11 inline comments as done.Feb 19 2024, 9:57 AM

pauamma_gundo.com added inline comments.Feb 21 2024, 10:57 PM

lib/libsys/mq_getfd_np.2
67
89

I'd like someone who knows about this system call to review this as well.

fix typos caught by pauamma_gundo

kib added a subscriber: kib.Feb 24 2024, 8:44 PM

kib added inline comments.

lib/libsys/mq_getfd_np.2
38	Was it? The function is non-standard, which part of the text was copied?
55
67	Why this property needs a special mention?
79	New sentence new line. I am not sure that these 'do not call close' are useful. It is better to formulate that the fd is owned by the mq descriptor.
99	otherwise part is weird and most likely should be just omitted.
103	again, 'but may ...' part should be omitted.
114	I do not see a point of listing all mq* functions. Only list functions that are referenced in the body of the man page, and perhaps mqueuefs(5)

Revision Contents
Changeset List

Path

Size

lib/

libsys/

mq_getfd_np.2

118 lines

Diff 134839

View Options

Manual page for mq_getfd_np(2)Needs ReviewPublicActions