pthread_cond.c

/*
 * Copyright (c) 2006-2024 RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2010-10-26     Bernard      the first version
 * 2022-06-27     xiangxistu   use atomic operation to protect pthread conditional variable
 */

#include <rthw.h>
#include <pthread.h>
#include "pthread_internal.h"

int pthread_condattr_destroy(pthread_condattr_t *attr)
{
    if (!attr)
        return EINVAL;

    return 0;
}
RTM_EXPORT(pthread_condattr_destroy);

int pthread_condattr_init(pthread_condattr_t *attr)
{
    if (!attr)
        return EINVAL;
    *attr = PTHREAD_PROCESS_PRIVATE;

    return 0;
}
RTM_EXPORT(pthread_condattr_init);

int pthread_condattr_getclock(const pthread_condattr_t *attr,
                              clockid_t *clock_id)
{
    return 0;
}
RTM_EXPORT(pthread_condattr_getclock);

int pthread_condattr_setclock(pthread_condattr_t *attr,
                              clockid_t clock_id)
{
    return 0;
}
RTM_EXPORT(pthread_condattr_setclock);

int pthread_condattr_getpshared(const pthread_condattr_t *attr, int *pshared)
{
    if (!attr || !pshared)
        return EINVAL;

    *pshared = PTHREAD_PROCESS_PRIVATE;

    return 0;
}
RTM_EXPORT(pthread_condattr_getpshared);

int pthread_condattr_setpshared(pthread_condattr_t *attr, int pshared)
{
    if ((pshared != PTHREAD_PROCESS_PRIVATE) &&
        (pshared != PTHREAD_PROCESS_SHARED))
    {
        return EINVAL;
    }

    if (pshared != PTHREAD_PROCESS_PRIVATE)
        return ENOSYS;

    return 0;
}
RTM_EXPORT(pthread_condattr_setpshared);

/**
 * @brief Initializes a condition variable.
 *
 * This function initializes the condition variable pointed to by `cond` with the attributes
 * specified by `attr`. If `attr` is NULL, the condition variable is initialized with the
 * default attributes.
 *
 * @param cond A pointer to the condition variable to be initialized.
 *             Must point to valid memory.
 * @param attr A pointer to the condition variable attributes object.
 *             If NULL, default attributes are used.
 *
 * @return
 * - `0` on success.
 * - A non-zero error code on failure, including:
 *   - `EINVAL`: Invalid attributes, invalid condition variable pointer, or semaphore init failed.
 *
 * @note
 * - The condition variable must not be used until it has been initialized.
 * - Each condition variable must be destroyed using `pthread_cond_destroy()`
 *   once it is no longer needed.
 *
 * @see pthread_cond_destroy, pthread_cond_wait, pthread_cond_signal, pthread_cond_broadcast
 */
int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr)
{
    rt_err_t result;
    char cond_name[RT_NAME_MAX];
    static rt_uint16_t cond_num = 0;

    /* parameter check */
    if (cond == RT_NULL)
        return EINVAL;
    if ((attr != RT_NULL) && (*attr != PTHREAD_PROCESS_PRIVATE))
        return EINVAL;

    rt_snprintf(cond_name, sizeof(cond_name), "cond%02d", cond_num++);

    /* use default value */
    if (attr == RT_NULL)
    {
        cond->attr = PTHREAD_PROCESS_PRIVATE;
    }
    else
    {
        cond->attr = *attr;
    }

    result = rt_sem_init(&cond->sem, cond_name, 0, RT_IPC_FLAG_FIFO);
    if (result != RT_EOK)
    {
        return EINVAL;
    }

    /* detach the object from system object container */
    rt_object_detach(&(cond->sem.parent.parent));
    cond->sem.parent.parent.type = RT_Object_Class_Semaphore;

    return 0;
}
RTM_EXPORT(pthread_cond_init);

