los_lockdep.h 文件参考

浏览源代码.

结构体
struct	HeldLocks
struct	LockDep

类型定义
typedef struct Spinlock	SPIN_LOCK_S

枚举
enum	LockDepErrType {   LOCKDEP_SUCCESS = 0 , LOCKDEP_ERR_DOUBLE_LOCK , LOCKDEP_ERR_DEAD_LOCK , LOCKDEP_ERR_UNLOCK_WITOUT_LOCK ,   LOCKDEP_ERR_OVERFLOW }

函数
VOID	OsLockDepCheckIn (SPIN_LOCK_S *lock)
VOID	OsLockDepRecord (SPIN_LOCK_S *lock)
VOID	OsLockDepCheckOut (SPIN_LOCK_S *lock)
VOID	OsLockdepClearSpinlocks (VOID)

类型定义说明

SPIN_LOCK_S

typedef struct Spinlock SPIN_LOCK_S

在文件 los_lockdep.h 第 41 行定义.

枚举类型说明

LockDepErrType

enum LockDepErrType

枚举值
LOCKDEP_SUCCESS
LOCKDEP_ERR_DOUBLE_LOCK
LOCKDEP_ERR_DEAD_LOCK
LOCKDEP_ERR_UNLOCK_WITOUT_LOCK
LOCKDEP_ERR_OVERFLOW

在文件 los_lockdep.h 第 45 行定义.

                    {
    LOCKDEP_SUCCESS = 0,
    LOCKDEP_ERR_DOUBLE_LOCK,
    LOCKDEP_ERR_DEAD_LOCK,
    LOCKDEP_ERR_UNLOCK_WITOUT_LOCK,
    /* overflow, needs expand */
    LOCKDEP_ERR_OVERFLOW,
};

函数说明

OsLockDepCheckIn()

VOID OsLockDepCheckIn

(

SPIN_LOCK_S *

lock

)

Description:

This API is used to check dead lock in spinlock.

注意

• The parameter passed in should be ensured to be a legal pointer.

参数

lock	[IN] point to a SPIN_LOCK_S.

返回值

None.

Dependency:

• los_lockdep.h: the header file that contains the API declaration.

参见

在文件 los_lockdep.c 第 189 行定义.

{
    UINT32 intSave;
    enum LockDepErrType checkResult = LOCKDEP_SUCCESS;
#ifdef LOSCFG_COMPILER_CLANG_LLVM
    VOID *requestAddr = (VOID *)__builtin_return_address(1);
#else
    VOID *requestAddr = (VOID *)__builtin_return_address(0);
#endif
    LosTaskCB *current = OsCurrTaskGet();
    LockDep *lockDep = &current->lockDep;
    LosTaskCB *lockOwner = NULL;
 
    OsLockDepRequire(&intSave);
 
    if (lockDep->lockDepth >= (INT32)MAX_LOCK_DEPTH) {
        checkResult = LOCKDEP_ERR_OVERFLOW;
        goto OUT;
    }
 
    lockOwner = lock->owner;
    /* not owned by any tasks yet, not doing following checks */
    if (lockOwner == SPINLOCK_OWNER_INIT) {
        goto OUT;
    }
 
    if (current == lockOwner) {
        checkResult = LOCKDEP_ERR_DOUBLE_LOCK;
        goto OUT;
    }
 
    if (OsLockDepCheckDependency(current, lockOwner) != TRUE) {
        checkResult = LOCKDEP_ERR_DEAD_LOCK;
        goto OUT;
    }
 
OUT:
    if (checkResult == LOCKDEP_SUCCESS) {
        /*
         * though the check may succeed, the waitLock still need to be set.
         * because the OsLockDepCheckIn and OsLockDepRecord is not strictly multi-core
         * sequential, there would be more than two tasks can pass the checking, but
         * only one task can successfully obtain the lock.
         */
        lockDep->waitLock = lock;
        lockDep->heldLocks[lockDep->lockDepth].lockAddr = requestAddr;
        lockDep->heldLocks[lockDep->lockDepth].waitTime = OsLockDepGetCycles(); /* start time */
        OsLockDepRelease(intSave);
        return;
    }
    OsLockDepDumpLock(current, lock, requestAddr, checkResult);
    OsLockDepRelease(intSave);
    OsLockDepPanic(checkResult);
}

函数调用图:

OsLockDepCheckOut()

VOID OsLockDepCheckOut

(

SPIN_LOCK_S *

lock

)

Description:

