Commit Graph

620 Commits

Author SHA1 Message Date
Ruslan Ermilov
acaf79e1b9 MAN[1-9] -> MAN. 2001-03-27 13:48:25 +00:00
Kenneth D. Merry
3393f8daa3 Rewrite of the CAM error recovery code.
Some of the major changes include:

	- The SCSI error handling portion of cam_periph_error() has
	  been broken out into a number of subfunctions to better
	  modularize the code that handles the hierarchy of SCSI errors.
	  As a result, the code is now much easier to read.

	- String handling and error printing has been significantly
	  revamped.  We now use sbufs to do string formatting instead
	  of using printfs (for the kernel) and snprintf/strncat (for
	  userland) as before.

	  There is a new catchall error printing routine,
	  cam_error_print() and its string-based counterpart,
	  cam_error_string() that allow the kernel and userland
	  applications to pass in a CCB and have errors printed out
	  properly, whether or not they're SCSI errors.  Among other
	  things, this helped eliminate a fair amount of duplicate code
	  in camcontrol.

	  We now print out more information than before, including
	  the CAM status and SCSI status and the error recovery action
	  taken to remedy the problem.

	- sbufs are now available in userland, via libsbuf.  This
	  change was necessary since most of the error printing code
	  is shared between libcam and the kernel.

	- A new transfer settings interface is included in this checkin.
	  This code is #ifdef'ed out, and is primarily intended to aid
	  discussion with HBA driver authors on the final form the
	  interface should take.  There is example code in the ahc(4)
	  driver that implements the HBA driver side of the new
	  interface.  The new transfer settings code won't be enabled
	  until we're ready to switch all HBA drivers over to the new
	  interface.

src/Makefile.inc1,
lib/Makefile:		Add libsbuf.  It must be built before libcam,
			since libcam uses sbuf routines.

libcam/Makefile:	libcam now depends on libsbuf.

libsbuf/Makefile:	Add a makefile for libsbuf.  This pulls in the
			sbuf sources from sys/kern.

bsd.libnames.mk:	Add LIBSBUF.

camcontrol/Makefile:	Add -lsbuf.  Since camcontrol is statically
			linked, we can't depend on the dynamic linker
			to pull in libsbuf.

camcontrol.c:		Use cam_error_print() instead of checking for
			CAM_SCSI_STATUS_ERROR on every failed CCB.

sbuf.9:			Change the prototypes for sbuf_cat() and
			sbuf_cpy() so that the source string is now a
			const char *.  This is more in line wth the
			standard system string functions, and helps
			eliminate warnings when dealing with a const
			source buffer.

			Fix a typo.

cam.c:			Add description strings for the various CAM
			error status values, as well as routines to
			look up those strings.

			Add new cam_error_string() and
			cam_error_print() routines for userland and
			the kernel.

cam.h:			Add a new CAM flag, CAM_RETRY_SELTO.

			Add enumerated types for the various options
			available with cam_error_print() and
			cam_error_string().

cam_ccb.h:		Add new transfer negotiation structures/types.

			Change inq_len in the ccb_getdev structure to
			be "reserved".  This field has never been
			filled in, and will be removed when we next
			bump the CAM version.

cam_debug.h:		Fix typo.

cam_periph.c:		Modularize cam_periph_error().  The SCSI error
			handling part of cam_periph_error() is now
			in camperiphscsistatuserror() and
			camperiphscsisenseerror().

			In cam_periph_lock(), increase the reference
			count on the periph while we wait for our lock
			attempt to succeed so that the periph won't go
			away while we're sleeping.

cam_xpt.c:		Add new transfer negotiation code.  (ifdefed
			out)

			Add a new function, xpt_path_string().  This
			is a string/sbuf analog to xpt_print_path().

scsi_all.c:		Revamp string handing and error printing code.
			We now use sbufs for much of the string
			formatting code.  More of that code is shared
			between userland the kernel.

scsi_all.h:		Get rid of SS_TURSTART, it wasn't terribly
			useful in the first place.

			Add a new error action, SS_REQSENSE.  (Send a
			request sense and then retry the command.)
			This is useful when the controller hasn't
			performed autosense for some reason.

			Change the default actions around a bit.

scsi_cd.c,
scsi_da.c,
scsi_pt.c,
scsi_ses.c:		SF_RETRY_SELTO -> CAM_RETRY_SELTO.  Selection
			timeouts shouldn't be covered by a sense flag.

scsi_pass.[ch]:		SF_RETRY_SELTO -> CAM_RETRY_SELTO.

			Get rid of the last vestiges of a read/write
			interface.

libkern/bsearch.c,
sys/libkern.h,
conf/files:		Add bsearch.c, which is needed for some of the
			new table lookup routines.

aic7xxx_freebsd.c:	Define AHC_NEW_TRAN_SETTINGS if
			CAM_NEW_TRAN_CODE is defined.

sbuf.h,
subr_sbuf.c:		Add the appropriate #ifdefs so sbufs can
			compile and run in userland.

			Change sbuf_printf() to use vsnprintf()
			instead of kvprintf(), which is only available
			in the kernel.

			Change the source string for sbuf_cpy() and
			sbuf_cat() to be a const char *.

			Add __BEGIN_DECLS and __END_DECLS around
			function prototypes since they're now exported
			to userland.

kdump/mkioctls:		Include stdio.h before cam.h since cam.h now
			includes a function with a FILE * argument.

