xref: /illumos-gate/usr/src/man/man9f/atomic_inc.9f (revision d48be21240dfd051b689384ce2b23479d757f2d8)
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_INC 9F "February 17, 2023"
NAME
atomic_inc, atomic_inc_8, atomic_inc_uchar, atomic_inc_16, atomic_inc_ushort, atomic_inc_32, atomic_inc_uint, atomic_inc_ulong, atomic_inc_64, atomic_inc_ptr, atomic_inc_8_nv, atomic_inc_uchar_nv, atomic_inc_16_nv, atomic_inc_ushort_nv, atomic_inc_32_nv, atomic_inc_uint_nv, atomic_inc_ulong_nv, atomic_inc_64_nv, atomic_inc_ptr_nv - atomic increment operations
SYNOPSIS
#include <sys/atomic.h>

void atomic_inc_8(volatile uint8_t *target);

void atomic_inc_uchar(volatile uchar_t *target);

void atomic_inc_16(volatile uint16_t *target);

void atomic_inc_ushort(volatile ushort_t *target);

void atomic_inc_32(volatile uint32_t *target);

void atomic_inc_uint(volatile uint_t *target);

void atomic_inc_ulong(volatile ulong_t *target);

void atomic_inc_64(volatile uint64_t *target);

void atomic_inc_ptr(volatile void *target);

uint8_t atomic_inc_8_nv(volatile uint8_t *target);

uchar_t atomic_inc_uchar_nv(volatile uchar_t *target);

uint16_t atomic_inc_16_nv(volatile uint16_t *target);

ushort_t atomic_inc_ushort_nv(volatile ushort_t *target);

uint32_t atomic_inc_32_nv(volatile uint32_t *target);

uint_t atomic_inc_uint_nv(volatile uint_t *target);

ulong_t atomic_inc_ulong_nv(volatile ulong_t *target);

uint64_t atomic_inc_64_nv(volatile uint64_t *target);

void *atomic_inc_ptr_nv(volatile void *target);
DESCRIPTION
These functions enable the incrementing (by one) of the value stored in target to occur in an atomic manner.
RETURN VALUES
The *_nv() variants of these functions return the new value of target.
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_bits (9F), atomic_cas (9F), atomic_dec (9F), atomic_or (9F), atomic_swap (9F), membar_ops (9F)
NOTES
The *_nv() variants are substantially more expensive on some platforms than the versions that do not return values. Do not use them unless you need to know the new value atomically.