This API is used to trace when a spinlock unlocked.

注意

• The parameter passed in should be ensured to be a legal pointer.

参数

lock	[IN] point to a SPIN_LOCK_S.

返回值

None.

Dependency:

• los_lockdep.h: the header file that contains the API declaration.

参见

在文件 los_lockdep.c 第 274 行定义.

{
    UINT32 intSave;
    INT32 depth;
    enum LockDepErrType checkResult = LOCKDEP_SUCCESS;
#ifdef LOSCFG_COMPILER_CLANG_LLVM
    VOID *requestAddr = (VOID *)__builtin_return_address(1);
#else
    VOID *requestAddr = (VOID *)__builtin_return_address(0);
#endif
    LosTaskCB *current = OsCurrTaskGet();
    LosTaskCB *owner = NULL;
    LockDep *lockDep = NULL;
    HeldLocks *heldlocks = NULL;
 
    OsLockDepRequire(&intSave);
 
    owner = lock->owner;
    if (owner == SPINLOCK_OWNER_INIT) {
        checkResult = LOCKDEP_ERR_UNLOCK_WITOUT_LOCK;
        OsLockDepDumpLock(current, lock, requestAddr, checkResult);
        OsLockDepRelease(intSave);
        OsLockDepPanic(checkResult);
        return;
    }
 
    lockDep = &owner->lockDep;
    heldlocks = &lockDep->heldLocks[0];
    depth = lockDep->lockDepth;
 
    /* find the lock position */
    while (--depth >= 0) {
        if (heldlocks[depth].lockPtr == lock) {
            break;
        }
    }
 
    LOS_ASSERT(depth >= 0);
 
    /* record lock holding time */
    heldlocks[depth].holdTime = OsLockDepGetCycles() - heldlocks[depth].holdTime;
 
    /* if unlock an older lock, needs move heldLock records */
    while (depth < lockDep->lockDepth - 1) {
        lockDep->heldLocks[depth] = lockDep->heldLocks[depth + 1];
        depth++;
    }
 
    lockDep->lockDepth--;
    lock->cpuid = (UINT32)(-1);
    lock->owner = SPINLOCK_OWNER_INIT;
 
    OsLockDepRelease(intSave);
}

函数调用图:

OsLockdepClearSpinlocks()

VOID OsLockdepClearSpinlocks

(

VOID

)

Description:

This API is used to clear lockdep record of curret task.

注意

• None.

参数

None

返回值

None.

Dependency:

• los_lockdep.h: the header file that contains the API declaration.

参见

在文件 los_lockdep.c 第 329 行定义.

{
    LosTaskCB *task = OsCurrTaskGet();
    LockDep *lockDep = &task->lockDep;
    SPIN_LOCK_S *lock = NULL;
 
    /*
     * Unlock spinlocks that running task has held.
     * lockDepth will decrease after each spinlock is unlockded.
     */
    while (lockDep->lockDepth) {
        lock = lockDep->heldLocks[lockDep->lockDepth - 1].lockPtr;
        LOS_SpinUnlock(lock);
    }
}

函数调用图:

OsLockDepRecord()

VOID OsLockDepRecord

(

SPIN_LOCK_S *

lock

)

Description:

This API is used to trace when a spinlock locked.

注意

• The parameter passed in should be ensured to be a legal pointer.

参数

lock	[IN] point to a SPIN_LOCK_S.

返回值

None.

Dependency:

• los_lockdep.h: the header file that contains the API declaration.

参见

在文件 los_lockdep.c 第 244 行定义.

{
    UINT32 intSave;
    UINT64 cycles;
    LosTaskCB *current = OsCurrTaskGet();
    LockDep *lockDep = &current->lockDep;
    HeldLocks *heldlock = &lockDep->heldLocks[lockDep->lockDepth];
 
    OsLockDepRequire(&intSave);
 
    /*
     * OsLockDepCheckIn records start time t1, after the lock is obtained, we
     * get the time t2, (t2 - t1) is the time of waiting for the lock
     */
    cycles = OsLockDepGetCycles();
    heldlock->waitTime = cycles - heldlock->waitTime;
    heldlock->holdTime = cycles;
 
    /* record lock info */
    lock->owner = current;
    lock->cpuid = ArchCurrCpuid();
 
    /* record lockdep info */
    heldlock->lockPtr = lock;
    lockDep->lockDepth++;
    lockDep->waitLock = NULL;
 
    OsLockDepRelease(intSave);
}

函数调用图: