Queue 的协作图:

结构体
struct	LosQueueCB

struct	tagQueueInfo

类型定义
typedef struct tagQueueInfo	QUEUE_INFO_S

函数
VOID *	OsQueueMailAlloc (UINT32 queueID, VOID *mailPool, UINT32 timeout)
	Alloc a stationary memory for a mail. 更多...

UINT32	OsQueueMailFree (UINT32 queueID, VOID mailPool, VOID mailMem)
	Free a stationary memory of a mail. 更多...

UINT32	LOS_QueueCreate (CHAR queueName, UINT16 len, UINT32 queueID, UINT32 flags, UINT16 maxMsgSize)
	Create a message queue. 更多...

UINT32	LOS_QueueReadCopy (UINT32 queueID, VOID bufferAddr, UINT32 bufferSize, UINT32 timeout)
	Read a queue. 更多...

UINT32	LOS_QueueWriteCopy (UINT32 queueID, VOID *bufferAddr, UINT32 bufferSize, UINT32 timeout)
	Write data into a queue. 更多...

UINT32	LOS_QueueRead (UINT32 queueID, VOID *bufferAddr, UINT32 bufferSize, UINT32 timeout)
	Read a queue. 更多...

UINT32	LOS_QueueWrite (UINT32 queueID, VOID *bufferAddr, UINT32 bufferSize, UINT32 timeout)
	Write data into a queue. 更多...

UINT32	LOS_QueueWriteHead (UINT32 queueID, VOID *bufferAddr, UINT32 bufferSize, UINT32 timeout)
	Write data into a queue header. 更多...

UINT32	LOS_QueueWriteHeadCopy (UINT32 queueID, VOID *bufferAddr, UINT32 bufferSize, UINT32 timeout)
	Write data into a queue header. 更多...

UINT32	LOS_QueueDelete (UINT32 queueID)
	Delete a queue. 更多...

UINT32	LOS_QueueInfoGet (UINT32 queueID, QUEUE_INFO_S *queueInfo)
	Obtain queue information. 更多...

变量
LosQueueCB *	g_allQueue
	消息队列池更多...

详细描述

类型定义说明

◆ QUEUE_INFO_S

typedef struct tagQueueInfo QUEUE_INFO_S

Structure of the block for queue information query

函数说明

◆ LOS_QueueCreate()

UINT32 LOS_QueueCreate	(	CHAR *	queueName,
		UINT16	len,
		UINT32 *	queueID,
		UINT32	flags,
		UINT16	maxMsgSize
	)

Create a message queue.

Description:: This API is used to create a message queue.

注意

Threre are LOSCFG_BASE_IPC_QUEUE_LIMIT queues available, change it's value when necessory.

参数

queueName	[IN] Message queue name. Reserved parameter, not used for now.
len	[IN] Queue length. The value range is [1,0xffff].
queueID	[OUT] ID of the queue control structure that is successfully created.
flags	[IN] Queue mode. Reserved parameter, not used for now.
maxMsgSize	[IN] Node size. The value range is [1,0xffff-4].

返回值

#LOS_OK	The message queue is successfully created.
#LOS_ERRNO_QUEUE_CB_UNAVAILABLE	The upper limit of the number of created queues is exceeded.
#LOS_ERRNO_QUEUE_CREATE_NO_MEMORY	Insufficient memory for queue creation.
#LOS_ERRNO_QUEUE_CREAT_PTR_NULL	Null pointer, queueID is NULL.
#LOS_ERRNO_QUEUE_PARA_ISZERO	The queue length or message node size passed in during queue creation is 0.
#LOS_ERRNO_QUEUE_SIZE_TOO_BIG	The parameter usMaxMsgSize is larger than 0xffff - 4.

Dependency:

los_queue.h: the header file that contains the API declaration.

参见: LOS_QueueDelete

Create a message queue.

在文件 los_queue.c 第 131 行定义.