/**
 * @brief Destroys a condition variable.
 *
 * This function destroys the condition variable pointed to by `cond`. After a condition
 * variable is destroyed, it must not be used until it is reinitialized with
 * `pthread_cond_init`.
 *
 * @param cond A pointer to the condition variable to be destroyed.
 *             Must point to a valid, previously initialized condition variable.
 *
 * @return
 * - `0` on success.
 * - A non-zero error code on failure, including:
 *   - `EBUSY`: The condition variable is currently in use by other threads.
 *   - `EINVAL`: The condition variable is invalid or uninitialized.
 *
 * @note
 * - The condition variable must not be destroyed while it is being used by other threads
 *   (e.g., in `pthread_cond_wait` or `pthread_cond_timedwait`).
 * - Attempting to destroy a condition variable that has not been initialized results in
 *   undefined behavior.
 *
 * @see pthread_cond_init, pthread_cond_wait, pthread_cond_signal, pthread_cond_broadcast
 */
int pthread_cond_destroy(pthread_cond_t *cond)
{
    rt_err_t result;
    if (cond == RT_NULL)
    {
        return EINVAL;
    }
    /* which is not initialized */
    if (cond->attr == -1)
    {
        return 0;
    }

    if (!rt_list_isempty(&cond->sem.parent.suspend_thread))
    {
        return EBUSY;
    }
__retry:
    result = rt_sem_trytake(&(cond->sem));
    if (result == EBUSY)
    {
        pthread_cond_broadcast(cond);
        goto __retry;
    }

    /* clean condition */
    rt_memset(cond, 0, sizeof(pthread_cond_t));
    cond->attr = -1;

    return 0;
}
RTM_EXPORT(pthread_cond_destroy);

/**
 * @brief Unblocks all threads waiting on the specified condition variable.
 *
 * This function wakes up all threads that are currently blocked on the condition variable
 * pointed to by `cond`. The condition variable must be associated with a mutex, and
 * threads waiting on the condition variable should recheck the condition after being
 * unblocked.
 *
 * @param cond A pointer to the condition variable.
 *             Must point to a valid, initialized condition variable.
 *
 * @return
 * - `0` on success.
 * - A non-zero error code on failure, including:
 *   - `EINVAL`: The condition variable is invalid or uninitialized.
 *
 * @note
 * - Calling this function does not release the associated mutex.
 * - Waking up threads does not guarantee that any specific thread will acquire the
 *   mutex immediately, as thread scheduling depends on the system.
 * - Typically used when the condition might allow multiple waiting threads to proceed.
 *
 * @see pthread_cond_signal, pthread_cond_wait, pthread_cond_init, pthread_cond_destroy
 */
int pthread_cond_broadcast(pthread_cond_t *cond)
{
    rt_err_t result;

    if (cond == RT_NULL)
        return EINVAL;
    if (cond->attr == -1)
        pthread_cond_init(cond, RT_NULL);

    while (1)
    {
        /* try to take condition semaphore */
        result = rt_sem_trytake(&(cond->sem));
        if (result == -RT_ETIMEOUT)
        {
            /* it's timeout, release this semaphore */
            rt_sem_release(&(cond->sem));
        }
        else if (result == RT_EOK)
        {
            /* has taken this semaphore, release it */
            rt_sem_release(&(cond->sem));
            break;
        }
        else
        {
            return EINVAL;
        }
    }

    return 0;
}
RTM_EXPORT(pthread_cond_broadcast);

/**
 * @brief Wakes up one thread waiting on the specified condition variable.
 *
 * This function unblocks one thread that is currently waiting on the
 * condition variable `cond`. If multiple threads are waiting, the thread to wake
 * up is determined by the system's scheduling policies.
 *
 * @param cond A pointer to the condition variable to signal.
 *             Must point to a valid and initialized condition variable.
 *
 * @return
 * - `0` on success.
 * - A non-zero error code on failure, including:
 *   - `EINVAL`: The condition variable is invalid or uninitialized.
 *
 * @note
 * - This function does not release the associated mutex.
 * - If no threads are currently waiting on the condition variable, the call has no effect.
 * - The awakened thread will not run until it can reacquire the associated mutex and
 *   re-evaluate the waiting condition.
 * - It is typically used when only one waiting thread should be allowed to proceed.
 *
 * @see pthread_cond_broadcast, pthread_cond_wait, pthread_cond_init, pthread_cond_destroy
 */
