独占写部分中断上锁模式的顺序锁RAII机制守卫更多...

#include <Seqlock.hxx>

xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList > 的协作图:

[图例]

Public 成员函数
	WrLkIrqsGrd (Seqlock *seqlock)
	构造顺序锁的RAII机制守卫

	WrLkIrqsGrd (Seqlock &seqlock)
	构造顺序锁的RAII机制守卫

	~WrLkIrqsGrd ()
	析构顺序锁的RAII机制守卫

void	unlock ()
	解锁顺序锁

enum LockStatus	getStatus ()
	获取锁状态

xwer_t	wait (sync::Cond *cond)
	等待条件量

xwer_t	wait (sync::Cond &cond)
	等待条件量

xwer_t	wait (sync::Cond *cond, xwtm_t to)
	限时等待条件量

xwer_t	wait (sync::Cond &cond, xwtm_t to)
	限时等待条件量

Protected 成员函数
	WrLkIrqsGrd ()

Protected 属性
Seqlock *	mSeqlock

enum LockStatus	mStatus

xwirq_t	mIrqs [sizeof...(TIrqList)]

xwreg_t	mIrqFlags [sizeof...(TIrqList)]

详细描述

template<xwirq_t... TIrqList>
class xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >

独占写部分中断上锁模式的顺序锁RAII机制守卫

构造函数关闭并保存 TIrqList 列表内的中断，关闭当前CPU调度器的抢占，上锁顺序锁。上锁失败会自旋等待，直到上锁成功为止。
析构函数解锁顺序锁，开启当前CPU调度器的抢占，用保存的中断标志恢复 TIrqList 列表内的中断。
注解
上下文：线程、TIrqList 列表中的中断

在文件 Seqlock.hxx 第 1807 行定义.

构造及析构函数说明

◆ WrLkIrqsGrd() [1/3]

template<xwirq_t... TIrqList>

xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::WrLkIrqsGrd ( Seqlock * seqlock )

inline

构造顺序锁的RAII机制守卫

参数

[in] seqlock 顺序锁对象指针

在文件 Seqlock.hxx 第 1820 行定义.

            : mSeqlock(seqlock)
            , mStatus(Seqlock::LockStatus::SeqlockUnlocked)
            , mIrqs{ TIrqList... }
        {
            if (nullptr != mSeqlock) {
                xwos_sqlk_wr_lock_irqssv(&mSeqlock->mLock, mIrqs, mIrqFlags,
                                         sizeof...(TIrqList));
                mStatus = Seqlock::LockStatus::SeqlockWrLocked;
            }
        }

函数调用图:

◆ WrLkIrqsGrd() [2/3]

template<xwirq_t... TIrqList>

xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::WrLkIrqsGrd ( Seqlock & seqlock )

inline

构造顺序锁的RAII机制守卫

参数

[in] seqlock 顺序锁对象引用

在文件 Seqlock.hxx 第 1836 行定义.

            : mSeqlock(&seqlock)
            , mStatus(Seqlock::LockStatus::SeqlockUnlocked)
            , mIrqs{ TIrqList... }
        {
            if (nullptr != mSeqlock) {
                xwos_sqlk_wr_lock_irqssv(&mSeqlock->mLock, mIrqs, mIrqFlags,
                                         sizeof...(TIrqList));
                mStatus = Seqlock::LockStatus::SeqlockWrLocked;
            }
        }

函数调用图:

◆ ~WrLkIrqsGrd()

template<xwirq_t... TIrqList>

xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::~WrLkIrqsGrd ( )

inline

析构顺序锁的RAII机制守卫

在文件 Seqlock.hxx 第 1851 行定义.

        {
            if (nullptr != mSeqlock) {
                if (Seqlock::LockStatus::SeqlockWrLocked == mStatus) {
                    mStatus = Seqlock::LockStatus::SeqlockUnlocked;
                    xwos_sqlk_wr_unlock_irqsrs(&mSeqlock->mLock, mIrqs, mIrqFlags,
                                               sizeof...(TIrqList));
                }
            }
        }

