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

#include <Seqlock.hxx>

类 xwos::lock::Seqlock::WrLkThGrd 继承关系图:

xwos::lock::Seqlock::WrLkThGrd 的协作图:

[图例]

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

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

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

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 成员函数
	WrLkThGrd ()

Protected 属性
Seqlock *	mSeqlock

enum LockStatus	mStatus

xwreg_t	mCpuirq

详细描述

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

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

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

构造及析构函数说明

◆ WrLkThGrd() [1/3]

xwos::lock::Seqlock::WrLkThGrd::WrLkThGrd ( Seqlock * seqlock )

构造顺序锁的RAII机制守卫

参数

[in] seqlock 顺序锁对象指针

在文件 Seqlock.cxx 第 557 行定义.

    : mSeqlock(seqlock)
    , mStatus(Seqlock::LockStatus::SeqlockUnlocked)
{
    if (nullptr != mSeqlock) {
        xwos_sqlk_wr_lock_cpuirqsv(&mSeqlock->mLock, &mCpuirq);
        mStatus = Seqlock::LockStatus::SeqlockWrLocked;
    }
}

函数调用图:

◆ WrLkThGrd() [2/3]

xwos::lock::Seqlock::WrLkThGrd::WrLkThGrd ( Seqlock & seqlock )

构造顺序锁的RAII机制守卫

参数

[in] seqlock 顺序锁对象引用

在文件 Seqlock.cxx 第 567 行定义.

    : mSeqlock(&seqlock)
    , mStatus(Seqlock::LockStatus::SeqlockUnlocked)
{
    if (nullptr != mSeqlock) {
        xwos_sqlk_wr_lock_cpuirqsv(&mSeqlock->mLock, &mCpuirq);
        mStatus = Seqlock::LockStatus::SeqlockWrLocked;
    }
}

函数调用图:

◆ ~WrLkThGrd()

xwos::lock::Seqlock::WrLkThGrd::~WrLkThGrd ( )

析构顺序锁的RAII机制守卫

在文件 Seqlock.cxx 第 577 行定义.

{
    if (nullptr != mSeqlock) {
        if (Seqlock::LockStatus::SeqlockWrLocked == mStatus) {
            mStatus = Seqlock::LockStatus::SeqlockUnlocked;
            xwos_sqlk_wr_unlock_cpuirqrs(&mSeqlock->mLock, mCpuirq);
        }
    }
}

函数调用图:

◆ WrLkThGrd() [3/3]

xwos::lock::Seqlock::WrLkThGrd::WrLkThGrd ( )

inlineprotected

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

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

成员函数说明

◆ getStatus()

enum LockStatus xwos::lock::Seqlock::WrLkThGrd::getStatus ( )

inline

获取锁状态

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

1308{ return mStatus; }

◆ wait() [1/4]

xwer_t xwos::lock::Seqlock::WrLkThGrd::wait ( sync::Cond & cond )

inline

等待条件量

参数

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

返回: 错误码

注解

上下文：线程

同 wait(sync::Cond * cond) 。

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

1342{ return wait(&cond); }

xwos::lock::Seqlock::WrLkThGrd::wait

xwer_t wait(sync::Cond *cond)

等待条件量

Definition Seqlock.cxx:587

函数调用图:

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

◆ wait() [2/4]

xwer_t xwos::lock::Seqlock::WrLkThGrd::wait	(	sync::Cond &	cond,
		xwtm_t	to
	)

inline

限时等待条件量

参数

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

返回: 错误码

注解

上下文：线程

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

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

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

函数调用图:

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

◆ wait() [3/4]

xwer_t xwos::lock::Seqlock::WrLkThGrd::wait ( sync::Cond * cond )

等待条件量

参数

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

返回: 错误码

返回值

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

注解

上下文：线程

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

在文件 Seqlock.cxx 第 587 行定义.

{
    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() [4/4]

xwer_t xwos::lock::Seqlock::WrLkThGrd::wait	(	sync::Cond *	cond,
		xwtm_t	to
	)

限时等待条件量

参数

[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() 确认是否上锁成功。

在文件 Seqlock.cxx 第 611 行定义.

{
    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;
}

函数调用图:

结构体成员变量说明

◆ mCpuirq

xwreg_t xwos::lock::Seqlock::WrLkThGrd::mCpuirq

protected

保存当前CPU的中断标志

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

◆ mSeqlock

Seqlock* xwos::lock::Seqlock::WrLkThGrd::mSeqlock

protected

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

◆ mStatus

enum LockStatus xwos::lock::Seqlock::WrLkThGrd::mStatus

protected

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

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

xwos/cxx/lock/Seqlock.hxx
xwos/cxx/lock/Seqlock.cxx

Public 成员函数

Protected 成员函数

Protected 属性

详细描述

构造及析构函数说明

◆ WrLkThGrd() [1/3]

◆ WrLkThGrd() [2/3]

◆ ~WrLkThGrd()

◆ WrLkThGrd() [3/3]

成员函数说明

◆ getStatus()

◆ wait() [1/4]

◆ wait() [2/4]

◆ wait() [3/4]

◆ wait() [4/4]

结构体成员变量说明

◆ mCpuirq

◆ mSeqlock

◆ mStatus