nuttx/libs/libc/semaphore/sem_init.c
rongbaichuan 9c461f03ac sched/semaphore: Correct the return value comment of nxsem_init/nxmutex_init
nxsem_init(), nxsem_destroy(), nxmutex_init(), nxmutex_destroy(),
nxrmutex_init() and nxrmutex_destroy() cannot fail, so promising a
negated errno value on failure documents an error that is never returned.
The coding standard asks the returned value description to identify all
error values of a function, and there are none, so state that OK is
always returned.

Follows "sched/semaphore: Remove the return value check of
nxsem_init/nxmutex_init", which removed the last checks of these values.

Assisted-by: DeepSeek Harness:deepseek-flash
Signed-off-by: rongbaichuan <rongbaichuan1027@163.com>
2026-09-25 10:37:43 +02:00

134 lines
4.3 KiB
C

/****************************************************************************
* libs/libc/semaphore/sem_init.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 <sys/types.h>
#include <assert.h>
#include <limits.h>
#include <errno.h>
#include <nuttx/semaphore.h>
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: nxsem_init
*
* Description:
* This function initializes the UNNAMED semaphore sem. Following a
* successful call to nxsem_init(), the semaphore may be used in subsequent
* calls to nxsem_wait(), nxsem_post(), and nxsem_trywait(). The semaphore
* remains usable until it is destroyed.
*
* Only sem itself may be used for performing synchronization. The result
* of referring to copies of sem in calls to nxsem_wait(), nxsem_trywait(),
* nxsem_post(), and nxsem_destroy() is undefined.
*
* Input Parameters:
* sem - Semaphore to be initialized
* pshared - Process sharing (not used)
* value - Semaphore initialization value
*
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* Zero (OK) is always returned.
*
****************************************************************************/
int nxsem_init(FAR sem_t *sem, int pshared, int32_t value)
{
UNUSED(pshared);
DEBUGASSERT(sem != NULL);
/* Initialize the semaphore count or mutex holder */
sem->val.semcount = (int32_t)value;
#ifdef CONFIG_CUSTOM_SEMAPHORE_MAXVALUE
sem->maxvalue = SEM_VALUE_MAX;
#endif
/* Initialize semaphore wait list */
dq_init(&sem->waitlist);
/* Initialize to support priority inheritance */
sem->flags = 0;
#ifdef CONFIG_PRIORITY_INHERITANCE
# if CONFIG_SEM_PREALLOCHOLDERS > 0
sem->hhead = NULL;
# else
INITIALIZE_SEMHOLDER(&sem->holder);
# endif
#endif
return OK;
}
/****************************************************************************
* Name: sem_init
*
* Description:
* This function initializes the UNNAMED semaphore sem. Following a
* successful call to sem_init(), the semaphore may be used in subsequent
* calls to sem_wait(), sem_post(), and sem_trywait(). The semaphore
* remains usable until it is destroyed.
*
* Only sem itself may be used for performing synchronization. The result
* of referring to copies of sem in calls to sem_wait(), sem_trywait(),
* sem_post(), and sem_destroy() is undefined.
*
* Input Parameters:
* sem - Semaphore to be initialized
* pshared - Process sharing (not used)
* value - Semaphore initialization value
*
* Returned Value:
* This returns zero (OK) if successful. Otherwise, -1 (ERROR) is
* returned and the errno value is set appropriately.
*
****************************************************************************/
int sem_init(FAR sem_t *sem, int pshared, unsigned int value)
{
/* Verify that a semaphore was provided and the count is within the valid
* range.
*/
if (sem == NULL || value > SEM_VALUE_MAX)
{
set_errno(EINVAL);
return ERROR;
}
nxsem_init(sem, pshared, value);
return OK;
}