部分中断上锁模式的自旋锁RAII机制守卫更多...

#include <Spinlock.hxx>

xwos::lock::Spinlock::LkIrqsGrd< TIrqList > 的协作图:

[图例]

Public 成员函数
	LkIrqsGrd (Spinlock *spinlock)
	构造自旋锁的RAII机制守卫

	LkIrqsGrd (Spinlock &spinlock)
	构造自旋锁的RAII机制守卫

	~LkIrqsGrd ()
	析构自旋锁的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 成员函数
	LkIrqsGrd ()

Protected 属性
Spinlock *	mSpinlock

enum LockStatus	mStatus

xwirq_t	mIrqs [sizeof...(TIrqList)]

xwreg_t	mIrqFlags [sizeof...(TIrqList)]

详细描述

template<xwirq_t... TIrqList>
class xwos::lock::Spinlock::LkIrqsGrd< TIrqList >

部分中断上锁模式的自旋锁RAII机制守卫

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

在文件 Spinlock.hxx 第 779 行定义.

构造及析构函数说明

◆ LkIrqsGrd() [1/3]

template<xwirq_t... TIrqList>

xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::LkIrqsGrd ( Spinlock * spinlock )

inline

构造自旋锁的RAII机制守卫

参数

[in] spinlock 自旋锁对象指针

在文件 Spinlock.hxx 第 792 行定义.

            : mSpinlock(spinlock)
            , mStatus(Spinlock::LockStatus::SpinlockUnlocked)
            , mIrqs{ TIrqList... }
        {
            if (nullptr != mSpinlock) {
                xwos_splk_lock_irqssv(&mSpinlock->mLock, mIrqs, mIrqFlags,
                                      sizeof...(TIrqList));
                mStatus = Spinlock::LockStatus::SpinlockLocked;
            }
        }

函数调用图:

◆ LkIrqsGrd() [2/3]

template<xwirq_t... TIrqList>

xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::LkIrqsGrd ( Spinlock & spinlock )

inline

构造自旋锁的RAII机制守卫

参数

[in] spinlock 自旋锁对象引用

在文件 Spinlock.hxx 第 808 行定义.

            : mSpinlock(&spinlock)
            , mStatus(Spinlock::LockStatus::SpinlockUnlocked)
            , mIrqs{ TIrqList... }
        {
            if (nullptr != mSpinlock) {
                xwos_splk_lock_irqssv(&mSpinlock->mLock, mIrqs, mIrqFlags,
                                      sizeof...(TIrqList));
                mStatus = Spinlock::LockStatus::SpinlockLocked;
            }
        }

函数调用图:

◆ ~LkIrqsGrd()

template<xwirq_t... TIrqList>

xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::~LkIrqsGrd ( )

inline

析构自旋锁的RAII机制守卫

在文件 Spinlock.hxx 第 823 行定义.

        {
            if (nullptr != mSpinlock) {
                if (Spinlock::LockStatus::SpinlockLocked == mStatus) {
                    mStatus = Spinlock::LockStatus::SpinlockUnlocked;
                    xwos_splk_unlock_irqsrs(&mSpinlock->mLock, mIrqs, mIrqFlags,
                                            sizeof...(TIrqList));
                }
            }
        }

函数调用图:

◆ LkIrqsGrd() [3/3]

template<xwirq_t... TIrqList>

xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::LkIrqsGrd ( )

inlineprotected

在文件 Spinlock.hxx 第 972 行定义.

            : mSpinlock(nullptr)
            , mStatus(SpinlockUnlocked)
        {
        }

成员函数说明

◆ unlock()

template<xwirq_t... TIrqList>

void xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::unlock ( )

inline

解锁自旋锁

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

在文件 Spinlock.hxx 第 839 行定义.

        {
            if (nullptr != mSpinlock) {
                if (Spinlock::LockStatus::SpinlockLocked == mStatus) {
                    mStatus = Spinlock::LockStatus::SpinlockUnlocked;
                    xwos_splk_unlock_irqsrs(&mSpinlock->mLock, mIrqs, mIrqFlags,
                                            sizeof...(TIrqList));
                }
            }
        }

函数调用图:

◆ getStatus()

template<xwirq_t... TIrqList>

enum LockStatus xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::getStatus ( )

inline

获取锁状态

在文件 Spinlock.hxx 第 853 行定义.

