xwos::lock::Spinlock::LkGrd类 参考

普通上锁模式下的自旋锁RAII机制守卫 更多...

#include <Spinlock.hxx>

类 xwos::lock::Spinlock::LkGrd 继承关系图:

xwos::lock::Spinlock::LkGrd 的协作图:

Public 成员函数
	LkGrd (Spinlock *spinlock)
	构造自旋锁的RAII机制守卫
	LkGrd (Spinlock &spinlock)
	构造自旋锁的RAII机制守卫
	~LkGrd ()
	析构自旋锁的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 成员函数
	LkGrd ()

Protected 属性
Spinlock *	mSpinlock
enum LockStatus	mStatus

详细描述

普通上锁模式下的自旋锁RAII机制守卫

• 构造函数关闭当前CPU调度器的抢占，然后上锁自旋锁。
• 上锁失败会自旋等待，直到上锁成功为止。
• 析构函数解锁自旋锁，开启当前CPU调度器的抢占。

  注解

• 上下文：线程

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

构造及析构函数说明

LkGrd() [1/3]

xwos::lock::Spinlock::LkGrd::LkGrd

(

Spinlock *

spinlock

)

构造自旋锁的RAII机制守卫

参数

[in]

spinlock

自旋锁对象指针

在文件 Spinlock.cxx 第 19 行定义.

    : mSpinlock(spinlock)
    , mStatus(Spinlock::LockStatus::SpinlockUnlocked)
{
    if (nullptr != mSpinlock) {
        xwos_splk_lock(&mSpinlock->mLock);
        mStatus = Spinlock::LockStatus::SpinlockLocked;
    }
}

函数调用图:

LkGrd() [2/3]

xwos::lock::Spinlock::LkGrd::LkGrd

(

Spinlock &

spinlock

)

构造自旋锁的RAII机制守卫

参数

[in]

spinlock

自旋锁对象引用

在文件 Spinlock.cxx 第 29 行定义.

    : mSpinlock(&spinlock)
    , mStatus(Spinlock::LockStatus::SpinlockUnlocked)
{
    if (nullptr != mSpinlock) {
        xwos_splk_lock(&mSpinlock->mLock);
        mStatus = Spinlock::LockStatus::SpinlockLocked;
    }
}

函数调用图:

~LkGrd()

xwos::lock::Spinlock::LkGrd::~LkGrd

(

)

析构自旋锁的RAII机制守卫

在文件 Spinlock.cxx 第 39 行定义.

{
    if (nullptr != mSpinlock) {
        if (Spinlock::LockStatus::SpinlockLocked == mStatus) {
            mStatus = Spinlock::LockStatus::SpinlockUnlocked;
            xwos_splk_unlock(&mSpinlock->mLock);
        }
    }
}

函数调用图:

LkGrd() [3/3]

xwos::lock::Spinlock::LkGrd::LkGrd ( )

inlineprotected

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

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

成员函数说明

getStatus()

enum LockStatus xwos::lock::Spinlock::LkGrd::getStatus ( )

inline

获取锁状态

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

{ return mStatus; }

wait() [1/4]

xwer_t xwos::lock::Spinlock::LkGrd::wait ( sync::Cond &  cond )

inline

等待条件量

参数

[in]

cond

条件量对象的引用

返回

错误码

注解

• 上下文：线程

• 同 wait(sync::Cond * cond) 。

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

{ return wait(&cond); }

函数调用图:

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

wait() [2/4]

xwer_t xwos::lock::Spinlock::LkGrd::wait ( sync::Cond &  cond, xwtm_t  to  )

inline

限时等待条件量

参数

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

返回

错误码

注解

• 上下文：线程

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

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

{ return wait(&cond, to); }

函数调用图:

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

wait() [3/4]

xwer_t xwos::lock::Spinlock::LkGrd::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() 确认是否上锁成功。

在文件 Spinlock.cxx 第 49 行定义.

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

xwer_t xwos::lock::Spinlock::LkGrd::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() 确认是否上锁成功。

在文件 Spinlock.cxx 第 72 行定义.

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

函数调用图:

结构体成员变量说明

mSpinlock

Spinlock* xwos::lock::Spinlock::LkGrd::mSpinlock

protected

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

mStatus

enum LockStatus xwos::lock::Spinlock::LkGrd::mStatus

protected

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

---

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

• xwos/cxx/lock/Spinlock.hxx
• xwos/cxx/lock/Spinlock.cxx