{
    LosQueueCB *queueCB = NULL;
    UINT32 intSave;
    LOS_DL_LIST *unusedQueue = NULL;
    UINT8 *queue = NULL;
    UINT16 msgSize;
 
    (VOID)queueName;
    (VOID)flags;
 
    if (queueID == NULL) {
        return LOS_ERRNO_QUEUE_CREAT_PTR_NULL;
    }
 
    if (maxMsgSize > (OS_NULL_SHORT - sizeof(UINT32))) {// maxMsgSize上限 为啥要减去 sizeof(UINT32) ,因为前面存的是队列的大小
        return LOS_ERRNO_QUEUE_SIZE_TOO_BIG;
    }
 
    if ((len == 0) || (maxMsgSize == 0)) {
        return LOS_ERRNO_QUEUE_PARA_ISZERO;
    }
 
    msgSize = maxMsgSize + sizeof(UINT32);//总size = 消息体内容长度 + 消息大小(UINT32) 
    /*
     * Memory allocation is time-consuming, to shorten the time of disable interrupt,
     * move the memory allocation to here.
     *///内存分配非常耗时，为了缩短禁用中断的时间，将内存分配移到此处,用的时候分配队列内存
    queue = (UINT8 *)LOS_MemAlloc(m_aucSysMem1, (UINT32)len * msgSize);//从系统内存池中分配,由这里提供读写队列的内存
    if (queue == NULL) {//这里是一次把队列要用到的所有最大内存都申请下来了,能保证不会出现后续使用过程中内存不够的问题出现
        return LOS_ERRNO_QUEUE_CREATE_NO_MEMORY;//调用处有 OsSwtmrInit sys_mbox_new DoMqueueCreate ==
    }
 
    SCHEDULER_LOCK(intSave);
    if (LOS_ListEmpty(&g_freeQueueList)) {//没有空余的队列ID的处理,注意软时钟定时器是由 g_swtmrCBArray统一管理的,里面有正在使用和可分配空闲的队列
        SCHEDULER_UNLOCK(intSave);//g_freeQueueList是管理可用于分配的队列链表,申请消息队列的ID需要向它要
        OsQueueCheckHook();
        (VOID)LOS_MemFree(m_aucSysMem1, queue);//没有就要释放 queue申请的内存
        return LOS_ERRNO_QUEUE_CB_UNAVAILABLE;
    }
 
    unusedQueue = LOS_DL_LIST_FIRST(&g_freeQueueList);//找到一个没有被使用的队列
    LOS_ListDelete(unusedQueue);//将自己从g_freeQueueList中摘除, unusedQueue只是个 LOS_DL_LIST 结点.
    queueCB = GET_QUEUE_LIST(unusedQueue);//通过unusedQueue找到整个消息队列(LosQueueCB)
    queueCB->queueLen = len;    //队列中消息的总个数,注意这个一旦创建是不能变的.
    queueCB->queueSize = msgSize;//消息节点的大小,注意这个一旦创建也是不能变的.
    queueCB->queueHandle = queue;   //队列句柄,队列内容存储区. 
    queueCB->queueState = OS_QUEUE_INUSED;  //队列状态使用中
    queueCB->readWriteableCnt[OS_QUEUE_READ] = 0;//可读资源计数，OS_QUEUE_READ(0):可读.
    queueCB->readWriteableCnt[OS_QUEUE_WRITE] = len;//可些资源计数 OS_QUEUE_WRITE(1):可写, 默认len可写.
    queueCB->queueHead = 0;//队列头节点
    queueCB->queueTail = 0;//队列尾节点
    LOS_ListInit(&queueCB->readWriteList[OS_QUEUE_READ]);//初始化可读队列任务链表
    LOS_ListInit(&queueCB->readWriteList[OS_QUEUE_WRITE]);//初始化可写队列任务链表
    LOS_ListInit(&queueCB->memList);//
 
    OsQueueDbgUpdateHook(queueCB->queueID, OsCurrTaskGet()->taskEntry);//在创建或删除队列调试信息时更新任务条目
    SCHEDULER_UNLOCK(intSave);
 
    *queueID = queueCB->queueID;//带走队列ID
    OsHookCall(LOS_HOOK_TYPE_QUEUE_CREATE, queueCB);
    return LOS_OK;
}

函数调用图:

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

◆ LOS_QueueDelete()

UINT32 LOS_QueueDelete ( UINT32 queueID )

Delete a queue.

Description:: This API is used to delete a queue.

注意

This API cannot be used to delete a queue that is not created.
A synchronous queue fails to be deleted if any tasks are blocked on it, or some queues are being read or written.

参数

queueID [IN] Queue ID created by LOS_QueueCreate. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].

返回值

#LOS_OK	The queue is successfully deleted.
#LOS_ERRNO_QUEUE_NOT_FOUND	The queue cannot be found.
#LOS_ERRNO_QUEUE_NOT_CREATE	The queue handle passed in when the queue is being deleted is incorrect.
#LOS_ERRNO_QUEUE_IN_TSKUSE	The queue that blocks a task cannot be deleted.
#LOS_ERRNO_QUEUE_IN_TSKWRITE	Queue reading and writing are not synchronous.

Dependency:

los_queue.h: the header file that contains the API declaration.

参见: LOS_QueueCreate | LOS_QueueCreate

   外部接口 删除队列,还有任务要读/写消息时不能删除
   删除队列时，根据传入的队列ID寻找到对应的队列，把队列状态置为未使用，
   释放原队列所占的空间，对应的队列控制头置为初始状态。
*

在文件 los_queue.c 第 486 行定义.

{
    LosQueueCB *queueCB = NULL;
    UINT8 *queue = NULL;
    UINT32 intSave;
    UINT32 ret;
 
    if (GET_QUEUE_INDEX(queueID) >= LOSCFG_BASE_IPC_QUEUE_LIMIT) {
        return LOS_ERRNO_QUEUE_NOT_FOUND;
    }
 
    SCHEDULER_LOCK(intSave);
    queueCB = (LosQueueCB *)GET_QUEUE_HANDLE(queueID);//拿到队列实体
    if ((queueCB->queueID != queueID) || (queueCB->queueState == OS_QUEUE_UNUSED)) {
        ret = LOS_ERRNO_QUEUE_NOT_CREATE;
        goto QUEUE_END;
    }
 
    if (!LOS_ListEmpty(&queueCB->readWriteList[OS_QUEUE_READ])) {//尚有任务要读数据
        ret = LOS_ERRNO_QUEUE_IN_TSKUSE;
        goto QUEUE_END;
    }
 
    if (!LOS_ListEmpty(&queueCB->readWriteList[OS_QUEUE_WRITE])) {//尚有任务要写数据
        ret = LOS_ERRNO_QUEUE_IN_TSKUSE;
        goto QUEUE_END;
    }
 
    if (!LOS_ListEmpty(&queueCB->memList)) {//
        ret = LOS_ERRNO_QUEUE_IN_TSKUSE;
        goto QUEUE_END;
    }
 
    if ((queueCB->readWriteableCnt[OS_QUEUE_WRITE] + queueCB->readWriteableCnt[OS_QUEUE_READ]) !=
        queueCB->queueLen) {//读写队列的内容长度不等于总长度
        ret = LOS_ERRNO_QUEUE_IN_TSKWRITE;
        goto QUEUE_END;
    }
 
    queue = queueCB->queueHandle;   //队列buf
    queueCB->queueHandle = NULL;    //
    queueCB->queueState = OS_QUEUE_UNUSED;//重置队列状态
    queueCB->queueID = SET_QUEUE_ID(GET_QUEUE_COUNT(queueCB->queueID) + 1, GET_QUEUE_INDEX(queueCB->queueID));//@note_why 这里需要这样做吗?
    OsQueueDbgUpdateHook(queueCB->queueID, NULL);
 
    LOS_ListTailInsert(&g_freeQueueList, &queueCB->readWriteList[OS_QUEUE_WRITE]);//回收，将节点挂入可分配链表,等待重新被分配再利用
    SCHEDULER_UNLOCK(intSave);                                  
    OsHookCall(LOS_HOOK_TYPE_QUEUE_DELETE, queueCB);
    ret = LOS_MemFree(m_aucSysMem1, (VOID *)queue);//释放队列句柄
    return ret;
 
QUEUE_END:
    SCHEDULER_UNLOCK(intSave);
    return ret;
}

函数调用图:

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

◆ LOS_QueueInfoGet()

UINT32 LOS_QueueInfoGet	(	UINT32	queueID,
		QUEUE_INFO_S *	queueInfo
	)

Obtain queue information.

Description:: This API is used to obtain queue information.

注意

The specific queue should be created firstly.

参数

queueID	[IN] Queue ID created by LOS_QueueCreate. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
queueInfo	[OUT] The queue information to be read must not be null.

返回值

#LOS_OK	The queue information is successfully obtained.
#LOS_ERRNO_QUEUE_PTR_NULL	The pointer to the queue information to be obtained is null.
#LOS_ERRNO_QUEUE_INVALID	The handle of the queue that is being read is invalid.
#LOS_ERRNO_QUEUE_NOT_CREATE	The queue in which the information to be obtained is stored is not created.

Dependency:

los_queue.h: the header file that contains the API declaration.

参见: LOS_QueueCreate

Obtain queue information.

在文件 los_queue.c 第 542 行定义.

