Messagequeue 的协作图:

结构体
struct	rt_messagequeue

struct	rt_mq_message

宏定义
#define	RT_MQ_BUF_SIZE(msg_size, max_msgs)

类型定义
typedef struct rt_messagequeue *	rt_mq_t

函数
rt_err_t	rt_mq_init (rt_mq_t mq, const char name, void msgpool, rt_size_t msg_size, rt_size_t pool_size, rt_uint8_t flag)

	RTM_EXPORT (rt_mq_init)

rt_err_t	rt_mq_detach (rt_mq_t mq)

	RTM_EXPORT (rt_mq_detach)

rt_mq_t	rt_mq_create (const char *name, rt_size_t msg_size, rt_size_t max_msgs, rt_uint8_t flag)

	RTM_EXPORT (rt_mq_create)

rt_err_t	rt_mq_delete (rt_mq_t mq)

	RTM_EXPORT (rt_mq_delete)

rt_err_t	rt_mq_send_wait (rt_mq_t mq, const void *buffer, rt_size_t size, rt_int32_t timeout)

	RTM_EXPORT (rt_mq_send_wait)

rt_err_t	rt_mq_send_wait_interruptible (rt_mq_t mq, const void *buffer, rt_size_t size, rt_int32_t timeout)

	RTM_EXPORT (rt_mq_send_wait_interruptible)

rt_err_t	rt_mq_send_wait_killable (rt_mq_t mq, const void *buffer, rt_size_t size, rt_int32_t timeout)

	RTM_EXPORT (rt_mq_send_wait_killable)

rt_err_t	rt_mq_send (rt_mq_t mq, const void *buffer, rt_size_t size)

	RTM_EXPORT (rt_mq_send)

rt_err_t	rt_mq_send_interruptible (rt_mq_t mq, const void *buffer, rt_size_t size)

	RTM_EXPORT (rt_mq_send_interruptible)

rt_err_t	rt_mq_send_killable (rt_mq_t mq, const void *buffer, rt_size_t size)

	RTM_EXPORT (rt_mq_send_killable)

rt_err_t	rt_mq_urgent (rt_mq_t mq, const void *buffer, rt_size_t size)

	RTM_EXPORT (rt_mq_urgent)

rt_ssize_t	rt_mq_recv (rt_mq_t mq, void *buffer, rt_size_t size, rt_int32_t timeout)

	RTM_EXPORT (rt_mq_recv)

rt_ssize_t	rt_mq_recv_interruptible (rt_mq_t mq, void *buffer, rt_size_t size, rt_int32_t timeout)

	RTM_EXPORT (rt_mq_recv_interruptible)

rt_ssize_t	rt_mq_recv_killable (rt_mq_t mq, void *buffer, rt_size_t size, rt_int32_t timeout)

	RTM_EXPORT (rt_mq_recv_killable)

rt_err_t	rt_mq_control (rt_mq_t mq, int cmd, void *arg)

	RTM_EXPORT (rt_mq_control)

详细描述

宏定义说明

◆ RT_MQ_BUF_SIZE

#define RT_MQ_BUF_SIZE	(		msg_size,
			max_msgs )

值:

((RT_ALIGN((msg_size), RT_ALIGN_SIZE) + sizeof(struct rt_mq_message)) * (max_msgs))

RT_ALIGN

#define RT_ALIGN(size, align)

定义 rtdef.h:255

rt_mq_message

定义 rtthread.h:566

在文件 rtthread.h 第 574 行定义.

574#define RT_MQ_BUF_SIZE(msg_size, max_msgs) \

575((RT_ALIGN((msg_size), RT_ALIGN_SIZE) + sizeof(struct rt_mq_message)) * (max_msgs))

类型定义说明

◆ rt_mq_t

typedef struct rt_messagequeue* rt_mq_t

在文件 rtdef.h 第 1126 行定义.

函数说明

◆ rt_mq_init()

rt_err_t rt_mq_init	(	rt_mq_t	mq,
		const char *	name,
		void *	msgpool,
		rt_size_t	msg_size,
		rt_size_t	pool_size,
		rt_uint8_t	flag )

