los_mux.h 文件参考

浏览源代码.

结构体
struct	LosMuxAttr
struct	OsMux

类型定义
typedef struct OsMux	LosMux

枚举
enum	{ LOS_MUX_PRIO_NONE = 0 , LOS_MUX_PRIO_INHERIT = 1 , LOS_MUX_PRIO_PROTECT = 2 }
enum	{ LOS_MUX_NORMAL = 0 , LOS_MUX_RECURSIVE = 1 , LOS_MUX_ERRORCHECK = 2 , LOS_MUX_DEFAULT = LOS_MUX_RECURSIVE }

函数
UINT32	LOS_MuxAttrInit (LosMuxAttr *attr)
	互斥属性初始化 更多...
UINT32	LOS_MuxAttrDestroy (LosMuxAttr *attr)
	????? 销毁互斥属 ,这里啥也没干呀 更多...
UINT32	LOS_MuxAttrGetType (const LosMuxAttr *attr, INT32 *outType)
	获取互斥锁的类型属性,由outType接走,不送! 更多...
UINT32	LOS_MuxAttrSetType (LosMuxAttr *attr, INT32 type)
	设置互斥锁的类型属性 更多...
UINT32	LOS_MuxAttrGetProtocol (const LosMuxAttr *attr, INT32 *protocol)
	获取互斥锁的类型属性 更多...
UINT32	LOS_MuxAttrSetProtocol (LosMuxAttr *attr, INT32 protocol)
	设置互斥锁属性的协议 更多...
UINT32	LOS_MuxAttrGetPrioceiling (const LosMuxAttr *attr, INT32 *prioceiling)
	获取互斥锁属性优先级 更多...
UINT32	LOS_MuxAttrSetPrioceiling (LosMuxAttr *attr, INT32 prioceiling)
	设置互斥锁属性的优先级的上限 更多...
UINT32	LOS_MuxSetPrioceiling (LosMux *mutex, INT32 prioceiling, INT32 *oldPrioceiling)
	设置互斥锁的优先级的上限,老优先级由oldPrioceiling带走 更多...
UINT32	LOS_MuxGetPrioceiling (const LosMux *mutex, INT32 *prioceiling)
	获取互斥锁的优先级的上限 更多...
BOOL	LOS_MuxIsValid (const LosMux *mutex)
	互斥锁是否有效 更多...
UINT32	LOS_MuxInit (LosMux *mutex, const LosMuxAttr *attr)
	Init a mutex. 更多...
UINT32	LOS_MuxDestroy (LosMux *mutex)
	Destroy a mutex. 更多...
UINT32	LOS_MuxLock (LosMux *mutex, UINT32 timeout)
	Wait to lock a mutex. 更多...
UINT32	LOS_MuxTrylock (LosMux *mutex)
	Try wait to lock a mutex. 更多...
UINT32	LOS_MuxUnlock (LosMux *mutex)
	Release a mutex. 更多...

枚举类型说明

anonymous enum

anonymous enum

枚举值
LOS_MUX_PRIO_NONE	线程的优先级和调度不会受到互斥锁影响,先来后到,普通排队.
LOS_MUX_PRIO_INHERIT	当高优先级的等待低优先级的线程释放锁时，低优先级的线程以高优先级线程的优先级运行。 当线程解锁互斥量时，线程的优先级自动被将到它原来的优先级
LOS_MUX_PRIO_PROTECT	详见: OsMuxPendOp 中的注解,详细说明了LOS_MUX_PRIO_PROTECT的含义

在文件 los_mux.h 第 48 行定义.

     {
    LOS_MUX_PRIO_NONE = 0,      ///< 线程的优先级和调度不会受到互斥锁影响,先来后到,普通排队.
    LOS_MUX_PRIO_INHERIT = 1,   ///< 当高优先级的等待低优先级的线程释放锁时，低优先级的线程以高优先级线程的优先级运行。
                                ///< 当线程解锁互斥量时，线程的优先级自动被将到它原来的优先级
    LOS_MUX_PRIO_PROTECT = 2    ///< 详见: OsMuxPendOp 中的注解,详细说明了LOS_MUX_PRIO_PROTECT的含义
};

