目录

shared_mutex.h

概述

声明读写锁(rwlock)的C接口。

引用文件: <ffrt/shared_mutex.h>

库: libffrt.z.so

系统能力: SystemCapability.Resourceschedule.Ffrt.Core

起始版本: 18

相关模块: FFRT

汇总

[h2]函数

名称 描述
FFRT_C_API int ffrt_rwlock_init(ffrt_rwlock_t* rwlock, const ffrt_rwlockattr_t* attr) 初始化rwlock。该rwlock不再使用时,必须通过ffrt_rwlock_destroy销毁。
FFRT_C_API int ffrt_rwlock_wrlock(ffrt_rwlock_t* rwlock) 加写锁。锁不可用时阻塞当前线程。成功时,调用线程持有排他写锁,直至通过ffrt_rwlock_unlock释放。写锁具有排他性,不允许与任何读锁同时持有。
FFRT_C_API int ffrt_rwlock_trywrlock(ffrt_rwlock_t* rwlock) 尝试加写锁。不会阻塞当前线程。成功时,调用线程持有排他写锁,直至通过ffrt_rwlock_unlock释放。
FFRT_C_API int ffrt_rwlock_rdlock(ffrt_rwlock_t* rwlock) 加读锁。锁不可用时阻塞当前线程。成功时,调用线程持有读锁,直至通过ffrt_rwlock_unlock释放。多个读者可同时持有该锁,但不允许与写锁同时持有。
FFRT_C_API int ffrt_rwlock_tryrdlock(ffrt_rwlock_t* rwlock) 尝试加读锁。不会阻塞当前线程。成功时,调用线程持有读锁,直至通过ffrt_rwlock_unlock释放。
FFRT_C_API int ffrt_rwlock_unlock(ffrt_rwlock_t* rwlock) 解锁rwlock。调用线程必须已持有该rwlock,且该锁之前由ffrt_rwlock_rdlock、ffrt_rwlock_tryrdlock、ffrt_rwlock_wrlock或ffrt_rwlock_trywrlock获取。
FFRT_C_API int ffrt_rwlock_destroy(ffrt_rwlock_t* rwlock) 销毁rwlock。该rwlock必须已通过ffrt_rwlock_init初始化,且在调用本接口时不得被任何线程以读锁或写锁持有。

函数说明

[h2]ffrt_rwlock_init()

FFRT_C_API int ffrt_rwlock_init(ffrt_rwlock_t* rwlock, const ffrt_rwlockattr_t* attr)

描述

初始化rwlock。该rwlock不再使用时,必须通过ffrt_rwlock_destroy销毁。

起始版本: 18

参数:

参数项 描述
ffrt_rwlock_t* rwlock 指向rwlock的指针。
const ffrt_rwlockattr_t* attr 指向rwlock属性的指针。当前仅支持默认模式,需设置为空指针。

返回:

类型 说明
FFRT_C_API int

rwlock初始化成功且attr为空指针时返回ffrt_success;

否则返回ffrt_error_inval。

[h2]ffrt_rwlock_wrlock()

FFRT_C_API int ffrt_rwlock_wrlock(ffrt_rwlock_t* rwlock)

描述

加写锁。锁不可用时阻塞当前线程。成功时,调用线程持有排他写锁,直至通过ffrt_rwlock_unlock释放。写锁具有排他性,不允许与任何读锁同时持有。

起始版本: 18

参数:

参数项 描述
ffrt_rwlock_t* rwlock 指向rwlock的指针。

返回:

类型 说明
FFRT_C_API int

rwlock加锁成功时返回ffrt_success;

rwlock为空指针时返回ffrt_error_inval。

参考:

ffrt_rwlock_rdlock

ffrt_rwlock_trywrlock

[h2]ffrt_rwlock_trywrlock()

FFRT_C_API int ffrt_rwlock_trywrlock(ffrt_rwlock_t* rwlock)

描述

尝试加写锁。不会阻塞当前线程。成功时,调用线程持有排他写锁,直至通过ffrt_rwlock_unlock释放。

起始版本: 18

参数:

参数项 描述
ffrt_rwlock_t* rwlock 指向rwlock的指针。

返回:

类型 说明
FFRT_C_API int

rwlock加锁成功时返回ffrt_success;

否则返回ffrt_error_inval或ffrt_error_busy。

参考:

ffrt_rwlock_wrlock

[h2]ffrt_rwlock_rdlock()

FFRT_C_API int ffrt_rwlock_rdlock(ffrt_rwlock_t* rwlock)

描述

加读锁。锁不可用时阻塞当前线程。成功时,调用线程持有读锁,直至通过ffrt_rwlock_unlock释放。多个读者可同时持有该锁,但不允许与写锁同时持有。

起始版本: 18

参数:

参数项 描述
ffrt_rwlock_t* rwlock 指向rwlock的指针。

返回:

类型 说明
FFRT_C_API int

rwlock加锁成功时返回ffrt_success;

rwlock为空指针时返回ffrt_error_inval。

参考:

ffrt_rwlock_wrlock

ffrt_rwlock_tryrdlock

[h2]ffrt_rwlock_tryrdlock()

FFRT_C_API int ffrt_rwlock_tryrdlock(ffrt_rwlock_t* rwlock)

描述

尝试加读锁。不会阻塞当前线程。成功时,调用线程持有读锁,直至通过ffrt_rwlock_unlock释放。

起始版本: 18

参数:

参数项 描述
ffrt_rwlock_t* rwlock 指向rwlock的指针。

返回:

类型 说明
FFRT_C_API int

rwlock加锁成功时返回ffrt_success;

否则返回ffrt_error_inval或ffrt_error_busy。

参考:

ffrt_rwlock_rdlock

[h2]ffrt_rwlock_unlock()

FFRT_C_API int ffrt_rwlock_unlock(ffrt_rwlock_t* rwlock)

描述

解锁rwlock。调用线程必须已持有该rwlock,且该锁之前由ffrt_rwlock_rdlock、ffrt_rwlock_tryrdlock、ffrt_rwlock_wrlock或ffrt_rwlock_trywrlock获取。

起始版本: 18

参数:

参数项 描述
ffrt_rwlock_t* rwlock 指向rwlock的指针。

返回:

类型 说明
FFRT_C_API int

rwlock解锁成功时返回ffrt_success;

否则返回ffrt_error_inval。

[h2]ffrt_rwlock_destroy()

FFRT_C_API int ffrt_rwlock_destroy(ffrt_rwlock_t* rwlock)

描述

销毁rwlock。该rwlock必须已通过ffrt_rwlock_init初始化,且在调用本接口时不得被任何线程以读锁或写锁持有。

起始版本: 18

参数:

参数项 描述
ffrt_rwlock_t* rwlock 指向rwlock的指针。

返回:

类型 说明
FFRT_C_API int

rwlock销毁成功时返回ffrt_success;

否则返回ffrt_error_inval。