xref: /titanic_52/usr/src/man/man9f/atomic_swap.9f (revision 26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0)
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_SWAP 9F "Jan 16, 2006"
NAME
atomic_swap, atomic_swap_8, atomic_swap_uchar, atomic_swap_16, atomic_swap_ushort, atomic_swap_32, atomic_swap_uint, atomic_swap_ulong, atomic_swap_64, atomic_swap_ptr - atomic swap operations
SYNOPSIS

#include <sys/atomic.h>

uint8_t atomic_swap_8(volatile uint8_t *target, uint8_t newval);

uchar_t atomic_swap_uchar(volatile uchar_t *target, uchar_t newval);

uint16_t atomic_swap_16(volatile uint16_t *target, uint16_t newval);

ushort_t atomic_swap_ushort(volatile ushort_t *target, ushort_t newval);

uint32_t atomic_swap_32(volatile uint32_t *target, uint32_t newval);

uint_t atomic_swap_uint(volatile uint_t *target, uint_t newval);

ulong_t atomic_swap_ulong(volatile ulong_t *target, ulong_t newval);

uint64_t atomic_swap_64(volatile uint64_t *target, uint64_t newval);

void *atomic_swap_ptr(volatile void *target, void *newval);
DESCRIPTION

These functions enable a swap operation to occur atomically. The value stored in target is replaced with newval. The old value is returned by the function.

RETURN VALUES

These functions return the old of *target.

ERRORS

No errors are defined.

CONTEXT

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

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
SEE ALSO

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