xref: /illumos-gate/usr/src/man/man9f/atomic_bits.9f (revision bbf21555)
te
Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
ATOMIC_BITS 9F "Jan 16, 2006"
NAME
atomic_bits, atomic_set_long_excl, atomic_clear_long_excl - atomic set and clear bit operations
SYNOPSIS

#include <sys/atomic.h>

int atomic_set_long_excl(volatile ulong_t *target, uint_t bit);

int atomic_clear_long_excl(volatile ulong_t *target, uint_t bit);
DESCRIPTION

The atomic_set_long_excl() and atomic_clear_long_excl() functions perform an exclusive atomic bit set or clear operation on target. The value of bit specifies the number of the bit to be modified within target. Bits are numbered from zero to one less than the maximum number of bits in a long. If the value of bit falls outside of this range, the result of the operation is undefined.

RETURN VALUES

The atomic_set_long_excl() and atomic_clear_long_excl() functions return 0 if bit was successfully set or cleared. They return -1 if bit was already set or cleared.

ERRORS

No errors are defined.

CONTEXT

These functions can be called from user, interrupt, or kernel context.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
SEE ALSO

atomic_ops (3C), attributes (7), atomic_add (9F), atomic_and (9F), atomic_cas (9F), atomic_dec (9F), atomic_inc (9F), atomic_or (9F), atomic_swap (9F), membar_ops (9F)