Commit graph

719 commits

Author SHA1 Message Date
Ryan Libby fda32d5860 lock.9: describe lockmgr_{disowned,lock_flags,slock,unlock,xlock}
Describe and link the following functions in the lockgmr API:
 - lockmgr_disowned
 - lockmgr_lock_flags
 - lockmgr_slock
 - lockmgr_unlock
 - lockmgr_xlock

This is not a complete update of lock.9 but at least covers all the main
lock operations.

Reviewed by:	gbe, kib
Sponsored by:	Dell EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D45689
2024-06-23 14:46:31 -07:00
Jake Freeland cd4bd9750c bitset: Add ORNOT macros
Macros to ANDNOT a bitset currently exist, but there are no ORNOT
equivalents. Introduce ORNOT macros for bitset(9), cpuset(9), and
domainset(9).

Approved by:	markj (mentor)
Reviewed by:	markj
MFC after:	1 week
Sponsored by:	NIKSUN, Inc.
Differential Revision:	https://reviews.freebsd.org/D44976
2024-04-27 19:20:34 -05:00
Gleb Smirnoff c68eed82a3 accf_tls: accept filter that waits for TLS handshake header 2024-04-24 17:53:10 -07:00
David E. O'Brien fde4074640 Add SYSCTL_ADD_CONST_STRING(9)
Catch up with 10a1e981d (2019-03-19) so that one can do
'man SYSCTL_ADD_CONST_STRING' and not get
"No manual entry for SYSCTL_ADD_CONST_STRING".

Reviewed by: sjg
2024-04-02 23:19:49 -07:00
Antoine Brodin a200093c21 share/man/man9/Makefile: fix buildworld 2024-03-23 07:17:59 +00:00
Konstantin Belousov 88f2c58d1a cdevpriv(9): document devfs_foreach_cdevpriv()
Sponsored by:	The FreeBSD Foundation
MFC after:	1 week
2024-03-23 08:59:00 +02:00
Gleb Smirnoff a77605a8d9 man9: mlink for counter_ratecheck(9) 2024-03-22 14:36:54 -07:00
John Baldwin b30a80b655 rman: Add rman_get/set_type
This permits associating a resource type (e.g. SYS_RES_MEMORY) with a
struct resource.

I considered adding a new field to struct rman to store the type and
only providing rman_get_type as an accessor.  However, changing
'struct rman' is an ABI breakage.  I might revisit this in main, but
the current approach is MFC'able.

Reviewed by:	imp
Differential Revision:	https://reviews.freebsd.org/D44122
2024-03-13 15:05:53 -07:00
Gleb Smirnoff 5fc3104ae7 callout: retire callout_async_drain()
This function was used only in TCP before 446ccdd08e.  It was born in
pain in 2016 to plug different complex panics in TCP timers.  It wasn't
warmly accepted in phabricator by all of the reviewers and my recollection
of overall agreement was that "if you need this KPI, then you'd better fix
your code to not need it".  However, the function served its duty well all
the way to FreeBSD 14.  But now that TCP doesn't need it anymore, let's
retire it to reduce complexity of callout code and also to avoid its
further use.

Reviewed by:		jhb, markj, kib, rrs
Differential Revision:	https://reviews.freebsd.org/D43546
2024-01-24 09:33:27 -08:00
Christos Margiolis 6b6914c1e2 subr_bus: introduce device_set_descf() and modify allocation logic
device_set_descf() is a printf-like version of device_set_desc().

Allocation code has been transferred from device_set_desc_internal() to
device_set_desc_copy() and device_set_descf() to avoid complicating
device_set_desc_internal(). The "copy" argument in
device_set_desc_internal() has been replaced with a flag which is set
when the description string has been allocated with M_BUS.

Sponsored by:	The FreeBSD Foundation
MFC after:	2 weeks
Reviewed by:	imp, markj
Differential Revision:	https://reviews.freebsd.org/D43370
2024-01-16 18:49:15 +02:00
Robert Wing c8328f1a7b pmap_init(9): drop MLINKS reference
fix the build
2024-01-12 17:29:15 +00:00
Robert Wing bc1eea0c0b pmap_init(9): sweep references to pmap_init2()
gone since 2005
2024-01-12 13:29:50 +00:00
Robert Wing 55e2a7d3ea pmap_pinit(9): sweep references to pmap_pinit2()
gone since 2004
2024-01-12 13:29:17 +00:00
John Baldwin 854e1fd692 mbuf.9: Document mtodo
mtodo() accepts an mbuf and offset and returns a void * pointer to the
requested offset into the mbuf's associated data.  Similar to mtod(),
no bounds checking is performed.