Initialize a static messagequeue object.

注解: For the static messagequeue object, its memory space is allocated by the compiler during compiling, and shall placed on the read-write data segment or on the uninitialized data segment. By contrast, the rt_mq_create() function will allocate memory space automatically and initialize the messagequeue.

参见: rt_mq_create()

参数

mq	is a pointer to the messagequeue to initialize. It is assumed that storage for the messagequeue will be allocated in your application.
name	is a pointer to the name that given to the messagequeue.
msgpool	is a pointer to the starting address of the memory space you allocated for the messagequeue in advance. In other words, msgpool is a pointer to the messagequeue buffer of the starting address.
msg_size	is the maximum length of a message in the messagequeue (Unit: Byte).
pool_size	is the size of the memory space allocated for the messagequeue in advance.
flag	is the messagequeue flag, which determines the queuing way of how multiple threads wait when the messagequeue is not available. The messagequeue flag can be ONE of the following values: RT_IPC_FLAG_PRIO The pending threads will queue in order of priority. RT_IPC_FLAG_FIFO The pending threads will queue in the first-in-first-out method (also known as first-come-first-served (FCFS) scheduling strategy). NOTE: RT_IPC_FLAG_FIFO is a non-real-time scheduling mode. It is strongly recommended to use RT_IPC_FLAG_PRIO to ensure the thread is real-time UNLESS your applications concern about the first-in-first-out principle, and you clearly understand that all threads involved in this messagequeue will become non-real-time threads.

返回: Return the operation status. When the return value is RT_EOK, the initialization is successful. If the return value is any other values, it represents the initialization failed.

警告: This function can ONLY be called from threads.

在文件 ipc.c 第 3092 行定义.

{
    struct rt_mq_message *head;
    rt_base_t temp;
    register rt_size_t msg_align_size;
 
    /* parameter check */
    RT_ASSERT(mq != RT_NULL);
    RT_ASSERT((flag == RT_IPC_FLAG_FIFO) || (flag == RT_IPC_FLAG_PRIO));
 
    /* initialize object */
    rt_object_init(&(mq->parent.parent), RT_Object_Class_MessageQueue, name);
 
    /* set parent flag */
    mq->parent.parent.flag = flag;
 
    /* initialize ipc object */
    _ipc_object_init(&(mq->parent));
 
    /* set message pool */
    mq->msg_pool = msgpool;
 
    /* get correct message size */
    msg_align_size = RT_ALIGN(msg_size, RT_ALIGN_SIZE);
    mq->msg_size = msg_size;
    mq->max_msgs = pool_size / (msg_align_size + sizeof(struct rt_mq_message));
 
    if (0 == mq->max_msgs)
    {
        return -RT_EINVAL;
    }
 
    /* initialize message list */
    mq->msg_queue_head = RT_NULL;
    mq->msg_queue_tail = RT_NULL;
 
    /* initialize message empty list */
    mq->msg_queue_free = RT_NULL;
    for (temp = 0; temp < mq->max_msgs; temp ++)
    {
        head = (struct rt_mq_message *)((rt_uint8_t *)mq->msg_pool +
                                        temp * (msg_align_size + sizeof(struct rt_mq_message)));
        head->next = (struct rt_mq_message *)mq->msg_queue_free;
        mq->msg_queue_free = head;
    }
 
    /* the initial entry is zero */
    mq->entry = 0;
 
    /* initialize an additional list of sender suspend thread */
    rt_list_init(&(mq->suspend_sender_thread));
    rt_spin_lock_init(&(mq->spinlock));
 
    return RT_EOK;
}

引用了 _ipc_object_init(), rt_messagequeue::entry, rt_object::flag, rt_messagequeue::max_msgs, rt_messagequeue::msg_pool, rt_messagequeue::msg_queue_free, rt_messagequeue::msg_queue_head, rt_messagequeue::msg_queue_tail, rt_messagequeue::msg_size, rt_mq_message::next, rt_ipc_object::parent, rt_messagequeue::parent, RT_ALIGN, RT_ASSERT, RT_IPC_FLAG_FIFO, RT_IPC_FLAG_PRIO, rt_list_init(), RT_NULL, RT_Object_Class_MessageQueue, rt_object_init(), rt_spin_lock_init(), rt_messagequeue::spinlock , 以及 rt_messagequeue::suspend_sender_thread.

函数调用图:

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

◆ RTM_EXPORT() [1/15]

RTM_EXPORT ( rt_mq_init )

引用了 rt_mq_init().

函数调用图:

◆ rt_mq_detach()

rt_err_t rt_mq_detach ( rt_mq_t mq )

This function will detach a static messagequeue object.

注解: This function is used to detach a static messagequeue object which is initialized by rt_mq_init() function. By contrast, the rt_mq_delete() function will delete a messagequeue object. When the messagequeue is successfully detached, it will resume all suspended threads in the messagequeue list.

参见: rt_mq_delete()

参数

mq	is a pointer to a messagequeue object to be detached.

返回: Return the operation status. When the return value is RT_EOK, the initialization is successful. If the return value is any other values, it means that the messagequeue detach failed.

警告: This function can ONLY detach a static messagequeue initialized by the rt_mq_init() function. If the messagequeue is created by the rt_mq_create() function, you MUST NOT USE this function to detach it, and ONLY USE the rt_mq_delete() function to complete the deletion.

在文件 ipc.c 第 3173 行定义.

{
    rt_base_t level;
 
    /* parameter check */
    RT_ASSERT(mq != RT_NULL);
    RT_ASSERT(rt_object_get_type(&mq->parent.parent) == RT_Object_Class_MessageQueue);
    RT_ASSERT(rt_object_is_systemobject(&mq->parent.parent));
 
    level = rt_spin_lock_irqsave(&(mq->spinlock));
    /* resume all suspended thread */
    rt_susp_list_resume_all(&mq->parent.suspend_thread, RT_ERROR);
    /* also resume all message queue private suspended thread */
    rt_susp_list_resume_all(&(mq->suspend_sender_thread), RT_ERROR);
    rt_spin_unlock_irqrestore(&(mq->spinlock), level);
 
    /* detach message queue object */
    rt_object_detach(&(mq->parent.parent));
 
    return RT_EOK;
}