int pthread_cond_signal(pthread_cond_t *cond)
{
    rt_base_t temp;
    rt_err_t result;

    if (cond == RT_NULL)
        return EINVAL;
    if (cond->attr == -1)
        pthread_cond_init(cond, RT_NULL);

    /* disable interrupt */
    temp = rt_hw_interrupt_disable();
    if (rt_list_isempty(&cond->sem.parent.suspend_thread))
    {
        /* enable interrupt */
        rt_hw_interrupt_enable(temp);
        return 0;
    }
    else
    {
        /* enable interrupt */
        rt_hw_interrupt_enable(temp);
        result = rt_sem_release(&(cond->sem));
        if (result == RT_EOK)
        {
            return 0;
        }

        return 0;
    }
}
RTM_EXPORT(pthread_cond_signal);

/**
 * @brief Waits on a condition variable with a timeout.
 *
 * This function causes the calling thread to block on the condition variable `cond`,
 * releasing the associated mutex `mutex`. The thread will remain blocked until
 * one of the following occurs:
 * - It is signaled or broadcast using `pthread_cond_signal` or `pthread_cond_broadcast`.
 * - The specified timeout expires.
 *
 * @param cond A pointer to the condition variable to wait on.
 *             Must point to a valid, initialized condition variable.
 * @param mutex A pointer to the mutex associated with the condition variable.
 *              Must be locked by the calling thread before invoking this function.
 * @param timeout The timeout duration in milliseconds. A value of `RT_WAITING_FOREVER`
 *                indicates the thread will wait indefinitely.
 *
 * @return
 * - `RT_EOK` on successful wakeup (signaled or broadcast).
 * - `-RT_ETIMEOUT` if the timeout expires before the condition variable is signaled.
 * - `-RT_ERROR` if an error occurs (e.g., invalid parameters).
 *
 * @note
 * - The mutex is automatically released while the thread waits and re-acquired before
 *   the function returns.
 * - If `timeout` is 0, the function behaves as a non-blocking check.
 * - Ensure the condition variable and mutex are properly initialized before use.
 *
 * @see pthread_cond_signal, pthread_cond_broadcast, pthread_mutex_lock, pthread_mutex_unlock
 */
rt_err_t _pthread_cond_timedwait(pthread_cond_t *cond,
                                 pthread_mutex_t *mutex,
                                 rt_int32_t timeout)
{
    rt_err_t result = RT_EOK;
    rt_sem_t sem;
    rt_int32_t time;

    sem = &(cond->sem);
    if (sem == RT_NULL)
    {
        return -RT_ERROR;
    }
    time = timeout;

    if (!cond || !mutex)
    {
        return -RT_ERROR;
    }
    /* check whether initialized */
    if (cond->attr == -1)
    {
        pthread_cond_init(cond, RT_NULL);
    }

    /* The mutex was not owned by the current thread at the time of the call. */
    if (mutex->lock.owner != rt_thread_self())
    {
        return -RT_ERROR;
    }

    {
        struct rt_thread *thread;

        /* parameter check */
        RT_ASSERT(sem != RT_NULL);
        RT_ASSERT(rt_object_get_type(&sem->parent.parent) == RT_Object_Class_Semaphore);

        rt_enter_critical();

        if (sem->value > 0)
        {
            /* semaphore is available */
            sem->value--;

            rt_exit_critical();
        }
        else
        {
            /* no waiting, return with timeout */
            if (time == 0)
            {
                rt_exit_critical();

                return -RT_ETIMEOUT;
            }
            else
            {
                /* current context checking */
                RT_DEBUG_IN_THREAD_CONTEXT;

                /* semaphore is unavailable, push to suspend list */
                /* get current thread */
                thread = rt_thread_self();

                /* reset thread error number */
                thread->error = RT_EOK;

                /* suspend thread */
                rt_thread_suspend(thread);

                /* Only support FIFO */
                rt_list_insert_before(&(sem->parent.suspend_thread), &RT_THREAD_LIST_NODE(thread));

                /**
                rt_ipc_list_suspend(&(sem->parent.suspend_thread),
                                    thread,
                                    sem->parent.parent.flag);
                */

                /* has waiting time, start thread timer */
                if (time > 0)
                {
                    /* reset the timeout of thread timer and start it */
                    rt_timer_control(&(thread->thread_timer),
                                     RT_TIMER_CTRL_SET_TIME,
                                     &time);
                    rt_timer_start(&(thread->thread_timer));
                }

                /* to avoid the lost of singal< cond->sem > */
                if (pthread_mutex_unlock(mutex) != 0)
                {
                    return -RT_ERROR;
                }

                /* exit critical and do schedule */
                rt_exit_critical();

                result = thread->error;

                /* lock mutex again */
                pthread_mutex_lock(mutex);
            }
        }
    }

    return result;
}
RTM_EXPORT(_pthread_cond_timedwait);

