los_lockdep.c 文件参考

浏览源代码.

函数
STATIC INLINE VOID	OsLockDepRequire (UINT32 *intSave)
STATIC INLINE VOID	OsLockDepRelease (UINT32 intSave)
STATIC INLINE UINT64	OsLockDepGetCycles (VOID)
STATIC INLINE CHAR *	OsLockDepErrorStringGet (enum LockDepErrType type)
WEAK VOID	OsLockDepPanic (enum LockDepErrType errType)
STATIC VOID	OsLockDepPrint (const CHAR *fmt, va_list ap)
STATIC VOID	OsPrintLockDepInfo (const CHAR *fmt,...)
STATIC VOID	OsLockDepDumpLock (const LosTaskCB *task, const SPIN_LOCK_S *lock, const VOID *requestAddr, enum LockDepErrType errType)
STATIC BOOL	OsLockDepCheckDependency (const LosTaskCB *current, LosTaskCB *lockOwner)
VOID	OsLockDepCheckIn (SPIN_LOCK_S *lock)
VOID	OsLockDepRecord (SPIN_LOCK_S *lock)
VOID	OsLockDepCheckOut (SPIN_LOCK_S *lock)
VOID	OsLockdepClearSpinlocks (VOID)

变量
STATIC Atomic	g_lockdepAvailable = 1

函数说明

OsLockDepCheckDependency()

STATIC BOOL OsLockDepCheckDependency	(	const LosTaskCB *	current,
		LosTaskCB *	lockOwner
	)

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

{
    BOOL checkResult = TRUE;
    SPIN_LOCK_S *lockTemp = NULL;
 
    do {
        if (current == lockOwner) {
            checkResult = FALSE;
            return checkResult;
        }
        if (lockOwner->lockDep.waitLock != NULL) {
            lockTemp = lockOwner->lockDep.waitLock;
            lockOwner = lockTemp->owner;
        } else {
            break;
        }
    } while (lockOwner != SPINLOCK_OWNER_INIT);
 
    return checkResult;
}

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

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

函数调用图:

OsLockDepDumpLock()

STATIC VOID OsLockDepDumpLock	(	const LosTaskCB *	task,
		const SPIN_LOCK_S *	lock,
		const VOID *	requestAddr,
		enum LockDepErrType	errType
	)

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

{
    INT32 i;
    const LockDep *lockDep = &task->lockDep;
    const LosTaskCB *temp = task;
 
    OsPrintLockDepInfo("lockdep check failed\n");
    OsPrintLockDepInfo("error type   : %s\n", OsLockDepErrorStringGet(errType));
    OsPrintLockDepInfo("request addr : 0x%x\n", requestAddr);
 
    while (1) {
        OsPrintLockDepInfo("task name    : %s\n", temp->taskName);
        OsPrintLockDepInfo("task id      : %u\n", temp->taskID);
        OsPrintLockDepInfo("cpu num      : %u\n", temp->currCpu);
        OsPrintLockDepInfo("start dumping lockdep information\n");
        for (i = 0; i < lockDep->lockDepth; i++) {
            if (lockDep->heldLocks[i].lockPtr == lock) {
                OsPrintLockDepInfo("[%d] %s <-- addr:0x%x\n", i, LOCKDEP_GET_NAME(lockDep, i),
                                   LOCKDEP_GET_ADDR(lockDep, i));
            } else {
                OsPrintLockDepInfo("[%d] %s \n", i, LOCKDEP_GET_NAME(lockDep, i));
            }
        }
        OsPrintLockDepInfo("[%d] %s <-- now\n", i, lock->name);
 
        if (errType == LOCKDEP_ERR_DEAD_LOCK) {
            temp = lock->owner;
            lock = temp->lockDep.waitLock;
            lockDep = &temp->lockDep;
        }
 
        if (temp == task) {
            break;
        }
    }
}

函数调用图:

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

OsLockDepErrorStringGet()

STATIC INLINE CHAR * OsLockDepErrorStringGet

(

enum LockDepErrType

type

)

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

{
    CHAR *errorString = NULL;
 
    switch (type) {
        case LOCKDEP_ERR_DOUBLE_LOCK:
            errorString = "double lock";
            break;
        case LOCKDEP_ERR_DEAD_LOCK:
            errorString = "dead lock";
            break;
        case LOCKDEP_ERR_UNLOCK_WITOUT_LOCK:
            errorString = "unlock without lock";
            break;
        case LOCKDEP_ERR_OVERFLOW:
            errorString = "lockdep overflow";
            break;
        default:
            errorString = "unknown error code";
            break;
    }
 
    return errorString;
}

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

OsLockDepGetCycles()

STATIC INLINE UINT64 OsLockDepGetCycles

(

VOID

)

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

{
    UINT32 high, low;
 
    LOS_GetCpuCycle(&high, &low);
    /* combine cycleHi and cycleLo into 8 bytes cycles */
    return (((UINT64)high << 32) + low); // 32 bits for lower half of UINT64
}

函数调用图:

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

OsLockDepPanic()

WEAK VOID OsLockDepPanic

(

enum LockDepErrType

errType

)

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

{
    /* halt here */
    (VOID)errType;
    (VOID)LOS_IntLock();
    OsBackTrace();
    while (1) {}
}

函数调用图:

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

OsLockDepPrint()

STATIC VOID OsLockDepPrint	(	const CHAR *	fmt,
		va_list	ap
	)

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

{
    UINT32 len;
    CHAR buf[PRINT_BUF_SIZE] = {0};
 
    len = vsnprintf_s(buf, PRINT_BUF_SIZE, PRINT_BUF_SIZE - 1, fmt, ap);
    if ((len == -1) && (*buf == '\0')) {
        /* parameter is illegal or some features in fmt dont support */
        UartPuts("OsLockDepPrint is error\n", strlen("OsLockDepPrint is error\n"), 0);
        return;
    }
    *(buf + len) = '\0';
 
    UartPuts(buf, len, 0);
}

函数调用图:

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

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

函数调用图:

OsLockDepRelease()

STATIC INLINE VOID OsLockDepRelease

(

UINT32

intSave

)

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

{
    LOS_AtomicSet(&g_lockdepAvailable, 1);
    LOS_IntRestore(intSave);
}

函数调用图:

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

OsLockDepRequire()

STATIC INLINE VOID OsLockDepRequire

(

UINT32 *

intSave

)

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

{
    *intSave = LOS_IntLock();
    while (LOS_AtomicCmpXchg32bits(&g_lockdepAvailable, 0, 1)) {
        /* busy waiting */
    }
}

函数调用图:

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

OsPrintLockDepInfo()

STATIC VOID OsPrintLockDepInfo	(	const CHAR *	fmt,
			...
	)

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

{
    va_list ap;
    va_start(ap, fmt);
    OsLockDepPrint(fmt, ap);
    va_end(ap);
}

函数调用图:

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

变量说明

g_lockdepAvailable

STATIC Atomic g_lockdepAvailable = 1

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