{
    UINT32 intSave;
    UINT32 ret = LOS_OK;
    LosQueueCB *queueCB = NULL;
    LosTaskCB *tskCB = NULL;
 
    if (queueInfo == NULL) {
        return LOS_ERRNO_QUEUE_PTR_NULL;
    }
 
    if (GET_QUEUE_INDEX(queueID) >= LOSCFG_BASE_IPC_QUEUE_LIMIT) {//1024
        return LOS_ERRNO_QUEUE_INVALID;
    }
 
    (VOID)memset_s((VOID *)queueInfo, sizeof(QUEUE_INFO_S), 0, sizeof(QUEUE_INFO_S));//接走数据之前先清0
    SCHEDULER_LOCK(intSave);
 
    queueCB = (LosQueueCB *)GET_QUEUE_HANDLE(queueID);//通过队列ID获取 QCB
    if ((queueCB->queueID != queueID) || (queueCB->queueState == OS_QUEUE_UNUSED)) {
        ret = LOS_ERRNO_QUEUE_NOT_CREATE;
        goto QUEUE_END;
    }
 
    queueInfo->uwQueueID = queueID;
    queueInfo->usQueueLen = queueCB->queueLen;
    queueInfo->usQueueSize = queueCB->queueSize;
    queueInfo->usQueueHead = queueCB->queueHead;
    queueInfo->usQueueTail = queueCB->queueTail;
    queueInfo->usReadableCnt = queueCB->readWriteableCnt[OS_QUEUE_READ];//可读数
    queueInfo->usWritableCnt = queueCB->readWriteableCnt[OS_QUEUE_WRITE];//可写数
 
    LOS_DL_LIST_FOR_EACH_ENTRY(tskCB, &queueCB->readWriteList[OS_QUEUE_READ], LosTaskCB, pendList) {//找出哪些task需要读消息
        queueInfo->uwWaitReadTask |= 1ULL << tskCB->taskID;//记录等待读消息的任务号, uwWaitReadTask 每一位代表一个任务编号
    }//0b..011011011 代表   0,1,3,4,6,7 号任务有数据等待读消息.
 
    LOS_DL_LIST_FOR_EACH_ENTRY(tskCB, &queueCB->readWriteList[OS_QUEUE_WRITE], LosTaskCB, pendList) {//找出哪些task需要写消息
        queueInfo->uwWaitWriteTask |= 1ULL << tskCB->taskID;//记录等待写消息的任务号, uwWaitWriteTask 每一位代表一个任务编号
    }////0b..011011011 代表   0,1,3,4,6,7 号任务有数据等待写消息.
 
    LOS_DL_LIST_FOR_EACH_ENTRY(tskCB, &queueCB->memList, LosTaskCB, pendList) {//同上
        queueInfo->uwWaitMemTask |= 1ULL << tskCB->taskID; //MailBox模块使用
    }
 
QUEUE_END:
    SCHEDULER_UNLOCK(intSave);
    return ret;
}

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

◆ LOS_QueueRead()

UINT32 LOS_QueueRead	(	UINT32	queueID,
		VOID *	bufferAddr,
		UINT32	bufferSize,
		UINT32	timeout
	)

Read a queue.

Description:: This API is used to read the address of data in a specified queue, and store it to the address specified by bufferAddr.

注意

The specific queue should be created firstly.
Queue reading adopts the fist in first out (FIFO) mode. The data that is first stored in the queue is read first.
bufferAddr stores the obtained data address.
Do not read or write a queue in unblocking modes such as an interrupt.
This API cannot be called before the Huawei LiteOS is initialized.
The argument timeout is a relative time.
The bufferSize is not really used in LOS_QueueRead, because the interface is only used to obtain the address of data.
The buffer which the bufferAddr pointing to must be greater than or equal to 4 bytes.
Do not call this API in software timer callback.

参数

queueID	[IN] Queue ID created by LOS_QueueCreate. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
bufferAddr	[OUT] Starting address that stores the obtained data. The starting address must not be null.
bufferSize	[IN] Passed-in buffer size,The value range is [sizeof(CHAR*),OS_NULL_SHORT - sizeof(UINT32)].
timeout	[IN] Expiry time. The value range is [0,LOS_WAIT_FOREVER](unit: Tick).

返回值

#LOS_OK	The queue is successfully read.
#LOS_ERRNO_QUEUE_INVALID	The handle of the queue that is being read is invalid.
#LOS_ERRNO_QUEUE_READ_PTR_NULL	The pointer passed in during queue reading is null.
#LOS_ERRNO_QUEUE_READSIZE_IS_INVALID	The buffer size passed in during queue reading is invalid.
#LOS_ERRNO_QUEUE_READ_IN_INTERRUPT	The queue cannot be read during an interrupt when the time for waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_NOT_CREATE	The queue to be read is not created.
#LOS_ERRNO_QUEUE_ISEMPTY	No resource is in the queue that is being read when the time for waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_PEND_IN_LOCK	The task is forbidden to be blocked on a queue when the task is locked.
#LOS_ERRNO_QUEUE_TIMEOUT	The time set for waiting to processing the queue expires.