853{ return mStatus; }

◆ wait() [1/4]

template<xwirq_t... TIrqList>

xwer_t xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::wait ( sync::Cond * cond )

inline

等待条件量

参数

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

返回: 错误码

返回值

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

注解

上下文：线程

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

在文件 Spinlock.hxx 第 876 行定义.

        {
            xwer_t rc;
            if (nullptr != mSpinlock) {
                if (Spinlock::LockStatus::SpinlockLocked == mStatus) {
                    union xwos_ulock lock;
                    xwsq_t lkst;
                    lock.osal.splk = &mSpinlock->mLock;
                    rc = xwos_cond_wait(cond->getXwosObj(), lock, XWOS_LK_SPLK, nullptr,
                                        &lkst);
                    if (rc < 0) {
                        if (XWOS_LKST_UNLOCKED == lkst) {
                            xwos_splk_lock(&mSpinlock->mLock);
                        }
                    }
                } else {
                    rc = -ENOLCK;
                }
            } else {
                rc = -EFAULT;
            }
            return rc;
        }

函数调用图:

◆ wait() [2/4]

template<xwirq_t... TIrqList>

xwer_t xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::wait ( sync::Cond & cond )

inline

等待条件量

参数

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

返回: 错误码

注解

上下文：线程

同 wait(sync::Cond * cond) 。

在文件 Spinlock.hxx 第 909 行定义.

909{ return wait(&cond); }

xwos::lock::Spinlock::LkIrqsGrd::wait

xwer_t wait(sync::Cond *cond)

等待条件量

Definition Spinlock.hxx:876

函数调用图:

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

◆ wait() [3/4]

template<xwirq_t... TIrqList>

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

inline

限时等待条件量

参数

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

返回: 错误码

返回值

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

注解

上下文：线程

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

在文件 Spinlock.hxx 第 935 行定义.

        {
            xwer_t rc;
            if (nullptr != mSpinlock) {
                if (Spinlock::LockStatus::SpinlockLocked == mStatus) {
                    union xwos_ulock lock;
                    xwsq_t lkst;
                    lock.osal.splk = &mSpinlock->mLock;
                    rc = xwos_cond_wait_to(cond->getXwosObj(), lock, XWOS_LK_SPLK,
                                           nullptr, to, &lkst);
                    if (rc < 0) {
                        if (XWOS_LKST_UNLOCKED == lkst) {
                            xwos_splk_lock(&mSpinlock->mLock);
                        }
                    }
                } else {
                    rc = -ENOLCK;
                }
            } else {
                rc = -EFAULT;
            }
            return rc;
        }

函数调用图:

◆ wait() [4/4]

template<xwirq_t... TIrqList>

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

inline

限时等待条件量

参数

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

返回: 错误码

注解

上下文：线程

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

在文件 Spinlock.hxx 第 969 行定义.

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

函数调用图:

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

结构体成员变量说明

◆ mSpinlock

template<xwirq_t... TIrqList>

Spinlock* xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::mSpinlock

protected

在文件 Spinlock.hxx 第 782 行定义.

◆ mStatus

template<xwirq_t... TIrqList>

enum LockStatus xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::mStatus

protected

在文件 Spinlock.hxx 第 783 行定义.

◆ mIrqs

template<xwirq_t... TIrqList>

xwirq_t xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::mIrqs[sizeof...(TIrqList)]

protected

在文件 Spinlock.hxx 第 784 行定义.

◆ mIrqFlags

template<xwirq_t... TIrqList>

xwreg_t xwos::lock::Spinlock::LkIrqsGrd< TIrqList >::mIrqFlags[sizeof...(TIrqList)]

protected

在文件 Spinlock.hxx 第 785 行定义.

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

xwos/cxx/lock/Spinlock.hxx

Public 成员函数

Protected 成员函数

Protected 属性

详细描述

构造及析构函数说明

◆ LkIrqsGrd() [1/3]

◆ LkIrqsGrd() [2/3]

◆ ~LkIrqsGrd()

◆ LkIrqsGrd() [3/3]

成员函数说明

◆ unlock()

◆ getStatus()

◆ wait() [1/4]

◆ wait() [2/4]

◆ wait() [3/4]

◆ wait() [4/4]

结构体成员变量说明

◆ mSpinlock

◆ mStatus

◆ mIrqs

◆ mIrqFlags