Fix nasa#1440, Split up BinSemGetInfo() to avoid partial success returns

thnkslprpt · Oct 10, 2024 · f8855ab · f8855ab
1 parent 8270166
commit f8855ab
Show file tree

Hide file tree

Showing 14 changed files with 348 additions and 49 deletions.
diff --git a/src/os/inc/osapi-binsem.h b/src/os/inc/osapi-binsem.h
@@ -178,6 +178,8 @@ int32 OS_BinSemDelete(osal_id_t sem_id);
  */
 int32 OS_BinSemGetIdByName(osal_id_t *sem_id, const char *sem_name);
 
+#ifdef OSAL_OMIT_DEPRECATED
+#else
 /*-------------------------------------------------------------------------------------*/
 /**
  * @brief Fill a property object buffer with details regarding the resource
@@ -196,6 +198,56 @@ int32 OS_BinSemGetIdByName(osal_id_t *sem_id, const char *sem_name);
  * @retval #OS_ERR_NOT_IMPLEMENTED @copybrief OS_ERR_NOT_IMPLEMENTED
  */
 int32 OS_BinSemGetInfo(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop);
+#endif
+
+/*-------------------------------------------------------------------------------------*/
+/**
+ * @brief Get the name of the binary semaphore
+ *
+ * This function retrieves the name of the specified binary semaphore.
+ *
+ * @param[in] sem_id The object ID to operate on
+ * @param[out] bin_prop The property object buffer to fill @nonnull
+ *
+ * @return Execution status, see @ref OSReturnCodes
+ * @retval #OS_SUCCESS @copybrief OS_SUCCESS
+ * @retval #OS_ERR_INVALID_ID if the id passed in is not a valid semaphore
+ * @retval #OS_INVALID_POINTER if the bin_prop pointer is null
+ */
+int32 OS_BinSemGetName(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop);
+
+/*-------------------------------------------------------------------------------------*/
+/**
+ * @brief Get the creator of the binary semaphore
+ *
+ * This function retrieves the creator of the specified binary semaphore.
+ *
+ * @param[in] sem_id The object ID to operate on
+ * @param[out] bin_prop The property object buffer to fill @nonnull
+ *
+ * @return Execution status, see @ref OSReturnCodes
+ * @retval #OS_SUCCESS @copybrief OS_SUCCESS
+ * @retval #OS_ERR_INVALID_ID if the id passed in is not a valid semaphore
+ * @retval #OS_INVALID_POINTER if the bin_prop pointer is null
+ */
+int32 OS_BinSemGetCreator(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop);
+
+/*-------------------------------------------------------------------------------------*/
+/**
+ * @brief Get the value of the binary semaphore
+ *
+ * This function retrieves the value of the specified binary semaphore.
+ *
+ * @param[in] sem_id The object ID to operate on
+ * @param[out] bin_prop The property object buffer to fill @nonnull
+ *
+ * @return Execution status, see @ref OSReturnCodes
+ * @retval #OS_SUCCESS @copybrief OS_SUCCESS
+ * @retval #OS_ERR_INVALID_ID if the id passed in is not a valid semaphore
+ * @retval #OS_INVALID_POINTER if the bin_prop pointer is null
+ * @retval #OS_ERR_NOT_IMPLEMENTED @copybrief OS_ERR_NOT_IMPLEMENTED
+ */
+int32 OS_BinSemGetValue(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop);
 
 /**@}*/
 

diff --git a/src/os/posix/src/os-impl-binsem.c b/src/os/posix/src/os-impl-binsem.c
@@ -466,6 +466,8 @@ int32 OS_BinSemTimedWait_Impl(const OS_object_token_t *token, uint32 msecs)
     return (OS_GenericBinSemTake_Impl(token, &ts));
 }
 
+#ifdef OSAL_OMIT_DEPRECATED
+#else
 /*----------------------------------------------------------------
  *
  *  Purpose: Implemented per internal OSAL API
@@ -482,3 +484,21 @@ int32 OS_BinSemGetInfo_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *s
     sem_prop->value = sem->current_value;
     return OS_SUCCESS;
 }
+#endif
+
+/*----------------------------------------------------------------
+ *
+ *  Purpose: Implemented per internal OSAL API
+ *           See prototype for argument/return detail
+ *
+ *-----------------------------------------------------------------*/
+int32 OS_BinSemGetValue_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *sem_prop)
+{
+    OS_impl_binsem_internal_record_t *sem;
+
+    sem = OS_OBJECT_TABLE_GET(OS_impl_bin_sem_table, *token);
+
+    /* put the info into the structure */
+    sem_prop->value = sem->current_value;
+    return OS_SUCCESS;
+}
diff --git a/src/os/rtems/src/os-impl-binsem.c b/src/os/rtems/src/os-impl-binsem.c
@@ -266,6 +266,8 @@ int32 OS_BinSemTimedWait_Impl(const OS_object_token_t *token, uint32 msecs)
     return OS_SUCCESS;
 }
 
+#ifdef OSAL_OMIT_DEPRECATED
+#else
 /*----------------------------------------------------------------
  *
  *  Purpose: Implemented per internal OSAL API
@@ -277,3 +279,16 @@ int32 OS_BinSemGetInfo_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *b
     /* RTEMS has no API for obtaining the current value of a semaphore */
     return OS_ERR_NOT_IMPLEMENTED;
 }
+#endif
+
+/*----------------------------------------------------------------
+ *
+ *  Purpose: Implemented per internal OSAL API
+ *           See prototype for argument/return detail
+ *
+ *-----------------------------------------------------------------*/
+int32 OS_BinSemGetValue_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *bin_prop)
+{
+    /* RTEMS has no API for obtaining the current value of a semaphore */
+    return OS_ERR_NOT_IMPLEMENTED;
+}
diff --git a/src/os/shared/inc/os-shared-binsem.h b/src/os/shared/inc/os-shared-binsem.h
@@ -105,12 +105,24 @@ int32 OS_BinSemTimedWait_Impl(const OS_object_token_t *token, uint32 msecs);
  ------------------------------------------------------------------*/
 int32 OS_BinSemDelete_Impl(const OS_object_token_t *token);
 
+
+#ifdef OSAL_OMIT_DEPRECATED
+#else
 /*----------------------------------------------------------------
 
     Purpose: Obtain OS-specific information about the semaphore
 
     Returns: OS_SUCCESS on success, or relevant error code
  ------------------------------------------------------------------*/
 int32 OS_BinSemGetInfo_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *bin_prop);
+#endif
+
+/*----------------------------------------------------------------
+
+    Purpose: Obtain the value of a semaphore (if possible/implemented in the relevent OS)
+
+    Returns: OS_SUCCESS on success, or relevant error code
+ ------------------------------------------------------------------*/
+int32 OS_BinSemGetValue_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *bin_prop);
 
 #endif /* OS_SHARED_BINSEM_H */
diff --git a/src/os/shared/src/osapi-binsem.c b/src/os/shared/src/osapi-binsem.c
@@ -243,13 +243,45 @@ int32 OS_BinSemGetIdByName(osal_id_t *sem_id, const char *sem_name)
     return return_code;
 }
 
+#ifdef OSAL_OMIT_DEPRECATED
+#else
 /*----------------------------------------------------------------
  *
  *  Purpose: Implemented per public OSAL API
  *           See description in API and header file for detail
  *
  *-----------------------------------------------------------------*/
 int32 OS_BinSemGetInfo(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop)
