freebsd-nq/share/man/man9/critical_enter.9

.\" Copyright (c) 2001,2002 John H. Baldwin <jhb@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. 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 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 October 5, 2005
.Dt CRITICAL_ENTER 9
.Os
.Sh NAME
.Nm critical_enter ,
.Nm critical_exit
.Nd enter and exit a critical region
.Sh SYNOPSIS
.In sys/param.h
.In sys/systm.h
.Ft void
.Fn critical_enter "void"
.Ft void
.Fn critical_exit "void"
.Sh DESCRIPTION
These functions are used to prevent preemption in a critical region of code.
All that is guaranteed is that the thread currently executing on a CPU will
not be preempted.
Specifically, a thread in a critical region will not migrate to another
CPU while it is in a critical region.
The current CPU may still trigger faults and exceptions during a critical
section; however, these faults are usually fatal.
.Pp
The
.Fn critical_enter
and
.Fn critical_exit
functions manage a per-thread counter to handle nested critical sections.
If a thread is made runnable that would normally preempt the current thread
while the current thread is in a critical section,
then the preemption will be deferred until the current thread exits the
outermost critical section.
.Pp
Note that these functions are not required to provide any inter-CPU
synchronization, data protection, or memory ordering guarantees and thus
should
.Em not
be used to protect shared data structures.
.Pp
These functions should be used with care as an infinite loop within a
critical region will deadlock the CPU.
Also, they should not be interlocked with operations on mutexes, sx locks,
semaphores, or other synchronization primitives.
One exception to this is that spin mutexes include a critical section,
so in certain cases critical sections may be interlocked with spin mutexes.
.Sh HISTORY
These functions were introduced in
.Fx 5.0 .
Fully catch up to the recent critical section API change. Update the content of the manpage and document cpu_critical_enter/exit. 2002-01-04 23:56:17 +00:00			`.\" Copyright (c) 2001,2002 John H. Baldwin <jhb@FreeBSD.org>`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`.\" 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 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$`
			`.\"`
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			`.Dd October 5, 2005`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`.Dt CRITICAL_ENTER 9`
			`.Os`
			`.Sh NAME`
			`.Nm critical_enter ,`
			`.Nm critical_exit`
			`.Nd enter and exit a critical region`
			`.Sh SYNOPSIS`
Fix the prototypes for cpu_critical_exit and cpu_critical_enter and update the text to reflect the changes. Update the header files list. 2002-04-12 05:06:38 +00:00			`.In sys/param.h`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/systm.h`
Update function definitions and required include files to reflect the current state of the system. Approved by: alfred 2001-12-26 23:14:04 +00:00			`.Ft void`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`.Fn critical_enter "void"`
			`.Ft void`
Update function definitions and required include files to reflect the current state of the system. Approved by: alfred 2001-12-26 23:14:04 +00:00			`.Fn critical_exit "void"`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`.Sh DESCRIPTION`
ispell sweep of share/man/man9/*. 2002-01-09 11:43:48 +00:00			`These functions are used to prevent preemption in a critical region of code.`
Fully catch up to the recent critical section API change. Update the content of the manpage and document cpu_critical_enter/exit. 2002-01-04 23:56:17 +00:00			`All that is guaranteed is that the thread currently executing on a CPU will`
			`not be preempted.`
			`Specifically, a thread in a critical region will not migrate to another`
			`CPU while it is in a critical region.`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`The current CPU may still trigger faults and exceptions during a critical`
Fully catch up to the recent critical section API change. Update the content of the manpage and document cpu_critical_enter/exit. 2002-01-04 23:56:17 +00:00			`section; however, these faults are usually fatal.`
			`.Pp`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`The`
Fully catch up to the recent critical section API change. Update the content of the manpage and document cpu_critical_enter/exit. 2002-01-04 23:56:17 +00:00			`.Fn critical_enter`
			`and`
			`.Fn critical_exit`
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			`functions manage a per-thread counter to handle nested critical sections.`
			`If a thread is made runnable that would normally preempt the current thread`
			`while the current thread is in a critical section,`
			`then the preemption will be deferred until the current thread exits the`
			`outermost critical section.`
Fully catch up to the recent critical section API change. Update the content of the manpage and document cpu_critical_enter/exit. 2002-01-04 23:56:17 +00:00			`.Pp`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`Note that these functions are not required to provide any inter-CPU`
			`synchronization, data protection, or memory ordering guarantees and thus`
			`should`
mdoc(7) police: there is no single manpage that uses ``.Sy not''. 2001-04-04 11:57:03 +00:00			`.Em not`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`be used to protect shared data structures.`
			`.Pp`
			`These functions should be used with care as an infinite loop within a`
			`critical region will deadlock the CPU.`
Fix the prototypes for cpu_critical_exit and cpu_critical_enter and update the text to reflect the changes. Update the header files list. 2002-04-12 05:06:38 +00:00			`Also, they should not be interlocked with operations on mutexes, sx locks,`
			`semaphores, or other synchronization primitives.`
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			`One exception to this is that spin mutexes include a critical section,`
			`so in certain cases critical sections may be interlocked with spin mutexes.`
Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00			`.Sh HISTORY`
			`These functions were introduced in`
			`.Fx 5.0 .`