Submitted by:	gibbs (mostly)
Reviewed by:	jdp, marcel (libsbuf makefile changes)
Reviewed by:	des (sbuf changes)
Reviewed by:	ken
2001-03-27 05:45:52 +00:00
Alexander Langer
80b91e98af Sort includes and remove bogus typedef of modeventhand_t, since this
isn't used in the example any more.

Pointed out by:		bde
2001-03-24 12:18:45 +00:00
Alexander Langer
12829b5fd8 - DECLARE_MODULE needs SYSINIT -> include sys/kernel.h
- modeventhand_t declares a pointer to a function, so it can't be
  used as a forward declaration (d'oh!)

Submitted by:	Harti Brandt <brandt@fokus.gmd.de>
2001-03-23 14:05:05 +00:00
Robert Watson
6feb993d95 o Rename "namespace" argument to "attrnamespace" as namespace is a C++
reserved word

Submitted by:	jkh
Obtained from:	TrustedBSD Project
2001-03-19 05:53:39 +00:00
Alexander Langer
ec5dc5774c Fix typo: s/DRIVERMODULE/DRIVER_MODULE/
PR:		25901
Submitted by:	Maxime Henrion <mux@qualys.com>
2001-03-18 16:54:39 +00:00
Robert Watson
e2cd9aeda3 o The revenge of the mdoc(7) police:
- These pages abused Ar macro (they should have used Fa).
   - NULL and other numeric constants should be marked with Dv.
   - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked
     with Fn.

Submitted by:	ru
2001-03-16 17:42:38 +00:00
Robert Watson
42f558db10 o The mdoc(7) police strike with avengance:
- These pages abused Ar macro (they should have used Fa).
   - NULL constant should be marked with Dv.
   - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked
     with Fn.

Submitted by:	ru
2001-03-16 15:02:30 +00:00
Ruslan Ermilov
ef99442288 mdoc(7) police: empty lines outside displays cause warnings in -mdocNG. 2001-03-16 13:50:50 +00:00
Robert Watson
50b19f1978 o Update some of the kernel man pages associated with extended attributes
to reflect EA API change to explicit namespacing.

Obtained from:	TrustedBSD Project
2001-03-15 03:13:58 +00:00
Ruslan Ermilov
edf0984dae mdoc(7) police:
removed hard sentence breaks, use Ft for function return type.
2001-03-12 10:15:03 +00:00
Ruslan Ermilov
0048d07db2 Fixed typo. 2001-03-12 10:07:33 +00:00
Ruslan Ermilov
90bd299417 mdoc(7) police: misc formatting fixes. 2001-03-12 09:26:32 +00:00
Ruslan Ermilov
e38cc86b60 mdoc(7) police: mark C types with Vt macro. 2001-03-12 08:54:49 +00:00
Boris Popov
e95f56120b Apply some grammar fixes.
Submitted by:	asmodai
2001-03-12 05:18:37 +00:00
Matt Jacob
792b236965 Document the make_dev_alias function. 2001-03-11 20:10:45 +00:00
Alexander Langer
74169a2c54 Add a manpage for the DEV_MODULE kernel macro. 2001-03-11 17:30:08 +00:00
Alexander Langer
3dca0e13fc Use type of modeventhand_t for the event handler (defined in module.h).
Add a reference to module(9) for more info about the event handler.
2001-03-11 17:07:20 +00:00
Alexander Langer
a8ed195d01 Fix brain damage: s/CDEV_MODULE/DEV_MODULE/ 2001-03-11 16:52:17 +00:00
Alexander Langer
ed488dd0c8 Add MODULE_DEPEND.9 and MODULE_VERSION.9 2001-03-11 14:42:38 +00:00
Alexander Langer
7b8dd7efbf Add a manpage for the MODULE_DEPEND macro. 2001-03-11 14:33:34 +00:00
Alexander Langer
3d34e980a0 Add a manpage for the MODULE_VERSION macro. 2001-03-11 14:33:15 +00:00
Alexander Langer
9790b255bb Add calls to MODULE_VERSION and MODULE_DEPEND to the EXAMPLE. 2001-03-11 14:18:23 +00:00
Alexander Langer
26b104142d Cross references between the DEVICE_*(9) manual pages. 2001-03-10 19:53:38 +00:00
Alexander Langer
66abaf8210 Add references to the various DEVICE_*(9) manpages, otherwise people
don't even know about these.
2001-03-10 19:42:26 +00:00
Alexander Langer
448be9f93c Add DEVICE_IDENTIFY.9 2001-03-10 19:37:27 +00:00
Alexander Langer
2fccaec614 Add a manpage for the last of the driver's functions, the identify
routine.

PR:		18654
Submitted by:	myself (reworked today)
2001-03-10 19:34:42 +00:00
Alexander Langer
ab71708be3 Two mdoc fixes:
- .Os is used without "FreeBSD" nowadays.
- remove hard sentence breaks.
2001-03-10 19:12:46 +00:00
Boris Popov
a1a5ca5514 Add documentation for mchain API.
Reviewed by:	asmodai, ru (mbchain.9)
2001-03-10 06:10:48 +00:00
Alexander Langer
85ac71e9c6 Add module.9 and DECLARE_MODULE.9 2001-03-09 14:16:46 +00:00
Alexander Langer
8b26e61fab Add a general manpage about kernel modules, similar to driver(9).
Reviewed by:	dfr, ru
2001-03-09 14:12:43 +00:00
Alexander Langer
b6a55e7adc Add a manpage for the kernel macro DECLARE_MODULE.
Reviewed by:	dfr, ru
2001-03-09 14:11:56 +00:00
John Baldwin
ebadd4f5b1 Document the ithread_* API used to manage interrupt threads and their
list of handlers.
2001-03-09 03:30:20 +00:00
John Baldwin
d265f30080 Add 2001 to copyright. 2001-03-09 03:17:18 +00:00
John Baldwin
29ef536da3 - Add 2001 to copyright.
- Kthread functions return an error status, they don't set errno to an
  error status.
- Remove the BUGS section as all the bugs listed have been fixed now.
2001-03-09 03:09:30 +00:00
Mark Murray
adcaec54eb Grammar police. 2001-03-06 10:19:12 +00:00
Mark Murray
63fe79c5e8 Fix markup.
Submitted by:	ru
2001-03-06 10:08:36 +00:00
Ruslan Ermilov
79cd39f2dd mdoc(7) police: Use Vt for variable types. 2001-03-06 08:22:10 +00:00
John Baldwin
3d92386026 Adjust swi.9 MLINKS to catch up to the new swi API. 2001-03-05 23:48:38 +00:00
John Baldwin
9ebce8e5b5 Catch up to the new swi API. 2001-03-05 23:47:34 +00:00
Jason Evans
6281b30a73 Implement shared/exclusive locks.
Reviewed by:	bmilekic, jake, jhb
2001-03-05 19:59:41 +00:00
Mark Murray
f4e8d446d8 Extra MLINKS to reflect expansion of BUS_SETUP_INTR(9) manpage. 2001-03-03 14:19:39 +00:00
Mark Murray
3adc6e857d Add a whole lot of extra info. Lots was gained from reading code
or comments, and some is as a result of simply documenting the
entropy harvester.

This still needs work: could a newbus guru pleazse follow up
and fix.extend my (no doubt) obvious mistakes!
2001-03-03 14:13:53 +00:00
Ruslan Ermilov
2a7e12fdbd mdoc(7) police: in -offset clause, spell the ``indent'' correctly. 2001-03-02 09:38:50 +00:00
Ruslan Ermilov
e6959b888b Fix the rest of formatting. 2001-03-02 08:09:19 +00:00
Warner Losh
6e5801f1af Add link for resource_query_unit, now documented in the
resource_query_string man page.
2001-03-02 04:32:50 +00:00
Warner Losh
2a2c539448 Flesh out this man page a bit more. Add information about
resource_query_unit and improve the descriptions of the parameters
passed to these functions.

Plus a couple minor formatting/markup changes:
o Quote -1 as \-1.
o .Dq hints to match resource_int_value().
2001-03-02 04:30:16 +00:00
Jeroen Ruigrok van der Werven
a9d6a1e2e5 Correct English used. 2001-03-01 09:37:38 +00:00
Ruslan Ermilov
d99c63df5a Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00
Jeroen Ruigrok van der Werven
392651edbe Hook Warner's resource_* manpages to the build.
This includes appropriate MLINKS for the other functions contained
within them.
2001-03-01 09:06:57 +00:00
Jeroen Ruigrok van der Werven
d8c9da66bd Remove leading . from .Nd description. 2001-03-01 09:02:01 +00:00
Jeroen Ruigrok van der Werven
1b766e78e8 Fix typo: the the -> to the. 2001-03-01 09:01:43 +00:00
Warner Losh
39b793da82 Document the resource_*_value and resource_query_string families of
functions.  These man pages likely need some markup work, so I've
specifically not added them to the Makefile yet.
2001-03-01 04:28:40 +00:00
Ben Smithurst
31e230ad42 Expand
if ((foo = bar()) != 0)

to
	foo = bar();
	if (foo != 0)

Submitted by:	phk
2001-02-21 20:43:55 +00:00
Ben Smithurst
06c8ab0c3c Don't suggest
if (error = function(a1, a2))

since it causes a warning with -Wall.  Change it so it has an explicit test
against zero,

	if ((error = function(a1, a2)) != 0)
2001-02-21 12:10:19 +00:00
Ruslan Ermilov
0b39b3ff10 mdoc(7) police: sanitize previous revision changes. 2001-02-16 09:05:48 +00:00
Bosko Milekic
328c0bbcf7 Document recently-implemented m_getm(). 2001-02-16 03:23:04 +00:00
Bruce Evans
2c9ba841c6 Fixed bitrot in synopsis. The Lite2 change from int to u_long for ioctl
command numbers had not reached here.
2001-02-15 12:54:34 +00:00
Bruce Evans
802cdd5fb2 Fixed rotted-as-committed pseudo-prototype for VFS_CHECKXP(). It had not
caught up with the changes to avoid storing socket addresses in mbufs,
although the VFS_CHECKEXP() code had to since it was committed 2 years
after those changes.

Fixed formatting in this prototype.
2001-02-15 12:41:44 +00:00
Bruce Evans
206402b24d Fixed bitrot in synopsis (some const poisoning had not reached here). 2001-02-15 12:27:11 +00:00
Bruce Evans
a10f4352b9 Fixed missing and wrong includes in synopsis. The prerequisites for
using bus_alloc_resource(), etc., are especially unobvious, but were
especially wrong (<sys/resource.h> has nothing to do with the resources
documented here...).  Order and format the includes as correctly as
possible (a layering violation makes <machine/bus.h> a prerequisite for
<sys/rman.h>).
2001-02-15 12:21:44 +00:00
Bruce Evans
6c613605bc Fixed missing include in synopsis.
Added evil #define of ACCEPT_FILTER_MODULE to synopsis.  Some of
the functions defined in this man page aren't declared unless
ACCEPT_FILTER_MOD is defined before including <sys/socketvar.h>.
2001-02-15 11:58:38 +00:00
Bruce Evans
2ba5bb1ff5 Fixed missing and/or wrong and/or extra includes in synopsis. 2001-02-15 11:47:31 +00:00
Ruslan Ermilov
51b37a2355 mdoc(7) cleanup. 2001-02-12 10:56:50 +00:00
Bosko Milekic
6f08f8297c Catch up to mutex API changes. 2001-02-12 03:14:57 +00:00
Ruslan Ermilov
46eea498da mdoc(7) police: Change -filled displays (which just happen
to be the same as -ragged in the current implementation) to
-ragged.  With mdocNG, -filled displays produce the correct
output, formatted and justified to both margins.
2001-02-07 13:45:30 +00:00
Ruslan Ermilov
b74e63f284 mdoc(7) police: Removed extraneous .No call. The .Nm macro in
mdocNG has been fixed to properly handle its arguments so this
was causing the extraneous (undesirable) space.
2001-02-07 10:11:57 +00:00
Ruslan Ermilov
308aca6c86 mdoc(7) police: minor style/formatting fixes. 2001-02-06 15:07:35 +00:00
Ruslan Ermilov
eb8afd58fe mdoc(7) police: minor style/formatting fixes. 2001-02-06 14:58:39 +00:00
Boris Popov
c7adfa9cf9 Add man page for VOP_GETVOBJECT, VOP_CREATEVOBJECT and VOP_DESTROYVOBJECT
operations.

Reviewed by:	sheldonh
2001-02-06 10:33:37 +00:00
Jeroen Ruigrok van der Werven
bcf588d94e Add vcount.9 / count_dev.9.
Touched up a bit and added some consistency to the text by your's truly.

PR:		23745
Submitted by:	Andrew Stevenson <andrew@ugh.net.au>
2001-02-06 09:04:52 +00:00
Bruce Evans
4d5a3a7a50 Removed vestiges of vop_mmap. 2001-02-02 12:51:22 +00:00
Nik Clayton
4444ad36bf Declaring functions inside functions was deprecated twice. Keep the
second recommendation, which includes more rationale, and nix the first.

PR:             docs/24690
Submitted by:   Alex Kapranoff <alex@kapran.bitmcnit.bryansk.su
2001-02-02 03:11:22 +00:00
John Baldwin
efd39a2f76 mtx_try_enter() returns an int, not void. 2001-02-02 00:49:17 +00:00
Ruslan Ermilov
d0353b836e mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00
Ben Smithurst
d13241e146 Document the mpsafe argument to callout_init().
PR:		24529
Submitted by:	harti brandt <brandt@fokus.gmd.de>
Reviewed by:	jlemon
2001-01-31 12:17:45 +00:00
Dag-Erling Smørgrav
f5fccbbcb4 Style police.
Submitted by:	ru
2001-01-29 08:59:30 +00:00
Dag-Erling Smørgrav
ea48868bf6 Add MLINKS for sbuf_clear() and sbuf_overflowed(). 2001-01-28 00:19:10 +00:00
Dag-Erling Smørgrav
e499b74df0 Document the changes in subr_sbuf.c rev. 1.2. 2001-01-28 00:18:54 +00:00
Dag-Erling Smørgrav
0aa028ffe9 Add a man page for the zone allocator. 2001-01-27 19:13:08 +00:00
Ruslan Ermilov
9aa16122c1 mdoc(7) police: fixed some minor formatting/spelling errors. 2001-01-24 09:41:17 +00:00
John Baldwin
ef7b803dcd - Activate runqueue.9, scheduler.9, and sleepqueue.9 along with appropriate
MLINKS.
- Update MLINKS for mi_switch.9.
2001-01-23 19:38:45 +00:00
John Baldwin
8861ba5bc8 Catch up to the new way that the scheduling code works since the original
SMPng commit.  Also document the new cpu_throw function (currently only
on i386).

Reviewed by:	sheldonh
2001-01-23 19:28:14 +00:00
John Baldwin
969843e476 Document the various functions and variables used by the current
scheduler code.  Includes a rough description of the various priority
values stored in struct proc as well as priority propagation.

Reviewed by:	chris
2001-01-23 19:26:21 +00:00
John Baldwin
533ef7852a Document the current organization and helper functions used to implement
the sleep queues used by msleep/wakeup and friends.

Submitted by:	sheldonh
2001-01-23 19:24:35 +00:00
John Baldwin
40abbce7a6 Document the current organization of the run queues and the various
functions used to manage them.

Reviewed by:	sheldonh
2001-01-23 19:23:42 +00:00
Jason Evans
d1c1b8413e Remove MUTEX_DECLARE() and MTX_COLD. Instead, postpone full mutex
initialization until after malloc() is safe to call, then iterate through
all mutexes and complete their initialization.

This change is necessary in order to avoid some circular bootstrapping
dependencies.
2001-01-21 07:52:20 +00:00
Ruslan Ermilov
404d68d48f mdoc(7) police: add missing .Ed call. 2001-01-18 17:23:15 +00:00
Ruslan Ermilov
e207e465df Prepare for mdoc(7)NG. 2001-01-16 09:32:40 +00:00
Ruslan Ermilov
55f4342b4e mdoc(7) police: use .Fa for function arguments, use .Vt for variable type. 2001-01-16 08:53:04 +00:00
Jason Evans
238510fc46 Implement condition variables. 2001-01-16 01:00:43 +00:00
Mark Murray
47608b56e1 Add a missing argument for SYSCTL_ADD_OPAQUE.
Fix the examples at the end which were horribly broken.
2001-01-14 16:43:41 +00:00
Chris Costello
3c5969ca27 The prototype for cpu_switch() was changed in revision 1.111 of
<sys/proc.h>

PR:		24311
Submitted by:	Robert Drehmel <robert@gizmo.quizbot.org>
2001-01-13 19:00:49 +00:00
Ruslan Ermilov
a05c0d110e Oops, the previous did not work with current mdoc(7). 2001-01-12 16:02:58 +00:00
Ruslan Ermilov
b77b3c00be mdoc(7) police: Ft/Vt now accept punctuation-type arguments. 2001-01-12 15:46:56 +00:00
Ruslan Ermilov
3136363f3e Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00
Bosko Milekic
f73f120bec Change M_WAIT to M_TRYWAIT, the new name of the flag. 2000-12-24 03:08:17 +00:00
John Baldwin
aea5b8ffe1 Catch up to the changes to the kthread API. 2000-12-15 20:39:35 +00:00
Ruslan Ermilov
d003b7796c mdoc(7) police: removed duplicate .Os calls. 2000-12-14 12:40:48 +00:00
Ruslan Ermilov
ed40311694 mdoc(7) police: removed history info from the .Os FreeBSD call. 2000-12-14 11:52:05 +00:00
Sheldon Hearn
67e35919d6 Grammar fix. 2000-12-14 09:36:49 +00:00
Ruslan Ermilov
1405da432e mdoc(7) police: add a missing .Os, change the list type to ``tagged''. 2000-12-14 08:55:32 +00:00
John Baldwin
ea84acd6ad Document the MA_RECURSED and MA_NOTRECURSED assertion flags as well as
the MTX_QUIET flag.
2000-12-13 23:30:43 +00:00
Dag-Erling Smørgrav
863edaec4d Add sbuf(9) man page with links to API function names.
Reviewed by:	ru
2000-12-13 19:53:37 +00:00
Ruslan Ermilov
d7b336c076 mdoc(7) police: use canonical form of .Dd macro. 2000-12-11 15:47:53 +00:00
John Baldwin
baeb94c70d Fix some nits in the globs used to describe the various sets of atomic
operations.

Submitted by:	jake, jasone
2000-12-08 22:10:28 +00:00
Daniel C. Sobral
232095104e Add a brief warning about devclass and multiple device driver attachments. 2000-11-23 17:19:54 +00:00
Ruslan Ermilov
b92a189eb9 mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:11:48 +00:00
Ruslan Ermilov
ea3d1f093f mdoc(7) police: add the missing and required .Dd macro call. 2000-11-22 13:31:01 +00:00
Ruslan Ermilov
f4d874a1db mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00
Ruslan Ermilov
ae9fd6288c mdoc(7) police: minor cleanup. 2000-11-22 08:19:15 +00:00
Alfred Perlstein
a0ae47cd48 Install DELAY(9). 2000-11-22 03:44:55 +00:00
Alfred Perlstein
0b0d531efb Document the DELAY() function. 2000-11-22 03:38:32 +00:00
Bosko Milekic
5d4050cc5d Add description of M_WRITABLE macro and new M_RDONLY flag. Try my best to
conform to line break mdoc FreeBSD standards, although I am new to this.

Reviewed by: sheldonh
2000-11-21 22:29:31 +00:00
Mark Murray
a28724c2c2 Add new man page to the mix. 2000-11-21 20:31:51 +00:00
Mark Murray
6323c703f7 Whitespace-only change. Tidy up, alphabetise and wrap. 2000-11-21 20:28:48 +00:00
Mark Murray
5855006767 Add a consistent API to a feature that most modern CPUs have; a fast
counter register in-CPU.

This is to be used as a fast "timer", where linearity is more important
than time, and multiple lines in the linearity caused by multiple CPUs
in an SMP machine is not a problem.

This adds no code whatsoever to the FreeBSD kernel until it is actually
used, and then as a single-instruction inline routine (except for the
80386 and 80486 where it is some more inline code around nanotime(9).

Reviewed by:	bde, kris, jhb
2000-11-21 19:55:21 +00:00
Ruslan Ermilov
4b66483fd8 mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00
Ben Smithurst
d641426e5a Fix typo.
PR:		22923
Submitted by:	Jimmy Olgeni <olgeni@uli.it>
2000-11-18 20:19:26 +00:00
Ben Smithurst
7a41bbd47b Fix another typo.
PR:		22924
Submitted by:	Jimmy Olgeni <olgeni@uli.it>
2000-11-18 20:16:47 +00:00
Ruslan Ermilov
218d216271 mdoc(7) police: eliminate warnings. 2000-11-17 15:40:57 +00:00
Ben Smithurst
0381c6e5ba Fix typos.
PR:		22901, 22902
Submitted by:	Jimmy Olgeni <olgeni@uli.it>
2000-11-17 09:16:29 +00:00
Alfred Perlstein
a984db451a install/build accf_* manpages 2000-11-16 00:57:52 +00:00
Alfred Perlstein
16fb0774c2 Xref accf_http and accf_data 2000-11-15 22:54:06 +00:00
Alfred Perlstein
9d6bbf9b1e Document the accf_data accept filter: "dataready" 2000-11-15 22:53:02 +00:00
Alfred Perlstein
9d3a32814d Document the accf_http accept filter "httpready". 2000-11-15 22:46:21 +00:00
Ben Smithurst
6fe89339b9 remove fullstops from the end of .Xr lines in SEE ALSO sections. 2000-11-15 16:00:07 +00:00
Ben Smithurst
b02eeb5c33 Add a newline character at the end of this file, it was missing which
resulted in ugly errors from 'diff'.
2000-11-15 13:34:41 +00:00
Ruslan Ermilov
b5c508fba3 Use Fx macro wherever possible. 2000-11-14 11:20:58 +00:00
John Baldwin
ab7e1991c0 Beef up the description of the kernel thread API.
Reviewed by:	sheldonh, jasone
2000-11-13 20:34:20 +00:00
John Baldwin
dc4e9f1a03 Describe the new software interrupt thread functionality.
Reviewed by:	sheldonh, jasone
2000-11-13 20:18:42 +00:00
John Baldwin
eaca618337 Add a manpage to document the atomic operations including a quick treatment
of memory barriers and the newish atomic variants that include them.

Reviewed by:	sheldonh
2000-11-13 20:08:17 +00:00
David Malone
9704bfcdfb Change a "xlint(1)" to a ".Xr lint 1" and add a reference in the see also
section.
2000-11-13 16:18:46 +00:00
Sheldon Hearn
6cfaa4a7de Sort NAMES section and separate Nm arguments from trailing punctuation. 2000-11-13 13:12:44 +00:00
Ruslan Ermilov
726b61ab5f Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00
Sheldon Hearn
25f1a2e9f9 Miscellaneous content fixes:
* xref sysctl
* do not mark kern.ipc.mbuf_wait up as a function argument.
* do not mix case of function argument names
* a mbuf -> an mbuf
* if -> whether
* typos
2000-11-10 10:22:49 +00:00
Sheldon Hearn
e73145f651 Whitespace only: fix hard sentence breaks now, before people really
get stuck into this page.
2000-11-10 10:08:34 +00:00
John Baldwin
c5f3b30e68 Replace non-existent 'mtx_t' typedef'd type with 'struct mtx'. 2000-11-10 01:51:55 +00:00
Bosko Milekic
bfd597212a Fixup some wrong statements in the new mbuf(9) man page.
Also introduce a bunch of (missed?) macros and functions.
This man page still needs a lot of work, most likely a re-ordering
of the macros/functions, and a more complete, more accurate, listing of
available routines.
A good and worthy start nonetheless.
2000-11-01 23:02:19 +00:00
John Baldwin
7e56ee52c8 Catch up to mutexes becoming MI: machine/mutex.h -> sys/mutex.h 2000-11-01 00:39:27 +00:00
Jeroen Ruigrok van der Werven
29c9277956 Fix a fundamental error. The device is not owned by the parent
bus before allocation.  The resource is.

Asked about by:	julian on -current
Verified by:	msmith
2000-10-31 13:16:47 +00:00
Sheldon Hearn
6296795713 Whitespace only:
* Remove hard sentence breaks.
 * Remove trailing whitespace.
 * Separate macro arguments from trailing punctuation with whitespace.
2000-10-30 19:49:26 +00:00
Ruslan Ermilov
dc5a40409d Add pfil.9 manpage to build after a repository copy. 2000-10-30 09:16:18 +00:00
Poul-Henning Kamp
cf9fa8e725 Move suser() and suser_xxx() prototypes and a related #define from
<sys/proc.h> to <sys/systm.h>.

Correctly document the #includes needed in the manpage.

Add one now needed #include of <sys/systm.h>.
Remove the consequent 48 unused #includes of <sys/proc.h>.
2000-10-29 16:06:56 +00:00
Alexander Langer
b7f4c6bf0e Use EX_USAGE in an example, as the SAME manual page describes a
few lines higher.

PR:		22371
Submitted by:	andrew@ugh.net.au
2000-10-28 10:02:23 +00:00
Mike Pritchard
096ed6644a Typo fix. 2000-10-27 20:55:15 +00:00
Jeroen Ruigrok van der Werven
e87b9f2824 Use FreeBSD.org, not freebsd.org, as has been the precedent. 2000-10-27 16:05:39 +00:00
John Baldwin
7dbdc1bff4 Add in MLINKS for all of the various mutex functions to mutex.9 2000-10-26 23:54:10 +00:00
John Baldwin
2c3d0ee6f4 - Document MUTEX_DECLARE and MTX_COLD
- Clean up some minor nits
2000-10-26 23:53:12 +00:00
John Baldwin
26fdc7e05b Add a note that the spl() API is deprecated in favor of mutexes. 2000-10-26 23:30:01 +00:00
Nik Clayton
de06f907d1 Add a prototype mbuf.9 man page. Probably needs work, but it's a good
start.

PR:             docs/22053
Submitted by:   Yar Tikhiy <yar@comp.chem.msu.su>
2000-10-26 23:15:47 +00:00
Mark Murray
e5e600c900 Add some very crude man pages to try to induce folk to work on them.
Agreed to work on them:	jasone
2000-10-24 03:33:24 +00:00
Poul-Henning Kamp
1921a06d6a Introduce the M_ZERO flag to malloc(9)
Instead of:

        foo = malloc(sizeof(foo), M_WAIT);
        bzero(foo, sizeof(foo));

You can now (and please do) use:

        foo = malloc(sizeof(foo), M_WAIT | M_ZERO);

In the future this will enable us to do idle-time pre-zeroing of
malloc-space.
2000-10-20 17:54:55 +00:00
Mark Murray
67297998c8 Add a man page for part of the PRNG API. 2000-10-14 16:16:42 +00:00
Brian Somers
e6e7337683 Index: Makefile
===================================================================
RCS file: /home/ncvs/src/share/man/man9/Makefile,v
retrieving revision 1.75
diff -u -r1.75 Makefile
--- Makefile	2000/09/17 12:15:12	1.75
+++ Makefile	2000/10/06 23:24:26
@@ -69,6 +69,8 @@
 MLINKS+=make_dev.9 destroy_dev.9
 MLINKS+=malloc.9 FREE.9 malloc.9 MALLOC.9 malloc.9 free.9
 MLINKS+=mi_switch.9 cpu_switch.9
+MLINKS+=namei.9 NDINIT.9
+MLINKS+=namei.9 NDFREE.9
 MLINKS+=posix4.9 p1003_1b.9
 MLINKS+=psignal.9 gsignal.9 psignal.9 pgsignal.9
 MLINKS+=rtalloc.9 rtalloc1.9 rtalloc.9 rtalloc_ign.9
2000-10-06 23:29:11 +00:00
Paul Saab
e8af5965e2 Correct who pioneered the accept filters and Yahoo!'s company name. 2000-10-06 10:51:24 +00:00
Mark Murray
4f1249a812 Huge improvement to the mutex man page.
o Document all the mutex calls, not just the entry and exit.

o Fix the mtx_t typedef (now is struct mtx).
2000-09-25 11:21:49 +00:00
Mark Murray
16aa79c236 Remove references to the defunct kern.timecounter.method sysctl variable. 2000-09-25 11:18:51 +00:00
Robert Watson
28994ea06f o Bring VOP_GETACL(9) and VOP_GETEXTATTR(9) man page "LOCKS" sections in
sync with the implementation.  Vnode locks *are* required for these
  operations, as some underlying implementations will require them.

Obtained from:	TrustedBSD Project
2000-09-21 18:51:48 +00:00
Alexander Langer
77f3abec92 Reference DRIVER_MODULE.9 2000-09-17 12:20:08 +00:00
Alexander Langer
72f8c78baf Add DRIVER_MODULE.9, the manual page describing the kernel driver
declaration macro.
Thanks to Sheldon for a big patch with language/mdoc fixes.

Reviewed by:	asmodai, sheldonh
2000-09-17 12:15:12 +00:00
Poul-Henning Kamp
0aa16c1a77 Fix a cut&paste mistake. 2000-09-16 14:37:41 +00:00
Jake Burkholder
e66ccea4a1 Add scant documentation for msleep. 2000-09-11 00:52:31 +00:00
Jason Evans
0384fff8c5 Major update to the way synchronization is done in the kernel. Highlights
include:

* Mutual exclusion is used instead of spl*().  See mutex(9).  (Note: The
  alpha port is still in transition and currently uses both.)

* Per-CPU idle processes.

* Interrupts are run in their own separate kernel threads and can be
  preempted (i386 only).

Partially contributed by:	BSDi (BSD/OS)
Submissions by (at least):	cp, dfr, dillon, grog, jake, jhb, sheldonh
2000-09-07 01:33:02 +00:00
Doug Rabson
21c58b8d40 Document kobj_class_compile_static(). 2000-08-28 21:17:46 +00:00
Sheldon Hearn
a948e10a1c Clear extraneous arguments to the name (Nm) macro.
Mark PRISON_ROOT and EPERM as defined values (Dv).
2000-08-17 08:17:16 +00:00
Mark Murray
58ea82758e Mention more functions in the headers so whatis(1) can find them, and
create links to functions so added found.
2000-08-16 19:53:38 +00:00
Mark Murray
dfea8241e6 Grammar police; make the English style more consistent throughout,
and give suser_xxx some more airtime.
2000-08-16 19:52:03 +00:00
Mark Murray
38bd736e76 Grammar police; "has been written by" --> "was written by". 2000-08-15 15:23:46 +00:00
Mark Murray
4fea914dda Improve the cross-references. 2000-08-15 15:14:13 +00:00
Mark Murray
3e36b6ef41 Fix grammar and a function name. 2000-08-15 15:09:13 +00:00
Sheldon Hearn
f0cddd5353 Clarify the guidelines surrounding the use of macros. The patch is
mostly unrelated to the attributed PR, and the attributed submitter
wasn't so much suggesting the patch for inclusion as providing it
for clarity.

PR:		9869
Submitted by:	bde
2000-08-08 09:54:57 +00:00
Mark Murray
1e42415db0 Remove references to the (removed) kern.timecounter.method sysctl. 2000-07-23 11:12:59 +00:00
Sheldon Hearn
785c4f1a3d Clean up this new manual page. This delta includes content and
whitespace changes, which should not be a problem because this
is only the second revision of the file and translators are
unlikely to have gotten started yet.

Reviewed by:	abial
2000-07-19 06:33:34 +00:00
Ben Smithurst
dff9235e4a Define what is meant by brackets' and braces'.
Suggested by:	grog
2000-07-18 14:41:01 +00:00
Sheldon Hearn
9400b2896e Order the cross-references in the SEE ALSO section correctly. 2000-07-18 13:03:09 +00:00
Sheldon Hearn
3ae5a45440 Clean up this new manual page. This delta includes content and
whitespace changes, which should not be a problem because this
is only the second revision of the file and translators are
unlikely to have gotten started yet.

Reviewed by:	abial
2000-07-18 07:46:14 +00:00
Ben Smithurst
de9bd90aa8 Remove some whitespace so the line with "brackets" changed to "angle
brackets" no longer touches the right edge of an 80 column display.
2000-07-17 19:05:57 +00:00
Ben Smithurst
044e09a0a8 1. "braces" -> "brackets" when referring to [ and ].
PR:		19894
Submitted by:	Tony Finch <dot@dotat.at>

2.   "brackets" -> "angle brackets" when referring to < and >.

3.  Clean up the bit about creating the usage() message.  After clarifying a
couple of points the sentence became rather long, and rather poor English, so
it was converted to a enumerated list instead.

parts 1, 2, 3:
Reviewed by:	sheldonh
2000-07-16 20:46:43 +00:00
Ben Smithurst
3fd5156000 "VFS entry point" -> "entry point", to be consistent with other VOP_*(9)
manual pages.

PR:		18593
Submitted by:	Anatoly Vorobey <mellon@pobox.com>
2000-07-15 22:28:16 +00:00
Andrzej Bialecki
bd3cdc3105 These patches implement dynamic sysctls. It's possible now to add
and remove sysctl oids at will during runtime - they don't rely on
linker sets. Also, the node oids can be referenced by more than
one kernel user, which means that it's possible to create partially
overlapping trees.

Add sysctl contexts to help programmers manage multiple dynamic
oids in convenient way.

Please see the manpages for detailed discussion, and example module
for typical use.

This work is based on ideas and code snippets coming from many
people, among them:  Arun Sharma, Jonathan Lemon, Doug Rabson,
Brian Feldman, Kelly Yancey, Poul-Henning Kamp and others. I'd like
to specially thank Brian Feldman for detailed review and style
fixes.

PR:		kern/16928
Reviewed by:	dfr, green, phk
2000-07-15 10:26:04 +00:00
Jeroen Ruigrok van der Werven
7bca8b217f Install accept_filter.9
Forgotten by:	alfred
2000-07-11 13:50:04 +00:00
Alfred Perlstein
ad9bccc5f7 attrib properly.
Pointed out by: asmodai
2000-07-10 19:20:08 +00:00
Alfred Perlstein
fb567cd9eb Document the kernel interface for accept filters.
Thanks to sheldonh for cleaning up the rough initial manpage.
2000-07-10 17:23:53 +00:00
Nick Hibma
fd473ea108 Correct the text for the return value.
Submitted by:	phk
2000-07-04 12:45:56 +00:00
Alexander Langer
aa3524dbd4 mdoc style cleanup: newline for new sentence.
Submitted by:	sheldonh
2000-06-20 15:05:06 +00:00
Alexander Langer
8f8b4df79a Fix typo (accessable --> accessible) and add period.
PR:		18588
Submitted by:	Anatoly Vorobey <mellon@pobox.com>
Reviewed by:	asmodai
2000-06-14 17:53:11 +00:00
Alexander Langer
505f2a7ecf Document possible values for the waitfor arg.
PR:		18627, 18628
Reviewed by:	asmodai
2000-06-12 13:53:04 +00:00
Alexander Langer
dc661e78a8 Remove XXX: Describe if_init().
Reviewed by:	asmodai
2000-06-10 10:23:06 +00:00
Alexander Langer
9092a4bca7 Add bus_alloc_resource.9 and bus_release_resource.9.
bus_release_resource.9 contains a paragraph obtained from a mail
by Warner Losh <imp@FreeBSD.org> to myself.

Reviewed by:	asmodai, hoek;  in parts by msmith, mdodd and imp
2000-06-08 21:00:12 +00:00
Jeroen Ruigrok van der Werven
7603b950ef VFS_CHECKEXP.9:
Fix typo.
	Fix description.

VFS_FHTOVP.9:
	Fix order in which the manpage says the calls should be made.

PR:		18590
Submitted by:	Anatoly Vorobey <mellon@pobox.com>
2000-06-04 15:31:12 +00:00
Doug Rabson
823234556f Add documentation for taskqueue apis. 2000-05-28 16:53:50 +00:00
Tim Vanderhoek
bca1f3c245 The LOCKPARENT flag is singular. It doesn't work causing complications
is also a singular fact.
2000-05-21 03:23:10 +00:00
Chris Costello
878f9ca614 Replace a manual.section file reference with a proper mdoc(7) .Xr
reference.

PR:		18625
Submitted by:	Alexander Langer <alex@cichlids.com>
2000-05-18 00:20:55 +00:00
Paul Richards
1c7d91744e Correct duplicate use of word "been" in a sentence. 2000-05-12 15:31:54 +00:00
Bruce Evans
1c171d7474 Abuse .Fn for macros better (don't hand-format the parameter string by
quoting it all and adding commas).

Don't say that the expression in KASSERT() is an int.  It is a collection
of tokens forming a C expression that can be compared with 0.
2000-05-11 16:54:52 +00:00
Bruce Evans
7925aadbe5 Removed bogus quoting of single tokens in a .Fn invocation. This helps
my synopsis checker decide which .Fn's are for prototypes (most function
parameters require quoting because they have multiple tokens).
2000-05-11 16:39:33 +00:00
Bruce Evans
b1f2329c99 Fixed bitrot. The changes from buf to bio had not reached here. 2000-05-11 16:25:03 +00:00
Darren Reed
08aa4ea3b8 patch from Alexey Zelkin 2000-05-11 00:44:35 +00:00
Darren Reed
e9c7bebf95 Add pfil(9) subroutines and manpage from NetBSD. 2000-05-10 13:37:51 +00:00