Dependency:

los_queue.h: The header file that contains the API declaration.

参见: LOS_QueueWrite | LOS_QueueCreate

   外部接口 读一个队列数据
   读队列时，根据Head找到最先写入队列中的消息节点进行读取。如果Head已经指向队列尾则采用回卷方式。
   根据usReadableCnt判断队列是否有消息读取，对全部空闲（usReadableCnt为0）队列进行读队列操作会引起任务挂起。
*

在文件 los_queue.c 第 436 行定义.

{
    return LOS_QueueReadCopy(queueID, bufferAddr, &bufferSize, timeout);
}

函数调用图:

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

◆ LOS_QueueReadCopy()

UINT32 LOS_QueueReadCopy	(	UINT32	queueID,
		VOID *	bufferAddr,
		UINT32 *	bufferSize,
		UINT32	timeout
	)

Read a queue.

Description:: This API is used to read data in a specified queue, and store the obtained data to the address specified by bufferAddr. The address and the size of the data to be read are defined by users.

注意

The specific queue should be created firstly.
Queue reading adopts the fist in first out (FIFO) mode. The data that is first stored in the queue is read first.
bufferAddr stores the obtained data.
Do not read or write a queue in unblocking modes such as an interrupt.
This API cannot be called before the Huawei LiteOS is initialized.
The argument timeout is a relative time.
Do not call this API in software timer callback.

参数

queueID	[IN] Queue ID created by LOS_QueueCreate. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
bufferAddr	[OUT] Starting address that stores the obtained data. The starting address must not be null.
bufferSize	[IN/OUT] Where to maintain the buffer wanted-size before read, and the real-size after read.
timeout	[IN] Expiry time. The value range is [0,LOS_WAIT_FOREVER](unit: Tick).

返回值

#LOS_OK	The queue is successfully read.
#LOS_ERRNO_QUEUE_INVALID	The handle of the queue that is being read is invalid.
#LOS_ERRNO_QUEUE_READ_PTR_NULL	The pointer passed in during queue reading is null.
#LOS_ERRNO_QUEUE_READSIZE_IS_INVALID	The buffer size passed in during queue reading is invalid.
#LOS_ERRNO_QUEUE_READ_IN_INTERRUPT	The queue cannot be read during an interrupt when the time for waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_NOT_CREATE	The queue to be read is not created.
#LOS_ERRNO_QUEUE_ISEMPTY	No resource is in the queue that is being read when the time for waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_PEND_IN_LOCK	The task is forbidden to be blocked on a queue when the task is locked.
#LOS_ERRNO_QUEUE_TIMEOUT	The time set for waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_READ_SIZE_TOO_SMALL	The buffer size passed in during queue reading is less than the queue size.

Dependency:

los_queue.h: the header file that contains the API declaration.

参见: LOS_QueueWriteCopy | LOS_QueueCreate

Read a queue.

在文件 los_queue.c 第 377 行定义.

{
    UINT32 ret;
    UINT32 operateType;
 
    ret = OsQueueReadParameterCheck(queueID, bufferAddr, bufferSize, timeout);//参数检查
    if (ret != LOS_OK) {
        return ret;
    }
 
    operateType = OS_QUEUE_OPERATE_TYPE(OS_QUEUE_READ, OS_QUEUE_HEAD);//从头开始读
    return OsQueueOperate(queueID, operateType, bufferAddr, bufferSize, timeout);//定时执行读操作
}

函数调用图:

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

◆ LOS_QueueWrite()

UINT32 LOS_QueueWrite	(	UINT32	queueID,
		VOID *	bufferAddr,
		UINT32	bufferSize,
		UINT32	timeout
	)

Write data into a queue.

Description:: This API is used to write the address of data specified by bufferAddr into a queue.

注意

The specific queue should be created firstly.
Do not read or write a queue in unblocking modes such as an interrupt.
This API cannot be called before the Huawei LiteOS is initialized.
The address of the data of the size specified by bufferSize and stored at the address specified by bufferAddr is to be written.
The argument timeout is a relative time.
The bufferSize is not really used in LOS_QueueWrite, because the interface is only used to write the address of data specified by bufferAddr into a queue.
Do not call this API in software timer callback.

参数

queueID	[IN] Queue ID created by LOS_QueueCreate. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
bufferAddr	[IN] Starting address that stores the data to be written. The starting address must not be null.
bufferSize	[IN] This parameter is not in use temporarily.
timeout	[IN] Expiry time. The value range is [0,LOS_WAIT_FOREVER](unit: Tick).

