当前位置: C语言 -- 标准库 -- <stdatomic.h> -- atomic_fetch_add_explicit

atomic_fetch_add_explicit函数


概要:
#include <stdatomic.h>
C atomic_fetch_add_explicit(volatile A *object, 
      M operand, memory_order order);

描述:

该泛型函数将参数object指向的原子对象值加上参数operand,得到的结果替换参数object指向的原子对象值。该操作是原子的读-修改-写操作。内存会受参数order值影响。当参数order值为memory_order_seq_cst时,atomic_fetch_add_explicit函数与atomic_fetch_add函数具有相同的语义。该函数适用于原子整数类型对象,但不包括atomic_bool类型以及底层类型为bool的枚举类型的原子版本。

对于有符号整数类型,算术运算在整数溢出时执行安静绕回处理(silent wrap-around on overflow);不存在未定义结果。对于地址类型,结果可能是未定义地址,但操作没有未定义行为。

ISO/IEC 9899标准未指定atomic_fetch_add_explicit是宏还是具有外部链接的标识符。如果为访问实际函数而抑制宏定义,或者程序定义了与atomic_fetch_add_explicit同名的外部标识符,其行为是未定义的。


该泛型函数和复合赋值运算符+=几乎等价,区别主要在于:

1、复合赋值运算符+=不能保证是原子操作。复合赋值运算是不是原子操作取决于左操作数,如果左操作数是原子对象,则是原子操作;如果左操作数不是原子对象,则不是原子操作。

2、复合赋值运算符+=产生的值是对象的更新值;但该泛型函数返回值是原子对象的先前值。


参数:
volatile A *object

指向原子类型对象的指针。

M operand

与参数object指向原子对象值相加的操作数。如果参数object指向对象是原子整数类型,参数operand为对应的非原子类型;如果参数object指向对象是原子指针类型,参数operand为ptrdiff_t类型。

memory_order order

枚举常量,显式地指定内存顺序。


返回值:

函数原子地返回函数调用生效前参数object指向的原子对象值。


范例:
1 
2 
3 
4 
5 
6 
7 
8 
9 
10 
11 
12 
13 
14 
15 
16 
17 
18 
19 
20 
21 
22 
23 
24 
25 
26 
27 
28 
29 
30 
31 
32 
33 
34 
35 
36 
37 
38 
39 
40 
41 
42 
43 
44 
45 
46 
47 
48 
49 
50 
51 
52 
53 
54 
55 
56 
57 
/*函数atomic_fetch_add_explicit范例*/

#ifdef __STDC_NO_ATOMICS__
#error "Implementation does not support atomic types."
#endif

#ifdef __STDC_NO_THREADS__
#error "Implementation does not support multi-threads."
#endif

#include <stdatomic.h>
#include <stdio.h>
#include <stdlib.h>
#include <threads.h>

#define THREADS 10

atomic_int aNumber = 0;
atomic_int aValue = 0;
int number = 0;

/*新线程中执行的函数。*/
int func(void *arg)
{
    for(int i=0; i<10000; ++i)
    {
        atomic_fetch_add_explicit(&aNumber, 1, memory_order_relaxed);
        aValue += 1;
        number += 1;
    }
    
    return 0;
}

int main(void)
{
    thrd_t threadId[THREADS];

    for(int i=0; i<THREADS; ++i)
    {
        if(thrd_create((threadId + i), func, NULL) != thrd_success)
        {
            perror("thrd_create error");
            exit(EXIT_FAILURE);
        }
    }

    for(int i=0; i<THREADS; ++i)
        thrd_join(threadId[i], NULL);

    printf("aNumber: %d\n", atomic_load(&aNumber));
    printf("aValue: %d\n", atomic_load(&aValue));
    printf("number: %d\n", number);
    
    return 0;
}


输出:

aNumber: 100000

aValue: 100000

number: 73541

number值应小于或者等于100000,不一定就是73541。


相关内容:
atomic_fetch_add 原子加运算函数。
atomic_fetch_sub_explicit 原子减运算函数。
atomic_fetch_or_explicit 原子按位或运算函数。
atomic_fetch_xor_explicit 原子按位异或运算函数。
atomic_fetch_and_explicit 原子按位与运算函数。


主要参考资料:

1、ISO/IEC 9899:2024

2、ISO/IEC 9899:2018