引用了 rt_ipc_object::parent, rt_messagequeue::parent, RT_ASSERT, RT_NULL, RT_Object_Class_MessageQueue, rt_object_detach(), rt_object_get_type(), rt_object_is_systemobject(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore(), rt_susp_list_resume_all(), rt_messagequeue::spinlock, rt_messagequeue::suspend_sender_thread , 以及 rt_ipc_object::suspend_thread.

函数调用图:

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

◆ RTM_EXPORT() [2/15]

RTM_EXPORT ( rt_mq_detach )

引用了 rt_mq_detach().

函数调用图:

◆ rt_mq_create()

rt_mq_t rt_mq_create	(	const char *	name,
		rt_size_t	msg_size,
		rt_size_t	max_msgs,
		rt_uint8_t	flag )

Creating a messagequeue object.

注解: For the messagequeue object, its memory space is allocated automatically. By contrast, the rt_mq_init() function will initialize a static messagequeue object.

参见: rt_mq_init()

参数

name	is a pointer that given to the messagequeue.
msg_size	is the maximum length of a message in the messagequeue (Unit: Byte).
max_msgs	is the maximum number of messages in the messagequeue.
flag	is the messagequeue flag, which determines the queuing way of how multiple threads wait when the messagequeue is not available. The messagequeue flag can be ONE of the following values: RT_IPC_FLAG_PRIO The pending threads will queue in order of priority. RT_IPC_FLAG_FIFO The pending threads will queue in the first-in-first-out method (also known as first-come-first-served (FCFS) scheduling strategy). NOTE: RT_IPC_FLAG_FIFO is a non-real-time scheduling mode. It is strongly recommended to use RT_IPC_FLAG_PRIO to ensure the thread is real-time UNLESS your applications concern about the first-in-first-out principle, and you clearly understand that all threads involved in this messagequeue will become non-real-time threads.

返回: Return a pointer to the messagequeue object. When the return value is RT_NULL, it means the creation failed.

警告: This function can NOT be called in interrupt context. You can use macor RT_DEBUG_NOT_IN_INTERRUPT to check it.

在文件 ipc.c 第 3229 行定义.

{
    struct rt_messagequeue *mq;
    struct rt_mq_message *head;
    rt_base_t temp;
    register rt_size_t msg_align_size;
 
    RT_ASSERT((flag == RT_IPC_FLAG_FIFO) || (flag == RT_IPC_FLAG_PRIO));
 
    RT_DEBUG_NOT_IN_INTERRUPT;
 
    /* allocate object */
    mq = (rt_mq_t)rt_object_allocate(RT_Object_Class_MessageQueue, name);
    if (mq == RT_NULL)
        return mq;
 
    /* set parent */
    mq->parent.parent.flag = flag;
 
    /* initialize ipc object */
    _ipc_object_init(&(mq->parent));
 
    /* initialize message queue */
 
    /* get correct message size */
    msg_align_size = RT_ALIGN(msg_size, RT_ALIGN_SIZE);
    mq->msg_size = msg_size;
    mq->max_msgs = max_msgs;
 
    /* allocate message pool */
    mq->msg_pool = RT_KERNEL_MALLOC((msg_align_size + sizeof(struct rt_mq_message)) * mq->max_msgs);
    if (mq->msg_pool == RT_NULL)
    {
        rt_object_delete(&(mq->parent.parent));
 
        return RT_NULL;
    }
 
    /* initialize message list */
    mq->msg_queue_head = RT_NULL;
    mq->msg_queue_tail = RT_NULL;
 
    /* initialize message empty list */
    mq->msg_queue_free = RT_NULL;
    for (temp = 0; temp < mq->max_msgs; temp ++)
    {
        head = (struct rt_mq_message *)((rt_uint8_t *)mq->msg_pool +
                                        temp * (msg_align_size + sizeof(struct rt_mq_message)));
        head->next = (struct rt_mq_message *)mq->msg_queue_free;
        mq->msg_queue_free = head;
    }
 
    /* the initial entry is zero */
    mq->entry = 0;
 
    /* initialize an additional list of sender suspend thread */
    rt_list_init(&(mq->suspend_sender_thread));
    rt_spin_lock_init(&(mq->spinlock));
 
    return mq;
}

引用了 _ipc_object_init(), rt_messagequeue::entry, rt_object::flag, rt_messagequeue::max_msgs, rt_messagequeue::msg_pool, rt_messagequeue::msg_queue_free, rt_messagequeue::msg_queue_head, rt_messagequeue::msg_queue_tail, rt_messagequeue::msg_size, rt_mq_message::next, rt_ipc_object::parent, rt_messagequeue::parent, RT_ALIGN, RT_ASSERT, RT_DEBUG_NOT_IN_INTERRUPT, RT_IPC_FLAG_FIFO, RT_IPC_FLAG_PRIO, RT_KERNEL_MALLOC, rt_list_init(), RT_NULL, rt_object_allocate(), RT_Object_Class_MessageQueue, rt_object_delete(), rt_spin_lock_init(), rt_messagequeue::spinlock , 以及 rt_messagequeue::suspend_sender_thread.

函数调用图:

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

◆ RTM_EXPORT() [3/15]

RTM_EXPORT ( rt_mq_create )

引用了 rt_mq_create().

函数调用图:

◆ rt_mq_delete()

rt_err_t rt_mq_delete ( rt_mq_t mq )

This function will delete a messagequeue object and release the memory.

注解: This function is used to delete a messagequeue object which is created by the rt_mq_create() function. By contrast, the rt_mq_detach() function will detach a static messagequeue object. When the messagequeue is successfully deleted, it will resume all suspended threads in the messagequeue list.

参见: rt_mq_detach()

参数

mq	is a pointer to a messagequeue object to be deleted.

返回: Return the operation status. When the return value is RT_EOK, the operation is successful. If the return value is any other values, it means that the messagequeue detach failed.

警告: This function can ONLY delete a messagequeue initialized by the rt_mq_create() function. If the messagequeue is initialized by the rt_mq_init() function, you MUST NOT USE this function to delete it, ONLY USE the rt_mq_detach() function to complete the detachment. for example,the rt_mq_create() function, it cannot be called in interrupt context.

在文件 ipc.c 第 3315 行定义.

{
    /* parameter check */
    RT_ASSERT(mq != RT_NULL);
    RT_ASSERT(rt_object_get_type(&mq->parent.parent) == RT_Object_Class_MessageQueue);
    RT_ASSERT(rt_object_is_systemobject(&mq->parent.parent) == RT_FALSE);
 
    RT_DEBUG_NOT_IN_INTERRUPT;
 
    rt_spin_lock(&(mq->spinlock));
    /* resume all suspended thread */
    rt_susp_list_resume_all(&(mq->parent.suspend_thread), RT_ERROR);
    /* also resume all message queue private suspended thread */
    rt_susp_list_resume_all(&(mq->suspend_sender_thread), RT_ERROR);
 
    rt_spin_unlock(&(mq->spinlock));
 
    /* free message queue pool */
    RT_KERNEL_FREE(mq->msg_pool);
 
    /* delete message queue object */
    rt_object_delete(&(mq->parent.parent));
 
    return RT_EOK;
}

引用了 rt_messagequeue::msg_pool, rt_ipc_object::parent, rt_messagequeue::parent, RT_ASSERT, RT_DEBUG_NOT_IN_INTERRUPT, RT_FALSE, RT_KERNEL_FREE, RT_NULL, RT_Object_Class_MessageQueue, rt_object_delete(), rt_object_get_type(), rt_object_is_systemobject(), rt_spin_lock(), rt_spin_unlock(), rt_susp_list_resume_all(), rt_messagequeue::spinlock, rt_messagequeue::suspend_sender_thread , 以及 rt_ipc_object::suspend_thread.

函数调用图:

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

◆ RTM_EXPORT() [4/15]

RTM_EXPORT ( rt_mq_delete )

引用了 rt_mq_delete(), RT_NULL , 以及 RT_Object_Class_MessageQueue.

函数调用图:

◆ rt_mq_send_wait()

rt_err_t rt_mq_send_wait	(	rt_mq_t	mq,
		const void *	buffer,
		rt_size_t	size,
		rt_int32_t	timeout )

在文件 ipc.c 第 3568 行定义.

{
    return _rt_mq_send_wait(mq, buffer, size, 0, timeout, RT_UNINTERRUPTIBLE);
}

引用了 RT_UNINTERRUPTIBLE.

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

◆ RTM_EXPORT() [5/15]

RTM_EXPORT ( rt_mq_send_wait )

引用了 rt_mq_send_wait().

函数调用图:

◆ rt_mq_send_wait_interruptible()

rt_err_t rt_mq_send_wait_interruptible	(	rt_mq_t	mq,
		const void *	buffer,
		rt_size_t	size,
		rt_int32_t	timeout )

在文件 ipc.c 第 3577 行定义.

{
    return _rt_mq_send_wait(mq, buffer, size, 0, timeout, RT_INTERRUPTIBLE);
}

引用了 RT_INTERRUPTIBLE.

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

◆ RTM_EXPORT() [6/15]

RTM_EXPORT ( rt_mq_send_wait_interruptible )

引用了 rt_mq_send_wait_interruptible().

函数调用图:

◆ rt_mq_send_wait_killable()

rt_err_t rt_mq_send_wait_killable	(	rt_mq_t	mq,
		const void *	buffer,
		rt_size_t	size,
		rt_int32_t	timeout )

在文件 ipc.c 第 3586 行定义.

{
    return _rt_mq_send_wait(mq, buffer, size, 0, timeout, RT_KILLABLE);
}

引用了 RT_KILLABLE.

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

◆ RTM_EXPORT() [7/15]

RTM_EXPORT ( rt_mq_send_wait_killable )

引用了 rt_mq_send_wait_killable().

函数调用图:

◆ rt_mq_send()

rt_err_t rt_mq_send	(	rt_mq_t	mq,
		const void *	buffer,
		rt_size_t	size )

This function will send a message to the messagequeue object. If there is a thread suspended on the messagequeue, the thread will be resumed.

注解: When using this function to send a message, if the messagequeue is fully used, the current thread will wait for a timeout. By contrast, when the messagequeue is fully used, the rt_mq_send_wait() function will return an error code immediately without waiting.

参见: rt_mq_send_wait()

参数

mq	is a pointer to the messagequeue object to be sent.
buffer	is the content of the message.
size	is the length of the message(Unit: Byte).

返回: Return the operation status. When the return value is RT_EOK, the operation is successful. If the return value is any other values, it means that the messagequeue detach failed.

警告: This function can be called in interrupt context and thread context.

在文件 ipc.c 第 3616 行定义.

{
    return rt_mq_send_wait(mq, buffer, size, 0);
}

引用了 rt_mq_send_wait().

函数调用图:

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

◆ RTM_EXPORT() [8/15]

RTM_EXPORT ( rt_mq_send )

引用了 rt_mq_send().

函数调用图:

◆ rt_mq_send_interruptible()

rt_err_t rt_mq_send_interruptible	(	rt_mq_t	mq,
		const void *	buffer,
		rt_size_t	size )

在文件 ipc.c 第 3622 行定义.

{
    return rt_mq_send_wait_interruptible(mq, buffer, size, 0);
}

引用了 rt_mq_send_wait_interruptible().

函数调用图:

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

◆ RTM_EXPORT() [9/15]

RTM_EXPORT ( rt_mq_send_interruptible )

引用了 rt_mq_send_interruptible().

函数调用图:

◆ rt_mq_send_killable()

rt_err_t rt_mq_send_killable	(	rt_mq_t	mq,
		const void *	buffer,
		rt_size_t	size )

在文件 ipc.c 第 3628 行定义.

{
    return rt_mq_send_wait_killable(mq, buffer, size, 0);
}

引用了 rt_mq_send_wait_killable().

函数调用图:

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

◆ RTM_EXPORT() [10/15]

RTM_EXPORT ( rt_mq_send_killable )

引用了 rt_mq_send_killable().

函数调用图:

◆ rt_mq_urgent()

rt_err_t rt_mq_urgent	(	rt_mq_t	mq,
		const void *	buffer,
		rt_size_t	size )

This function will send an urgent message to the messagequeue object.

注解: This function is almost the same as the rt_mq_send() function. The only difference is that when sending an urgent message, the message is placed at the head of the messagequeue so that the recipient can receive the urgent message first.

参见: rt_mq_send()

参数

mq	is a pointer to the messagequeue object to be sent.
buffer	is the content of the message.
size	is the length of the message(Unit: Byte).

返回: Return the operation status. When the return value is RT_EOK, the operation is successful. If the return value is any other values, it means that the mailbox detach failed.

在文件 ipc.c 第 3651 行定义.

{
    rt_base_t level;
    struct rt_mq_message *msg;
 
    /* parameter check */
    RT_ASSERT(mq != RT_NULL);
    RT_ASSERT(rt_object_get_type(&mq->parent.parent) == RT_Object_Class_MessageQueue);
    RT_ASSERT(buffer != RT_NULL);
    RT_ASSERT(size != 0);
 
    /* greater than one message size */
    if (size > mq->msg_size)
        return -RT_ERROR;
 
    RT_OBJECT_HOOK_CALL(rt_object_put_hook, (&(mq->parent.parent)));
 
    level = rt_spin_lock_irqsave(&(mq->spinlock));
 
    /* get a free list, there must be an empty item */
    msg = (struct rt_mq_message *)mq->msg_queue_free;
    /* message queue is full */
    if (msg == RT_NULL)
    {
        rt_spin_unlock_irqrestore(&(mq->spinlock), level);
 
        return -RT_EFULL;
    }
    /* move free list pointer */
    mq->msg_queue_free = msg->next;
 
    rt_spin_unlock_irqrestore(&(mq->spinlock), level);
 
    /* add the length */
    ((struct rt_mq_message *)msg)->length = size;
    /* copy buffer */
    rt_memcpy(GET_MESSAGEBYTE_ADDR(msg), buffer, size);
 
    level = rt_spin_lock_irqsave(&(mq->spinlock));
 
    /* link msg to the beginning of message queue */
    msg->next = (struct rt_mq_message *)mq->msg_queue_head;
    mq->msg_queue_head = msg;
 
    /* if there is no tail */
    if (mq->msg_queue_tail == RT_NULL)
        mq->msg_queue_tail = msg;
 
    if(mq->entry < RT_MQ_ENTRY_MAX)
    {
        /* increase message entry */
        mq->entry ++;
    }
    else
    {
        rt_spin_unlock_irqrestore(&(mq->spinlock), level);
        return -RT_EFULL; /* value overflowed */
    }
 
    /* resume suspended thread */
    if (!rt_list_isempty(&mq->parent.suspend_thread))
    {
        rt_susp_list_dequeue(&(mq->parent.suspend_thread), RT_EOK);
 
        rt_spin_unlock_irqrestore(&(mq->spinlock), level);
 
        rt_schedule();
 
        return RT_EOK;
    }
 
    rt_spin_unlock_irqrestore(&(mq->spinlock), level);
 
    return RT_EOK;
}

引用了 rt_messagequeue::entry, GET_MESSAGEBYTE_ADDR, rt_mq_message::length, rt_messagequeue::msg_queue_free, rt_messagequeue::msg_queue_head, rt_messagequeue::msg_queue_tail, rt_messagequeue::msg_size, rt_mq_message::next, rt_ipc_object::parent, rt_messagequeue::parent, RT_ASSERT, rt_list_isempty(), RT_MQ_ENTRY_MAX, RT_NULL, RT_Object_Class_MessageQueue, rt_object_get_type(), RT_OBJECT_HOOK_CALL, rt_schedule(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore(), rt_susp_list_dequeue(), rt_messagequeue::spinlock , 以及 rt_ipc_object::suspend_thread.

函数调用图:

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

◆ RTM_EXPORT() [11/15]

RTM_EXPORT ( rt_mq_urgent )

引用了 rt_mq_urgent(), RT_NULL , 以及 RT_Object_Class_MessageQueue.

函数调用图:

◆ rt_mq_recv()

rt_ssize_t rt_mq_recv	(	rt_mq_t	mq,
		void *	buffer,
		rt_size_t	size,
		rt_int32_t	timeout )

在文件 ipc.c 第 3920 行定义.

{
    return _rt_mq_recv(mq, buffer, size, 0, timeout, RT_UNINTERRUPTIBLE);
}

引用了 RT_UNINTERRUPTIBLE.

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

◆ RTM_EXPORT() [12/15]

RTM_EXPORT ( rt_mq_recv )

引用了 rt_mq_recv().

函数调用图:

◆ rt_mq_recv_interruptible()

rt_ssize_t rt_mq_recv_interruptible	(	rt_mq_t	mq,
		void *	buffer,
		rt_size_t	size,
		rt_int32_t	timeout )

在文件 ipc.c 第 3929 行定义.

{
    return _rt_mq_recv(mq, buffer, size, 0, timeout, RT_INTERRUPTIBLE);
}

引用了 RT_INTERRUPTIBLE.

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

◆ RTM_EXPORT() [13/15]

RTM_EXPORT ( rt_mq_recv_interruptible )

引用了 rt_mq_recv_interruptible().

函数调用图:

◆ rt_mq_recv_killable()

rt_ssize_t rt_mq_recv_killable	(	rt_mq_t	mq,
		void *	buffer,
		rt_size_t	size,
		rt_int32_t	timeout )

在文件 ipc.c 第 3938 行定义.

{
    return _rt_mq_recv(mq, buffer, size, 0, timeout, RT_KILLABLE);
}

引用了 RT_KILLABLE.

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

◆ RTM_EXPORT() [14/15]

RTM_EXPORT ( rt_mq_recv_killable )

引用了 rt_mq_recv_killable().

函数调用图:

◆ rt_mq_control()

rt_err_t rt_mq_control	(	rt_mq_t	mq,
		int	cmd,
		void *	arg )

This function will set some extra attributions of a messagequeue object.

注解: Currently this function only supports the RT_IPC_CMD_RESET command to reset the messagequeue.

参数

mq	is a pointer to a messagequeue object.
cmd	is a command used to configure some attributions of the messagequeue.
arg	is the argument of the function to execute the command.

返回: Return the operation status. When the return value is RT_EOK, the operation is successful. If the return value is any other values, it means that this function failed to execute.

在文件 ipc.c 第 3980 行定义.

{
    rt_base_t level;
    struct rt_mq_message *msg;
 
    RT_UNUSED(arg);
 
    /* parameter check */
    RT_ASSERT(mq != RT_NULL);
    RT_ASSERT(rt_object_get_type(&mq->parent.parent) == RT_Object_Class_MessageQueue);
 
    if (cmd == RT_IPC_CMD_RESET)
    {
        level = rt_spin_lock_irqsave(&(mq->spinlock));
 
        /* resume all waiting thread */
        rt_susp_list_resume_all(&mq->parent.suspend_thread, RT_ERROR);
        /* also resume all message queue private suspended thread */
        rt_susp_list_resume_all(&(mq->suspend_sender_thread), RT_ERROR);
 
        /* release all message in the queue */
        while (mq->msg_queue_head != RT_NULL)
        {
            /* get message from queue */
            msg = (struct rt_mq_message *)mq->msg_queue_head;
 
            /* move message queue head */
            mq->msg_queue_head = msg->next;
            /* reach queue tail, set to NULL */
            if (mq->msg_queue_tail == msg)
                mq->msg_queue_tail = RT_NULL;
 
            /* put message to free list */
            msg->next = (struct rt_mq_message *)mq->msg_queue_free;
            mq->msg_queue_free = msg;
        }
 
        /* clean entry */
        mq->entry = 0;
 
        rt_spin_unlock_irqrestore(&(mq->spinlock), level);
 
        rt_schedule();
 
        return RT_EOK;
    }
 
    return -RT_ERROR;
}

引用了 rt_messagequeue::entry, rt_messagequeue::msg_queue_free, rt_messagequeue::msg_queue_head, rt_messagequeue::msg_queue_tail, rt_mq_message::next, rt_ipc_object::parent, rt_messagequeue::parent, RT_ASSERT, RT_IPC_CMD_RESET, RT_NULL, RT_Object_Class_MessageQueue, rt_object_get_type(), rt_schedule(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore(), rt_susp_list_resume_all(), RT_UNUSED, rt_messagequeue::spinlock, rt_messagequeue::suspend_sender_thread , 以及 rt_ipc_object::suspend_thread.

函数调用图:

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

◆ RTM_EXPORT() [15/15]

RTM_EXPORT ( rt_mq_control )

引用了 rt_mq_control().

函数调用图:

结构体

宏定义

类型定义

函数

详细描述

宏定义说明

◆ RT_MQ_BUF_SIZE

类型定义说明

◆ rt_mq_t

函数说明

◆ rt_mq_init()

◆ RTM_EXPORT() [1/15]

◆ rt_mq_detach()

◆ RTM_EXPORT() [2/15]

◆ rt_mq_create()

◆ RTM_EXPORT() [3/15]

◆ rt_mq_delete()

◆ RTM_EXPORT() [4/15]

◆ rt_mq_send_wait()

◆ RTM_EXPORT() [5/15]

◆ rt_mq_send_wait_interruptible()

◆ RTM_EXPORT() [6/15]

◆ rt_mq_send_wait_killable()

◆ RTM_EXPORT() [7/15]

◆ rt_mq_send()

◆ RTM_EXPORT() [8/15]

◆ rt_mq_send_interruptible()

◆ RTM_EXPORT() [9/15]

◆ rt_mq_send_killable()

◆ RTM_EXPORT() [10/15]

◆ rt_mq_urgent()

◆ RTM_EXPORT() [11/15]

◆ rt_mq_recv()

◆ RTM_EXPORT() [12/15]

◆ rt_mq_recv_interruptible()

◆ RTM_EXPORT() [13/15]

◆ rt_mq_recv_killable()

◆ RTM_EXPORT() [14/15]

◆ rt_mq_control()

◆ RTM_EXPORT() [15/15]