Files
nuttx/sched/pthread/pthread_condwait.c
Ville Juven bb85ad849e pthread_cond_wait: Use atomic_t to protect the waiter count
The load/compare and RMW to wait_count need protection. Using atomic
operations should resolve both issues.

NOTE:
The assumption that the user will call pthread_cond_signal /
pthread_cond_broadcast with the mutex given to pthread_cond_wait held is
simply not true. It MAY hold it, but it is not forced. Thus, using the
user space lock for protecting the wait counter as well is not valid!

The pthread_cond_signal() or pthread_cond_broadcast() functions may be called by a thread whether or not it currently owns the mutex that threads calling pthread_cond_wait() or pthread_cond_timedwait() have associated with the condition variable during their waits; however, if predictable scheduling behaviour is required, then that mutex is locked by the thread calling pthread_cond_signal() or pthread_cond_broadcast().

[1] https://pubs.opengroup.org/onlinepubs/7908799/xsh/pthread_cond_signal.html
2025-01-20 23:55:26 +08:00

125 lines
3.3 KiB
C

/****************************************************************************
* sched/pthread/pthread_condwait.c
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <unistd.h>
#include <pthread.h>
#include <sched.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/atomic.h>
#include <nuttx/cancelpt.h>
#include "pthread/pthread.h"
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: int pthread_cond_wait
*
* Description:
* A thread can wait for a condition variable to be signalled or broadcast.
*
* Input Parameters:
* None
*
* Returned Value:
* None
*
* Assumptions:
*
****************************************************************************/
int pthread_cond_wait(FAR pthread_cond_t *cond, FAR pthread_mutex_t *mutex)
{
int status;
int ret;
sinfo("cond=%p mutex=%p\n", cond, mutex);
/* pthread_cond_wait() is a cancellation point */
enter_cancellation_point();
/* Make sure that non-NULL references were provided. */
if (cond == NULL || mutex == NULL)
{
ret = EINVAL;
}
/* Make sure that the caller holds the mutex */
else if (!mutex_is_hold(&mutex->mutex))
{
ret = EPERM;
}
else
{
unsigned int nlocks;
/* Give up the mutex */
sinfo("Give up mutex / take cond\n");
atomic_fetch_add(COND_WAIT_COUNT(cond), 1);
ret = pthread_mutex_breaklock(mutex, &nlocks);
status = -nxsem_wait_uninterruptible(&cond->sem);
if (ret == OK)
{
/* Report the first failure that occurs */
ret = status;
}
/* Reacquire the mutex.
*
* When cancellation points are enabled, we need to hold the mutex
* when the pthread is canceled and cleanup handlers, if any, are
* entered.
*/
sinfo("Reacquire mutex...\n");
status = pthread_mutex_restorelock(mutex, nlocks);
if (ret == OK)
{
/* Report the first failure that occurs */
ret = status;
}
}
leave_cancellation_point();
sinfo("Returning %d\n", ret);
return ret;
}