Commit Graph

271 Commits

Author SHA1 Message Date
John-Mark Gurney
18f1afb9f4 add links for the functions documented in bus_space.9... 2006-04-04 22:56:08 +00:00
Gleb Smirnoff
3182fc7b3e Document read/write locks.
Reviewed by:	jhb, ru
2006-02-01 19:39:25 +00:00
Pawel Jakub Dawidek
847a2a1716 Add buffer corruption protection (RedZone) for kernel's malloc(9).
It detects both: buffer underflows and buffer overflows bugs at runtime
(on free(9) and realloc(9)) and prints backtraces from where memory was
allocated and from where it was freed.

Tested by:	kris
2006-01-31 11:09:21 +00:00
Max Laier
6aec1278dc firmware(9) is a subsystem to load binary data into the kernel via a
specially crafted module.  There are several handrolled sollutions to this
problem in the tree already which will be replaced with this.  They include
iwi(4), ipw(4), ispfw(4) and digi(4).

No objection from:	arch
MFC after:		2 weeks
X-MFC after:		some drivers have been converted
2006-01-29 02:52:42 +00:00
John Baldwin
61d963bc57 - Don't list sleep() in the NAME section as we haven't had a sleep()
function in years.
- Change the 'ident' paramters to 'wchan' to match <sys/systm.h>.
- Use 'otherwise' in place of 'else' in one place so that this reads like
  English rather than C.
- Document the new msleep_spin() function.
- Add history notes for msleep() and msleep_spin().
2006-01-03 17:00:38 +00:00
Ian Dowse
0a9a8c2efa Add basic documentation for many of the kernel USB functions that
USB device drivers use to talk to USB devices. This is probably
still a bit rough and it does not yet include the functions specific
to HID, ethernet, hubs, host controller drivers, task threads or
debugging.
2005-12-31 03:53:02 +00:00
John Baldwin
eefd941ba2 Update this manpage:
- Remove references to cpu_critical_*() as they no longer exist.
- Explain that any preemptions that occur during a critical section are
  deferred until the current thread exits the section.
- Remove a bogus example usage of a critical section.
- Note that one can interlock critical sections with spin mutexes in
  certain situations.

MFC after:	3 days
2005-10-05 19:48:21 +00:00
Ruslan Ermilov
bf5a89d1d5 Sort MLINKS. 2005-09-28 07:32:43 +00:00
John Baldwin
4ea211a4f4 - Document atomic_fetchadd(9) and add a MLINK.
- Add arm and ppc to the list of archs not supporting operations on 64-bit
  integers.
- Update the sample code for acquiring a mutex to be more recent and to
  take into account the recent atomic_foo_ptr() changes.

MFC after:	1 week
2005-09-27 17:59:29 +00:00
Robert Watson
6b8a3687a1 Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9).
Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page.

Discussed with:	jeff
MFC after:	3 days
2005-09-21 10:19:57 +00:00
Scott Long
e91f1998a1 Now that VFS_START.9 has been removed, don't try to reference it from the
Makefile.
2005-07-27 02:08:21 +00:00
Warner Losh
751c35718a Don a flack jacket and start to document the FreeBSD bus_space
implementation.  I took the NetBSD man page, and hacked it to, I hope,
to reflect the preliminary version of the bus space that Justin Gibbs
committed as part of the CAM integration in FreeBSD 3.0.

This isn't perfect, but it is better than we have now (which is, ahem,
nothing).  Please coordinate changes to the file through me through
the 6.0 release.

Approved by: re (blanket for this one file)
2005-06-14 03:40:01 +00:00
Hiten Pandya
27c3fa33d9 Add manual page for newly added pmap_page_init(9) function, part of the
PMAP KPI.

Reviewed-by:	alc
2005-06-10 17:16:16 +00:00
Gleb Smirnoff
f9e6931c3d Manpage for unit allocator functions.
Reviewed by:	phk
2005-04-20 19:11:05 +00:00
Pawel Jakub Dawidek
ba9bc36af1 Add missing links.
MFC after:	2 weeks
2005-04-15 10:57:34 +00:00
Pawel Jakub Dawidek
c5e1d51bcd Create links to crypto.9 for every crypto(9) function.
OK'ed by:	sam
MFC after:	2 weeks
2005-04-09 18:38:54 +00:00
Nate Lawson
f86f6ce6e4 Hook up new man page for devclass_get_drivers() to build
Reminded by:	ru
2005-04-07 17:27:14 +00:00
Christian Brueffer
64716bfbf4 Connect memguard(9) to the build. 2005-02-22 17:42:12 +00:00
Ian Dowse
98c926b20f Add a mechanism for associating a mutex with a callout when the
callout is first initialised, using a new function callout_init_mtx().
The callout system will acquire this mutex before calling the callout
function and release it on return.

In addition, the callout system uses the mutex to avoid most of the
complications and race conditions inherent in asynchronous timer
facilities, so mutex-protected callouts have much simpler semantics.
As long as the mutex is held when invoking callout_stop() or
callout_reset(), then these functions will guarantee that the callout
will be stopped, even if softclock() had already begun to process
the callout.

Existing Giant-locked callouts will automatically pick up the new
race-free semantics. This should close a number of race conditions
in the USB code and probably other areas of the kernel too.

