Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 22 Mar 2001 14:53:53 -0800 (PST)
From:      John Baldwin <jhb@FreeBSD.org>
To:        arch@FreeBSD.org
Subject:   Critical Regions Round II
Message-ID:  <XFMail.010322145353.jhb@FreeBSD.org>

next in thread | raw e-mail | index | archive | help
This message is in MIME format
--_=XFMail.1.4.0.FreeBSD:010322145349:773=_
Content-Type: text/plain; charset=us-ascii

Hopefully this will make everyone happy.

Prior to SMPng we had the following functions related to interrupts:

disable_intr()  - x86 only and just did a 'cli'
enable_intr()   - x86 only and just did a 'sti'

With the initial SMPng commit this was added to to allow nested disabling
of interrupts:

save_intr()     - return current interrupt state
restore_intr()  - revert to previously read interrupt state

Thus one would do:

        u_int foo;

        foo = save_intr();
        disable_intr();
        ....
        restore_intr(foo);

Also, this entire API was forced out into MI code.  After the discussion on
the mailing list I propose the following that will hopefully make everyone
happy:

disable_intr()  - x86 / ia64 only, just clears the IF or psr.i bit, and is
                  a MD function
enable_intr()   - x86 / ia64 only, just sets the IF or psr.i bit, and is a
                  MD function

save_intr()     - gone
restore_intr()  - gone

critical_enter() - enters a critical region of code that must not be
                   preempted
critical_exit()  - leaves a critical region of code

The critical_enter/exit functions use an opaque type 'critical_t' for the
value that critical_enter() returns that must be passed to critical_exit().
Thus, the above code now becomes:

        critical_t foo;

        foo = critical_enter();
        ...
        critical_exit(foo);

This API includes the same optimizations mentioned for the Alpha as the
last proposal.  A manpage for critical_enter/exit is attached.

-- 

John Baldwin <jhb@FreeBSD.org> -- http://www.FreeBSD.org/~jhb/
PGP Key: http://www.baldwin.cx/~john/pgpkey.asc
"Power Users Use the Power to Serve!"  -  http://www.FreeBSD.org/

--_=XFMail.1.4.0.FreeBSD:010322145349:773=_
Content-Disposition: attachment; filename="critical_enter.9"
Content-Transfer-Encoding: 7bit
Content-Description: critical_enter.9
Content-Type: text/plain;
 charset=us-ascii; name=critical_enter.9; SizeOnDisk=3235

.\" Copyright (c) 2001 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 March 22, 2001
.Dt CRITICAL_ENTER 9
.Os
.Sh NAME
.Nm critical_enter ,
.Nm critical_exit
.Nd enter and exit a critical region
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/systm.h>
.Ft critical_t
.Fn critical_enter "void"
.Ft void
.Fn critical_exit "critical_t savecrit"
.Sh DESCRIPTION
These functions are used to prevent preemption in a critcal region of code.
All that is guaranteed is that the current CPU will not be preempted by an
external interrupt.
The current CPU may still trigger faults and exceptions during a critical
section.
The
.Fn critical_enter
function returns an opaque value of type
.Vt critical_t .
This value must be passed to the
.Fn critical_exit
function when leaving the critical region.
.Pp
Note that these functions are not required to provide any inter-CPU
synchronization, data protection, or memory ordering guarantees and thus
should
.Sy 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.
.Sh RETURN VALUES
The
.Fn critical_enter
function returns an opaque value that must be passed to a corresponding call to
.Fn critical_exit .
.Sh EXAMPLES
This example demonstrates the use of
.Fn critical_enter
and
.Fn critical_exit
to guarantee atomic access to the DMA controller.
.Bd -literal -offset indent
int
isa_dmastatus(int chan)
{
        u_long  cnt = 0;
        int     ffport, waport;
        u_long  low1, high1, low2, high2;
        critical_t savecrit;

	...
        savecrit = critical_enter();
        outb(ffport, 0);
        low1 = inb(waport);
        high1 = inb(waport);
        outb(ffport, 0);
        low2 = inb(waport);
        high2 = inb(waport);
        critical_exit(savecrit);
	...
}
.Ed
.Sh HISTORY
These functions were introduced in
.Fx 5.0 .

--_=XFMail.1.4.0.FreeBSD:010322145349:773=_--
End of MIME message

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-arch" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?XFMail.010322145353.jhb>