rt-thread-official/components/drivers/ipc/waitqueue.c

201 lines
5.1 KiB
C
Raw Normal View History

2018-06-26 11:57:20 +08:00
/*
2021-03-08 18:19:04 +08:00
* Copyright (c) 2006-2021, RT-Thread Development Team
2018-06-26 11:57:20 +08:00
*
2018-10-14 19:37:18 +08:00
* SPDX-License-Identifier: Apache-2.0
2018-06-26 11:57:20 +08:00
*
* Change Logs:
* Date Author Notes
2021-03-08 18:19:04 +08:00
* 2018/06/26 Bernard Fix the wait queue issue when wakeup a soon
2018-06-26 11:57:20 +08:00
* to blocked thread.
* 2022-01-24 THEWON let rt_wqueue_wait return thread->error when using signal
2018-06-26 11:57:20 +08:00
*/
#include <stdint.h>
#include <rthw.h>
#include <rtdevice.h>
#include <rtservice.h>
2021-12-10 11:14:23 +08:00
/**
* @brief This function will insert a node to the wait queue.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param queue is a pointer to the wait queue.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param node is a pointer to the node to be inserted.
*/
void rt_wqueue_add(rt_wqueue_t *queue, struct rt_wqueue_node *node)
{
rt_base_t level;
level = rt_hw_interrupt_disable();
rt_list_insert_before(&(queue->waiting_list), &(node->list));
rt_hw_interrupt_enable(level);
}
2021-12-10 11:14:23 +08:00
/**
* @brief This function will remove a node from the wait queue.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param node is a pointer to the node to be removed.
*/
void rt_wqueue_remove(struct rt_wqueue_node *node)
{
rt_base_t level;
level = rt_hw_interrupt_disable();
rt_list_remove(&(node->list));
rt_hw_interrupt_enable(level);
}
2021-12-10 11:14:23 +08:00
/**
2021-12-14 14:16:26 +08:00
* @brief This function is the default wakeup function, but it doesn't do anything in actual.
* It always return 0, user should define their own wakeup function.
2021-12-10 11:15:20 +08:00
*
* @param wait is a pointer to the wait queue.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param key is the wakeup condition.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @return always return 0.
*/
int __wqueue_default_wake(struct rt_wqueue_node *wait, void *key)
{
return 0;
}
2021-12-10 11:14:23 +08:00
/**
* @brief This function will wake up a pending thread on the specified waiting queue that meets the conditions.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param queue is a pointer to the wait queue.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param key is the wakeup conditions, but it is not effective now, because
* default wakeup function always return 0.
* If user wants to use it, user should define their own wakeup function.
*/
void rt_wqueue_wakeup(rt_wqueue_t *queue, void *key)
{
rt_base_t level;
int need_schedule = 0;
2018-06-26 11:57:20 +08:00
rt_list_t *queue_list;
struct rt_list_node *node;
struct rt_wqueue_node *entry;
2018-06-26 11:57:20 +08:00
queue_list = &(queue->waiting_list);
level = rt_hw_interrupt_disable();
2018-06-26 11:57:20 +08:00
/* set wakeup flag in the queue */
queue->flag = RT_WQ_FLAG_WAKEUP;
if (!(rt_list_isempty(queue_list)))
{
2018-06-26 11:57:20 +08:00
for (node = queue_list->next; node != queue_list; node = node->next)
{
entry = rt_list_entry(node, struct rt_wqueue_node, list);
if (entry->wakeup(entry, key) == 0)
{
rt_thread_resume(entry->polling_thread);
need_schedule = 1;
rt_wqueue_remove(entry);
break;
}
}
}
rt_hw_interrupt_enable(level);
if (need_schedule)
rt_schedule();
}
2021-12-10 11:14:23 +08:00
/**
* @brief This function will join a thread to the specified waiting queue, the thread will holds a wait or
* timeout return on the specified wait queue.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param queue is a pointer to the wait queue.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param condition is parameters compatible with POSIX standard interface (currently meaningless, just pass in 0).
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @param msec is the timeout value, unit is millisecond.
2021-12-10 11:15:20 +08:00
*
2021-12-10 11:14:23 +08:00
* @return Return 0 if the thread is woken up.
*/
static int _rt_wqueue_wait(rt_wqueue_t *queue, int condition, int msec, int suspend_flag)
{
int tick;
rt_thread_t tid = rt_thread_self();
rt_timer_t tmr = &(tid->thread_timer);
struct rt_wqueue_node __wait;
rt_base_t level;
rt_err_t ret;
/* current context checking */
2022-01-26 21:39:06 +08:00
RT_DEBUG_SCHEDULER_AVAILABLE(RT_TRUE);
tick = rt_tick_from_millisecond(msec);
if ((condition) || (tick == 0))
return 0;
__wait.polling_thread = rt_thread_self();
__wait.key = 0;
__wait.wakeup = __wqueue_default_wake;
rt_list_init(&__wait.list);
level = rt_hw_interrupt_disable();
/* reset thread error */
tid->error = RT_EOK;
2018-06-26 11:57:20 +08:00
if (queue->flag == RT_WQ_FLAG_WAKEUP)
{
/* already wakeup */
goto __exit_wakeup;
}
ret = rt_thread_suspend_with_flag(tid, suspend_flag);
if (ret != RT_EOK)
{
rt_hw_interrupt_enable(level);
/* suspend failed */
return -RT_EINTR;
}
rt_wqueue_add(queue, &__wait);
/* start timer */
if (tick != RT_WAITING_FOREVER)
{
rt_timer_control(tmr,
RT_TIMER_CTRL_SET_TIME,
&tick);
rt_timer_start(tmr);
}
rt_hw_interrupt_enable(level);
rt_schedule();
level = rt_hw_interrupt_disable();
__exit_wakeup:
2021-02-22 10:11:42 +08:00
queue->flag = RT_WQ_FLAG_CLEAN;
rt_hw_interrupt_enable(level);
rt_wqueue_remove(&__wait);
return tid->error;
}
int rt_wqueue_wait(rt_wqueue_t *queue, int condition, int msec)
{
return _rt_wqueue_wait(queue, condition, msec, RT_UNINTERRUPTIBLE);
}
int rt_wqueue_wait_killable(rt_wqueue_t *queue, int condition, int msec)
{
return _rt_wqueue_wait(queue, condition, msec, RT_KILLABLE);
}
int rt_wqueue_wait_interruptible(rt_wqueue_t *queue, int condition, int msec)
{
return _rt_wqueue_wait(queue, condition, msec, RT_INTERRUPTIBLE);
}