返回值

#LOS_OK	The data is successfully written into the queue.
#LOS_ERRNO_QUEUE_INVALID	The queue handle passed in during queue writing is invalid.
#LOS_ERRNO_QUEUE_WRITE_PTR_NULL	The pointer passed in during queue writing is null.
#LOS_ERRNO_QUEUE_WRITESIZE_ISZERO	The buffer size passed in during queue writing is 0.
#LOS_ERRNO_QUEUE_WRITE_IN_INTERRUPT	The queue cannot be written during an interrupt when the time for waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_NOT_CREATE	The queue into which the data is written is not created.
#LOS_ERRNO_QUEUE_WRITE_SIZE_TOO_BIG	The buffer size passed in during queue writing is bigger than the queue size.
#LOS_ERRNO_QUEUE_ISFULL	No free node is available during queue writing.
#LOS_ERRNO_QUEUE_PEND_IN_LOCK	The task is forbidden to be blocked on a queue when the task is locked.
#LOS_ERRNO_QUEUE_TIMEOUT	The time set for waiting to processing the queue expires.

Dependency:

los_queue.h: The header file that contains the API declaration.

参见: LOS_QueueRead | LOS_QueueCreate

   外部接口 写一个队列数据
   根据Tail找到被占用消息节点末尾的空闲节点作为数据写入对象。如果Tail已经指向队列尾则采用回卷方式。
   根据usWritableCnt判断队列是否可以写入，不能对已满（usWritableCnt为0）队列进行写队列操作
*

在文件 los_queue.c 第 449 行定义.

{
    if (bufferAddr == NULL) {
        return LOS_ERRNO_QUEUE_WRITE_PTR_NULL;
    }
    bufferSize = sizeof(CHAR *);
    return LOS_QueueWriteCopy(queueID, &bufferAddr, bufferSize, timeout);
}

函数调用图:

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

◆ LOS_QueueWriteCopy()

UINT32 LOS_QueueWriteCopy	(	UINT32	queueID,
		VOID *	bufferAddr,
		UINT32	bufferSize,
		UINT32	timeout
	)

Write data into a queue.

Description:: This API is used to write the data of the size specified by bufferSize and stored at the address specified by bufferAddr into a queue.

注意

The specific queue should be created firstly.
Do not read or write a queue in unblocking modes such as interrupt.
This API cannot be called before the Huawei LiteOS is initialized.
The data to be written is of the size specified by bufferSize and is stored at the address specified by bufferAddr.
The argument timeout is a relative time.
Do not call this API in software timer callback.

参数

queueID	[IN] Queue ID created by LOS_QueueCreate. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
bufferAddr	[IN] Starting address that stores the data to be written.The starting address must not be null.
bufferSize	[IN] Passed-in buffer size. The value range is [1,USHRT_MAX - sizeof(UINT32)].
timeout	[IN] Expiry time. The value range is [0,LOS_WAIT_FOREVER](unit: Tick).

返回值

#LOS_OK	The data is successfully written into the queue.
#LOS_ERRNO_QUEUE_INVALID	The queue handle passed in during queue writing is invalid.
#LOS_ERRNO_QUEUE_WRITE_PTR_NULL	The pointer passed in during queue writing is null.
#LOS_ERRNO_QUEUE_WRITESIZE_ISZERO	The buffer size passed in during queue writing is 0.
#LOS_ERRNO_QUEUE_WRITE_IN_INTERRUPT	The queue cannot be written during an interrupt when the time for waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_NOT_CREATE	The queue into which the data is written is not created.
#LOS_ERRNO_QUEUE_WRITE_SIZE_TOO_BIG	The buffer size passed in during queue writing is bigger than the queue size.
#LOS_ERRNO_QUEUE_ISFULL	No free node is available during queue writing.
#LOS_ERRNO_QUEUE_PEND_IN_LOCK	The task is forbidden to be blocked on a queue when the task is locked.
#LOS_ERRNO_QUEUE_TIMEOUT	The time set for waiting to processing the queue expires.

Dependency:

los_queue.h: the header file that contains the API declaration.

参见: LOS_QueueReadCopy | LOS_QueueCreate

Write data into a queue.

在文件 los_queue.c 第 411 行定义.