+{
+    OS_common_record_t *record;
+    OS_object_token_t   token;
+    int32               return_code;
+    /* Check parameters */
+    OS_CHECK_POINTER(bin_prop);
+    memset(bin_prop, 0, sizeof(OS_bin_sem_prop_t));
+    /* Check Parameters */
+    return_code = OS_ObjectIdGetById(OS_LOCK_MODE_GLOBAL, LOCAL_OBJID_TYPE, sem_id, &token);
+    if (return_code == OS_SUCCESS)
+    {
+        record = OS_OBJECT_TABLE_GET(OS_global_bin_sem_table, token);
+
+        strncpy(bin_prop->name, record->name_entry, sizeof(bin_prop->name) - 1);
+        bin_prop->creator = record->creator;
+        return_code       = OS_BinSemGetInfo_Impl(&token, bin_prop);
+
+        OS_ObjectIdRelease(&token);
+    }
+    return return_code;
+}
+#endif
+
+/*----------------------------------------------------------------
+ *
+ *  Purpose: Implemented per public OSAL API
+ *           See description in API and header file for detail
+ *
+ *-----------------------------------------------------------------*/
+int32 OS_BinSemGetName(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop)
 {
     OS_common_record_t *record;
     OS_object_token_t   token;
@@ -267,8 +299,66 @@ int32 OS_BinSemGetInfo(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop)
         record = OS_OBJECT_TABLE_GET(OS_global_bin_sem_table, token);
 
         strncpy(bin_prop->name, record->name_entry, sizeof(bin_prop->name) - 1);
+        bin_prop->name[sizeof(bin_prop->name) - 1] = '\0'; /* Ensure null termination */
+
+        OS_ObjectIdRelease(&token);
+    }
+
+    return return_code;
+}
+
+/*----------------------------------------------------------------
+ *
+ *  Purpose: Implemented per public OSAL API
+ *           See description in API and header file for detail
+ *
+ *-----------------------------------------------------------------*/
+int32 OS_BinSemGetCreator(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop)
+{
+    OS_common_record_t *record;
+    OS_object_token_t   token;
+    int32               return_code;
+
+    /* Check parameters */
+    OS_CHECK_POINTER(bin_prop);
+
+    memset(bin_prop, 0, sizeof(OS_bin_sem_prop_t));
+
+    /* Check Parameters */
+    return_code = OS_ObjectIdGetById(OS_LOCK_MODE_GLOBAL, LOCAL_OBJID_TYPE, sem_id, &token);
+    if (return_code == OS_SUCCESS)
+    {
+        record = OS_OBJECT_TABLE_GET(OS_global_bin_sem_table, token);
+
         bin_prop->creator = record->creator;
-        return_code       = OS_BinSemGetInfo_Impl(&token, bin_prop);
+
+        OS_ObjectIdRelease(&token);
+    }
+
+    return return_code;
+}
+
+/*----------------------------------------------------------------
+ *
+ *  Purpose: Implemented per public OSAL API
+ *           See description in API and header file for detail
+ *
+ *-----------------------------------------------------------------*/
+int32 OS_BinSemGetValue(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop)
+{
+    OS_object_token_t token;
+    int32             return_code;
+
+    /* Check parameters */
+    OS_CHECK_POINTER(bin_prop);
+
+    memset(bin_prop, 0, sizeof(OS_bin_sem_prop_t));
+
+    /* Check Parameters */
+    return_code = OS_ObjectIdGetById(OS_LOCK_MODE_GLOBAL, LOCAL_OBJID_TYPE, sem_id, &token);
+    if (return_code == OS_SUCCESS)
+    {
+        return_code = OS_BinSemGetValue_Impl(&token, bin_prop);
 
         OS_ObjectIdRelease(&token);
     }

diff --git a/src/os/vxworks/src/os-impl-binsem.c b/src/os/vxworks/src/os-impl-binsem.c
@@ -184,6 +184,8 @@ int32 OS_BinSemTimedWait_Impl(const OS_object_token_t *token, uint32 msecs)
     return status;
 }
 
+#ifdef OSAL_OMIT_DEPRECATED
+#else
 /*----------------------------------------------------------------
  *
  *  Purpose: Implemented per internal OSAL API
@@ -193,5 +195,18 @@ int32 OS_BinSemTimedWait_Impl(const OS_object_token_t *token, uint32 msecs)
 int32 OS_BinSemGetInfo_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *bin_prop)
 {
     /* VxWorks has no API for obtaining the current value of a semaphore */
-    return OS_SUCCESS;
+    return OS_ERR_NOT_IMPLEMENTED;
+}
+#endif
+
+/*----------------------------------------------------------------
+ *
+ *  Purpose: Implemented per internal OSAL API
+ *           See prototype for argument/return detail
+ *
+ *-----------------------------------------------------------------*/
+int32 OS_BinSemGetValue_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *bin_prop)
+{
+    /* VxWorks has no API for obtaining the current value of a semaphore */
+    return OS_ERR_NOT_IMPLEMENTED;
 }
