xref: /illumos-gate/usr/src/man/man3c/atomic_cas.3c (revision 915894ef19890baaed00080f85f6b69e225cda98)
te
Copyright (c) 2009, 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_CAS 3C "May 13, 2005"
NAME
atomic_cas, atomic_cas_8, atomic_cas_uchar, atomic_cas_16, atomic_cas_ushort, atomic_cas_32, atomic_cas_uint, atomic_cas_ulong, atomic_cas_64, atomic_cas_ptr - atomic compare and swap operations
SYNOPSIS

#include <atomic.h>

uint8_t atomic_cas_8(volatile uint8_t *target, uint8_t cmp,
 uint8_t newval);

uchar_t atomic_cas_uchar(volatile uchar_t *target, uchar_t cmp,
 uchar_t newval);

uint16_t atomic_cas_16(volatile uint16_t *target, uint16_t cmp,
 uint16_t newval);

ushort_t atomic_cas_ushort(volatile ushort_t *target, ushort_t cmp,
 ushort_t newval);

uint32_t atomic_cas_32(volatile uint32_t *target, uint32_t cmp,
 uint32_t newval);

uint_t atomic_cas_uint(volatile uint_t *target, uint_t cmp,
 uint_t newval);

ulong_t atomic_cas_ulong(volatile ulong_t *target, ulong_t cmp,
 ulong_t newval);

uint64_t atomic_cas_64(volatile uint64_t *target, uint64_t cmp,
 uint64_t newval);

void *atomic_cas_ptr(volatile void *target, void *cmp,
 void *newval);
DESCRIPTION

These functions enable a compare and swap operation to occur atomically. The value stored in target is compared with cmp. If these values are equal, the value stored in target is replaced with newval. The old value stored in target is returned by the function whether or not the replacement occurred.

RETURN VALUES

These functions return the old value of *target.

ERRORS

No errors are defined.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO

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