Reviewed by:	imp, markj
Sponsored by:	Chelsio Communications
Differential Revision:	https://reviews.freebsd.org/D43215
2023-12-28 11:17:45 -08:00
Mark Johnston be5464ae23 kmsan: Add kmsan_check_uio()
This was handy for some ad-hoc debugging and fits in with other
kmsan_check_*() routines which operate on some kind of data container.

MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
2023-12-06 12:46:25 -05:00
Mina Galić 74e4a8d208 pmap: add pmap_kextract(9) man page
Add a man page for pmap_kextract(9), with alias to vtophys(9). This man
page is based on pmap_extract(9).

Add it as cross reference in pmap(9), and add comments above the
function implementations.

Co-authored-by:	Graham Perrin <grahamperrin@gmail.com>
Co-authored-by:	mhorne
Sponsored by:	The FreeBSD Foundation
Pull Request:	https://github.com/freebsd/freebsd-src/pull/827
2023-10-13 15:27:24 -03:00
Bjoern A. Zeeb 1137943b1c net80211: remove ieee80211_unref_node()
ieee80211_unref_node() was only used in two error cases in
ieee80211_send_nulldata().  There we do not need to guard against
ni pointer reuse after decrementing the refcount of the ni as we
only update the stats and return.

Update the man page and remove the link for the now gone function.

Sponsored by:	The FreeBSD Foundation
X-MFC:		never
Reviewed by:	adrian, emaste
Differential Revision: https://reviews.freebsd.org/D42035
2023-10-05 14:28:55 +00:00
Olivier Certner 5d9f38405a realgroupmember(9): Link to groupmember(9), document the function
Reviewed by:            bcr (older version), mhorne
MFC after:              2 weeks
Sponsored by:           Kumacom SAS
Differential Revision:  https://reviews.freebsd.org/D40643
2023-09-28 12:05:46 -03:00
Olivier Certner 0d6bf73c4f cr_bsd_visible(9): New man page
Reviewed by:            bcr, pauamma_gundo.com
MFC after:              2 weeks
Sponsored by:           Kumacom SAS
Differential Revision:  https://reviews.freebsd.org/D40632
2023-09-28 12:05:45 -03:00
Olivier Certner 29d863bb7f cr_canseejailproc(9): New man page
Reviewed by:            pauamma_gundo.com, mhorne
MFC after:              2 weeks
Sponsored by:           Kumacom SAS
Differential Revision:  https://reviews.freebsd.org/D40631
2023-09-28 12:05:45 -03:00
Olivier Certner c59ab75c04 cr_canseeotheruids(), cr_canseeothergids(): Man pages: Impacts of rename
When these functions were renamed 7 years ago, their man pages were not.
Rename the latter in accordance and fix the names inside them.  Fix
references to them as well.  Add the old man pages to the list of
obsolete files.

Reviewed by:            mhorne
MFC after:              2 weeks
Sponsored by:           Kumacom SAS
Differential Revision:  https://reviews.freebsd.org/D40630
2023-09-28 12:05:45 -03:00
Robert Wing b3a714652f kqueue(9): sweep references to knlist_remove_inevent()
knlist_remove_inevent() gone in 9e590ff04b
2023-08-26 11:11:50 -08:00
Warner Losh d0b2dbfa0e Remove $FreeBSD$: one-line sh pattern
Remove /^\s*#[#!]?\s*\$FreeBSD\$.*$\n/
2023-08-16 11:55:03 -06:00
Mitchell Horne d441ec1c21 g_bio(9): add link to bio(9)
This page documents 'struct bio', so this can be helpful with finding or
referencing it.