diff --git a/src/tests/bin-sem-test/bin-sem-test.c b/src/tests/bin-sem-test/bin-sem-test.c
@@ -77,23 +77,32 @@ void Test_BinSem(void)
     char              long_name[OS_MAX_API_NAME + 1];
     OS_bin_sem_prop_t sem_prop;
     uint32            test_val;
-    bool              get_info_implemented;
+    bool              get_value_implemented;
 
     memset(&sem_prop, 0, sizeof(sem_prop));
     memset(task_counter, 0, sizeof(task_counter));
 
     /* Invalid id checks */
-    UtAssert_INT32_EQ(OS_BinSemGetInfo(OS_OBJECT_ID_UNDEFINED, &sem_prop), OS_ERR_INVALID_ID);
+    UtAssert_INT32_EQ(OS_BinSemGetName(OS_OBJECT_ID_UNDEFINED, &sem_prop), OS_ERR_INVALID_ID);
+    UtAssert_INT32_EQ(OS_BinSemGetCreator(OS_OBJECT_ID_UNDEFINED, &sem_prop), OS_ERR_INVALID_ID);
+    UtAssert_INT32_EQ(OS_BinSemGetValue(OS_OBJECT_ID_UNDEFINED, &sem_prop), OS_ERR_INVALID_ID);
     UtAssert_INT32_EQ(OS_BinSemFlush(OS_OBJECT_ID_UNDEFINED), OS_ERR_INVALID_ID);
     UtAssert_INT32_EQ(OS_BinSemGive(OS_OBJECT_ID_UNDEFINED), OS_ERR_INVALID_ID);
     UtAssert_INT32_EQ(OS_BinSemTake(OS_OBJECT_ID_UNDEFINED), OS_ERR_INVALID_ID);
     UtAssert_INT32_EQ(OS_BinSemTimedWait(OS_OBJECT_ID_UNDEFINED, 0), OS_ERR_INVALID_ID);
     UtAssert_INT32_EQ(OS_BinSemDelete(OS_OBJECT_ID_UNDEFINED), OS_ERR_INVALID_ID);
 
-    /* Null checks */
+    /* OS_BinSemCreate NULL checks */
     UtAssert_INT32_EQ(OS_BinSemCreate(NULL, "Test_Sem", 0, 0), OS_INVALID_POINTER);
     UtAssert_INT32_EQ(OS_BinSemCreate(&sem_id[0], NULL, 0, 0), OS_INVALID_POINTER);
-    UtAssert_INT32_EQ(OS_BinSemGetInfo(sem_id[0], NULL), OS_INVALID_POINTER);
+
+    // Initialize sem_id[0] to a valid value for the following NULL checks
+    sem_id[0] = OS_OBJECT_ID_UNDEFINED;
+
+    // OS_BinSemGet* NULL checks
+    UtAssert_INT32_EQ(OS_BinSemGetName(sem_id[0], NULL), OS_INVALID_POINTER);
+    UtAssert_INT32_EQ(OS_BinSemGetCreator(sem_id[0], NULL), OS_INVALID_POINTER);
+    UtAssert_INT32_EQ(OS_BinSemGetValue(sem_id[0], NULL), OS_INVALID_POINTER);
     UtAssert_INT32_EQ(OS_BinSemGetIdByName(NULL, "Test_Sem"), OS_INVALID_POINTER);
     UtAssert_INT32_EQ(OS_BinSemGetIdByName(&sem_id[0], NULL), OS_INVALID_POINTER);
 
@@ -109,15 +118,15 @@ void Test_BinSem(void)
     /* Nonzero create */
     UtAssert_INT32_EQ(OS_BinSemCreate(&sem_id[1], "Test_Sem_Nonzero", 1, 0), OS_SUCCESS);
 
-    /* Check get info implementation */
-    get_info_implemented = (OS_BinSemGetInfo(sem_id[0], &sem_prop) != OS_ERR_NOT_IMPLEMENTED);
+    /* Check get value implementation */
+    get_value_implemented = (OS_BinSemGetValue(sem_id[0], &sem_prop) != OS_ERR_NOT_IMPLEMENTED);
 
     /* Validate values */
