summaryrefslogtreecommitdiff
path: root/share/man/man3
Commit message (Collapse)AuthorAgeFilesLines
* sigevent(3): Fix a typoGordon Bergling2020-10-101-1/+1
| | | | | | | | | - asychronous -> asynchronous MFC after: 1 week Notes: svn path=/head/; revision=366610
* intro(3): Update the list of included librariesGordon Bergling2020-10-061-26/+146
| | | | | | | | | | | | | - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476 Notes: svn path=/head/; revision=366481
* Add further clarification on si_addr and si_trapno.John Baldwin2020-07-281-18/+17
| | | | | | | | | | | | | | | | | | | | | | | - In the initial description of si_addr, do not claim that it is always the faulting instruction. - For si_addr, document that it is generally set to the PC for synchronous signals, but that it can be set to the the address of the faulting memory reference for some signals including SIGSEGV and SIGBUS. In particular, while SIGSEGV generally sets si_addr to the faulting memory reference, SIGBUS can vary. On some platforms, some SIGBUS signals set si_addr to the PC and other SIGBUS signals set si_addr to the faulting address depending on the specific hardware exception. - For si_trapno, synchronous signals should set this to some value. Reviewed by: kib Sponsored by: DARPA Differential Revision: https://reviews.freebsd.org/D25777 Notes: svn path=/head/; revision=363652
* tree.3: Bump date after 363450 (WAVL)Mateusz Piotrowski2020-07-271-3/+4
| | | | | | | | | While here: - Address whitespace warnings. - Start sentences on a new line. Notes: svn path=/head/; revision=363599
* Rank balanced (RB) trees are a class of balanced trees that includesDoug Moore2020-07-231-25/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | AVL trees, red-black trees, and others. Weak AVL (wavl) trees are a recently discovered member of that class. This change replaces red-black rebalancing with weak AVL rebalancing in the RB tree macros. Wavl trees sit between AVL and red-black trees in terms of how strictly balance is enforced. They have the stricter balance of AVL trees as the tree is built - a wavl tree is an AVL tree until the first deletion. Once removals start, wavl trees are lazier about rebalancing than AVL trees, so that removals can be fast, but the balance of the tree can decay to that of a red-black tree. Subsequent insertions can push balance back toward the stricter AVL conditions. Removing a node from a wavl tree never requires more than two rotations, which is better than either red-black or AVL trees. Inserting a node into a wavl tree never requires more than two rotations, which matches red-black and AVL trees. The only disadvantage of wavl trees to red-black trees is that more insertions are likely to adjust the tree a bit. That's the cost of keeping the tree more balanced. Testing has shown that for the cases where red-black trees do worst, wavl trees better balance leads to faster lookups, so that if lookups outnumber insertions by a nontrivial amount, lookup time saved exceeds the extra cost of balancing. Reviewed by: alc, gbe, markj Tested by: pho Discussed with: emaste Differential Revision: https://reviews.freebsd.org/D25480 Notes: svn path=/head/; revision=363450
* Add pthread_getname_np() and pthread_setname_np() aliases forKonstantin Belousov2020-06-102-5/+38
| | | | | | | | | | | | | | | pthread_get_name_np() and pthread_set_name_np(). This re-applies r361770 after compatibility fixes. Reviewed by: antoine, jkim, markj Tested by: antoine (exp-run) Sponsored by: The FreeBSD Foundation MFC after: 1 week Differential revision: https://reviews.freebsd.org/D25117 Notes: svn path=/head/; revision=362032
* Revert r361770 "Add pthread_getname_np() and pthread_setname_np() aliases" ↵Konstantin Belousov2020-06-042-21/+4
| | | | | | | | | | | | for now. It is not compatible enough with Linux. Requested by: antoine, jkim Sponsored by: The FreeBSD Foundation Notes: svn path=/head/; revision=361784
* Add pthread_getname_np() and pthread_setname_np() aliasesKonstantin Belousov2020-06-032-4/+21
| | | | | | | | | | | | | | for pthread_get_name_np() and pthread_set_name_np(), to be compatible with Linux. PR: 238404 Proposed and reviewed by: markj Sponsored by: The FreeBSD Foundation MFC after: 1 week Differential revision: https://reviews.freebsd.org/D25117 Notes: svn path=/head/; revision=361770
* Document BUS_OOMERR.Konstantin Belousov2020-05-091-1/+3
| | | | | | | | | Sponsored by: The FreeBSD Foundation MFC after: 3 days Differential revision: https://reviews.freebsd.org/D24761 Notes: svn path=/head/; revision=360844
* Fix various, mostly minor errors in man pages like:Benedict Reuschling2020-05-033-8/+8
| | | | | | | | | | | | | | | | | | | | - Abbreviated month name in .Dd - position of HISTORY section - alphabetical ordering within SEE ALSO section - adding .Ed before .Sh DESCRIPTION - remove trailing whitespaces - Line break after a sentence stop - Use BSD OS macros instead of hardcoded strings No .Dd bumps as there was no actual content change made in any of these pages. Submitted by: Gordon Bergling gbergling_gmail.com Approved by: bcr Differential Revision: https://reviews.freebsd.org/D24591 Notes: svn path=/head/; revision=360603
* CMSG_DATA.3: Fix formatting of printf escape sequencesMateusz Piotrowski2020-03-131-3/+3
| | | | | | | | | | | | | | | | | | | Escape sequences like "\n" have to be escaped twice in examples in our mdoc(7)-based manual pages in order to be displayed properly. The problem is that otherwise they are interpreted by mdoc(7), which results in: printf("parent: received '%s'0, buf); being shown to the user instead of: printf("parent: received '%s'\n", buf); Approved by: bcr (mentor) MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D24056 Notes: svn path=/head/; revision=358954
* Add HISTORY sections to tree(3), stdarg(3) and sigevent(3)Sergio Carlavilla Delgado2020-02-263-3/+23
| | | | | | | | | | Submitted by: gbergling_gmail.com Approved by: bcr@(mentor) MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D23832 Notes: svn path=/head/; revision=358352
* Add pthread_peekjoin_np(3).Konstantin Belousov2020-02-152-12/+46
| | | | | | | | | | | | | | The function allows to peek at the thread exit status and even see return value, without joining (and thus finally destroying) the target thread. Reviewed by: markj Sponsored by: The FreeBSD Foundation (kib) MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D23676 Notes: svn path=/head/; revision=357985
* Expand stats(3) man page to add a caveat regarding HZ.Edward Tomasz Napierala2019-12-021-1/+7
| | | | | | | | Suggested by: thj Sponsored by: Klara Inc, Netflix Notes: svn path=/head/; revision=355307
* bitstring: add functions to find contiguous set/unset bit sequencesEric Joyner2019-11-211-1/+89
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add bit_ffs_area_at and bit_ffc_area_at functions for searching a bit string for a sequence of contiguous set or unset bits of at least the specified size. The bit_ffc_area function will be used by the Intel ice driver for implementing resource assignment logic using a bitstring to represent whether or not a given index has been assigned or is currently free. The bit_ffs_area, bit_ffc_area_at and bit_ffs_area_at functions are implemented for completeness. I'd like to add further test cases for the new functions, but I'm not really sure how to add them easily. The new functions depend on specific sequences of bits being set, while the bitstring tests appear to run for varying bit sizes. Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> Submitted by: Jacob Keller <jacob.e.keller@intel.com> Reviewed by: asomers@, erj@ MFC after: 1 week Sponsored by: Intel Corporation Differential Revision: https://reviews.freebsd.org/D22400 Notes: svn path=/head/; revision=354977
* Add copyrights that I forgot to add when splitting arb.h off from tree.h.Edward Tomasz Napierala2019-10-151-0/+1
| | | | | | | | | | | While here clean up the RCS tags. Suggested by: lstewart MFC after: 2 weeks Sponsored by: Klara Inc, Netflix Notes: svn path=/head/; revision=353588
* Fix some "RB_" -> "ARB_" copy and paste nits for text sourced from tree(3).Lawrence Stewart2019-10-141-4/+4
| | | | Notes: svn path=/head/; revision=353486
* Introduce stats(3), a flexible statistics gathering API.Edward Tomasz Napierala2019-10-073-3/+996
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This provides a framework to define a template describing a set of "variables of interest" and the intended way for the framework to maintain them (for example the maximum, sum, t-digest, or a combination thereof). Afterwards the user code feeds in the raw data, and the framework maintains these variables inside a user-provided, opaque stats blobs. The framework also provides a way to selectively extract the stats from the blobs. The stats(3) framework can be used in both userspace and the kernel. See the stats(3) manual page for details. This will be used by the upcoming TCP statistics gathering code, https://reviews.freebsd.org/D20655. The stats(3) framework is disabled by default for now, except in the NOTES kernel (for QA); it is expected to be enabled in amd64 GENERIC after a cool down period. Reviewed by: sef (earlier version) Obtained from: Netflix Relnotes: yes Sponsored by: Klara Inc, Netflix Differential Revision: https://reviews.freebsd.org/D20477 Notes: svn path=/head/; revision=353283
* Rename ARB_REBALANCE(3) to ARB_REINSERT(3) to match tree(3),Edward Tomasz Napierala2019-09-282-4/+26
| | | | | | | | | | and document it. MFC after: 2 weeks Sponsored by: Klara Inc, Netflix Notes: svn path=/head/; revision=352839
* Sort MLINKS for arb(3), and actually make them work by fixing a '=' vs '+='Edward Tomasz Napierala2019-09-281-24/+24
| | | | | | | | | | mixup. MFC after: 2 weeks Sponsored by: Klara Inc, Netflix Notes: svn path=/head/; revision=352838
* Add RB_REINSERT(3), a low overhead alternative to removing a nodeEdward Tomasz Napierala2019-09-282-4/+26
| | | | | | | | | | | | | | | and reinserting it back with an updated key. This is one of dependencies for the upcoming stats(3) code. Reviewed by: cem Obtained from: Netflix MFC after: 2 weeks Sponsored by: Klara Inc, Netflix Differential Revision: https://reviews.freebsd.org/D21786 Notes: svn path=/head/; revision=352837
* Introduce arb(3), the Array-based Red-Black Tree macros: similarEdward Tomasz Napierala2019-09-144-1/+523
| | | | | | | | | | | | | | | | | | | | | | | | to the traditional tree(3) RB trees, but using an array (preallocated, linear chunk of memory) to store the tree. This avoids allocation overhead, improves memory locality, and makes it trivially easy to share/transfer/copy the entire tree without the need for marshalling. The downside is that the size is fixed at initialization time; there is no mechanism to resize it. This is one of the dependencies for the new stats(3) framework (https://reviews.freebsd.org/D20477). Reviewed by: bcr (man pages), markj Discussed with: cem MFC after: 2 weeks Sponsored by: Klara Inc, Netflix Obtained from: Netflix Differential Revision: https://reviews.freebsd.org/D20324 Notes: svn path=/head/; revision=352337
* Introduce <sys/qmath.h>, a fixed-point math library from Netflix.
Edward Tomasz Napierala2019-08-2711-0/+1901
| | | | | | | | | | | | | | | | | | | | | | | | | | This makes it possible to perform mathematical operations
on fractional values without using floating point. It operates on Q numbers, which are integer-sized, opaque structures initialized to hold a chosen number of integer and fractional
bits.
 For a general description of the Q number system, see the "Fixed Point Representation & Fractional Math" whitepaper[1]; for the actual API see the qmath(3) man page. This is one of dependencies for the upcoming stats(3) framework[2] that will be applied to the TCP stack in a later commit. 1. https://www.superkits.net/whitepapers/Fixed%20Point%20Representation%20&%20Fractional%20Math.pdf 2. https://reviews.freebsd.org/D20477 Reviewed by: bcr (man pages, earlier version), sef (earlier version) Discussed with: cem, dteske, imp, lstewart Sponsored By: Klara Inc, Netflix Obtained from: Netflix Differential Revision: https://reviews.freebsd.org/D20116 Notes: svn path=/head/; revision=351544
* More places to clarify the robustness guarantees.Konstantin Belousov2019-08-073-9/+9
| | | | | | | | Wording submitted by: Martin Simmons <martin@lispworks.com> MFC after: 3 days Notes: svn path=/head/; revision=350684
* Clarify the robustness guarantees.Konstantin Belousov2019-08-072-6/+6
| | | | | | | | Wording submitted by: Martin Simmons <martin@lispworks.com> MFC after: 3 days Notes: svn path=/head/; revision=350683
* pkgbase: move man pages from runtime-manual to runtimeEmmanuel Vadot2019-07-191-2/+0
| | | | | | | | | | We don't split the other man pages in their own package so do the same for runtime. Reviewed by: bapt, gjb Differential Revision: https://reviews.freebsd.org/D20962 Notes: svn path=/head/; revision=350136
* Add some missing MLINKs for tree(3).Mark Johnston2019-06-171-0/+22
| | | | | | | MFC after: 3 days Notes: svn path=/head/; revision=349148
* Add usage example to tree(3).Edward Tomasz Napierala2019-05-081-1/+75
| | | | | | | | | Obtained from: OpenBSD MFC after: 2 weeks Sponsored by: Klara Inc. Notes: svn path=/head/; revision=347361
* Drop "All rights reserved" from my copyright statements.John Baldwin2019-03-061-1/+0
| | | | | | | | | Reviewed by: rgrimes MFC after: 1 month Differential Revision: https://reviews.freebsd.org/D19485 Notes: svn path=/head/; revision=344855
* Typo.Mark Johnston2019-01-021-1/+1
| | | | | | | | Reported by: Christian Barthel MFC after: 3 days Notes: svn path=/head/; revision=342688
* CMSG_DATA(3): Use consistent variable namesMateusz Piotrowski2018-11-011-5/+5
| | | | | | | | | | | | | | The description of CMSG_FIRSTHDR used two variables (mhdr and msg) to reference the same thing. Use msghdr consistency across the manual page instead. Reviewed by: bcr Approved by: krion (mentor, implicit), mat (mentor, implicit) MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D17804 Notes: svn path=/head/; revision=340001
* Document socket control message routines for ancillary data access (CMSG_DATA).Mateusz Piotrowski2018-08-192-0/+219
| | | | | | | | | | | PR: 227777 Reviewed by: bcr, eadler Approved by: mat (mentor), manpages (bcr) Obtained from: OpenBSD Differential Revision: https://reviews.freebsd.org/D15215 Notes: svn path=/head/; revision=338060
* Fix typo.Konstantin Belousov2018-08-191-1/+1
| | | | | | | | Noted by: Yuri Pankov <yuripv@yuripv.net> MFC after: 12 days Notes: svn path=/head/; revision=338044
* POSIX compliance improvements in the pthread(3) functions.Pedro F. Giffuni2018-08-1815-38/+38
| | | | | | | | | | | | | | | | This basically adds makes use of the C99 restrict keyword, and also adds some 'const's to four threading functions: pthread_mutexattr_gettype(), pthread_mutexattr_getprioceiling(), pthread_mutexattr_getprotocol(), and pthread_mutex_getprioceiling. The changes are in accordance to POSIX/SUSv4-2018. Hinted by: DragonFlyBSD Relnotes: yes MFC after: 1 month Differential Revision: D16722 Notes: svn path=/head/; revision=337992
* Add pthread_get_name_np(3).Konstantin Belousov2018-08-172-4/+29
| | | | | | | | | | | | | | | | The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702 Notes: svn path=/head/; revision=337983
* Make timespecadd(3) and friends publicAlan Somers2018-07-302-22/+73
| | | | | | | | | | | | | | | | | | | | | | The timespecadd(3) family of macros were imported from NetBSD back in r35029. However, they were initially guarded by #ifdef _KERNEL. In the meantime, we have grown at least 28 syscalls that use timespecs in some way, leading many programs both inside and outside of the base system to redefine those macros. It's better just to make the definitions public. Our kernel currently defines two-argument versions of timespecadd and timespecsub. NetBSD, OpenBSD, and FreeDesktop.org's libbsd, however, define three-argument versions. Solaris also defines a three-argument version, but only in its kernel. This revision changes our definition to match the common three-argument version. Bump _FreeBSD_version due to the breaking KPI change. Discussed with: cem, jilles, ian, bde Differential Revision: https://reviews.freebsd.org/D14725 Notes: svn path=/head/; revision=336914
* Depart from normal man page proactice a little and provide guidance onWarner Losh2018-05-311-6/+17
| | | | | | | | | | | | | when to use assert, as well as providing a bad example of using assert. While not strictly necessary, experience has shown issues with poor assert choice happen often enough that this departure seems warranted. Also, tighten up the previous example (there's no need to have extra paragraphs or gratuitously long lines). Reviewed by: emaste@ (earlier version) Notes: svn path=/head/; revision=334431
* Bump the date on man pages in r334306Eric van Gyzen2018-05-291-1/+1
| | | | | | | | | | | | | It seems a shame to ruin the patina of the June 4, 1993 date on abort.3, especially since it still matched the date of the SCCS ID, but those are the rules. Reported by: araujo MFC after: 3 days Sponsored by: Dell EMC Notes: svn path=/head/; revision=334308
* Cross-reference abort2(2) from a few man pagesEric van Gyzen2018-05-291-0/+1
| | | | | | | | | | | I didn't know abort2 existed until it was mentioned on a mailing list. Mention it in related pages so others can find it easily. MFC after: 3 days Sponsored by: Dell EMC Notes: svn path=/head/; revision=334306
* Remove "All rights reserved" from my files.Xin LI2018-05-102-2/+0
| | | | | | | | | See r333391 for the rationale. MFC after: 1 week Notes: svn path=/head/; revision=333449
* Document the TRAP_CAP code for SIGTRAP.John Baldwin2018-04-241-1/+3
| | | | | | | MFC after: 3 days Notes: svn path=/head/; revision=332975
* pthread: adding missing header to man pageEitan Adler2018-02-031-1/+2
| | | | | | | Reported by: swildner@DragonFlyBSD.org Notes: svn path=/head/; revision=328831
* Be less verbose and more precise.Warner Losh2018-01-011-1/+1
| | | | Notes: svn path=/head/; revision=327467
* Add note that assert.h may be included multiple timesWarner Losh2018-01-011-1/+9
| | | | | | | with and without NDEBUG defined. Notes: svn path=/head/; revision=327466
* assert(3) appeared first in the 7th Edition Unix, not the 6th, atWarner Losh2018-01-011-1/+1
| | | | | | | | | least according to the extant distributions preserved at tuhs.org. Obtained from: http://www.tuhs.org/cgi-bin/utree.pl?file=V7/usr/include/assert.h Notes: svn path=/head/; revision=327465
* Add missing wordEitan Adler2017-12-021-1/+1
| | | | | | | Reported by: swildner@dragonflybsd.org Notes: svn path=/head/; revision=326478
* Fix pthread_condattr(3) typeEitan Adler2017-11-301-2/+2
| | | | | | | | Reported by: Sascha Wildner <swildner@dragonflybsd.org> Reviewed by: mjg Notes: svn path=/head/; revision=326386
* Provide more detailed specification for major(), minor() and makedev().Konstantin Belousov2017-08-051-9/+21
| | | | | | | | | | | | | | | Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week Notes: svn path=/head/; revision=322077
* pthread_mutex_consistent: sort SEE ALSO by reference nameEnji Cooper2017-03-271-3/+3
| | | | | | | | | MFC after: 3 days Reported by: make manlint Sponsored by: Dell EMC Isilon Notes: svn path=/head/; revision=316053
* intro(3): fix markupEnji Cooper2017-03-231-42/+12
| | | | | | | | | | | | | | - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon Notes: svn path=/head/; revision=315793
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-04 03:25:27 +0000