los_futex_pri.h 文件参考

浏览源代码.

结构体
struct	FutexNode
	每个futex node对应一个被挂起的task ，key值唯一标识一把用户态锁，具有相同key值的node被queue_list串联起来表示被同一把锁阻塞的task队列。 更多...

函数
UINT32	OsFutexInit (VOID)
VOID	OsFutexNodeDeleteFromFutexHash (FutexNode *node, BOOL isDeleteHead, FutexNode **headNode, BOOL *queueFlags)
	从哈希桶上删除快锁 更多...
INT32	OsFutexWake (const UINT32 *userVaddr, UINT32 flags, INT32 wakeNumber)
	唤醒一个被指定锁阻塞的线程 更多...
INT32	OsFutexWait (const UINT32 *userVaddr, UINT32 flags, UINT32 val, UINT32 absTime)
	设置线程等待 | 向Futex表中插入代表被阻塞的线程的node 更多...
INT32	OsFutexRequeue (const UINT32 *userVaddr, UINT32 flags, INT32 wakeNumber, INT32 count, const UINT32 *newUserVaddr)
	调整指定锁在Futex表中的位置 更多...

详细描述

 FUTEX_WAIT
    这个操作用来检测有uaddr指向的futex是否包含关心的数值val，如果是，则继续sleep直到FUTEX_WAKE操作触发。
    加载futex的操作是原子的。这个加载，从比较关心的数值，到开始sleep，都是原子的，与另外一个对于同一个
    futex的操作是线性的，串行的，严格按照顺序来执行的。如果线程开始sleep，就表示有一个waiter在futex上。
    如果futex的值不匹配，回调直接返回失败，错误代码是EAGAIN。

    与期望值对比的目的是为了防止丢失唤醒的操作。如果另一个线程在基于前面的数值阻塞调用之后，修改了这个值，
    另一个线程在数值改变之后，调用FUTEX_WAIT之前执行了FUTEX_WAKE操作，这个调用的线程就会观察到数值变换并且无法唤醒。
    这里的意思是，调用FUTEX_WAIT需要做上面的一个操作，就是检测一下这个值是不是我们需要的，如果不是就等待，
    如果是就直接运行下去。之所以检测是为了避免丢失唤醒，也就是防止一直等待下去，比如我们在调用FUTEX_WAIT之前，
    另一个线程已经调用了FUTEX_WAKE，那么就不会有线程调用FUTEX_WAKE，调用FUTEX_WAIT的线程就永远等不到信号了，也就永远唤醒不了了。

    如果timeout不是NULL，就表示指向了一个特定的超时时钟。这个超时间隔使用系统时钟的颗粒度四舍五入，
    可以保证触发不会比定时的时间早。默认情况通过CLOCK_MONOTONIC测量，但是从Linux 4.5开始，可以在futex_op中设置
    FUTEX_CLOCK_REALTIME使用CLOCK_REALTIME测量。如果timeout是NULL，将会永远阻塞。

    注意：对于FUTEX_WAIT，timeout是一个关联的值。与其他的futex设置不同，timeout被认为是一个绝对值。
    使用通过FUTEX_BITSET_MATCH_ANY特殊定义的val3传入FUTEX_WAIT_BITSET可以获得附带timeout的FUTEX_WAIT的值。       

版本

作者

weharmonyos.com | 鸿蒙研究站 | 每天死磕一点点

日期

2021-11-24

在文件 los_futex_pri.h 中定义.

函数说明

OsFutexInit()

UINT32 OsFutexInit

(

VOID

)

在文件 los_futex.c 第 144 行定义.

{
    INT32 count;
    UINT32 ret;
    // 初始化 80个哈希桶 
    for (count = 0; count < FUTEX_INDEX_MAX; count++) {
        LOS_ListInit(&g_futexHash[count].lockList); // 初始化双向链表,上面挂 FutexNode
        ret = LOS_MuxInit(&(g_futexHash[count].listLock), NULL);//初始化互斥锁
        if (ret) {
            return ret;
        }
    }
 
    return LOS_OK;
}

函数调用图:

OsFutexNodeDeleteFromFutexHash()

VOID OsFutexNodeDeleteFromFutexHash	(	FutexNode *	node,
		BOOL	isDeleteHead,
		FutexNode **	headNode,
		BOOL *	queueFlags
	)

从哈希桶上删除快锁

在文件 los_futex.c 第 302 行定义.

{
    FutexHash *hashNode = NULL;
    //通过key找到桶号
    UINT32 index = OsFutexKeyToIndex(node->key, (node->pid == OS_INVALID) ? 0 : FUTEX_PRIVATE);
    if (index >= FUTEX_INDEX_MAX) {
        return;
    }
 
    hashNode = &g_futexHash[index];//找到hash桶
    if (OsMuxLockUnsafe(&hashNode->listLock, LOS_WAIT_FOREVER)) {
        return;
    }
 
    if (node->index != index) {//快锁节点桶号需和哈希桶号一致
        goto EXIT;
    }
 
    OsFutexDeleteKeyNodeFromHash(node, isDeleteHead, headNode, queueFlags);
 
EXIT:
    if (OsMuxUnlockUnsafe(OsCurrTaskGet(), &hashNode->listLock, NULL)) {
        return;
    }
 
    return;
}

函数调用图:

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

OsFutexRequeue()