Reviewed by:	imp, markj
MFC after:	3 days
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D41252
2023-08-03 11:07:31 -03:00
Dmitry Chagin c3f58005d9 signal: Remove gsignal references from manuals
Reported by:		Mina Galić, mhorne
Reviewed by:		Mina Galić, mhorne
Differential Revision:	https://reviews.freebsd.org/D41020
MFC after:		1 week
2023-07-14 00:15:47 +03:00
John Baldwin 884eaacd24 ddb: Rework macros to make it easier to add new command tables.
- Add new DB_DEFINE_TABLE and DB_DECLARE_TABLE macros to define new
  command tables.  DB_DECLARE_TABLE is intended for use in headers
  similar to MALLOC_DECLARE and SYSCTL_DECL.

  DB_DEFINE_TABLE takes three arguments, the name of the parent table,
  the command name, and the name of the table itself, e.g.
  DB_DEFINE_TABLE(show, foo, show_foo) defines a new "show foo" table.

- DB_TABLE_COMMAND, DB_TABLE_COMMAND_FLAGS, DB_TABLE_ALIAS, and
  DB_ALIAS_FLAGS allow new commands and aliases to be defined.  These
  are similar to the existing DB_COMMAND, etc. except that they take
  an initial argument giving the name of the parent table, e.g.:

  DB_TABLE_COMMAND(show_foo, bar, db_show_foo_bar)

  defines a new "show foo bar" command.

This provides a cleaner interface than the ad-hoc use of internal
macros like _DB_SET that was required previously (e.g. in cxgbe(4)).

This retires DB_FUNC macro as well as the internal _DB_FUNC macro.

Reviewed by:	melifaro, kib, markj
Differential Revision:	https://reviews.freebsd.org/D40819
2023-07-05 16:02:01 -07:00
Joseph Koshy c2eae5c39a
man9: Add a manual page for kstack_contains(9).
Approved by:	gnn (mentor)
Reviewed by:	mhorne
Differential Revision: https://reviews.freebsd.org/D39933
2023-05-05 15:42:59 +01:00
Mitchell Horne 84a44625a5 printf(9): add MLINKS for vlog(9) and vprintf(9)
MFC after:	3 days
Sponsored by:	The FreeBSD Foundation
2023-03-20 17:12:12 -03:00
Mitchell Horne b7caa912f9 kern_reboot(9): document shutdown_nice()
Reviewed by:	markj, Pau Amma <pauamma@gundo.com>
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D39134
2023-03-20 17:12:12 -03:00
Mitchell Horne d55c187738 kern_reboot(9): some updates
- This function no longer disables interrupts
 - MLINK to reboot.9
 - The mentions of autoconfiguration is more about shutdown_nice(),
   coming in the next commit.
 - Describe the RB_* flags relevant to this function
 - Describe behaviour when shutdown hooks fail the reset
 - Describe expected execution contexts
 - Add FF copyright
 - xref panic(9)
 - xref this page in reboot(2)

Reviewed by:	markj
Discussed with:	rpokala, Pau Amma <pauamma@gundo.com>
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D39133
2023-03-20 17:12:12 -03:00
Mitchell Horne d5e105bf7e panic(9): some updates
- Better description of what the panic() function does
 - Document KERNEL_PANICKED()
 - Add a section describing panic execution context
 - Add SEE ALSO

Reviewed by:	kib, markj, rpokala
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D39132
2023-03-20 17:12:11 -03:00
Mitchell Horne 87132d1dce KASSERT(9): some updates
- Add a little bit of introductory text
 - Improve the existing example: ANSI C, use a better assertion than a
   NULL check (which is discouraged)
 - Document the widely used MPASS macro in this page
 - Drop the cross-reference to config(8)

Reviewed by:	kib, markj, rpokala, Pau Amma <pauamma@gundo.com>
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D39131
2023-03-20 17:12:11 -03:00
Mitchell Horne 43db15b16a critical(9): small updates
- Document CRITICAL_ASSERT() in this man page.
 - Clarify that a thread may also handle interrupts in a critical
   section, not only faults/exceptions.
 - Note the negative effects of critical section abuse
 - Some other minor clarifications
 - Add short SEE ALSO

Reviewed by:	kib, markj, rpokala, Pau Amma <pauamma@gundo.com>
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D39130
2023-03-20 17:12:11 -03:00
Mitchell Horne b54391a1f8 vcount.9: remove obsolete man page
These functions, vcount() and count_dev(), no longer exist in the source
tree.

Reviewed by:	rpokala
MFC after:	3 days
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D39128
2023-03-20 17:12:11 -03:00
Mark Johnston 0de03c306c man9: Add an smr(9) manual page
Also update the UMA manual page to mention its SMR-enabled
functionality, and update locking.9 to mention both epoch and SMR.
Details of its usage are provided in the SMR manual page.