anonymous enum

anonymous enum

枚举值
LOS_MUX_NORMAL	非递归锁 只有[0.1]两个状态,不做任何特殊的错误检,不进行deadlock detection(死锁检测)
LOS_MUX_RECURSIVE	递归锁 允许同一线程在互斥量解锁前对该互斥量进行多次加锁。递归互斥量维护锁的计数，在解锁次数和加锁次数不相同的情况下，不会释放锁，别的线程就无法加锁此互斥量。
LOS_MUX_ERRORCHECK	进行错误检查,如果一个线程企图对一个已经锁住的mutex进行relock或对未加锁的unlock，将返回一个错误。
LOS_MUX_DEFAULT

在文件 los_mux.h 第 55 行定义.

     {
    LOS_MUX_NORMAL = 0,     ///< 非递归锁 只有[0.1]两个状态,不做任何特殊的错误检,不进行deadlock detection(死锁检测)
    LOS_MUX_RECURSIVE = 1,  ///< 递归锁 允许同一线程在互斥量解锁前对该互斥量进行多次加锁。递归互斥量维护锁的计数，在解锁次数和加锁次数不相同的情况下，不会释放锁，别的线程就无法加锁此互斥量。
    LOS_MUX_ERRORCHECK = 2, ///< 进行错误检查,如果一个线程企图对一个已经锁住的mutex进行relock或对未加锁的unlock，将返回一个错误。
    LOS_MUX_DEFAULT = LOS_MUX_RECURSIVE //鸿蒙系统默认使用递归锁
};

函数说明

LOS_MuxAttrDestroy()

UINT32 LOS_MuxAttrDestroy

(

LosMuxAttr *

attr

)

????? 销毁互斥属 ,这里啥也没干呀

在文件 los_mux.c 第 109 行定义.

{
    if (attr == NULL) {
        return LOS_EINVAL;
    }
 
    return LOS_OK;
}

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

LOS_MuxAttrGetPrioceiling()

UINT32 LOS_MuxAttrGetPrioceiling	(	const LosMuxAttr *	attr,
		INT32 *	prioceiling
	)

获取互斥锁属性优先级

在文件 los_mux.c 第 174 行定义.

{
    if (attr == NULL) {
        return LOS_EINVAL;
    }
 
    if (prioceiling != NULL) {
        *prioceiling = attr->prioceiling;
    }
 
    return LOS_OK;
}

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

LOS_MuxAttrGetProtocol()

UINT32 LOS_MuxAttrGetProtocol	(	const LosMuxAttr *	attr,
		INT32 *	protocol
	)

获取互斥锁的类型属性

在文件 los_mux.c 第 146 行定义.

{
    if ((attr != NULL) && (protocol != NULL)) {
        *protocol = attr->protocol;
    } else {
        return LOS_EINVAL;
    }
 
    return LOS_OK;
}

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

LOS_MuxAttrGetType()

UINT32 LOS_MuxAttrGetType	(	const LosMuxAttr *	attr,
		INT32 *	outType
	)

获取互斥锁的类型属性,由outType接走,不送!

在文件 los_mux.c 第 118 行定义.

{
    INT32 type;
 
    if ((attr == NULL) || (outType == NULL)) {
        return LOS_EINVAL;
    }
 
    type = (INT32)(attr->type & MUTEXATTR_TYPE_MASK);
    if ((type < LOS_MUX_NORMAL) || (type > LOS_MUX_ERRORCHECK)) {
        return LOS_EINVAL;
    }
 
    *outType = type;
 
    return LOS_OK;
}

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

LOS_MuxAttrInit()

UINT32 LOS_MuxAttrInit

(

LosMuxAttr *

attr

)

互斥属性初始化

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

{
    if (attr == NULL) {
        return LOS_EINVAL;
    }
 
    attr->protocol    = LOS_MUX_PRIO_INHERIT;   //协议默认用继承方式, A(4)task等B(19)释放锁时,B的调度优先级直接升到(4)
    attr->prioceiling = OS_TASK_PRIORITY_LOWEST;//最低优先级
    attr->type        = LOS_MUX_DEFAULT;        //默认 LOS_MUX_RECURSIVE
    return LOS_OK;
}

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