{
    UINT32 ret;
    UINT32 operateType;
 
    ret = OsQueueWriteParameterCheck(queueID, bufferAddr, &bufferSize, timeout);//参数检查
    if (ret != LOS_OK) {
        return ret;
    }
 
    operateType = OS_QUEUE_OPERATE_TYPE(OS_QUEUE_WRITE, OS_QUEUE_TAIL);//从尾部开始写
    return OsQueueOperate(queueID, operateType, bufferAddr, &bufferSize, timeout);//执行写操作
}

函数调用图:

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

◆ LOS_QueueWriteHead()

UINT32 LOS_QueueWriteHead	(	UINT32	queueID,
		VOID *	bufferAddr,
		UINT32	bufferSize,
		UINT32	timeout
	)

Write data into a queue header.

Description:: This API is used to write the data of the size specified by bufferSize and stored at the address specified by bufferAddr into a queue header.

注意

Do not read or write a queue in unblocking modes such as an interrupt.
This API cannot be called before the Huawei LiteOS is initialized.
The address of the data of the size specified by bufferSize and stored at the address specified by bufferAddr is to be written.
The argument timeout is a relative time.
LOS_QueueRead and LOS_QueueWriteHead are a set of interfaces, and the two groups of interfaces need to be used.
Do not call this API in software timer callback.

参数

queueID	[IN] Queue ID created by LOS_QueueCreate. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
bufferAddr	[OUT] Starting address that stores the data to be written. The starting address must not be null.
bufferSize	[IN] This parameter is not in use temporarily.
timeout	[IN] Expiry time. The value range is [0,LOS_WAIT_FOREVER](unit: Tick).

返回值

#LOS_OK	The data is successfully written into the queue.
#LOS_ERRNO_QUEUE_INVALID	The queue handle passed in during queue writing is invalid.
#LOS_ERRNO_QUEUE_WRITE_PTR_NULL	The pointer passed in during queue writing is null.
#LOS_ERRNO_QUEUE_WRITESIZE_ISZERO	The buffer size passed in during queue writing is 0.
#LOS_ERRNO_QUEUE_WRITE_IN_INTERRUPT	The queue cannot be written during an interrupt when the time for waiting to processing the queue expires. waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_NOT_CREATE	The queue into which the data is written is not created.
#LOS_ERRNO_QUEUE_WRITE_SIZE_TOO_BIG	The buffer size passed in during queue writing is bigger than the queue size.
#LOS_ERRNO_QUEUE_ISFULL	No free node is available during queue writing.
#LOS_ERRNO_QUEUE_PEND_IN_LOCK	The task is forbidden to be blocked on a queue when the task is locked.
#LOS_ERRNO_QUEUE_TIMEOUT	The time set for waiting to processing the queue expires.

Dependency:

los_queue.h: The header file that contains the API declaration.

参见: LOS_QueueRead | LOS_QueueCreate

   外部接口 从头部写入
   写队列时，根据Tail找到被占用消息节点末尾的空闲节点作为数据写入对象。如果Tail已经指向队列尾则采用回卷方式。
   根据usWritableCnt判断队列是否可以写入，不能对已满（usWritableCnt为0）队列进行写队列操作
*

在文件 los_queue.c 第 466 行定义.

{
    if (bufferAddr == NULL) {
        return LOS_ERRNO_QUEUE_WRITE_PTR_NULL;
    }
    bufferSize = sizeof(CHAR *);
    return LOS_QueueWriteHeadCopy(queueID, &bufferAddr, bufferSize, timeout);
}

函数调用图:

◆ LOS_QueueWriteHeadCopy()

UINT32 LOS_QueueWriteHeadCopy	(	UINT32	queueID,
		VOID *	bufferAddr,
		UINT32	bufferSize,
		UINT32	timeout
	)

Write data into a queue header.

Description:: This API is used to write the data of the size specified by bufferSize and stored at the address specified by bufferAddr into a queue header.

注意

Do not read or write a queue in unblocking modes such as an interrupt.
This API cannot be called before the Huawei LiteOS is initialized.
The address of the data of the size specified by bufferSize and stored at the address specified by bufferAddr is to be written.
The argument timeout is a relative time.
LOS_QueueRead and LOS_QueueWriteHead are a set of interfaces, and the two groups of interfaces need to be used.
Do not call this API in software timer callback.

参数

queueID	[IN] Queue ID created by LOS_QueueCreate. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
bufferAddr	[OUT] Starting address that stores the data to be written. The starting address must not be null.
bufferSize	[IN] Passed-in buffer size, which must not be 0. The value range is [1,0xffffffff].
timeout	[IN] Expiry time. The value range is [0,LOS_WAIT_FOREVER](unit: Tick).

返回值

