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

.\" Copyright (c) 2005 Robert N. M. Watson
.\" 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. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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 August 10, 2012
.Dt SCHED_ULE 4
.Os
.Sh NAME
.Nm sched_ule
.Nd ULE scheduler
.Sh SYNOPSIS
.Cd "options SCHED_ULE"
.Sh DESCRIPTION
The
.Nm
scheduler
provides a number of advanced scheduler
features not present in
.Xr sched_4bsd 4 ,
the traditional system scheduler.
These features address SMP and interactivity and include:
.Pp
.Bl -bullet -compact -offset indent
.It
Thread CPU affinity.
.It
CPU topology awareness, including for hyper-threading.
.It
Per-CPU run queues.
.It
Interactivity heuristics that detect interactive applications and schedules
them preferentially under high load.
.El
.Pp
The following sysctls are relevant to the operation of
.Nm :
.Bl -tag -width indent
.It Va kern.sched.name
This read-only sysctl reports the name of the active scheduler.
.It Va kern.sched.quantum
This read-write sysctl reports or sets the length of the quantum (in
micro-seconds) granted to a thread.
.El
.Sh SEE ALSO
.Xr sched_4bsd 4 ,
.Xr sysctl 8
.Sh HISTORY
The
.Nm
scheduler first appeared in
.Fx 5.1 .
.Sh AUTHORS
.An Jeff Roberson Aq Mt jeff@FreeBSD.org
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`.\" Copyright (c) 2005 Robert N. M. Watson`
			`.\" 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. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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$`
			`.\"`
Some minor tunings/cleanups inspired by bde@ after previous commits: - remove extra dynamic variable initializations; - restore (4BSD) and implement (ULE) hogticks variable setting; - make sched_rr_interval() more tolerant to options; - restore (4BSD) and implement (ULE) kern.sched.quantum sysctl, a more user-friendly wrapper for sched_slice; - tune some sysctl descriptions; - make some style fixes. 2012-08-10 19:02:49 +00:00			`.Dd August 10, 2012`
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`.Dt SCHED_ULE 4`
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors) 2010-04-14 19:08:06 +00:00			`.Os`
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`.Sh NAME`
			`.Nm sched_ule`
Revise markup. 2006-09-30 15:14:49 +00:00			`.Nd ULE scheduler`
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`.Sh SYNOPSIS`
			`.Cd "options SCHED_ULE"`
			`.Sh DESCRIPTION`
(Mostly) markup fixes. Approved by: re (blanket) 2005-06-16 18:46:17 +00:00			`The`
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`.Nm`
(Mostly) markup fixes. Approved by: re (blanket) 2005-06-16 18:46:17 +00:00			`scheduler`
- sched_4bsd is no longer a default system scheduler on some architectures, so call it "traditional" instead. - sched_ule is no longer buggy or experimental (according to rev. 1.7 of sched_ule(4)), so don't call it experimental (reported by a user on stable@). Reviewed by: rwatson 2008-01-24 13:48:20 +00:00			`provides a number of advanced scheduler`
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`features not present in`
			`.Xr sched_4bsd 4 ,`
- sched_4bsd is no longer a default system scheduler on some architectures, so call it "traditional" instead. - sched_ule is no longer buggy or experimental (according to rev. 1.7 of sched_ule(4)), so don't call it experimental (reported by a user on stable@). Reviewed by: rwatson 2008-01-24 13:48:20 +00:00			`the traditional system scheduler.`
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`These features address SMP and interactivity and include:`
			`.Pp`
			`.Bl -bullet -compact -offset indent`
			`.It`
			`Thread CPU affinity.`
			`.It`
			`CPU topology awareness, including for hyper-threading.`
			`.It`
			`Per-CPU run queues.`
			`.It`
			`Interactivity heuristics that detect interactive applications and schedules`
			`them preferentially under high load.`
			`.El`
			`.Pp`
			`The following sysctls are relevant to the operation of`
			`.Nm :`
			`.Bl -tag -width indent`
(Mostly) markup fixes. Approved by: re (blanket) 2005-06-16 18:46:17 +00:00			`.It Va kern.sched.name`
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`This read-only sysctl reports the name of the active scheduler.`
Some minor tunings/cleanups inspired by bde@ after previous commits: - remove extra dynamic variable initializations; - restore (4BSD) and implement (ULE) hogticks variable setting; - make sched_rr_interval() more tolerant to options; - restore (4BSD) and implement (ULE) kern.sched.quantum sysctl, a more user-friendly wrapper for sched_slice; - tune some sysctl descriptions; - make some style fixes. 2012-08-10 19:02:49 +00:00			`.It Va kern.sched.quantum`
			`This read-write sysctl reports or sets the length of the quantum (in`
			`micro-seconds) granted to a thread.`
Add rudimentary man pages for kernel options sched_4bsd and sched_ule, which document some of the sysctls available for configuring 4bsd, some of the bullet features of ule, and that ule is considered experimental still. MFC after: 3 days 2005-04-07 21:57:19 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr sched_4bsd 4 ,`
			`.Xr sysctl 8`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`scheduler first appeared in`
			`.Fx 5.1 .`
			`.Sh AUTHORS`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Jeff Roberson Aq Mt jeff@FreeBSD.org`