函数调用图:

◆ WrLkIrqsGrd() [3/3]

template<xwirq_t... TIrqList>

xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::WrLkIrqsGrd ( )

inlineprotected

在文件 Seqlock.hxx 第 2002 行定义.

            : mSeqlock(nullptr)
            , mStatus(SeqlockUnlocked)
        {
        }

成员函数说明

◆ unlock()

template<xwirq_t... TIrqList>

void xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::unlock ( )

inline

解锁顺序锁

主动解锁后，析构函数将不再解锁。

在文件 Seqlock.hxx 第 1867 行定义.

        {
            if (nullptr != mSeqlock) {
                if (Seqlock::LockStatus::SeqlockWrLocked == mStatus) {
                    mStatus = Seqlock::LockStatus::SeqlockUnlocked;
                    xwos_sqlk_wr_unlock_irqsrs(&mSeqlock->mLock, mIrqs, mIrqFlags,
                                               sizeof...(TIrqList));
                }
            }
        }

函数调用图:

◆ getStatus()

template<xwirq_t... TIrqList>

enum LockStatus xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::getStatus ( )

inline

获取锁状态

在文件 Seqlock.hxx 第 1881 行定义.

1881{ return mStatus; }

◆ wait() [1/4]

template<xwirq_t... TIrqList>

xwer_t xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::wait ( sync::Cond * cond )

inline

等待条件量

参数

[in] cond 条件量对象的指针

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-EINVAL	参数无效
-ENOTTHDCTX	不在线程上下文中
-ENOLCK	未上锁
-EINTR	等待被中断

注解

上下文：线程

调用此C++API的线程会阻塞等待条件量，等待的同时会解锁顺序锁。
条件量被单播 sync::Cond::unicast() 或广播 sync::Cond::broadcast() 时，会唤醒正在等待的线程。
线程被唤醒后，会重新用之前的上锁方式上锁顺序锁。
重新上锁成功后将返回 XWOK 。
线程的等待被中断后，此C++API返回 -EINTR 。
如果此C++API返回非 XWOK 的错误码后，应该使用 getStatus() 确认是否上锁成功。

在文件 Seqlock.hxx 第 1905 行定义.

        {
            xwer_t rc;
            if (nullptr != mSeqlock) {
                if (Seqlock::LockStatus::SeqlockWrLocked == mStatus) {
                    union xwos_ulock lock;
                    xwsq_t lkst;
                    lock.osal.sqlk = &mSeqlock->mLock;
                    rc = xwos_cond_wait(cond->getXwosObj(), lock, XWOS_LK_SQLK_WR,
                                        nullptr, &lkst);
                    if (rc < 0) {
                        if (XWOS_LKST_UNLOCKED == lkst) {
                            xwos_sqlk_wr_lock(&mSeqlock->mLock);
                        }
                    }
                } else {
                    rc = -ENOLCK;
                }
            } else {
                rc = -EFAULT;
            }
            return rc;
        }

函数调用图:

◆ wait() [2/4]

template<xwirq_t... TIrqList>

xwer_t xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::wait ( sync::Cond & cond )

inline

等待条件量

参数

[in] cond 条件量对象的引用

返回: 错误码

注解

上下文：线程

同 wait(sync::Cond * cond) 。

在文件 Seqlock.hxx 第 1938 行定义.

1938{ return wait(&cond); }

xwos::lock::Seqlock::WrLkIrqsGrd::wait

xwer_t wait(sync::Cond *cond)

等待条件量

Definition Seqlock.hxx:1905

函数调用图:

这是这个函数的调用关系图:

◆ wait() [3/4]

template<xwirq_t... TIrqList>

xwer_t xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::wait	(	sync::Cond *	cond,
		xwtm_t	to
	)

inline