-    if (get_info_implemented)
+    if (get_value_implemented)
     {
-        UtAssert_INT32_EQ(OS_BinSemGetInfo(sem_id[0], &sem_prop), OS_SUCCESS);
+        UtAssert_INT32_EQ(OS_BinSemGetValue(sem_id[0], &sem_prop), OS_SUCCESS);
         UtAssert_INT32_EQ(sem_prop.value, 0);
-        UtAssert_INT32_EQ(OS_BinSemGetInfo(sem_id[1], &sem_prop), OS_SUCCESS);
+        UtAssert_INT32_EQ(OS_BinSemGetValue(sem_id[1], &sem_prop), OS_SUCCESS);
         UtAssert_INT32_EQ(sem_prop.value, 1);
     }
 
@@ -141,11 +150,11 @@ void Test_BinSem(void)
     UtAssert_INT32_EQ(OS_BinSemTimedWait(sem_id[1], 0), OS_SUCCESS);
 
     /* Validate zeros */
-    if (get_info_implemented)
+    if (get_value_implemented)
     {
-        UtAssert_INT32_EQ(OS_BinSemGetInfo(sem_id[0], &sem_prop), OS_SUCCESS);
+        UtAssert_INT32_EQ(OS_BinSemGetValue(sem_id[0], &sem_prop), OS_SUCCESS);
         UtAssert_INT32_EQ(sem_prop.value, 0);
-        UtAssert_INT32_EQ(OS_BinSemGetInfo(sem_id[1], &sem_prop), OS_SUCCESS);
+        UtAssert_INT32_EQ(OS_BinSemGetValue(sem_id[1], &sem_prop), OS_SUCCESS);
         UtAssert_INT32_EQ(sem_prop.value, 0);
     }
     else
@@ -162,9 +171,9 @@ void Test_BinSem(void)
     UtAssert_INT32_EQ(OS_TaskDelete(task_id[0]), OS_SUCCESS);
     UtAssert_UINT32_EQ(task_counter[0], 0);
 
-    if (get_info_implemented)
+    if (get_value_implemented)
     {
-        UtAssert_INT32_EQ(OS_BinSemGetInfo(sem_id[0], &sem_prop), OS_SUCCESS);
+        UtAssert_INT32_EQ(OS_BinSemGetValue(sem_id[0], &sem_prop), OS_SUCCESS);
         UtAssert_INT32_EQ(sem_prop.value, 0);
     }
     else

diff --git a/src/tests/bin-sem-timeout-test/bin-sem-timeout-test.c b/src/tests/bin-sem-timeout-test/bin-sem-timeout-test.c
@@ -98,7 +98,7 @@ void task_1(void)
         if (status == OS_SUCCESS)
         {
             OS_printf("TASK 1:   Doing some work: %d\n", (int)counter++);
-            status = OS_BinSemGetInfo(bin_sem_id, &bin_sem_prop);
+            status = OS_BinSemGetValue(bin_sem_id, &bin_sem_prop);
             if (status == OS_SUCCESS)
             {
                 if (bin_sem_prop.value > 1)

diff --git a/src/tests/select-test/select-test.c b/src/tests/select-test/select-test.c
@@ -73,7 +73,7 @@ void BinSemSetup(void)
     UtAssert_INT32_EQ(OS_BinSemCreate(&bin_sem_id, "BinSem1", 0, 0), OS_SUCCESS);
     UtAssert_True(OS_ObjectIdDefined(bin_sem_id), "bin_sem_id (%lu) != UNDEFINED", OS_ObjectIdToInteger(bin_sem_id));
 
-    UtAssert_INT32_EQ(OS_BinSemGetInfo(bin_sem_id, &bin_sem_prop), OS_SUCCESS);
+    UtAssert_INT32_EQ(OS_BinSemGetValue(bin_sem_id, &bin_sem_prop), OS_SUCCESS);
     UtPrintf("BinSem1 value=%d", (int)bin_sem_prop.value);
 }