Reviewed by:	Olivier Certner, mhorne, kib
MFC after:	2 weeks
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D38108
2023-02-20 08:58:19 -05:00
Mitchell Horne 30cd6fd75d man9: Add man page for kern_yield() and friends
The page is fairly simple and will be referenced by mi_switch(9).
Provide some usage notes so that the broader implications of how/when to
use these functions are understood.

Reviewed by:	kib, markj
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D38182
2023-02-09 11:59:38 -04:00
Mitchell Horne 52f9a2823c rtalloc.9: remove obsolete man page
This KPI was removed in d223372545. Note that there are a handful of
references remaining in the src tree to these rtalloc functions that
could be cleaned up by someone with more domain knowledge.

Reviewed by:	pauamma (manpages), glebius, melifaro
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D38188
2023-01-27 18:01:47 -04:00
Mitchell Horne d1c7405ef6 PCBGROUP.9: remove obsolete man page
The PCBGROUP option and KPI were removed entirely in 93c67567e0.

Reviewed by:	pauamma (manpages), glebius, melifaro
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D38187
2023-01-27 18:01:47 -04:00
Mark Johnston b1ef176eb5 man9: Add MLINKS for dpcpu macros
MFC after:	1 week
2022-12-08 15:07:53 -05:00
Ed Maste b812132455 man9: add vm_map_unwire link
Reported by:	markj (in D37416)
Sponsored by:	The FreeBSD Foundation
2022-11-17 10:17:52 -05:00
Ed Maste 005609adda man9: correct vm_page_wire.9 links
PR:		244596
Reviewed by:	markj
Fixes:		fee2a2fa39 ("Change synchonization rules for ...")
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D37416
2022-11-17 10:08:36 -05:00
Ed Maste 42af87b83b man9: remove duplicate superio_find_dev link
PR:		244596
Fixes:		c812bea351 ("add superio.4 and superio.9 ...")
Sponsored by:	The FreeBSD Foundation
2022-11-16 19:30:23 -05:00
Mitchell Horne 334fc46f05 intr_event(9): document intr_event_handle()
Reviewed by:	pauamma
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D36934
2022-10-30 11:07:04 -03:00
Mitchell Horne 3cdbaee354 ithread(9): update functions to current day
The public KPI is now intr_event_**,
 - Convert existing documented functions to their equivalents.
 - Fix up the function arguments
 - Fix up the possible error return values for each
 - Remove ithread_schedule() completely
 - Rename man page to intr_event(9)
 - Update cross-references

Future changes will update the descriptive text for these functions.

PR:		100803
Based on work by: trhodes
Reviewed by:	jhb
MFC after:	2 weeks
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D33475
2022-10-15 15:49:33 -03:00
Mitchell Horne 30c6a66864 malloc(9): update names and hardlinks
Give all documented functions a .Nm entry in the man page, following the
order they are listed in the synopsis. Create MLINKs for each of the
functions as well.

While here, add a missing include directive to the synopsis, and appease
mandoc by wrapping a long line.

Reviewed by:	markj, imp (previous version), jhb (previous version)
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D36940
2022-10-12 13:46:12 -03:00
Mitchell Horne d88131e1e5 ofw_graph(9): hook it up to the Makefile
Otherwise, the man page is not installed. Add appropriate MLINKS.

Reviewed by:	manu
MFC after:	3 days
Fixes:	9a4eed0be2 ("ofw_graph: Add functions for graph bindings")
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D36932
2022-10-11 16:28:56 -03:00
Mark Johnston b3ab58bd43 man9: Add MLINKs for bus_space_{peek,poke}
MFC after:	1 week
2022-09-26 09:28:57 -04:00
Mateusz Guzik 145a50dcda Unbreak the build after b3ee318b79 2022-09-14 23:52:05 +00:00
Gleb Smirnoff b3ee318b79 domains: rewrite documentation to describe present state
Reviewed by:		debdrup, pauamma
Differential revision:	https://reviews.freebsd.org/D36513
2022-09-14 14:12:24 -07:00
Brooks Davis c2e1544f59 m_get3: add an MLINK for the manpage
Reviewed by:	kp
Sponsored by:	DARPA, AFRL
Differential Revision:	https://reviews.freebsd.org/D36319
2022-08-23 22:34:07 +01:00