There should be no change in behaviour for "MP-safe" callouts; these
still need to use the techniques mentioned in timeout(9) to avoid
race conditions.
2005-02-07 02:47:33 +00:00
Maxim Konovalov
15575dc0aa Finish src part VFS_INIT.9 removal. Need to check www/. 2005-01-07 15:38:21 +00:00
Warner Losh
93c22173bd The format of the MLINKS entries is pairwise, not MLINKS += wise. So
list kernel_mount.9 the required number of times to allow make
installworld to complete.
2004-12-13 23:09:19 +00:00
Tom Rhodes
fe10ebf1f4 Add kernel_mount.9 and appropriate MLINKS to the build. 2004-12-13 19:29:40 +00:00
Alan Cox
898bd99ea5 This jumbo allocator has been removed from the kernel. 2004-12-06 04:24:17 +00:00
Joseph Koshy
235b396aa1 Add a manual page for the kernel's EVENTHANDLER facility.
Reviewed by:	ru
2004-12-03 14:05:55 +00:00
Robert Watson
6f00fa1397 Link critical_enter.9 to critical.9 to make it easier to find. 2004-11-24 18:03:52 +00:00
Joseph Koshy
0252ce1723 Bring signal(9) in sync with -current.
Reviewed by:	ru (mdoc changes)
2004-11-20 02:11:42 +00:00
Joseph Koshy
9bd82b5c5d Add a manual page for hashinit(9), hashdestroy(9) and phashinit(9).
Reviewed by:	ru
2004-10-12 02:36:24 +00:00
Gleb Smirnoff
d7e6966d45 Add more MLINKS for rtalloc.9
Approved by:	ru
2004-10-08 09:52:56 +00:00
Alan Cox
af3db1449f Document the O(log n) algorithm for finding free space.
Submitted by: Mark W. Krentel
2004-09-27 04:22:41 +00:00
Ruslan Ermilov
346763649a Sort MAN and MLINKS in dictionary order ignoring case. 2004-09-19 05:17:21 +00:00
John-Mark Gurney
0283f35b4b add MLINKs for the mbuf.9 man page..
MFC after:	3 days
2004-09-18 19:04:24 +00:00
Brooks Davis
35779bdbd1 Bring kernel time variable and access function docs up to date by
updating the list of variables and mentioning the bin(up)time functions.
2004-09-17 07:24:18 +00:00
Joerg Wunsch
0da40ab229 Add documentation for log(9).
MFC after:	1 week
2004-08-10 09:19:08 +00:00
Max Laier
251b8d4557 Add altq(9) explaining about the IFQ_* and IFQ_DRV_* macros in if_var.h and
how to convert drivers.

Obtained from:	NetBSD (with changes)
Reviewed by:	josef
2004-08-07 12:35:56 +00:00
Warner Losh
899eeaa62f It appears that cdevsw_add/remove were removed quite a while ago, so
remove them from here.
2004-08-07 04:59:16 +00:00
Alfred Perlstein
cf92b47413 document vfs_suser. 2004-07-09 22:33:43 +00:00
Pawel Jakub Dawidek
f0f26fe5ac Add missing link. 2004-06-06 13:35:37 +00:00
Ruslan Ermilov
e85cc3f560 Document mbuf tags based on the OpenBSD manpage.
Submitted by:	Gleb Smirnoff
2004-05-20 09:34:19 +00:00
David Malone
83676de9d5 Add a man page for the kernel part of bpf. I made some edits to the
man page after Orla, so the mistakes are probably mine. Leave a
note on the door welcoming the mdoc police.

Submitted by: Orla McGann <orly@cnri.dit.ie>
2004-05-19 20:39:22 +00:00
Hiten Pandya
11053af551 Add rman_get_device(9) to SYNOPSIS, .Nm and MLINK it to
rman(9).
2004-05-17 21:25:02 +00:00
Warner Losh
aebc6093f9 The DEVICE_IDENTIFY man page refers to this, create a dummy one
directing people to device_add_child.
2004-05-13 20:28:18 +00:00
Nate Lawson
bdffb39f34 Add bus_alloc_resource_any(9), which does bus_alloc_resource() with the
appropriate default values.  Document it in the manpage.

Submitted by:	Mark Santcroos <marks@ripe.net>
Reviewed by:	imp, dfr, bde
Abstains:	bde
2004-03-17 17:40:34 +00:00
John Baldwin
bf0e60bbbb Rewrite sleepqueue manpage to catch up to the new sleep queue interface. 2004-03-12 19:07:18 +00:00
Pawel Jakub Dawidek
9e5681745a Connect g_access(9) to the build. 2004-03-11 19:51:14 +00:00
John Baldwin
f5531a094d - Document cv_broadcastpri().
- Remove references to cv_waitq_*() as they no longer exist.
2004-03-10 15:57:25 +00:00
Josef El-Rayes
2cd7fe4dc1 Document kernel functions securelevel_gt and securelevel_ge.
Approved by:            simon(mentor)
Submitted by:           Christian S.J. Peron <maneo@bsdpro.com>
PR:                     docs/62331
mdoc(7) cleanup by:     ru
2004-03-07 15:22:08 +00:00
Joseph Koshy
9cfa00a649 Link in contigmalloc(9) to the build. 2004-03-06 08:01:16 +00:00
Bruce M Simpson
904fd6bae5 Fix a typo. 2004-03-05 02:50:28 +00:00
Bruce M Simpson
54947b972f Hook ieee80211 manpages up to the build; fix 1 snafu which crept in.
Noticed by:	Matthias Schuendehuette
Pointy hat to:	bms
2004-03-04 21:13:06 +00:00
Bruce M Simpson
48fbb40803 Add an MLINKS entry for radiotap(9). 2004-03-04 12:54:22 +00:00