限时等待条件量

参数

[in]	cond	条件量对象的指针
[in]	to	期望唤醒的时间点

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效的指针或空指针
-EINVAL	参数无效
-ENOTTHDCTX	不在线程上下文中
-ENOLCK	未上锁
-EINTR	等待被中断
-ETIMEDOUT	超时

注解

上下文：线程

调用此C++API的线程会限时阻塞等待条件量，等待的同时会解锁顺序锁。
条件量被单播 sync::Cond::unicast() 或广播 sync::Cond::broadcast() 时，会唤醒正在等待的线程。
线程被唤醒后，会重新用之前的上锁方式上锁顺序锁。
重新上锁成功后将返回 XWOK 。
线程的等待被中断后，此C++API返回 -EINTR 。
线程的等待超时后，此C++API返回 -ETIMEDOUT 。
如果此C++API返回非 XWOK 的错误码，应该使用 getStatus() 确认是否上锁成功。

在文件 Seqlock.hxx 第 1965 行定义.

        {
            xwer_t rc;
            if (nullptr != mSeqlock) {
                if (Seqlock::LockStatus::SeqlockWrLocked == mStatus) {
                    union xwos_ulock lock;
                    xwsq_t lkst;
                    lock.osal.sqlk = &mSeqlock->mLock;
                    rc = xwos_cond_wait_to(cond->getXwosObj(), lock, XWOS_LK_SQLK_WR,
                                           nullptr, to, &lkst);
                    if (rc < 0) {
                        if (XWOS_LKST_UNLOCKED == lkst) {
                            xwos_sqlk_wr_lock(&mSeqlock->mLock);
                        }
                    }
                } else {
                    rc = -ENOLCK;
                }
            } else {
                rc = -EFAULT;
            }
            return rc;
        }

函数调用图:

◆ wait() [4/4]

template<xwirq_t... TIrqList>

xwer_t xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::wait	(	sync::Cond &	cond,
		xwtm_t	to
	)

inline

限时等待条件量

参数

[in]	cond	条件量对象的引用
[in]	to	期望唤醒的时间点

返回: 错误码

注解

上下文：线程

同 wait(sync::Cond * cond, xwtm_t to) 。

在文件 Seqlock.hxx 第 1999 行定义.

1999{ return wait(&cond, to); }

函数调用图:

这是这个函数的调用关系图:

结构体成员变量说明

◆ mSeqlock

template<xwirq_t... TIrqList>

Seqlock* xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::mSeqlock

protected

在文件 Seqlock.hxx 第 1810 行定义.

◆ mStatus

template<xwirq_t... TIrqList>

enum LockStatus xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::mStatus

protected

在文件 Seqlock.hxx 第 1811 行定义.

◆ mIrqs

template<xwirq_t... TIrqList>

xwirq_t xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::mIrqs[sizeof...(TIrqList)]

protected

在文件 Seqlock.hxx 第 1812 行定义.

◆ mIrqFlags

template<xwirq_t... TIrqList>

xwreg_t xwos::lock::Seqlock::WrLkIrqsGrd< TIrqList >::mIrqFlags[sizeof...(TIrqList)]

protected

在文件 Seqlock.hxx 第 1813 行定义.

该类的文档由以下文件生成:

xwos/cxx/lock/Seqlock.hxx

Public 成员函数

Protected 成员函数

Protected 属性

详细描述

构造及析构函数说明

◆ WrLkIrqsGrd() [1/3]

◆ WrLkIrqsGrd() [2/3]

◆ ~WrLkIrqsGrd()

◆ WrLkIrqsGrd() [3/3]

成员函数说明

◆ unlock()

◆ getStatus()

◆ wait() [1/4]

◆ wait() [2/4]

◆ wait() [3/4]

◆ wait() [4/4]

结构体成员变量说明

◆ mSeqlock

◆ mStatus

◆ mIrqs

◆ mIrqFlags