LOS_MuxAttrSetPrioceiling()

UINT32 LOS_MuxAttrSetPrioceiling	(	LosMuxAttr *	attr,
		INT32	prioceiling
	)

设置互斥锁属性的优先级的上限

在文件 los_mux.c 第 187 行定义.

{
    if ((attr == NULL) ||
        (prioceiling < OS_TASK_PRIORITY_HIGHEST) ||
        (prioceiling > OS_TASK_PRIORITY_LOWEST)) {
        return LOS_EINVAL;
    }
 
    attr->prioceiling = (UINT8)prioceiling;
 
    return LOS_OK;
}

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

LOS_MuxAttrSetProtocol()

UINT32 LOS_MuxAttrSetProtocol	(	LosMuxAttr *	attr,
		INT32	protocol
	)

设置互斥锁属性的协议

在文件 los_mux.c 第 157 行定义.

{
    if (attr == NULL) {
        return LOS_EINVAL;
    }
 
    switch (protocol) {
        case LOS_MUX_PRIO_NONE:
        case LOS_MUX_PRIO_INHERIT:
        case LOS_MUX_PRIO_PROTECT:
            attr->protocol = (UINT8)protocol;
            return LOS_OK;
        default:
            return LOS_EINVAL;
    }
}

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

LOS_MuxAttrSetType()

UINT32 LOS_MuxAttrSetType	(	LosMuxAttr *	attr,
		INT32	type
	)

设置互斥锁的类型属性

在文件 los_mux.c 第 136 行定义.

{
    if ((attr == NULL) || (type < LOS_MUX_NORMAL) || (type > LOS_MUX_ERRORCHECK)) {
        return LOS_EINVAL;
    }
 
    attr->type = (UINT8)((attr->type & ~MUTEXATTR_TYPE_MASK) | (UINT32)type);
    return LOS_OK;
}

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

LOS_MuxGetPrioceiling()

UINT32 LOS_MuxGetPrioceiling	(	const LosMux *	mutex,
		INT32 *	prioceiling
	)

获取互斥锁的优先级的上限

在文件 los_mux.c 第 229 行定义.

{
    if ((mutex != NULL) && (prioceiling != NULL) && (mutex->magic == OS_MUX_MAGIC)) {
        *prioceiling = mutex->attr.prioceiling;
        return LOS_OK;
    }
 
    return LOS_EINVAL;
}

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

LOS_MuxIsValid()

BOOL LOS_MuxIsValid

(

const LosMux *

mutex

)

互斥锁是否有效

在文件 los_mux.c 第 239 行定义.

{
    if ((mutex != NULL) && (mutex->magic == OS_MUX_MAGIC)) {
        return TRUE;
    }
 
    return FALSE;
}

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

LOS_MuxSetPrioceiling()

UINT32 LOS_MuxSetPrioceiling	(	LosMux *	mutex,
		INT32	prioceiling,
		INT32 *	oldPrioceiling
	)

设置互斥锁的优先级的上限,老优先级由oldPrioceiling带走

在文件 los_mux.c 第 200 行定义.

{
    INT32 ret;
    INT32 retLock;
    if ((mutex == NULL) ||
        (prioceiling < OS_TASK_PRIORITY_HIGHEST) ||
        (prioceiling > OS_TASK_PRIORITY_LOWEST)) {
        return LOS_EINVAL;
    }
 
    retLock = LOS_MuxLock(mutex, LOS_WAIT_FOREVER);
    if (retLock != LOS_OK) {
        return retLock;
    }
 
    if (oldPrioceiling != NULL) {
        *oldPrioceiling = mutex->attr.prioceiling;
    }
 
    ret = LOS_MuxAttrSetPrioceiling(&mutex->attr, prioceiling);
 
    retLock = LOS_MuxUnlock(mutex);
    if ((ret == LOS_OK) && (retLock != LOS_OK)) {
        return retLock;
    }
 
    return ret;
}

函数调用图:

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