#LOS_OK	The data is successfully written into the queue.
#LOS_ERRNO_QUEUE_INVALID	The queue handle passed in during queue writing is invalid.
#LOS_ERRNO_QUEUE_WRITE_PTR_NULL	The pointer passed in during queue writing is null.
#LOS_ERRNO_QUEUE_WRITESIZE_ISZERO	The buffer size passed in during queue writing is 0.
#LOS_ERRNO_QUEUE_WRITE_IN_INTERRUPT	The queue cannot be written during an interrupt when the time for waiting to processing the queue expires.
#LOS_ERRNO_QUEUE_NOT_CREATE	The queue into which the data is written is not created.
#LOS_ERRNO_QUEUE_WRITE_SIZE_TOO_BIG	The buffer size passed in during queue writing is bigger than the queue size.
#LOS_ERRNO_QUEUE_ISFULL	No free node is available during queue writing.
#LOS_ERRNO_QUEUE_PEND_IN_LOCK	The task is forbidden to be blocked on a queue when the task is locked.
#LOS_ERRNO_QUEUE_TIMEOUT	The time set for waiting to processing the queue expires.

Dependency:

los_queue.h: The header file that contains the API declaration.

参见: LOS_QueueWrite | LOS_QueueWriteHead

Write data into a queue header.

在文件 los_queue.c 第 394 行定义.

{
    UINT32 ret;
    UINT32 operateType;
 
    ret = OsQueueWriteParameterCheck(queueID, bufferAddr, &bufferSize, timeout);//参数检查
    if (ret != LOS_OK) {
        return ret;
    }
 
    operateType = OS_QUEUE_OPERATE_TYPE(OS_QUEUE_WRITE, OS_QUEUE_HEAD);//从头开始写
    return OsQueueOperate(queueID, operateType, bufferAddr, &bufferSize, timeout);//执行写操作
}

函数调用图:

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

◆ OsQueueMailAlloc()

VOID * OsQueueMailAlloc	(	UINT32	queueID,
		VOID *	mailPool,
		UINT32	timeout
	)

Alloc a stationary memory for a mail.

Description:: This API is used to alloc a stationary memory for a mail according to queueID.

注意

Do not alloc memory in unblocking modes such as interrupt.
This API cannot be called before the Huawei LiteOS is initialized.
The argument timeout is a relative time.

参数

queueID	[IN] Queue ID. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
mailPool	[IN] The memory poll that stores the mail.
timeout	[IN] Expiry time. The value range is [0,LOS_WAIT_FOREVER].

返回值

#NULL	The memory allocation is failed.
#pMem	The address of alloc memory.

Dependency:

los_queue_pri.h: the header file that contains the API declaration.

参见: OsQueueMailFree

◆ OsQueueMailFree()

UINT32 OsQueueMailFree	(	UINT32	queueID,
		VOID *	mailPool,
		VOID *	mailMem
	)

Free a stationary memory of a mail.

Description:: This API is used to free a stationary memory for a mail according to queueID.

注意

This API cannot be called before the Huawei LiteOS is initialized.

参数

queueID	[IN] Queue ID. The value range is [1,LOSCFG_BASE_IPC_QUEUE_LIMIT].
mailPool	[IN] The mail memory poll address.
mailMem	[IN] The mail memory block address.

返回值

#LOS_OK	0x00000000: The memory free successfully.
#OS_ERRNO_QUEUE_MAIL_HANDLE_INVALID	0x02000619: The handle of the queue passed-in when the memory for the queue is being freed is invalid.
#OS_ERRNO_QUEUE_MAIL_PTR_INVALID	0x0200061a: The pointer to the memory to be freed is null.
#OS_ERRNO_QUEUE_MAIL_FREE_ERROR	0x0200061b: The memory for the queue fails to be freed.

Dependency:

los_queue_pri.h: the header file that contains the API declaration.

参见: OsQueueMailAlloc

变量说明

◆ g_allQueue

LosQueueCB* g_allQueue

extern

消息队列池

Queue information control block

在文件 los_queue.c 第 98 行定义.

结构体

类型定义

函数

变量

详细描述

类型定义说明

◆ QUEUE_INFO_S

函数说明

◆ LOS_QueueCreate()

◆ LOS_QueueDelete()

◆ LOS_QueueInfoGet()

◆ LOS_QueueRead()

◆ LOS_QueueReadCopy()

◆ LOS_QueueWrite()

◆ LOS_QueueWriteCopy()

◆ LOS_QueueWriteHead()

◆ LOS_QueueWriteHeadCopy()

◆ OsQueueMailAlloc()

◆ OsQueueMailFree()

变量说明

◆ g_allQueue