INT32 OsFutexRequeue	(	const UINT32 *	userVaddr,
		UINT32	flags,
		INT32	wakeNumber,
		INT32	count,
		const UINT32 *	newUserVaddr
	)

调整指定锁在Futex表中的位置

在文件 los_futex.c 第 1022 行定义.

{
    INT32 ret;
    UINTPTR oldFutexKey;
    UINTPTR newFutexKey;
    INT32 oldIndex;
    INT32 newIndex;
    FutexHash *oldHashNode = NULL;
    FutexHash *newHashNode = NULL;
    FutexNode *oldHeadNode = NULL;
    BOOL wakeAny = FALSE;
 
    if (OsFutexRequeueParamCheck(userVaddr, flags, newUserVaddr)) {
        return LOS_EINVAL;
    }
 
    oldFutexKey = OsFutexFlagsToKey(userVaddr, flags);//先拿key
    newFutexKey = OsFutexFlagsToKey(newUserVaddr, flags);
    oldIndex = OsFutexKeyToIndex(oldFutexKey, flags);//再拿所在哈希桶位置,共有80个哈希桶
    newIndex = OsFutexKeyToIndex(newFutexKey, flags);
 
    oldHashNode = &g_futexHash[oldIndex];//拿到对应哈希桶实体
    if (OsFutexLock(&oldHashNode->listLock)) {
        return LOS_EINVAL;
    }
 
    oldHeadNode = OsFutexRequeueRemoveOldKeyAndGetHead(oldFutexKey, flags, wakeNumber, newFutexKey, count, &wakeAny);
    if (oldHeadNode == NULL) {
        (VOID)OsFutexUnlock(&oldHashNode->listLock);
        if (wakeAny == TRUE) {
            ret = LOS_OK;
            goto EXIT;
        }
        return LOS_EBADF;
    }
 
    newHashNode = &g_futexHash[newIndex];
    if (oldIndex != newIndex) {
        if (OsFutexUnlock(&oldHashNode->listLock)) {
            return LOS_EINVAL;
        }
 
        if (OsFutexLock(&newHashNode->listLock)) {
            return LOS_EINVAL;
        }
    }
 
    ret = OsFutexRequeueInsertNewKey(newFutexKey, newIndex, oldHeadNode);
 
    if (OsFutexUnlock(&newHashNode->listLock)) {
        return LOS_EINVAL;
    }
 
EXIT:
    if (wakeAny == TRUE) {
        LOS_MpSchedule(OS_MP_CPU_ALL);
        LOS_Schedule();
    }
 
    return ret;
}

函数调用图:

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

OsFutexWait()

INT32 OsFutexWait	(	const UINT32 *	userVaddr,
		UINT32	flags,
		UINT32	val,
		UINT32	absTime
	)

设置线程等待 | 向Futex表中插入代表被阻塞的线程的node

在文件 los_futex.c 第 693 行定义.

{
    INT32 ret;
    UINT32 timeout = LOS_WAIT_FOREVER;
 
    ret = OsFutexWaitParamCheck(userVaddr, flags, absTime);//参数检查
    if (ret) {
        return ret;
    }
    if (absTime != LOS_WAIT_FOREVER) {//转换时间 , 内核的时间单位是 tick
        timeout = OsNS2Tick((UINT64)absTime * OS_SYS_NS_PER_US); //转成 tick
    }
 
    return OsFutexWaitTask(userVaddr, flags, val, timeout);//将任务挂起 timeOut 时长
}

函数调用图:

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

OsFutexWake()

INT32 OsFutexWake	(	const UINT32 *	userVaddr,
		UINT32	flags,
		INT32	wakeNumber
	)

唤醒一个被指定锁阻塞的线程

在文件 los_futex.c 第 815 行定义.

{
    INT32 ret, futexRet;
    UINTPTR futexKey;
    UINT32 index;
    FutexHash *hashNode = NULL;
    FutexNode *headNode = NULL;
    BOOL wakeAny = FALSE;
    //1.检查参数
    if (OsFutexWakeParamCheck(userVaddr, flags)) {
        return LOS_EINVAL;
    }
    //2.找到指定用户空间地址对应的桶
    futexKey = OsFutexFlagsToKey(userVaddr, flags);
    index = OsFutexKeyToIndex(futexKey, flags);
 
    hashNode = &g_futexHash[index];
    if (OsFutexLock(&hashNode->listLock)) {
        return LOS_EINVAL;
    }
    //3.换起等待该锁的进程
    ret = OsFutexWakeTask(futexKey, flags, wakeNumber, &headNode, &wakeAny);
    if (ret) {
        goto EXIT_ERR;
    }
 
#ifdef LOS_FUTEX_DEBUG
    OsFutexHashShow();
#endif
 
    futexRet = OsFutexUnlock(&hashNode->listLock);
    if (futexRet) {
        goto EXIT_UNLOCK_ERR;
    }
    //4.根据指定参数决定是否发起调度
    if (wakeAny == TRUE) {
        LOS_MpSchedule(OS_MP_CPU_ALL);
        LOS_Schedule();
    }
 
    return LOS_OK;
 
EXIT_ERR:
    futexRet = OsFutexUnlock(&hashNode->listLock);
EXIT_UNLOCK_ERR:
    if (futexRet) {
        return futexRet;
    }
    return ret;
}

函数调用图:

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