freebsd-skq/share/man/man4/smp.4

.\" Copyright (c) 1997
.\"	Steve Passe <fsmp@FreeBSD.ORG>.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. The name of the developer may NOT be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd December 5, 2002
.Dt SMP 4
.Os
.Sh NAME
.Nm SMP
.Nd description of the FreeBSD Symmetric MultiProcessor kernel
.Sh SYNOPSIS
.Cd options SMP
.Cd options APIC_IO
.Sh DESCRIPTION
The
.Nm
kernel implements symmetric multiprocessor support.
.Sh COMPATIBILITY
Support for multi-processor systems is present for all supported
architectures on
.Fx .
Currently, this includes alpha, i386, ia64, and sparc64.
Support is enabled using
.Cd options SMP .
On some, but not all platforms, it is permissible to use the SMP
kernel configuration on non-SMP equipped motherboards.
.Pp
For i386 systems, the
.Nm
kernel supports motherboards that follow the Intel MP specification,
version 1.4.
In addition to
.Cd options SMP ,
i386 also requires
.Cd options APIC_IO .
The
.Xr mptable 1
command may be used to view the status of multi-processor support.
.Sh SEE ALSO
.Xr mptable 1 ,
.Xr condvar 9 ,
.Xr msleep 9 ,
.Xr mtx_pool 9 ,
.Xr mutex 9 ,
.Xr sema 9 ,
.Xr sx 9
.Sh HISTORY
The
.Nm
kernel's early history is not (properly) recorded.  It was developed
in a separate CVS branch until April 26, 1997, at which point it was
merged into 3.0-current.  By this date 3.0-current had already been
merged with Lite2 kernel code.
.Pp
.Fx 5.0
introduced support for a host of new synchronization primitives, and
a move towards fine-grained kernel locking rather than reliance on
a Giant kernel lock.
The SMPng Project relied heavily on the support of BSDi, who provided
reference source code from the fine-grained SMP implementation found
in
.Bsx .
.Sh AUTHORS
.An Steve Passe Aq fsmp@FreeBSD.org
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.\" Copyright (c) 1997`
			`.\" Steve Passe <fsmp@FreeBSD.ORG>. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. The name of the developer may NOT be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
$FreeBSD$ tags moved to bottom of license aggmt. 1999-10-30 16:05:26 +00:00			`.\" SUCH DAMAGE.`
Add $Id$, to make it simpler for members of the translation teams to track. The $Id$ line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde 1999-07-12 21:02:10 +00:00			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add $Id$, to make it simpler for members of the translation teams to track. The $Id$ line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde 1999-07-12 21:02:10 +00:00			`.\"`
Take a pass at updating this man page a bit to at least mention SMPng, that we do MP on more than just i386, and add some cross-references. This is far from a perfect update, but at least it's a start. More will no doubt follow. Reviewed by: jhb Approved by: re 2002-12-07 01:37:12 +00:00			`.Dd December 5, 2002`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Dt SMP 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Sh NAME`
			`.Nm SMP`
mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00			`.Nd description of the FreeBSD Symmetric MultiProcessor kernel`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Sh SYNOPSIS`
Provide enhanced information on configuring SMP support in a kernel. Approved by: re 2002-12-07 01:50:06 +00:00			`.Cd options SMP`
			`.Cd options APIC_IO`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Sh DESCRIPTION`
			`The`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`.Nm`
Spelling fixes. Submitted by: Josh Gilliam <josh@quick.net> PR: 6880 1998-06-08 06:12:02 +00:00			`kernel implements symmetric multiprocessor support.`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Sh COMPATIBILITY`
Take a pass at updating this man page a bit to at least mention SMPng, that we do MP on more than just i386, and add some cross-references. This is far from a perfect update, but at least it's a start. More will no doubt follow. Reviewed by: jhb Approved by: re 2002-12-07 01:37:12 +00:00			`Support for multi-processor systems is present for all supported`
mdoc(7) police: markup nits. Approved by: re (blanket) 2002-12-09 12:28:33 +00:00			`architectures on`
			`.Fx .`
Take a pass at updating this man page a bit to at least mention SMPng, that we do MP on more than just i386, and add some cross-references. This is far from a perfect update, but at least it's a start. More will no doubt follow. Reviewed by: jhb Approved by: re 2002-12-07 01:37:12 +00:00			`Currently, this includes alpha, i386, ia64, and sparc64.`
Provide enhanced information on configuring SMP support in a kernel. Approved by: re 2002-12-07 01:50:06 +00:00			`Support is enabled using`
			`.Cd options SMP .`
			`On some, but not all platforms, it is permissible to use the SMP`
			`kernel configuration on non-SMP equipped motherboards.`
Take a pass at updating this man page a bit to at least mention SMPng, that we do MP on more than just i386, and add some cross-references. This is far from a perfect update, but at least it's a start. More will no doubt follow. Reviewed by: jhb Approved by: re 2002-12-07 01:37:12 +00:00			`.Pp`
			`For i386 systems, the`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Nm`
			`kernel supports motherboards that follow the Intel MP specification,`
			`version 1.4.`
Provide enhanced information on configuring SMP support in a kernel. Approved by: re 2002-12-07 01:50:06 +00:00			`In addition to`
			`.Cd options SMP ,`
			`i386 also requires`
			`.Cd options APIC_IO .`
			`The`
Take a pass at updating this man page a bit to at least mention SMPng, that we do MP on more than just i386, and add some cross-references. This is far from a perfect update, but at least it's a start. More will no doubt follow. Reviewed by: jhb Approved by: re 2002-12-07 01:37:12 +00:00			`.Xr mptable 1`
			`command may be used to view the status of multi-processor support.`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Sh SEE ALSO`
Sort cross refereces in section SEE ALSO. 1997-09-29 10:11:02 +00:00			`.Xr mptable 1 ,`
Take a pass at updating this man page a bit to at least mention SMPng, that we do MP on more than just i386, and add some cross-references. This is far from a perfect update, but at least it's a start. More will no doubt follow. Reviewed by: jhb Approved by: re 2002-12-07 01:37:12 +00:00			`.Xr condvar 9 ,`
			`.Xr msleep 9 ,`
			`.Xr mtx_pool 9 ,`
			`.Xr mutex 9 ,`
			`.Xr sema 9 ,`
			`.Xr sx 9`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`kernel's early history is not (properly) recorded. It was developed`
			`in a separate CVS branch until April 26, 1997, at which point it was`
			`merged into 3.0-current. By this date 3.0-current had already been`
			`merged with Lite2 kernel code.`
Take a pass at updating this man page a bit to at least mention SMPng, that we do MP on more than just i386, and add some cross-references. This is far from a perfect update, but at least it's a start. More will no doubt follow. Reviewed by: jhb Approved by: re 2002-12-07 01:37:12 +00:00			`.Pp`
			`.Fx 5.0`
			`introduced support for a host of new synchronization primitives, and`
			`a move towards fine-grained kernel locking rather than reliance on`
			`a Giant kernel lock.`
			`The SMPng Project relied heavily on the support of BSDi, who provided`
			`reference source code from the fine-grained SMP implementation found`
mdoc(7) police: markup nits. Approved by: re (blanket) 2002-12-09 12:28:33 +00:00			`in`
			`.Bsx .`
Added missing SMP kernel manpage. Mostly a stub at this point, needs alot of work. Noticed by: Steve Roome steve@visint.co.uk 1997-08-04 21:02:11 +00:00			`.Sh AUTHORS`
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq. 1998-03-12 07:31:21 +00:00			`.An Steve Passe Aq fsmp@FreeBSD.org`