asc_atomic_dec

产品支持情况

Ascend 950PR/Ascend 950DT：支持

Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持

Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持

Atlas 200I/500 A2 推理产品：不支持

Atlas 推理系列产品AI Core：不支持
Atlas 推理系列产品Vector Core：不支持

Atlas 训练系列产品：不支持

功能说明

对Unified Buffer（UB）或Global Memory上address的数值进行原子减1操作，如果address上的数值等于0或大于指定数值val，则对address赋值为val，否则将address上数值减1。

函数原型

inline uint32_t asc_atomic_dec(uint32_t *address, uint32_t val)

inline uint64_t asc_atomic_dec(uint64_t *address, uint64_t val)

参数说明

表1 参数说明

参数名	输入/输出	描述
address	输出	UB或Global Memory的地址。
val	输入	源操作数。

不同数据类型支持的内存范围说明如下：

表2 不同数据类型支持的内存范围

参数数据类型	支持的内存空间
uint32_t	UB、Global Memory
uint64_t	Global Memory

返回值说明

UB或Global Memory上的初始数据。

约束说明

原子操作保证对同一地址的读改写过程具有原子性，但不保证多个线程之间的执行顺序。对于依赖返回值分配序号或槽位的场景，返回值对应的序号唯一，但分配给具体线程的顺序可能随线程调度变化而不同。
本接口的性能受以下因素影响，相关原理请参见原子操作机制。
- 内存空间：UB的访问路径比Global Memory短，通常具有更低的访问开销。当使用的数据类型支持UB（即uint32_t）时，建议优先在UB中完成原子操作。
- 返回值：该接口无对应的性能优化指令，对于所有数据类型，程序中是否使用该接口返回值，接口性能基本一致。
- 地址分布：Global Memory原子操作经过L2 Cache处理，L2 Cache以512B Cache Line为缓存管理单位，每条Cache Line包含4个128B扇区（Sector），Global Memory原子操作以128B Sector为处理粒度。目标地址集中在同一个Sector内时，处理效率较低；目标地址分布在更多Sector内时，处理效率较高。因此，业务允许时，建议将原子操作的目标地址分散到更多Sector中。

需要包含的头文件

使用该接口需要包含"simt_api/device_atomic_functions.h"头文件。

#include "simt_api/device_atomic_functions.h"

调用示例

示例场景为：多个线程从高到低循环分配槽位，使用asc_atomic_dec接口获取更新前的旧计数。当旧值为0时，计数器会回绕到指定上界capacity - 1。输入参数说明如下：

名称	说明
`ticket`	Global Memory中的反向环形计数器，kernel启动前初始化。
`slots`	保存每个线程获得的槽位编号。
`capacity`	环形队列容量。
`n`	需要分配槽位的线程数。

核心代码实现如下：

SIMT编程场景：

__global__ __launch_bounds__(256) void allocate_reverse_ring_slot(uint32_t *ticket,
                                                                uint32_t *slots,
                                                                uint32_t capacity,
                                                                uint32_t n)
{
    uint32_t idx = blockIdx.x * blockDim.x + threadIdx.x;
    if (idx >= n) {
        return;
    }

    uint32_t old_ticket = asc_atomic_dec(ticket, capacity - 1U);
    slots[idx] = old_ticket;
}

SIMD与SIMT混合编程场景：

SIMD与SIMT混合编程场景，需要显式使用地址空间限定符表示地址空间：__gm__表示Global Memory内存空间，__ubuf__表示UB内存空间。

__simt_vf__ __launch_bounds__(1024) inline void allocate_reverse_ring_slot(__gm__ uint32_t *ticket,
                                                                         __gm__ uint32_t *slots,
                                                                         uint32_t capacity,
                                                                         uint32_t n)
{
    uint32_t idx = blockIdx.x * blockDim.x + threadIdx.x;
    if (idx >= n) {
        return;
    }

    uint32_t old_ticket = asc_atomic_dec(ticket, capacity - 1U);
    slots[idx] = old_ticket;
}

输出结果示例如下：

ticket before: 0
capacity: 4
n: 6
slots: 0, 3, 2, 1, 0, 3 // 顺序由实际原子执行顺序决定
ticket after: 2