/**
 * @brief Waits on a condition variable.
 *
 * This function blocks the calling thread on the condition variable `cond` and releases
 * the associated mutex `mutex`. The thread remains blocked until it is signaled or
 * broadcast using `pthread_cond_signal` or `pthread_cond_broadcast`. When the thread
 * is awakened, it re-acquires the mutex and resumes execution.
 *
 * @param cond A pointer to the condition variable to wait on.
 *             Must point to a valid, initialized condition variable.
 * @param mutex A pointer to the mutex associated with the condition variable.
 *              Must be locked by the calling thread before invoking this function.
 *
 * @return
 * - `0` on success.
 * - A non-zero error code on failure, including:
 *   - `EINVAL`: The condition variable or mutex is invalid or uninitialized.
 *
 * @note
 * - The mutex must be locked before calling this function.
 * - Upon returning, the mutex is locked again by the calling thread.
 * - Spurious wakeups may occur, so the thread should always recheck the waiting
 *   condition upon wakeup.
 * - This function may block indefinitely unless the condition is signaled or broadcast.
 *
 * @see pthread_cond_signal, pthread_cond_broadcast, pthread_cond_timedwait, pthread_mutex_lock
 */
int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
{
    rt_err_t result;

__retry:
    result = _pthread_cond_timedwait(cond, mutex, RT_WAITING_FOREVER);
    if (result == RT_EOK)
    {
        return 0;
    }
    else if (result == -RT_EINTR)
    {
        /* https://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_wait.html
         * These functions shall not return an error code of [EINTR].
         */
        goto __retry;
    }

    return EINVAL;
}
RTM_EXPORT(pthread_cond_wait);

/**
 * @brief Waits on a condition variable with a timeout.
 *
 * This function blocks the calling thread on the condition variable `cond`, releasing
 * the associated mutex `mutex`. The thread remains blocked until one of the following occurs:
 * - The condition variable is signaled or broadcast using `pthread_cond_signal` or `pthread_cond_broadcast`.
 * - The specified absolute timeout `abstime` is reached.
 * - A spurious wakeup occurs (requiring the thread to recheck the condition).
 *
 * @param cond A pointer to the condition variable to wait on.
 *             Must point to a valid, initialized condition variable.
 * @param mutex A pointer to the mutex associated with the condition variable.
 *              Must be locked by the calling thread before invoking this function.
 * @param abstime A pointer to a `struct timespec` specifying the absolute timeout (in seconds and nanoseconds
 *                since the Epoch). If the time specified is already reached, the function immediately returns.
 *
 * @return
 * - `0` on successful wakeup (signaled or broadcast).
 * - `ETIMEDOUT` if the timeout expires before the condition variable is signaled.
 * - A non-zero error code on failure, including:
 *   - `EINVAL`: The condition variable, mutex, or `abstime` is invalid.
 *   - `EPERM`: The mutex is not owned by the calling thread.
 *
 * @note
 * - The mutex is released while the thread is waiting and re-acquired before the function returns.
 * - Spurious wakeups may occur, so the thread must always recheck the waiting condition upon wakeup.
 * - The timeout is specified in absolute time, not relative duration.
 * - Ensure the condition variable and mutex are properly initialized before use.
 *
 * @see pthread_cond_wait, pthread_cond_signal, pthread_cond_broadcast, pthread_mutex_lock
 */
int pthread_cond_timedwait(pthread_cond_t *cond,
                           pthread_mutex_t *mutex,
                           const struct timespec *abstime)
{
    int timeout;
    rt_err_t result;

    timeout = rt_timespec_to_tick(abstime);
    result = _pthread_cond_timedwait(cond, mutex, timeout);
    if (result == RT_EOK)
    {
        return 0;
    }
    if (result == -RT_ETIMEOUT)
    {
        return ETIMEDOUT;
    }

    return EINVAL;
}
RTM_EXPORT(pthread_cond_timedwait);