From f097d7d30465f5bf1dd6b658260646ef29a117ca Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Tue, 20 Jul 2021 15:55:10 -0400 Subject: [PATCH 001/178] Partial #1108, add typedef for OSAL status codes Minimal change to add a typedef for OS_Status_t, a macro for constants/literals, and an inline function to convert to "long" for printing/logging. --- src/os/inc/common_types.h | 6 ++++++ src/os/inc/osapi-error.h | 16 ++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/src/os/inc/common_types.h b/src/os/inc/common_types.h index 411407452..277c85ec9 100644 --- a/src/os/inc/common_types.h +++ b/src/os/inc/common_types.h @@ -118,6 +118,11 @@ extern "C" */ typedef uint32 osal_objtype_t; + /** + * The preferred type to represent OSAL status codes defined in osapi-error.h + */ + typedef int32 osal_status_t; + /** * @brief General purpose OSAL callback function * @@ -155,5 +160,6 @@ extern "C" #define OSAL_BLOCKCOUNT_C(X) ((osal_blockcount_t)(X)) #define OSAL_INDEX_C(X) ((osal_index_t)(X)) #define OSAL_OBJTYPE_C(X) ((osal_objtype_t)(X)) +#define OSAL_STATUS_C(X) ((osal_status_t)(X)) #endif /* COMMON_TYPES_H */ diff --git a/src/os/inc/osapi-error.h b/src/os/inc/osapi-error.h index f71e97eb7..53db5c3c5 100644 --- a/src/os/inc/osapi-error.h +++ b/src/os/inc/osapi-error.h @@ -138,6 +138,22 @@ typedef char os_err_name_t[OS_ERROR_NAME_LENGTH]; * @{ */ +/*-------------------------------------------------------------------------------------*/ +/** + * @brief Convert a status code to a native "long" type + * + * For printing or logging purposes, this converts the given status code + * to a "long" (signed integer) value. It should be used in conjunction + * with the "%ld" conversion specifier in printf-style statements. + * + * @param[in] Status Execution status, see @ref OSReturnCodes + * @return Same status value converted to the "long" data type + */ +static inline long OS_StatusToInteger(osal_status_t Status) +{ + return (long)Status; +} + /*-------------------------------------------------------------------------------------*/ /** * @brief Convert an error number to a string From e24735c6be98e0e033a3957ad6f147f54e275f4c Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Wed, 25 Aug 2021 13:40:18 -0400 Subject: [PATCH 002/178] Fix #1135, add bitmask assert macros Add a pair of macros that can confirm a value has bits set or does not have bits set. By using bitmask-aware macros, the logged information can include both the raw/actual value as well as the specific bits being tested. --- ut_assert/inc/utassert.h | 36 ++++++++++++++++++++++++++++-------- ut_assert/src/utassert.c | 12 ++++++++++++ 2 files changed, 40 insertions(+), 8 deletions(-) diff --git a/ut_assert/inc/utassert.h b/ut_assert/inc/utassert.h index bde9ff397..67470fdc6 100644 --- a/ut_assert/inc/utassert.h +++ b/ut_assert/inc/utassert.h @@ -81,14 +81,16 @@ typedef enum */ typedef enum { - UtAssert_Compare_NONE, /**< invalid/not used, always false */ - UtAssert_Compare_EQ, /**< actual equals reference value */ - UtAssert_Compare_NEQ, /**< actual does not non equal reference value */ - UtAssert_Compare_LT, /**< actual less than reference (exclusive) */ - UtAssert_Compare_GT, /**< actual greater than reference (exclusive) */ - UtAssert_Compare_LTEQ, /**< actual less than or equal to reference (inclusive) */ - UtAssert_Compare_GTEQ, /**< actual greater than reference (inclusive) */ - UtAssert_Compare_MAX /**< placeholder, not used */ + UtAssert_Compare_NONE, /**< invalid/not used, always false */ + UtAssert_Compare_EQ, /**< actual equals reference value */ + UtAssert_Compare_NEQ, /**< actual does not non equal reference value */ + UtAssert_Compare_LT, /**< actual less than reference (exclusive) */ + UtAssert_Compare_GT, /**< actual greater than reference (exclusive) */ + UtAssert_Compare_LTEQ, /**< actual less than or equal to reference (inclusive) */ + UtAssert_Compare_GTEQ, /**< actual greater than reference (inclusive) */ + UtAssert_Compare_BITMASK_SET, /**< actual equals reference value */ + UtAssert_Compare_BITMASK_UNSET, /**< actual equals reference value */ + UtAssert_Compare_MAX /**< placeholder, not used */ } UtAssert_Compare_t; /** @@ -404,6 +406,24 @@ typedef struct UtAssert_GenericUnsignedCompare((uint32)(expr), UtAssert_Compare_GT, (uint32)(ref), UtAssert_Radix_DECIMAL, \ __FILE__, __LINE__, "", #expr, #ref) +/** + * \brief Macro for checking that bits in a bit field are set + * + * Test Passes if all the bits specified in "mask" are set in "rawval" + */ +#define UtAssert_BITMASK_SET(rawval, mask) \ + UtAssert_GenericUnsignedCompare((uint32)(rawval), UtAssert_Compare_BITMASK_SET, (uint32)(mask), \ + UtAssert_Radix_HEX, __FILE__, __LINE__, "", #rawval, #mask) + +/** + * \brief Macro for checking that bits in a bit field are unset + * + * Test Passes if none of the bits specified in "mask" are set in "rawval" + */ +#define UtAssert_BITMASK_UNSET(rawval, mask) \ + UtAssert_GenericUnsignedCompare((uint32)(rawval), UtAssert_Compare_BITMASK_UNSET, (uint32)(mask), \ + UtAssert_Radix_HEX, __FILE__, __LINE__, "", #rawval, #mask) + /** * \brief Macro for logging calls to a "void" function * diff --git a/ut_assert/src/utassert.c b/ut_assert/src/utassert.c index 8642ca260..4d3f064e2 100644 --- a/ut_assert/src/utassert.c +++ b/ut_assert/src/utassert.c @@ -336,6 +336,12 @@ const char *UtAssert_GetOpText(UtAssert_Compare_t CompareType) case UtAssert_Compare_GTEQ: /* actual greater than reference (inclusive) */ OpText = ">="; break; + case UtAssert_Compare_BITMASK_SET: /* bit(s) in reference are set in actual */ + OpText = "&"; + break; + case UtAssert_Compare_BITMASK_UNSET: /* bit(s) in reference are not set in actual */ + OpText = "&~"; + break; default: /* should never happen */ OpText = "??"; break; @@ -371,6 +377,12 @@ bool UtAssert_GenericUnsignedCompare(unsigned long ActualValue, UtAssert_Compare case UtAssert_Compare_GTEQ: /* actual greater than reference (inclusive) */ Result = (ActualValue >= ReferenceValue); break; + case UtAssert_Compare_BITMASK_SET: /* bit(s) in reference are set in actual */ + Result = (ActualValue & ReferenceValue) == ReferenceValue; + break; + case UtAssert_Compare_BITMASK_UNSET: /* bit(s) in reference are not set in actual */ + Result = (ActualValue & ReferenceValue) == 0; + break; default: /* should never happen */ Result = false; break; From 8939836f29ee19dd083f7b00ebb5d6e2bf2748c4 Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Wed, 1 Sep 2021 10:18:29 -0400 Subject: [PATCH 003/178] IC:2021-08-31, Bump to v5.1.0-rc1+dev598 --- README.md | 5 +++++ src/os/inc/osapi-version.h | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0986500c..8970e8baf 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,11 @@ The autogenerated OSAL user's guide can be viewed at and + ### Development Build: v5.1.0-rc1+dev594 - Add test case types similar to NA diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index 679edaee0..e91916b83 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -36,7 +36,7 @@ /* * Development Build Macro Definitions */ -#define OS_BUILD_NUMBER 594 +#define OS_BUILD_NUMBER 598 #define OS_BUILD_BASELINE "v5.1.0-rc1" /* From a6cf564a85759d8de089f6c078fe5f6dec8d414c Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Tue, 7 Sep 2021 11:29:46 -0400 Subject: [PATCH 004/178] Fix #1141, add typecast to memchr call This function is documented as returning `void*`, and on some compilers this requires an explicit cast to `const char*` to avoid a warning. --- src/os/shared/inc/os-shared-common.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/os/shared/inc/os-shared-common.h b/src/os/shared/inc/os-shared-common.h index c6cb302fc..3de1a93ce 100644 --- a/src/os/shared/inc/os-shared-common.h +++ b/src/os/shared/inc/os-shared-common.h @@ -149,7 +149,7 @@ void OS_ApplicationShutdown_Impl(void); ------------------------------------------------------------------*/ static inline size_t OS_strnlen(const char *s, size_t maxlen) { - const char *end = memchr(s, 0, maxlen); + const char *end = (const char *)memchr(s, 0, maxlen); if (end != NULL) { /* actual length of string is difference */ From e68c8a9a4c9ed20f369f7d5d7bf9f1727154f31b Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Tue, 7 Sep 2021 20:55:53 +0000 Subject: [PATCH 005/178] Fix #1143, Regex update in coverage enforcement to match .0 --- .github/workflows/local_unit_test.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/local_unit_test.yml b/.github/workflows/local_unit_test.yml index c5c89587f..ac7657da5 100644 --- a/.github/workflows/local_unit_test.yml +++ b/.github/workflows/local_unit_test.yml @@ -44,10 +44,10 @@ jobs: run: | # Current best possible branch coverage is all but 4, with associated issues for each missing case missed_branches=4 - coverage_nums=$(grep -A 3 "Overall coverage rate" lcov_out.txt | grep branches | grep -oP "[1-9]+[0-9]*") + coverage_nums=$(grep -A 3 "Overall coverage rate" lcov_out.txt | grep branches | grep -oP "[0-9]+[0-9]*") diff=$(echo $coverage_nums | awk '{ print $4 - $3 }') - if [ $(($diff > $missed_branches)) == 1 ] + if [ $diff -gt $missed_branches ] then grep -A 3 "Overall coverage rate" lcov_out.txt echo "More than $missed_branches branches missed" From 1743a68709fe7f9ba910a27547af261c12aa17ff Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Thu, 9 Sep 2021 12:57:04 -0400 Subject: [PATCH 006/178] IC:2021-09-07, Bump to v5.1.0-rc1+dev604 Part of nasa/cFS#351 --- README.md | 5 +++++ src/os/inc/osapi-version.h | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8970e8baf..2d360b32e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,11 @@ The autogenerated OSAL user's guide can be viewed at and ### Development Build: v5.1.0-rc1+dev598 - Add UTAssert macros that help test bit field storage diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index e91916b83..4e546f389 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -36,7 +36,7 @@ /* * Development Build Macro Definitions */ -#define OS_BUILD_NUMBER 598 +#define OS_BUILD_NUMBER 604 #define OS_BUILD_BASELINE "v5.1.0-rc1" /* From ce66b73a46079c8685f52dd00c0b296e33cf9a91 Mon Sep 17 00:00:00 2001 From: Avi Date: Thu, 2 Sep 2021 08:55:47 +0200 Subject: [PATCH 007/178] Fix #1147, Correct documentation typos --- CMakeLists.txt | 4 ++-- README.md | 20 +++++++++---------- SECURITY.md | 2 +- docs/OSAL-Configuration-Guide.md | 18 ++++++++--------- docs/src/osal_fs.dox | 4 ++-- src/os/portable/README.txt | 2 +- src/tests/file-api-test/README.txt | 12 +++++------ src/tests/osal-core-test/README.txt | 4 ++-- src/unit-test-coverage/shared/CMakeLists.txt | 2 +- .../shared/adaptors/CMakeLists.txt | 2 +- src/unit-test-coverage/ut-stubs/inc/README.md | 2 +- .../vxworks/adaptors/CMakeLists.txt | 2 +- ut_assert/README.txt | 6 +++--- 13 files changed, 40 insertions(+), 40 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 519183d1e..3dbc9ef66 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -48,7 +48,7 @@ project(OSAL C) # part of the open source release. # CAUTION: The API between the OSAL and the low level implementation and/or BSP # is not stabilized, and may change with every OSAL release. No attempt is made -# to provide backward compatibility with to external sources. +# to provide backward compatibility with external sources. set(OSAL_EXT_SOURCE_DIR "$ENV{OSAL_EXT_SOURCE_DIR}" CACHE PATH "External source directory to check for additional OS/BSP implementations") @@ -106,7 +106,7 @@ add_subdirectory(ut_assert) # OSAL_SYSTEM_BSPTYPE indicate which of the BSP packages -# to build. These is required and must be defined. Confirm that this exists +# to build. This is required and must be defined. Confirm that this exists # and error out now if it does not. if (NOT DEFINED OSAL_SYSTEM_BSPTYPE) message(FATAL_ERROR "OSAL_SYSTEM_BSPTYPE must be set to the appropriate BSP") diff --git a/README.md b/README.md index d0986500c..3ca65635a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository contains NASA's Operating System Abstraction Layer (OSAL), which is a framework component of the Core Flight System. -This is a collection of abstractio APIs and associated framework to be located in the `osal` subdirectory of a cFS Mission Tree. The Core Flight System is bundled at , which includes build and execution instructions. +This is a collection of abstraction APIs and associated framework to be located in the `osal` subdirectory of a cFS Mission Tree. The Core Flight System is bundled at , which includes build and execution instructions. The autogenerated OSAL user's guide can be viewed at . @@ -134,14 +134,14 @@ See and and ### Development Build: v5.1.0-rc1+dev411 -- [docs] Clarifies that that zero will be returned on EOF condition in the API documentation for OS_read/write/TimedRead/TimedWrite. In the case of the timed API calls, the `OS_ERR_TIMEOUT` status code will be returned if the timeout expired without the handle becoming readable/writable during that time. -- Addresses a shortcomings in the UT Assert hook functions. Namely the assumed return type of int32 which is not always the case. +- [docs] Clarifies that zero will be returned on EOF condition in the API documentation for OS_read/write/TimedRead/TimedWrite. In the case of the timed API calls, the `OS_ERR_TIMEOUT` status code will be returned if the timeout expired without the handle becoming readable/writable during that time. +- Addresses shortcomings in the UT Assert hook functions. Namely the assumed return type of int32 which is not always the case. - Adds the concept of a "handler" function to UT assert to replace hard-coded custom logic in UT assert. A handler is the custom logic that exists between the hook function and the return to the stub caller. The handler is directly responsible for setting all outputs. - Adds a script to auto-generate stub functions that match this pattern. Given an API header file, the script extracts the declarations, and generates a source file with stub definitions that rely on a separate handler to deal with the needed outputs. @@ -156,7 +156,7 @@ the declarations, and generates a source file with stub definitions that rely on ### Development Build: v5.1.0-rc1+dev393 - Changes parameter names to avoid collisions. Renames `access` as `access_mode` in `osapi-file.h`. Renames `time` as `TimeSp` in `os-impl-posix-gettime.c`. -- Deletes the broken RTEMS `os-impl-shell.c` file so so OSAL builds with `OSAL_CONFIG_INCLUDE_SHELL=true`. RTEMS will always report `OS_ERR_NOT_IMPLEMENTED`. +- Deletes the broken RTEMS `os-impl-shell.c` file so OSAL builds with `OSAL_CONFIG_INCLUDE_SHELL=true`. RTEMS will always report `OS_ERR_NOT_IMPLEMENTED`. - See and ### Development Build: v5.1.0-rc1+dev387 @@ -172,7 +172,7 @@ the declarations, and generates a source file with stub definitions that rely on ### Development Build: v5.1.0-rc1+dev378 - Replaces nonstandard header file block comments and include guards. No behavior changes -- Removes `CLOCK_MONOTONIC` as the osal colck source since PSP no longer needs it. `OS_GetLocalTime()` and `OS_SetLocalTime()` will work as described. +- Removes `CLOCK_MONOTONIC` as the osal clock source since PSP no longer needs it. `OS_GetLocalTime()` and `OS_SetLocalTime()` will work as described. - Replaces `shellName` with a specific `localShellName` that can be polled safely and changes its type to a char of `OS_MAX_API_NAME` length for safety. - See and @@ -182,7 +182,7 @@ the declarations, and generates a source file with stub definitions that rely on - Applies minor code and documentation cleanup: white space, typos, etc. - Adds test to get full coverage of vxworks in `os-impl-bsd-socket.c` resulting in full line coverage for OSAL - Adds more descriptive return codes if `OS_SymbolTableDump_Impl` does not do what is expected. Adds a new error `OS_ERR_OUTPUT_TOO_LARGE` if the size limit was insufficient. Return `OS_ERROR` if an empty file was written - this likely indicates some fundamental issue with the VxWorks symbol table. Returns `OS_ERR_NAME_TOO_LONG` if one of the symbol names was too long. Improves unit test to check for/verify these responses. -- Removes the unneeded `OS_TaskRegister()` and all references to it in code, tests, and documentation. No impact to behavior, but does affect API and has depenedencies +- Removes the unneeded `OS_TaskRegister()` and all references to it in code, tests, and documentation. No impact to behavior, but does affect API and has dependencies - Removes unused `-SCRIPT_MODE` flag in cmake - Remove comparison between `osal_id_t` and `integers` to use the provided comparison function, `OS_ObjectIdDefined()`. System builds and runs again when using a type-safe/non-integer osal_id_t type. - See @@ -379,7 +379,7 @@ OS_MutSemTake():216:WARNING: Task 65547 taking mutex 327685 while owned by task ### Development Build: v5.1.0-rc1+dev60 -- Appliy standard formating, whitespace-only changes +- Apply standard formatting, whitespace-only changes - See ### Development Build: v5.1.0-rc1+dev55 @@ -407,7 +407,7 @@ OS_MutSemTake():216:WARNING: Task 65547 taking mutex 327685 while owned by task ### Development Build: v5.1.0-rc1+dev34 -- Move this existing function into the public API, as it is performs more verification than the OS_ConvertToArrayIndex function. +- Move this existing function into the public API, as it performs more verification than the OS_ConvertToArrayIndex function. - The C library type is signed, and this makes the result check work as intended. - See @@ -453,7 +453,7 @@ a common location for additional table-deletion-related logic. - No impact to current unit testing which runs UT assert as a standalone app. Add a position independent code (PIC) variant of the ut_assert library, which can be dynamically loaded into other applications rather than running as a standalone OSAL application. This enables loading UT assert as a CFE library. - Unit tests pass on RTEMS. -- Resolve inconsistency in how the stack size is treated across different OS implemntations. With this change the user-requested size is passed through to the underlying OS without an enforced minimum. An additional sanity check is added at the shared layer to ensure that the stack size is never passed as 0. +- Resolve inconsistency in how the stack size is treated across different OS implementations. With this change the user-requested size is passed through to the underlying OS without an enforced minimum. An additional sanity check is added at the shared layer to ensure that the stack size is never passed as 0. - Update Licenses for Apache 2.0 - See diff --git a/SECURITY.md b/SECURITY.md index c53d27f70..15371021a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,7 @@ To report a vulnerability for the OSAL subsystem please [submit an issue](https: For general cFS vulnerabilities please [open a cFS framework issue](https://github.com/nasa/cfs/issues/new/choose) and see our [top-level security policy](https://github.com/nasa/cFS/security/policy) for additional information. -In either case please use the "Bug Report" template and provide as much information as possible. Apply appropraite labels for each report. For security related reports, tag the issue with the "security" label. +In either case please use the "Bug Report" template and provide as much information as possible. Apply appropriate labels for each report. For security related reports, tag the issue with the "security" label. ## Testing diff --git a/docs/OSAL-Configuration-Guide.md b/docs/OSAL-Configuration-Guide.md index 710aed2f5..a2c4660a4 100644 --- a/docs/OSAL-Configuration-Guide.md +++ b/docs/OSAL-Configuration-Guide.md @@ -76,7 +76,7 @@ The following sections provide instructions on how to: - Configure the build directory for an OSAL application -- Configure a OSAL Application +- Configure an OSAL Application - Build the OSAL Application @@ -135,7 +135,7 @@ Most parameters set upper bounds on the number of OS objects that can be created the OSAL keeps track of allocated OS objects using fixed size tables. If customization is desired, one should not modify the `default_config.cmake` file directly, -but rather provide a alternative values by one of the override methods: +but rather provide alternative values by one of the override methods: - If configuring OSAL as a standalone build for testing, values for options can be specified as `-D` options on the cmake command. This is a common method of specifying @@ -486,13 +486,13 @@ software to remain portable. There are a few ways to map these host file systems to OSAL file systems: -- **Map existing target file systems to a OSAL path**. This is one of +- **Map existing target file systems to an OSAL path**. This is one of the most common ways to map the Non-Volatile disk to the OSAL. The OSAL relies on the target OS to create/mount a file system and it simply is given a mapping to the disk to allow the OSAL to access it. - **Create EEPROM/Flash/ATA File systems**. The OSAL has the ability -on some targets to format or initialize a EEPROM or ATA disk device. +on some targets to format or initialize an EEPROM or ATA disk device. This is less commonly used. - **Create RAM File Systems**. The OSAL can create RAM disks on the @@ -510,7 +510,7 @@ mappings via API calls during its startup. This may be done any time after call `OS_API_Init()`. For example, for Core Flight System (cFS) configurations that require persistent -storage to be provided under a virual directory called `/cf`, the platform-specific +storage to be provided under a virtual directory called `/cf`, the platform-specific CFE PSP layer configures the mapping in an appropriate manner by calling the `OS_FileSysAddFixedMap()` API during its OS_Application_Startup() implementation. @@ -633,14 +633,14 @@ qemu-system-i386 -m 128 -no-reboot -display none -serial stdio \ ``` Where `.exe` refers to any of the test programs or applications -that are provided with OSAL. This command puts the virual console on +that are provided with OSAL. This command puts the virtual console on the same terminal where the QEMU emulator is started. The program should run automatically after the kernel boots. The system may be stopped by issuing the "shutdown" command at the shell, or by pressing the CTRL+A followed by CTRL+C which terminates QEMU. -## Generc Linux Platform +## Generic Linux Platform The OSAL can run on many Linux distributions. Testing is done with currently supported Ubuntu LTS versions (up through 20.04 at the time of the current @@ -690,7 +690,7 @@ each OSAL subsystem is specially compiled with special flags to enable profiling (to track line and branch coverage) and linked with _stub_ implementations of all other dependencies. This way, test cases can trigger error paths from library calls that would otherwise not be possible -in a black box test enviornment. +in a black box test environment. These test programs are executed just as any other application program. @@ -720,7 +720,7 @@ the test programs will be copied to the output location/staging area. ### Option 1: Execute single test directly from a build tree The tests can be executed directly in-place in the build directory. This method often useful -when debugging, as the exectuable can also be run in a debugger (i.e. gdb) this way. +when debugging, as the executable can also be run in a debugger (i.e. gdb) this way. The following example executes the task subsystem coverage test for the shared layer, but any other test can be run in a similar fashion. diff --git a/docs/src/osal_fs.dox b/docs/src/osal_fs.dox index 6a8b8cf29..c909055ba 100644 --- a/docs/src/osal_fs.dox +++ b/docs/src/osal_fs.dox @@ -74,8 +74,8 @@ instance, the path of the file that the file descriptor points to can be easily to determine statistics for a task, or the entire system. This information can all be retrieved with a single API, OS_FDGetInfo. - All of possible file system calls are not implemented. "Special" files requiring OS - specific control/operations are by nature not portable. Abstraction in this case is + All of the possible file system calls are not implemented. "Special" files requiring + OS specific control/operations are by nature not portable. Abstraction in this case is not possible, so the raw OS calls should be used (including open/close/etc). Mixing with OSAL calls is not supported for such cases. #OS_TranslatePath is available to support using open directly by an app and maintain abstraction on the file system. diff --git a/src/os/portable/README.txt b/src/os/portable/README.txt index 1f7ffd425..f4d985249 100644 --- a/src/os/portable/README.txt +++ b/src/os/portable/README.txt @@ -1,4 +1,4 @@ -Files in this directory contain an implmentation that adheres to a defined API +Files in this directory contain an implementation that adheres to a defined API that is applicable to more than one of the supported OS's, but not all. For example, the BSD-style sockets API is implemented in VxWorks, RTEMS, and Linux. Therefore it is beneficial to put the code in here and let each implementation diff --git a/src/tests/file-api-test/README.txt b/src/tests/file-api-test/README.txt index b8b0b07c9..948801543 100644 --- a/src/tests/file-api-test/README.txt +++ b/src/tests/file-api-test/README.txt @@ -4,7 +4,7 @@ test2.c is designed to test the functionality of the functions provided in osfil The modules are separate and independent. Each does not interfere with the others. -These modules are placed in a specific order, however, which assumes that the previous module worked. This is due to the uncircumventable nature of a filesystem (i.e. you cannot open a file for reading/writing without being able to create the file, and you can testing reading/writing without being able to open a file) +These modules are placed in a specific order, however, which assumes that the previous module worked. This is due to the uncircumventable nature of a filesystem (i.e. you cannot open a file for reading/writing without being able to create the file, and you can test reading/writing without being able to open a file) NOTE: When all is working properly, the output from each test will start with "OK", and not "ERROR" @@ -17,22 +17,22 @@ It also tests removing files that are not on the drive. TestOpenClose: -This module tests the ability to open and close files, opening nonexistant files, and closing files multiple times. +This module tests the ability to open and close files, opening non-existent files, and closing files multiple times. TestReadWriteLseek: -This module tests reading to a file, writing to a file, and seeking to a specific byte in a file. Once something is written, the read/write pointer is position at the beginning, and the contents are read, and compared to what was written. +This module tests reading to a file, writing to a file, and seeking to a specific byte in a file. Once something is written, the read/write pointer is positioned at the beginning, and the contents are read, and compared to what was written. TestMkRmDirFreeBytes: -This module making and removing different directories, with files in them. It also tests reading and writing to those files. +This module tests making and removing different directories, with files in them. It also tests reading and writing to those files. It also includes three calls to OS_FreeBytes, to test its functionality TestOpenCloseReadDir: -This module tests opening and closing directories, as well as reading though the directories in search of specific files or sub-level directories. +This module tests opening and closing directories, as well as reading through the directories in search of specific files or sub-level directories. TestRename: -This module create 2 directories, with a file in each, writes data to the file, then tries to rename the files and the directories, and then reads the data written to the files back out after the renaming. +This module creates 2 directories, with a file in each, writes data to the file, then tries to rename the files and the directories, and then reads the data written to the files back out after the renaming. diff --git a/src/tests/osal-core-test/README.txt b/src/tests/osal-core-test/README.txt index 79c6a2087..9f4144c1d 100644 --- a/src/tests/osal-core-test/README.txt +++ b/src/tests/osal-core-test/README.txt @@ -1,6 +1,6 @@ Explanation: -This osal-core-test.c file is a test to designed to demonstrate the functionality of the functions of osapi.c in the ../os// directory. The tests are separated into different modules- tasks, queues, binary semaphores, mutexes, and *GetInfo functions. +This osal-core-test.c file is a test designed to demonstrate the functionality of the functions of osapi.c in the ../os// directory. The tests are separated into different modules- tasks, queues, binary semaphores, mutexes, and *GetInfo functions. This separation allows for the modules to be run individually or concurrently. Each module does not affect any of the others. @@ -18,7 +18,7 @@ Tries to get the ID of the tasks by their names. Tries to Delete the tasks created previously. -NOTE: for clairity, the tasks are declared in test1.h +NOTE: for clarity, the tasks are declared in test1.h ************ TestQueues ************* diff --git a/src/unit-test-coverage/shared/CMakeLists.txt b/src/unit-test-coverage/shared/CMakeLists.txt index 7c51940aa..2aafdde48 100644 --- a/src/unit-test-coverage/shared/CMakeLists.txt +++ b/src/unit-test-coverage/shared/CMakeLists.txt @@ -54,7 +54,7 @@ foreach(MODNAME ${MODULE_LIST}) ) endforeach(MODNAME ${MODULE_LIST}) -# Add extra defintion to force the OS_STATIC_SYMTABLE_SOURCE to the +# Add extra definition to force the OS_STATIC_SYMTABLE_SOURCE to the # local value within the module coverage test target_compile_definitions(utobj_coverage-shared-module PRIVATE "OS_STATIC_SYMTABLE_SOURCE=OS_UT_STATIC_SYMBOL_TABLE" diff --git a/src/unit-test-coverage/shared/adaptors/CMakeLists.txt b/src/unit-test-coverage/shared/adaptors/CMakeLists.txt index 58caa998b..19a620d04 100644 --- a/src/unit-test-coverage/shared/adaptors/CMakeLists.txt +++ b/src/unit-test-coverage/shared/adaptors/CMakeLists.txt @@ -2,7 +2,7 @@ # are otherwise not exposed. This is generally required for any OSAL subsystem # which tracks an internal resource state (i.e. anything with a table). -# NOTE: These source files are compile with OVERRIDES on the headers just like +# NOTE: These source files are compiled with OVERRIDES on the headers just like # the FSW code is compiled. This is how it is able to include internal headers # which otherwise would fail. But that also means that adaptor code cannot call # any library functions, as this would also reach a stub, not the real function. diff --git a/src/unit-test-coverage/ut-stubs/inc/README.md b/src/unit-test-coverage/ut-stubs/inc/README.md index 720a7bffd..5a8cd1f0b 100644 --- a/src/unit-test-coverage/ut-stubs/inc/README.md +++ b/src/unit-test-coverage/ut-stubs/inc/README.md @@ -1,7 +1,7 @@ ABOUT THE SYSTEM HEADER OVERRIDES ================================= -The "overrides" directory contain replacement versions of many system-provided +The "overrides" directory contains replacement versions of many system-provided header files. All replacement functions and types are identified using an `OCS_` prefix. diff --git a/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt b/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt index 459d59373..eb22c05de 100644 --- a/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt +++ b/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt @@ -2,7 +2,7 @@ # are otherwise not exposed. This is generally required for any OSAL subsystem # which tracks an internal resource state (i.e. anything with a table). -# NOTE: These source files are compile with OVERRIDES on the headers just like +# NOTE: These source files are compiled with OVERRIDES on the headers just like # the FSW code is compiled. This is how it is able to include internal headers # which otherwise would fail. But that also means that adaptor code cannot call # any library functions, as this would also reach a stub, not the real function. diff --git a/ut_assert/README.txt b/ut_assert/README.txt index 4fde6aa99..98ba7e275 100644 --- a/ut_assert/README.txt +++ b/ut_assert/README.txt @@ -21,7 +21,7 @@ is true or false. This approach is much different than the Flight Software Branc historical approach to unit testing that creates a log file that requires developer analysis in order to determine whether a test passed or failed. In order to use the tools a developer populates the framework with their unit tests and links with the -ut-asssert library to create an executable. +ut-assert library to create an executable. Project Goals @@ -40,9 +40,9 @@ analysis in order to determine whether a test passed or failed. Functional Goals This approach allows developers to write self-verifying unit tests and the tools -provide a framework that allow unit tests to be bundled into a single executional +provide a framework that allow unit tests to be bundled into single executable units. This aggregation allows comprehensive automated unit testing so as FSRL -components are added and/or modfiied automated regression unit testing can be +components are added and/or modified automated regression unit testing can be performed. Evolvability Goals From 9c47395293e2c1443f3cd2dfe71e6781b59b58f0 Mon Sep 17 00:00:00 2001 From: Avi Date: Thu, 2 Sep 2021 08:57:27 +0200 Subject: [PATCH 008/178] Fix #1147, Correct typos in error message strings --- src/bsp/generic-vxworks/src/bsp_start.c | 2 +- src/os/rtems/src/os-impl-loader.c | 2 +- src/os/vxworks/src/os-impl-mutex.c | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/bsp/generic-vxworks/src/bsp_start.c b/src/bsp/generic-vxworks/src/bsp_start.c index 07e9e107c..89eb34cdc 100644 --- a/src/bsp/generic-vxworks/src/bsp_start.c +++ b/src/bsp/generic-vxworks/src/bsp_start.c @@ -108,7 +108,7 @@ int OS_BSPMain(void) if (OS_BSP_GenericVxWorksGlobal.AccessMutex == (SEM_ID)0) { - BSP_DEBUG("semMInitalize: errno=%d\n", errno); + BSP_DEBUG("semMInitialize: errno=%d\n", errno); } /* diff --git a/src/os/rtems/src/os-impl-loader.c b/src/os/rtems/src/os-impl-loader.c index dd986511d..3c36c672e 100644 --- a/src/os/rtems/src/os-impl-loader.c +++ b/src/os/rtems/src/os-impl-loader.c @@ -144,7 +144,7 @@ int32 OS_ModuleLoad_Impl(const OS_object_token_t *token, const char *translated_ * is acceptable. If not acceptable, it sets the status back to an error. */ - OS_DEBUG("module has has unresolved externals\n"); + OS_DEBUG("Module has unresolved externals\n"); status = OS_SUCCESS; /* note - not final, probably overridden */ OSAL_UNRESOLVED_ITERATE(OS_rtems_rtl_check_unresolved, &status); } diff --git a/src/os/vxworks/src/os-impl-mutex.c b/src/os/vxworks/src/os-impl-mutex.c index d044e5bed..4b0f64271 100644 --- a/src/os/vxworks/src/os-impl-mutex.c +++ b/src/os/vxworks/src/os-impl-mutex.c @@ -81,7 +81,7 @@ int32 OS_MutSemCreate_Impl(const OS_object_token_t *token, uint32 options) if (tmp_sem_id == (SEM_ID)0) { - OS_DEBUG("semMInitalize() - vxWorks errno %d\n", errno); + OS_DEBUG("semMInitialize() - vxWorks errno %d\n", errno); return OS_SEM_FAILURE; } From 99b3047900681df90a627a44a9973e2e4dfbb64c Mon Sep 17 00:00:00 2001 From: Avi Date: Thu, 2 Sep 2021 08:57:45 +0200 Subject: [PATCH 009/178] Fix #1147, Correct code comment typos --- Makefile.sample | 6 +++--- default_config.cmake | 8 ++++---- src/bsp/generic-linux/src/bsp_start.c | 4 ++-- src/bsp/pc-rtems/src/bsp_start.c | 4 ++-- src/bsp/shared/inc/bsp-impl.h | 2 +- src/os/inc/osapi-common.h | 2 +- src/os/inc/osapi-file.h | 18 +++++++++--------- src/os/inc/osapi-filesys.h | 2 +- src/os/inc/osapi-idmap.h | 2 +- src/os/inc/osapi-macros.h | 4 ++-- src/os/inc/osapi-module.h | 4 ++-- src/os/inc/osapi-queue.h | 2 +- src/os/inc/osapi-select.h | 2 +- src/os/inc/osapi-sockets.h | 6 +++--- src/os/inc/osapi-version.h | 2 +- src/os/portable/os-impl-bsd-sockets.c | 4 ++-- src/os/posix/inc/os-impl-gettime.h | 2 +- src/os/posix/src/os-impl-binsem.c | 4 ++-- src/os/posix/src/os-impl-countsem.c | 2 +- src/os/posix/src/os-impl-timebase.c | 2 +- src/os/rtems/inc/os-impl-gettime.h | 2 +- src/os/rtems/src/os-impl-console.c | 2 +- src/os/rtems/src/os-impl-tasks.c | 2 +- src/os/rtems/src/os-impl-timebase.c | 4 ++-- src/os/shared/inc/os-shared-common.h | 2 +- src/os/shared/inc/os-shared-console.h | 2 +- src/os/shared/inc/os-shared-filesys.h | 2 +- src/os/shared/inc/os-shared-idmap.h | 10 +++++----- src/os/shared/src/osapi-binsem.c | 2 +- src/os/shared/src/osapi-countsem.c | 2 +- src/os/shared/src/osapi-debug.c | 2 +- src/os/shared/src/osapi-dir.c | 2 +- src/os/shared/src/osapi-file.c | 2 +- src/os/shared/src/osapi-filesys.c | 4 ++-- src/os/shared/src/osapi-idmap.c | 8 ++++---- src/os/shared/src/osapi-module.c | 2 +- src/os/shared/src/osapi-mutex.c | 2 +- src/os/shared/src/osapi-queue.c | 2 +- src/os/shared/src/osapi-task.c | 2 +- src/os/shared/src/osapi-time.c | 2 +- src/os/shared/src/osapi-timebase.c | 2 +- src/os/vxworks/inc/os-impl-gettime.h | 2 +- src/os/vxworks/src/os-impl-filesys.c | 2 +- src/os/vxworks/src/os-impl-timebase.c | 4 ++-- src/tests/file-api-test/file-api-test.c | 8 ++++---- src/tests/network-api-test/network-api-test.c | 14 +++++++------- src/tests/osal-core-test/osal-core-test.c | 2 +- src/tests/queue-test/queue-test.c | 2 +- src/tests/sem-speed-test/sem-speed-test.c | 2 +- src/tests/timer-test/timer-test.c | 2 +- .../portable/src/coveragetest-bsd-select.c | 2 +- .../portable/src/coveragetest-bsd-sockets.c | 6 +++--- .../shared/src/coveragetest-idmap.c | 2 +- .../shared/src/os-shared-coveragetest.h | 2 +- .../ut-stubs/inc/OCS_vxWorks.h | 2 +- .../vxworks/src/coveragetest-tasks.c | 2 +- .../vxworks/src/coveragetest-timebase.c | 2 +- .../osfile-test/ut_osfile_dirio_test.c | 2 +- .../osfile-test/ut_osfile_fileio_test.c | 2 +- .../osfilesys-test/ut_osfilesys_diskio_test.c | 4 ++-- .../osloader-test/ut_osloader_symtable_test.c | 2 +- ut_assert/inc/utassert.h | 12 ++++++------ ut_assert/inc/utbsp.h | 2 +- ut_assert/inc/utstubs.h | 2 +- ut_assert/scripts/generate_stubs.pl | 2 +- 65 files changed, 113 insertions(+), 113 deletions(-) diff --git a/Makefile.sample b/Makefile.sample index a49cd2093..d3f83f835 100644 --- a/Makefile.sample +++ b/Makefile.sample @@ -83,13 +83,13 @@ $(FILETGTS): $(MAKE) -C $(O) $(@) endif -# The "prep" step requires extra options that are specified via enviroment variables. +# The "prep" step requires extra options that are specified via environment variables. # Certain special ones should be passed via cache (-D) options to CMake. # These are only needed for the "prep" target but they are computed globally anyway. # -# Note this simple makefile just builds for one target, could trivally manage +# Note this simple makefile just builds for one target, could trivially manage # multiple targets by changing build directory. More complex target -# list examples are provide by cFE.. +# list examples are provided by cFE. PREP_OPTS := -DOSAL_SYSTEM_BSPTYPE=$(BSPTYPE) -DINSTALL_TARGET_LIST=. ifneq ($(INSTALLPREFIX),) diff --git a/default_config.cmake b/default_config.cmake index 2ba2c0d1d..62172307c 100644 --- a/default_config.cmake +++ b/default_config.cmake @@ -30,7 +30,7 @@ # either in the OSAL or the application which invoked OSAL. # # If set FALSE (default), then the OSAL bugcheck macro will evaluate its -# boolean conditional and generate an action if that conditional evaulates +# boolean conditional and generate an action if that conditional evaluates # false. (The specific action to take is configured via a different # directive -- see OSAL_CONFIG_BUGCHECK_STRICT). # @@ -73,7 +73,7 @@ set(OSAL_CONFIG_BUGCHECK_STRICT FALSE) # # Whether to include the Network API # -# If set TRUE, the the socket abstraction (if applicable on the platform) +# If set TRUE, the socket abstraction (if applicable on the platform) # will be included. If set FALSE, then all calls to the network API will # return OS_ERR_NOT_IMPLEMENTED. # @@ -276,12 +276,12 @@ set(OSAL_CONFIG_MAX_FILE_NAME 20 CACHE STRING "Maximum Length of file names" ) -# Maximum length for an virtual path name (virtual directory + file) +# Maximum length for a virtual path name (virtual directory + file) set(OSAL_CONFIG_MAX_PATH_LEN 64 CACHE STRING "Maximum Length of path names" ) -# Maximum length allowed for a object (task,queue....) name +# Maximum length allowed for an object (task,queue....) name set(OSAL_CONFIG_MAX_API_NAME 20 CACHE STRING "Maximum Length of resource names" ) diff --git a/src/bsp/generic-linux/src/bsp_start.c b/src/bsp/generic-linux/src/bsp_start.c index 67e21158d..5f10c7126 100644 --- a/src/bsp/generic-linux/src/bsp_start.c +++ b/src/bsp/generic-linux/src/bsp_start.c @@ -136,7 +136,7 @@ void OS_BSP_Unlock_Impl(void) } else { - /* Restore previous cancelability state */ + /* Restore previous cancellability state */ pthread_setcancelstate(OS_BSP_GenericLinuxGlobal.AccessCancelState, NULL); } } @@ -212,7 +212,7 @@ int main(int argc, char *argv[]) * Note that the first argument (0) is the command name. The * first "real" argument is at position 1. * - * However this still needs to pass it through as the appliction + * However this still needs to pass it through as the application * might still want to use library "getopt" and this expects the * first parameter to be this way. */ diff --git a/src/bsp/pc-rtems/src/bsp_start.c b/src/bsp/pc-rtems/src/bsp_start.c index 1d0ef9789..f3c9cfa67 100644 --- a/src/bsp/pc-rtems/src/bsp_start.c +++ b/src/bsp/pc-rtems/src/bsp_start.c @@ -101,7 +101,7 @@ void OS_BSP_Setup(void) * Known arguments are handled here, and unknown args are * saved for the UT application. * - * Batch mode is intended for non-interative execution. + * Batch mode is intended for non-interactive execution. * * It does two things: * - do not start the shell task @@ -385,7 +385,7 @@ rtems_task Init(rtems_task_argument ignored) /* configuration information */ /* -** RTEMS OS Configuration defintions +** RTEMS OS Configuration definitions */ #define TASK_INTLEVEL 0 #define CONFIGURE_INIT diff --git a/src/bsp/shared/inc/bsp-impl.h b/src/bsp/shared/inc/bsp-impl.h index d2e7cfcbc..bb7d4a16f 100644 --- a/src/bsp/shared/inc/bsp-impl.h +++ b/src/bsp/shared/inc/bsp-impl.h @@ -113,7 +113,7 @@ extern OS_BSP_GlobalData_t OS_BSP_Global; Purpose: Get exclusive access to a BSP-provided service or object - Useful in conjuction with console output functions to avoid strings + Useful in conjunction with console output functions to avoid strings from multiple tasks getting mixed together in the final output. ------------------------------------------------------------------*/ diff --git a/src/os/inc/osapi-common.h b/src/os/inc/osapi-common.h index 4f1659d9c..26b389257 100644 --- a/src/os/inc/osapi-common.h +++ b/src/os/inc/osapi-common.h @@ -150,7 +150,7 @@ int32 OS_API_Init(void); * * Normally for embedded applications, the OSAL is initialized after boot and will remain * initialized in memory until the processor is rebooted. However for testing and - * developement purposes, it is potentially useful to reset back to initial conditions. + * development purposes, it is potentially useful to reset back to initial conditions. * * For testing purposes, this API is designed/intended to be compatible with the * UtTest_AddTeardown() routine provided by the UT-Assert subsystem. diff --git a/src/os/inc/osapi-file.h b/src/os/inc/osapi-file.h index b16a45e18..78871f848 100644 --- a/src/os/inc/osapi-file.h +++ b/src/os/inc/osapi-file.h @@ -306,7 +306,7 @@ int32 OS_chmod(const char *path, uint32 access_mode); /** * @brief Obtain information about a file or directory * - * Returns information about a file or directory in a os_fstat_t structure + * Returns information about a file or directory in an os_fstat_t structure * * @param[in] path The file to operate on @nonnull * @param[out] filestats Buffer to store file information @nonnull @@ -344,9 +344,9 @@ int32 OS_lseek(osal_id_t filedes, int32 offset, uint32 whence); * * Removes a given filename from the drive * - * @note The behvior of this API on an open file is not defined at the OSAL level + * @note The behavior of this API on an open file is not defined at the OSAL level * due to dependencies on the underlying OS which may or may not allow the related - * operation based on a varienty of potential configurations. For portability, + * operation based on a variety of potential configurations. For portability, * it is recommended that applications ensure the file is closed prior to removal. * * @param[in] path The file to operate on @nonnull @@ -368,9 +368,9 @@ int32 OS_remove(const char *path); * Changes the name of a file, where the source and destination * reside on the same file system. * - * @note The behvior of this API on an open file is not defined at the OSAL level + * @note The behavior of this API on an open file is not defined at the OSAL level * due to dependencies on the underlying OS which may or may not allow the related - * operation based on a varienty of potential configurations. For portability, + * operation based on a variety of potential configurations. For portability, * it is recommended that applications ensure the file is closed prior to removal. * * @param[in] old_filename The original filename @nonnull @@ -390,9 +390,9 @@ int32 OS_rename(const char *old_filename, const char *new_filename); /** * @brief Copies a single file from src to dest * - * @note The behvior of this API on an open file is not defined at the OSAL level + * @note The behavior of this API on an open file is not defined at the OSAL level * due to dependencies on the underlying OS which may or may not allow the related - * operation based on a varienty of potential configurations. For portability, + * operation based on a variety of potential configurations. For portability, * it is recommended that applications ensure the file is closed prior to removal. * * @param[in] src The source file to operate on @nonnull @@ -418,9 +418,9 @@ int32 OS_cp(const char *src, const char *dest); * If this fails, it falls back to copying the file and removing * the original. * - * @note The behvior of this API on an open file is not defined at the OSAL level + * @note The behavior of this API on an open file is not defined at the OSAL level * due to dependencies on the underlying OS which may or may not allow the related - * operation based on a varienty of potential configurations. For portability, + * operation based on a variety of potential configurations. For portability, * it is recommended that applications ensure the file is closed prior to removal. * * @param[in] src The source file to operate on @nonnull diff --git a/src/os/inc/osapi-filesys.h b/src/os/inc/osapi-filesys.h index 58ca0ffbf..4330ce534 100644 --- a/src/os/inc/osapi-filesys.h +++ b/src/os/inc/osapi-filesys.h @@ -270,7 +270,7 @@ int32 OS_FS_GetPhysDriveName(char *PhysDriveName, const char *MountPoint); /*-------------------------------------------------------------------------------------*/ /** - * @brief Translates a OSAL Virtual file system path to a host Local path + * @brief Translates an OSAL Virtual file system path to a host Local path * * Translates a virtual path to an actual system path name * diff --git a/src/os/inc/osapi-idmap.h b/src/os/inc/osapi-idmap.h index cf7e4c361..93048c4b9 100644 --- a/src/os/inc/osapi-idmap.h +++ b/src/os/inc/osapi-idmap.h @@ -66,7 +66,7 @@ * * The returned value is of the type "unsigned long" for direct use with * printf-style functions. It is recommended to use the "%lx" conversion - * specifier as the hexidecimal encoding clearly delineates the internal fields. + * specifier as the hexadecimal encoding clearly delineates the internal fields. * * @note This provides the raw integer value and is _not_ suitable for use * as an array index, as the result is not zero-based. See the diff --git a/src/os/inc/osapi-macros.h b/src/os/inc/osapi-macros.h index 594ddee7f..5f94e116f 100644 --- a/src/os/inc/osapi-macros.h +++ b/src/os/inc/osapi-macros.h @@ -57,7 +57,7 @@ #ifdef OSAL_CONFIG_BUGCHECK_STRICT /* - * This BUGREPORT implementation aborts the application so that the applicaiton + * This BUGREPORT implementation aborts the application so that the application * can be debugged immediately. This prints the message direct to stderr, which is * typically not buffered, so it should appear on the console before the abort occurs, * but may appear out of order with respect to calls to OS_printf(). @@ -114,7 +114,7 @@ * which may (validly) occur at runtime and do not necessarily indicate bugs in the * application. * - * These argument checks are NOT considered a fatal errors. The application + * These argument checks are NOT considered fatal errors. The application * continues to run normally. This does not report the error on the console. * * As such, ARGCHECK actions are always compiled in - not selectable at compile-time. diff --git a/src/os/inc/osapi-module.h b/src/os/inc/osapi-module.h index ed5c52c5b..376bd87f1 100644 --- a/src/os/inc/osapi-module.h +++ b/src/os/inc/osapi-module.h @@ -55,8 +55,8 @@ * * When supplied as the "flags" argument to OS_ModuleLoad(), this indicates * that the symbols in the loaded module should NOT be added to the global - * symbol table. This means the symbols in the loaded library will not available - * to for use by other modules. + * symbol table. This means the symbols in the loaded library will not be + * available for use by other modules. * * Use this option is recommended for cases where no other entities will need * to reference symbols within this module. This helps ensure that the module diff --git a/src/os/inc/osapi-queue.h b/src/os/inc/osapi-queue.h index 874f368b7..2792cd36c 100644 --- a/src/os/inc/osapi-queue.h +++ b/src/os/inc/osapi-queue.h @@ -105,7 +105,7 @@ int32 OS_QueueDelete(osal_id_t queue_id); * @retval #OS_SUCCESS @copybrief OS_SUCCESS * @retval #OS_ERR_INVALID_ID if the given ID does not exist * @retval #OS_INVALID_POINTER if a pointer passed in is NULL - * @retval #OS_QUEUE_EMPTY if the Queue has no messages on it to be recieved + * @retval #OS_QUEUE_EMPTY if the Queue has no messages on it to be received * @retval #OS_QUEUE_TIMEOUT if the timeout was OS_PEND and the time expired * @retval #OS_QUEUE_INVALID_SIZE if the size copied from the queue was not correct * @retval #OS_ERROR if the OS call returns an unexpected error @covtest diff --git a/src/os/inc/osapi-select.h b/src/os/inc/osapi-select.h index c46fd4750..012bf62bd 100644 --- a/src/os/inc/osapi-select.h +++ b/src/os/inc/osapi-select.h @@ -70,7 +70,7 @@ typedef enum /** * @brief Wait for events across multiple file handles * - * Wait for any of the given sets of IDs to be become readable or writable + * Wait for any of the given sets of IDs to become readable or writable * * This function will block until any of the following occurs: * - At least one OSAL ID in the ReadSet is readable diff --git a/src/os/inc/osapi-sockets.h b/src/os/inc/osapi-sockets.h index ca7e9622f..266887fa2 100644 --- a/src/os/inc/osapi-sockets.h +++ b/src/os/inc/osapi-sockets.h @@ -134,7 +134,7 @@ typedef struct * is (mostly) agnostic to the actual network address type. * * Every network address should be representable as a string (i.e. dotted decimal IP, etc). - * This can serve as a the "common denominator" to all address types. + * This can serve as the "common denominator" to all address types. * * @{ */ @@ -208,7 +208,7 @@ int32 OS_SocketAddrFromString(OS_SockAddr_t *Addr, const char *string); /** * @brief Get the port number of a network address * - * For network prototcols that have the concept of a port number (such + * For network protocols that have the concept of a port number (such * as TCP/IP and UDP/IP) this function gets the port number from the * address structure. * @@ -226,7 +226,7 @@ int32 OS_SocketAddrGetPort(uint16 *PortNum, const OS_SockAddr_t *Addr); /** * @brief Set the port number of a network address * - * For network prototcols that have the concept of a port number (such + * For network protocols that have the concept of a port number (such * as TCP/IP and UDP/IP) this function sets the port number from the * address structure. * diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index 679edaee0..5c54397c9 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -49,7 +49,7 @@ /*! * @brief Mission revision. * - * Set to 0 on OFFIFICIAL releases, and set to 255 (0xFF) on development versions. + * Set to 0 on OFFICIAL releases, and set to 255 (0xFF) on development versions. * Values 1-254 are reserved for mission use to denote patches/customizations as needed. */ #define OS_MISSION_REV 0xFF diff --git a/src/os/portable/os-impl-bsd-sockets.c b/src/os/portable/os-impl-bsd-sockets.c index e7da995cb..cb31211a6 100644 --- a/src/os/portable/os-impl-bsd-sockets.c +++ b/src/os/portable/os-impl-bsd-sockets.c @@ -22,7 +22,7 @@ * \file os-impl-bsd-sockets.c * \author joseph.p.hickey@nasa.gov * - * Purpose: This file contains the network functionality for for + * Purpose: This file contains the network functionality for * systems which implement the BSD-style socket API. */ @@ -77,7 +77,7 @@ typedef union * Confirm that the abstract socket address buffer size (OS_SOCKADDR_MAX_LEN) is * large enough to store any of the enabled address types. If this is true, the * size of the above union will match OS_SOCKADDR_MAX_LEN. However, if any - * implemention-provided struct types are larger than this, the union will be + * implementation-provided struct types are larger than this, the union will be * larger, and this indicates a configuration error. */ CompileTimeAssert(sizeof(OS_SockAddr_Accessor_t) == OS_SOCKADDR_MAX_LEN, SockAddrSize); diff --git a/src/os/posix/inc/os-impl-gettime.h b/src/os/posix/inc/os-impl-gettime.h index a15ae3a78..c75251080 100644 --- a/src/os/posix/inc/os-impl-gettime.h +++ b/src/os/posix/inc/os-impl-gettime.h @@ -32,7 +32,7 @@ #include /** - * \brief Idenfies the clock ID for OSAL clock operations on POSIX + * \brief Identifies the clock ID for OSAL clock operations on POSIX * * This is the POSIX clock ID that will be used to implement * OS_GetLocalTime() and OS_SetLocalTime(). diff --git a/src/os/posix/src/os-impl-binsem.c b/src/os/posix/src/os-impl-binsem.c index 42999931a..c794407ce 100644 --- a/src/os/posix/src/os-impl-binsem.c +++ b/src/os/posix/src/os-impl-binsem.c @@ -37,7 +37,7 @@ #include "os-impl-binsem.h" /* - * This controls the maximum time the that the calling thread will wait to + * This controls the maximum time that the calling thread will wait to * acquire the condition mutex before returning an error. * * Under normal conditions, this lock is held by giving/taking threads very @@ -495,7 +495,7 @@ int32 OS_BinSemGetInfo_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *s sem = OS_OBJECT_TABLE_GET(OS_impl_bin_sem_table, *token); - /* put the info into the stucture */ + /* put the info into the structure */ sem_prop->value = sem->current_value; return OS_SUCCESS; } /* end OS_BinSemGetInfo_Impl */ diff --git a/src/os/posix/src/os-impl-countsem.c b/src/os/posix/src/os-impl-countsem.c index dac78b6ab..ea79b88e3 100644 --- a/src/os/posix/src/os-impl-countsem.c +++ b/src/os/posix/src/os-impl-countsem.c @@ -221,7 +221,7 @@ int32 OS_CountSemGetInfo_Impl(const OS_object_token_t *token, OS_count_sem_prop_ return OS_SEM_FAILURE; } - /* put the info into the stucture */ + /* put the info into the structure */ count_prop->value = sval; return OS_SUCCESS; } /* end OS_CountSemGetInfo_Impl */ diff --git a/src/os/posix/src/os-impl-timebase.c b/src/os/posix/src/os-impl-timebase.c index 1c35b0279..fd30f78fa 100644 --- a/src/os/posix/src/os-impl-timebase.c +++ b/src/os/posix/src/os-impl-timebase.c @@ -57,7 +57,7 @@ static void OS_UsecToTimespec(uint32 usecs, struct timespec *time_spec); ***************************************************************************************/ /* - * Prefer to use the MONOTONIC clock if available, as it will not get distrupted by setting + * Prefer to use the MONOTONIC clock if available, as it will not get disrupted by setting * the time like the REALTIME clock will. */ #ifndef OS_PREFERRED_CLOCK diff --git a/src/os/rtems/inc/os-impl-gettime.h b/src/os/rtems/inc/os-impl-gettime.h index 701e0c130..fb8b303fb 100644 --- a/src/os/rtems/inc/os-impl-gettime.h +++ b/src/os/rtems/inc/os-impl-gettime.h @@ -32,7 +32,7 @@ #include /** - * \brief Idenfies the clock ID for OSAL clock operations on RTEMS + * \brief Identifies the clock ID for OSAL clock operations on RTEMS * * This is the POSIX clock ID that will be used to implement * OS_GetLocalTime() and OS_SetLocalTime(). diff --git a/src/os/rtems/src/os-impl-console.c b/src/os/rtems/src/os-impl-console.c index ce3ee18c8..02458693a 100644 --- a/src/os/rtems/src/os-impl-console.c +++ b/src/os/rtems/src/os-impl-console.c @@ -172,7 +172,7 @@ int32 OS_ConsoleCreate_Impl(const OS_object_token_t *token) /* check if task_create failed */ if (status != RTEMS_SUCCESSFUL) { - /* Provide some freedback as to why this failed */ + /* Provide some feedback as to why this failed */ OS_DEBUG("rtems_task_create failed: %s\n", rtems_status_text(status)); rtems_semaphore_delete(local->data_sem); return_code = OS_ERROR; diff --git a/src/os/rtems/src/os-impl-tasks.c b/src/os/rtems/src/os-impl-tasks.c index 675ac50a5..99407107c 100644 --- a/src/os/rtems/src/os-impl-tasks.c +++ b/src/os/rtems/src/os-impl-tasks.c @@ -127,7 +127,7 @@ int32 OS_TaskCreate_Impl(const OS_object_token_t *token, uint32 flags) /* check if task_create failed */ if (status != RTEMS_SUCCESSFUL) { - /* Provide some freedback as to why this failed */ + /* Provide some feedback as to why this failed */ OS_printf("rtems_task_create failed: %s\n", rtems_status_text(status)); return OS_ERROR; } diff --git a/src/os/rtems/src/os-impl-timebase.c b/src/os/rtems/src/os-impl-timebase.c index 2c59cdc29..b85151630 100644 --- a/src/os/rtems/src/os-impl-timebase.c +++ b/src/os/rtems/src/os-impl-timebase.c @@ -49,7 +49,7 @@ void OS_UsecsToTicks(uint32 usecs, rtems_interval *ticks); ***************************************************************************************/ /* - * Prefer to use the MONOTONIC clock if available, as it will not get distrupted by setting + * Prefer to use the MONOTONIC clock if available, as it will not get disrupted by setting * the time like the REALTIME clock will. */ #ifndef OS_PREFERRED_CLOCK @@ -385,7 +385,7 @@ int32 OS_TimeBaseCreate_Impl(const OS_object_token_t *token) /* check if task_create failed */ if (rtems_sc != RTEMS_SUCCESSFUL) { - /* Provide some freedback as to why this failed */ + /* Provide some feedback as to why this failed */ OS_printf("rtems_task_create failed: %s\n", rtems_status_text(rtems_sc)); return_code = OS_TIMER_ERR_INTERNAL; } diff --git a/src/os/shared/inc/os-shared-common.h b/src/os/shared/inc/os-shared-common.h index c6cb302fc..cbc6b4e5c 100644 --- a/src/os/shared/inc/os-shared-common.h +++ b/src/os/shared/inc/os-shared-common.h @@ -98,7 +98,7 @@ int32 OS_NotifyEvent(OS_Event_t event, osal_id_t object_id, void *data); int32 OS_API_Impl_Init(osal_objtype_t idtype); /* - * This functions implement a the OS-specific portion + * This function implements the OS-specific portion * of various OSAL functions. They are defined in * OS-specific source files. */ diff --git a/src/os/shared/inc/os-shared-console.h b/src/os/shared/inc/os-shared-console.h index ccba744f6..d3cd32210 100644 --- a/src/os/shared/inc/os-shared-console.h +++ b/src/os/shared/inc/os-shared-console.h @@ -87,7 +87,7 @@ int32 OS_ConsoleCreate_Impl(const OS_object_token_t *token); This is a notification API that is invoked whenever there is new data available in the console output buffer. - It is only used of the console is configured for async operation, + It is only used if the console is configured for async operation, and it should wakeup the actual console servicing thread. ------------------------------------------------------------------*/ void OS_ConsoleWakeup_Impl(const OS_object_token_t *token); diff --git a/src/os/shared/inc/os-shared-filesys.h b/src/os/shared/inc/os-shared-filesys.h index 190ce4cde..1ea87cba6 100644 --- a/src/os/shared/inc/os-shared-filesys.h +++ b/src/os/shared/inc/os-shared-filesys.h @@ -77,7 +77,7 @@ enum { OS_FILESYS_TYPE_UNKNOWN = 0, /**< Unspecified or unknown file system type */ - OS_FILESYS_TYPE_FS_BASED, /**< A emulated virtual file system that maps to another file system location */ + OS_FILESYS_TYPE_FS_BASED, /**< An emulated virtual file system that maps to another file system location */ OS_FILESYS_TYPE_NORMAL_DISK, /**< A traditional disk drive or something that emulates one */ OS_FILESYS_TYPE_VOLATILE_DISK, /**< A temporary/volatile file system or RAM disk */ OS_FILESYS_TYPE_MTD, /**< A "memory technology device" such as FLASH or EEPROM */ diff --git a/src/os/shared/inc/os-shared-idmap.h b/src/os/shared/inc/os-shared-idmap.h index 4eab9e44e..4fb87c862 100644 --- a/src/os/shared/inc/os-shared-idmap.h +++ b/src/os/shared/inc/os-shared-idmap.h @@ -75,8 +75,8 @@ typedef enum } OS_lock_mode_t; /* - * A unique key value issued when obtaining a table lock, based on a - * the a combination of the requesting task ID and a transaction ID + * A unique key value issued when obtaining a table lock, based on + * a combination of the requesting task ID and a transaction ID */ typedef struct { @@ -233,7 +233,7 @@ void OS_WaitForStateChange(OS_object_token_t *token, uint32 attempts); another thread. It is not guaranteed what, if any, state change has actually - occured when this function returns. This may be implement as + occurred when this function returns. This may be implemented as a simple OS_TaskDelay(). ------------------------------------------------------------------*/ @@ -454,7 +454,7 @@ void OS_ObjectIdRelease(OS_object_token_t *token); /*---------------------------------------------------------------- Function: OS_ObjectIdTransferToken - Purpose: Transfers ownership of a object token without unlocking/releasing. + Purpose: Transfers ownership of an object token without unlocking/releasing. The original token will become benign and the new token becomes active. Returns: none @@ -512,7 +512,7 @@ int32 OS_ObjectIdIteratorInit(OS_ObjectMatchFunc_t matchfunc, void *matcharg, os /*---------------------------------------------------------------- Function: OS_ObjectIdIterateActive - Purpose: Initialize a object iterator of the given type that will + Purpose: Initialize an object iterator of the given type that will return only active/valid OSAL objects. Returns: OS_SUCCESS on success, or relevant error code diff --git a/src/os/shared/src/osapi-binsem.c b/src/os/shared/src/osapi-binsem.c index e498db02f..c068f529c 100644 --- a/src/os/shared/src/osapi-binsem.c +++ b/src/os/shared/src/osapi-binsem.c @@ -43,7 +43,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_BIN_SEMAPHORES) || (OS_MAX_BIN_SEMAPHORES <= 0) #error "osconfig.h must define OS_MAX_BIN_SEMAPHORES to a valid value" diff --git a/src/os/shared/src/osapi-countsem.c b/src/os/shared/src/osapi-countsem.c index 9eebafc84..c8208ae6d 100644 --- a/src/os/shared/src/osapi-countsem.c +++ b/src/os/shared/src/osapi-countsem.c @@ -43,7 +43,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_COUNT_SEMAPHORES) || (OS_MAX_COUNT_SEMAPHORES <= 0) #error "osconfig.h must define OS_MAX_COUNT_SEMAPHORES to a valid value" diff --git a/src/os/shared/src/osapi-debug.c b/src/os/shared/src/osapi-debug.c index 5a3e2fa5f..f67fe48dc 100644 --- a/src/os/shared/src/osapi-debug.c +++ b/src/os/shared/src/osapi-debug.c @@ -25,7 +25,7 @@ * * Contains the implementation for OS_DEBUG(). * - * This is only compiled in when OSAL_CONFIG_DEBUG_PRINTF is enabled. + * This is only compiled when OSAL_CONFIG_DEBUG_PRINTF is enabled. */ /**************************************************************************************** diff --git a/src/os/shared/src/osapi-dir.c b/src/os/shared/src/osapi-dir.c index 0a296306e..90eab3223 100644 --- a/src/os/shared/src/osapi-dir.c +++ b/src/os/shared/src/osapi-dir.c @@ -45,7 +45,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_NUM_OPEN_DIRS) || (OS_MAX_NUM_OPEN_DIRS <= 0) #error "osconfig.h must define OS_MAX_NUM_OPEN_DIRS to a valid value" diff --git a/src/os/shared/src/osapi-file.c b/src/os/shared/src/osapi-file.c index 0e8a28bdb..c2d3191b6 100644 --- a/src/os/shared/src/osapi-file.c +++ b/src/os/shared/src/osapi-file.c @@ -49,7 +49,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_NUM_OPEN_FILES) || (OS_MAX_NUM_OPEN_FILES <= 0) #error "osconfig.h must define OS_MAX_NUM_OPEN_FILES to a valid value" diff --git a/src/os/shared/src/osapi-filesys.c b/src/os/shared/src/osapi-filesys.c index 68eb5f438..f2a77f264 100644 --- a/src/os/shared/src/osapi-filesys.c +++ b/src/os/shared/src/osapi-filesys.c @@ -348,7 +348,7 @@ int32 OS_mkfs(char *address, const char *devname, const char *volname, size_t bl /* * This is the historic filesystem-specific error code generated when * attempting to mkfs()/initfs() on a filesystem that was - * already initialized, or of there were no free slots in the table. + * already initialized, or if there were no free slots in the table. * * This code preserved just in case application code was checking for it. */ @@ -418,7 +418,7 @@ int32 OS_initfs(char *address, const char *devname, const char *volname, size_t /* * This is the historic filesystem-specific error code generated when * attempting to mkfs()/initfs() on a filesystem that was - * already initialized, or of there were no free slots in the table. + * already initialized, or if there were no free slots in the table. * * This code preserved just in case application code was checking for it. */ diff --git a/src/os/shared/src/osapi-idmap.c b/src/os/shared/src/osapi-idmap.c index c66b93237..725cbbdf0 100644 --- a/src/os/shared/src/osapi-idmap.c +++ b/src/os/shared/src/osapi-idmap.c @@ -1003,7 +1003,7 @@ int32 OS_ObjectIdFindByName(osal_objtype_t idtype, const char *name, osal_id_t * OS_object_token_t token; /* - * As this is an internal-only function, calling it will NULL is allowed. + * As this is an internal-only function, calling it with NULL is allowed. * This is required by the file/dir/socket API since these DO allow multiple * instances of the same name. */ @@ -1031,7 +1031,7 @@ int32 OS_ObjectIdFindByName(osal_objtype_t idtype, const char *name, osal_id_t * * If successful, this returns with the item locked according to "lock_mode". * * IMPORTANT: when this function returns OS_SUCCESS with lock_mode something - * other than NONE, then the caller must take appropriate action to UN lock + * other than NONE, then the caller must take appropriate action to UNLOCK * after completing the respective operation. The OS_ObjectIdRelease() * function may be used to release the lock appropriately for the lock_mode. * @@ -1056,7 +1056,7 @@ int32 OS_ObjectIdGetById(OS_lock_mode_t lock_mode, osal_objtype_t idtype, osal_i /* * The "ConvertToken" routine will return with the global lock * in a state appropriate for returning to the caller, as indicated - * by the "check_mode" paramter. + * by the "check_mode" parameter. * * Note If this operation fails, then it always unlocks the global for * all check_mode's other than NONE. @@ -1209,7 +1209,7 @@ int32 OS_ObjectIdAllocateNew(osal_objtype_t idtype, const char *name, OS_object_ } /* - * Check if an object of the same name already exits. + * Check if an object of the same name already exists. * If so, a new object cannot be allocated. */ if (name != NULL) diff --git a/src/os/shared/src/osapi-module.c b/src/os/shared/src/osapi-module.c index 23ddc0126..720da42ed 100644 --- a/src/os/shared/src/osapi-module.c +++ b/src/os/shared/src/osapi-module.c @@ -48,7 +48,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_MODULES) || (OS_MAX_MODULES <= 0) #error "osconfig.h must define OS_MAX_MODULES to a valid value" diff --git a/src/os/shared/src/osapi-mutex.c b/src/os/shared/src/osapi-mutex.c index fb07100cd..70c651db0 100644 --- a/src/os/shared/src/osapi-mutex.c +++ b/src/os/shared/src/osapi-mutex.c @@ -48,7 +48,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_MUTEXES) || (OS_MAX_MUTEXES <= 0) #error "osconfig.h must define OS_MAX_MUTEXES to a valid value" diff --git a/src/os/shared/src/osapi-queue.c b/src/os/shared/src/osapi-queue.c index 24a303577..c3a351934 100644 --- a/src/os/shared/src/osapi-queue.c +++ b/src/os/shared/src/osapi-queue.c @@ -47,7 +47,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_QUEUES) || (OS_MAX_QUEUES <= 0) #error "osconfig.h must define OS_MAX_QUEUES to a valid value" diff --git a/src/os/shared/src/osapi-task.c b/src/os/shared/src/osapi-task.c index 9124b1349..abeb839c4 100644 --- a/src/os/shared/src/osapi-task.c +++ b/src/os/shared/src/osapi-task.c @@ -49,7 +49,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_TASKS) || (OS_MAX_TASKS <= 0) #error "osconfig.h must define OS_MAX_TASKS to a valid value" diff --git a/src/os/shared/src/osapi-time.c b/src/os/shared/src/osapi-time.c index c196ec003..89b624399 100644 --- a/src/os/shared/src/osapi-time.c +++ b/src/os/shared/src/osapi-time.c @@ -48,7 +48,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_TIMERS) || (OS_MAX_TIMERS <= 0) #error "osconfig.h must define OS_MAX_TIMERS to a valid value" diff --git a/src/os/shared/src/osapi-timebase.c b/src/os/shared/src/osapi-timebase.c index a7918852a..f6ba02f49 100644 --- a/src/os/shared/src/osapi-timebase.c +++ b/src/os/shared/src/osapi-timebase.c @@ -50,7 +50,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_TIMEBASES) || (OS_MAX_TIMEBASES <= 0) #error "osconfig.h must define OS_MAX_TIMEBASES to a valid value" diff --git a/src/os/vxworks/inc/os-impl-gettime.h b/src/os/vxworks/inc/os-impl-gettime.h index fcd1ded7b..980275605 100644 --- a/src/os/vxworks/inc/os-impl-gettime.h +++ b/src/os/vxworks/inc/os-impl-gettime.h @@ -32,7 +32,7 @@ #include /** - * \brief Idenfies the clock ID for OSAL clock operations on VxWorks + * \brief Identifies the clock ID for OSAL clock operations on VxWorks * * This is the POSIX clock ID that will be used to implement * OS_GetLocalTime() and OS_SetLocalTime(). diff --git a/src/os/vxworks/src/os-impl-filesys.c b/src/os/vxworks/src/os-impl-filesys.c index 5352e8563..638279e0e 100644 --- a/src/os/vxworks/src/os-impl-filesys.c +++ b/src/os/vxworks/src/os-impl-filesys.c @@ -105,7 +105,7 @@ int32 OS_FileSysStartVolume_Impl(const OS_object_token_t *token) /* ** Create the ram disk device ** The 32 is the number of blocks per track. - ** Other values dont seem to work here + ** Other values don't seem to work here */ impl->blkDev = ramDevCreate(local->address, local->blocksize, 32, local->numblocks, 0); impl->xbdMaxPartitions = 1; diff --git a/src/os/vxworks/src/os-impl-timebase.c b/src/os/vxworks/src/os-impl-timebase.c index 959376ff3..a68494c6b 100644 --- a/src/os/vxworks/src/os-impl-timebase.c +++ b/src/os/vxworks/src/os-impl-timebase.c @@ -48,7 +48,7 @@ DEFINES ****************************************************************************************/ -/* Each "timebase" resource spawns an dedicated servicing task- +/* Each "timebase" resource spawns a dedicated servicing task- * this task (not the timer ISR) is the context that calls back to * the user application. * @@ -60,7 +60,7 @@ #define OSAL_TIMEBASE_REG_WAIT_LIMIT 100 /* - * Prefer to use the MONOTONIC clock if available, as it will not get distrupted by setting + * Prefer to use the MONOTONIC clock if available, as it will not get disrupted by setting * the time like the REALTIME clock will. */ #ifndef OS_PREFERRED_CLOCK diff --git a/src/tests/file-api-test/file-api-test.c b/src/tests/file-api-test/file-api-test.c index 3ca691f09..807a74030 100644 --- a/src/tests/file-api-test/file-api-test.c +++ b/src/tests/file-api-test/file-api-test.c @@ -195,7 +195,7 @@ void TestCreatRemove(void) /*--------------------------------------------------------------------------------------- * Name: TestOpenClose - * This functions tests the basic functionality of OS_open and OS_close. + * This function tests the basic functionality of OS_open and OS_close. ---------------------------------------------------------------------------------------*/ void TestOpenClose(void) { @@ -485,7 +485,7 @@ void TestMkRmDirFreeBytes(void) status = OS_OpenCreate(&fd2, filename2, OS_FILE_FLAG_CREATE | OS_FILE_FLAG_TRUNCATE, OS_READ_WRITE); UtAssert_True(status >= OS_SUCCESS, "status after creat 2 = %d", (int)status); - /* write the propper buffers into each of the files */ + /* write the proper buffers into each of the files */ size = strlen(buffer1); status = OS_write(fd1, buffer1, size); UtAssert_True(status == size, "status after write 1 = %d size = %lu", (int)status, (unsigned long)size); @@ -796,7 +796,7 @@ void TestRename(void) status = OS_OpenCreate(&fd1, filename1, OS_FILE_FLAG_CREATE | OS_FILE_FLAG_TRUNCATE, OS_READ_WRITE); UtAssert_True(status >= OS_SUCCESS, "status after creat 1 = %d", (int)status); - /* write the propper buffes into the file */ + /* write the proper buffers into the file */ size = strlen(buffer1); status = OS_write(fd1, buffer1, size); @@ -904,7 +904,7 @@ void TestStat(void) /*--------------------------------------------------------------------------------------- * Name: TestOpenFileAPI - * This function tests the the misc open File API: + * This function tests the misc open File API: * OS_FileOpenCheck(char *Filename); * OS_CloseAllFiles(void); * OS_CloseFileByName(char *Filename); diff --git a/src/tests/network-api-test/network-api-test.c b/src/tests/network-api-test/network-api-test.c index 9e7c29213..6a9f8e778 100644 --- a/src/tests/network-api-test/network-api-test.c +++ b/src/tests/network-api-test/network-api-test.c @@ -296,7 +296,7 @@ void TestDatagramNetworkApi(void) /* Send data from peer1 to peer2 */ UtAssert_INT32_EQ(OS_SocketSendTo(p1_socket_id, &Buf1, sizeof(Buf1), &p2_addr), sizeof(Buf1)); - /* Recieve data from peer1 to peer2 */ + /* Receive data from peer1 to peer2 */ UtAssert_INT32_EQ(OS_SocketRecvFrom(p2_socket_id, &Buf2, sizeof(Buf2), &l_addr, UT_TIMEOUT), sizeof(Buf2)); UtAssert_True(Buf1 == Buf2, "Buf1 (%ld) == Buf2 (%ld)", (long)Buf1, (long)Buf2); @@ -314,7 +314,7 @@ void TestDatagramNetworkApi(void) /* Send data from peer2 to peer1 */ UtAssert_INT32_EQ(OS_SocketSendTo(p2_socket_id, &Buf3, sizeof(Buf3), &p1_addr), sizeof(Buf3)); - /* Recieve data from peer2 to peer1 */ + /* Receive data from peer2 to peer1 */ UtAssert_INT32_EQ(OS_SocketRecvFrom(p1_socket_id, &Buf4, sizeof(Buf4), &l_addr, UT_TIMEOUT), sizeof(Buf4)); UtAssert_True(Buf3 == Buf4, "Buf3 (%ld) == Buf4 (%ld)", (long)Buf3, (long)Buf4); @@ -382,7 +382,7 @@ void Server_Fn(void) UtPrintf("SERVER: handling connection %u", (unsigned int)iter); - /* Recieve incoming data from client - + /* Receive incoming data from client - * should be exactly 4 bytes on most cycles, but 0 bytes on the cycle * where write shutdown was done by client side prior to initial write. */ if (iter == UT_STREAM_CONNECTION_RDWR_SHUTDOWN) @@ -409,7 +409,7 @@ void Server_Fn(void) { /* Send back to client: * 1. uint32 value indicating number of connections so far (4 bytes) - * 2. Original value recieved above (4 bytes) + * 2. Original value received above (4 bytes) * 3. String of all possible 8-bit chars [0-255] (256 bytes) */ Status = OS_TimedWrite(connsock_id, &iter, sizeof(iter), UT_TIMEOUT); @@ -674,20 +674,20 @@ void TestStreamNetworkApi(void) * work) */ if (iter != UT_STREAM_CONNECTION_READ_SHUTDOWN && iter != UT_STREAM_CONNECTION_RDWR_SHUTDOWN) { - /* Recieve back data from server, first is loop count */ + /* Receive back data from server, first is loop count */ expected = sizeof(loopcnt); actual = OS_TimedRead(c_socket_id, &loopcnt, sizeof(loopcnt), UT_TIMEOUT); UtAssert_True(actual == expected, "OS_TimedRead() (%ld) == %ld", (long)actual, (long)expected); UtAssert_UINT32_EQ(iter, loopcnt); - /* Recieve back data from server, next is original string */ + /* Receive back data from server, next is original string */ expected = sizeof(Buf_rcv_c); actual = OS_TimedRead(c_socket_id, Buf_rcv_c, sizeof(Buf_rcv_c), UT_TIMEOUT); UtAssert_True(actual == expected, "OS_TimedRead() (%ld) == %ld", (long)actual, (long)expected); UtAssert_True(strcmp(Buf_send_c, Buf_rcv_c) == 0, "Buf_rcv_c (%s) == Buf_send_c (%s)", Buf_rcv_c, Buf_send_c); - /* Recieve back data from server, next is 8-bit charset */ + /* Receive back data from server, next is 8-bit charset */ expected = sizeof(Buf_each_char_rcv); actual = OS_TimedRead(c_socket_id, Buf_each_char_rcv, sizeof(Buf_each_char_rcv), UT_TIMEOUT); UtAssert_True(actual == expected, "OS_TimedRead() (%ld) == %ld", (long)actual, (long)expected); diff --git a/src/tests/osal-core-test/osal-core-test.c b/src/tests/osal-core-test/osal-core-test.c index fddea472e..0c349504e 100644 --- a/src/tests/osal-core-test/osal-core-test.c +++ b/src/tests/osal-core-test/osal-core-test.c @@ -314,7 +314,7 @@ void TestQueues(void) /* * Now that the Queues are created, its time to see if we can find - * the propper ID by the name of the queue; + * the proper ID by the name of the queue; */ status = OS_QueueGetIdByName(&msgq_0, "q 0"); UtAssert_True(status == OS_SUCCESS, "OS_QueueGetIdByName, q 0"); diff --git a/src/tests/queue-test/queue-test.c b/src/tests/queue-test/queue-test.c index a7f1526c4..ea2405453 100644 --- a/src/tests/queue-test/queue-test.c +++ b/src/tests/queue-test/queue-test.c @@ -226,7 +226,7 @@ void QueueMessageSetup(void) UtAssert_True(status == OS_SUCCESS, "Timer 1 set Rc=%d", (int)status); /* - * Put 10 messages onto the que with some time inbetween the later messages + * Put 10 messages onto the que with some time in between the later messages * to make sure the que handles both storing and waiting for messages */ for (i = 0; i < MSGQ_TOTAL; i++) diff --git a/src/tests/sem-speed-test/sem-speed-test.c b/src/tests/sem-speed-test/sem-speed-test.c index fdda695b6..8bde8f9e9 100644 --- a/src/tests/sem-speed-test/sem-speed-test.c +++ b/src/tests/sem-speed-test/sem-speed-test.c @@ -49,7 +49,7 @@ /* * Note the worker priority must be lower than that of * the executive (init) task. Otherwise, the SemRun() - * function may may never get CPU time to stop the test. + * function may never get CPU time to stop the test. */ #define SEMTEST_TASK_PRIORITY 150 diff --git a/src/tests/timer-test/timer-test.c b/src/tests/timer-test/timer-test.c index 2863dafbd..85cc1a833 100644 --- a/src/tests/timer-test/timer-test.c +++ b/src/tests/timer-test/timer-test.c @@ -200,7 +200,7 @@ void TimerTestCheck(void) if (TimerInterval[i] == 0) { /* - * When the Timer Interval is 0, it's a one shot so expect eaxctly 1 tick + * When the Timer Interval is 0, it's a one shot so expect exactly 1 tick */ expected = 1; UtAssert_True(timer_counter[i] == (expected), "Timer %d count = %d", (int)i, (int)(expected)); diff --git a/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c b/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c index abd97645a..6329f80b7 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c +++ b/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c @@ -82,7 +82,7 @@ void Test_OS_SelectSingle_Impl(void) UtAssert_STUB_COUNT(OCS_clock_gettime, 3); UtAssert_STUB_COUNT(OCS_select, 2); - /* Repeaded select with alternate branches */ + /* Repeated select with alternate branches */ OCS_errno = OCS_EAGAIN; SelectFlags = OS_STREAM_STATE_READABLE | OS_STREAM_STATE_WRITABLE; latertime2.tv_nsec = 300000000; diff --git a/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c b/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c index bacdab00a..7abcd2bbe 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c +++ b/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c @@ -168,7 +168,7 @@ void Test_OS_SocketConnect_Impl(void) addr.ActualLength = sizeof(struct OCS_sockaddr_in); OSAPI_TEST_FUNCTION_RC(OS_SocketConnect_Impl, (&token, &addr, 0), OS_ERR_BAD_ADDRESS); - /* Sucessful connect */ + /* Successful connect */ sa->sa_family = OCS_AF_INET; OSAPI_TEST_FUNCTION_RC(OS_SocketConnect_Impl, (&token, &addr, 0), OS_SUCCESS); @@ -185,7 +185,7 @@ void Test_OS_SocketConnect_Impl(void) UT_SetDeferredRetcode(UT_KEY(OS_SelectSingle_Impl), 1, UT_ERR_UNIQUE); OSAPI_TEST_FUNCTION_RC(OS_SocketConnect_Impl, (&token, &addr, 0), UT_ERR_UNIQUE); - /* Timout error by clearing select flags with hook */ + /* Timeout error by clearing select flags with hook */ selectflags = 0; UT_SetHookFunction(UT_KEY(OS_SelectSingle_Impl), UT_Hook_OS_SelectSingle_Impl, &selectflags); OSAPI_TEST_FUNCTION_RC(OS_SocketConnect_Impl, (&token, &addr, 0), OS_ERROR_TIMEOUT); @@ -325,7 +325,7 @@ void Test_OS_SocketSendTo_Impl(void) /* Set up token */ token.obj_idx = UT_INDEX_0; - /* Bad adderss length */ + /* Bad address length */ sa->sa_family = -1; addr.ActualLength = sizeof(struct OCS_sockaddr_in); OSAPI_TEST_FUNCTION_RC(OS_SocketSendTo_Impl, (&token, buffer, sizeof(buffer), &addr), OS_ERR_BAD_ADDRESS); diff --git a/src/unit-test-coverage/shared/src/coveragetest-idmap.c b/src/unit-test-coverage/shared/src/coveragetest-idmap.c index 9659a3d17..c42b4c823 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-idmap.c +++ b/src/unit-test-coverage/shared/src/coveragetest-idmap.c @@ -141,7 +141,7 @@ void Test_OS_LockUnlockGlobal(void) UT_ResetState(UT_KEY(OS_TaskGetId)); /* - * Execute paths where the incorrect patten is followed, + * Execute paths where the incorrect pattern is followed, * such as unlocking from a different task than the lock. * These trigger OS_DEBUG messages, if compiled in. * diff --git a/src/unit-test-coverage/shared/src/os-shared-coveragetest.h b/src/unit-test-coverage/shared/src/os-shared-coveragetest.h index a2efd7eab..0d34de1fa 100644 --- a/src/unit-test-coverage/shared/src/os-shared-coveragetest.h +++ b/src/unit-test-coverage/shared/src/os-shared-coveragetest.h @@ -79,7 +79,7 @@ typedef union #define UT_INDEX_2 OSAL_INDEX_C(2) /* - * Set up an coverage test iterator of the given type. + * Set up a coverage test iterator of the given type. * * The OS_ObjectIdIteratorGetNext() stub routine will be configured * to return the given range of IDs. diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h b/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h index fd5e56ae7..59d960cbe 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h @@ -66,7 +66,7 @@ typedef long OCS_Vx_usr_arg_t; * without arguments, e.g. "int (*FUNCPTR)()". This is acceptable * by some compilers but generally incompatible with the * "-Wstrict-prototype" gcc warning option. So in this override it - * is defined as a int argument. This means that application code + * is defined as an int argument. This means that application code * may need to cast it at the time of use (which is generally done anyway). */ typedef int (*OCS_FUNCPTR)(int); diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c b/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c index 8bbfecb78..afd7c3184 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c @@ -147,7 +147,7 @@ void Test_OS_TaskDetach_Impl(void) */ OS_object_token_t token; - /* no-op on VxWorks - always returns sucess */ + /* no-op on VxWorks - always returns success */ OSAPI_TEST_FUNCTION_RC(OS_TaskDetach_Impl(&token), OS_SUCCESS); } diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c b/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c index 5005224f9..359c61fd7 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c @@ -105,7 +105,7 @@ void Test_OS_TimeBaseCreate_Impl(void) OS_object_token_t token = UT_TOKEN_0; /* - * Test paths though the signal number assignment. + * Test paths through the signal number assignment. * * This should be done first as it will assign the "external_sync" * and therefore cause future calls to skip this block. diff --git a/src/unit-tests/osfile-test/ut_osfile_dirio_test.c b/src/unit-tests/osfile-test/ut_osfile_dirio_test.c index b6ed6d5a4..d74c8a132 100644 --- a/src/unit-tests/osfile-test/ut_osfile_dirio_test.c +++ b/src/unit-tests/osfile-test/ut_osfile_dirio_test.c @@ -438,7 +438,7 @@ void UT_os_readdir_test() ** 10) Call OS_readdir() the 3rd time with the directory descriptor pointer returned in #3 ** 11) Expect the returned value to be ** (a) a directory entry pointer __and__ -** (b) a the directory name to be "." +** (b) the directory name to be "." **--------------------------------------------------------------------------------*/ void UT_os_rewinddir_test() { diff --git a/src/unit-tests/osfile-test/ut_osfile_fileio_test.c b/src/unit-tests/osfile-test/ut_osfile_fileio_test.c index 078cec401..8d406454f 100644 --- a/src/unit-tests/osfile-test/ut_osfile_fileio_test.c +++ b/src/unit-tests/osfile-test/ut_osfile_fileio_test.c @@ -1257,7 +1257,7 @@ void UT_os_copyfile_test() ** Syntax: int32 OS_mv(const char *src, const char *dest) ** Purpose: Moves the given file to a new specified file ** Parameters: *src - pointer to the absolute path of the file to be moved -** *dest - pointer to the aboslute path of the new file +** *dest - pointer to the absolute path of the new file ** Returns: OS_INVALID_POINTER if any of the pointers passed in is null ** OS_FS_ERR_INVALID_PATH if path is invalid ** OS_FS_ERR_PATH_TOO_LONG if the path name is too long diff --git a/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.c b/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.c index f83291b89..a27f55938 100644 --- a/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.c +++ b/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.c @@ -706,7 +706,7 @@ void UT_os_getfsinfo_test(void) ** (a) OS_FS_ERR_PATH_TOO_LONG ** ----------------------------------------------------- ** Test #3: Invalid-virtual-path-arg condition -** 1) Call this routine with a incorrectly formatted virtual path name as argument +** 1) Call this routine with an incorrectly formatted virtual path name as argument ** 2) Expect the returned value to be ** (a) OS_FS_ERR_PATH_INVALID ** ----------------------------------------------------- @@ -857,7 +857,7 @@ void UT_os_checkfs_test() /*--------------------------------------------------------------------------------* ** Syntax: int32 OS_fsstatvolume(const char *name) -** Purpose: Returns the number of blocks free in a the file system +** Purpose: Returns the number of blocks free in the file system ** Parameters: *name - a pointer to the name of the drive to check for free blocks ** Returns: OS_INVALID_POINTER if the pointer passed in is NULL ** OS_FS_ERR_PATH_TOO_LONG if the path passed in is too long diff --git a/src/unit-tests/osloader-test/ut_osloader_symtable_test.c b/src/unit-tests/osloader-test/ut_osloader_symtable_test.c index 96333b1b2..1a5f8bc88 100644 --- a/src/unit-tests/osloader-test/ut_osloader_symtable_test.c +++ b/src/unit-tests/osloader-test/ut_osloader_symtable_test.c @@ -38,7 +38,7 @@ /** * The size limit to pass for OS_SymbolTableDump nominal test * - * This must be large enough to actually accomodate all of the symbols + * This must be large enough to actually accommodate all of the symbols * in the target system. */ #define UT_SYMTABLE_SIZE_LIMIT 1048576 diff --git a/ut_assert/inc/utassert.h b/ut_assert/inc/utassert.h index bde9ff397..10208dddd 100644 --- a/ut_assert/inc/utassert.h +++ b/ut_assert/inc/utassert.h @@ -24,9 +24,9 @@ * Purpose: This code implements a standard set of asserts for use in unit tests. * * Design Notes: - * - All asserts evaluate a expression as true or false to determine if a unit test has + * - All asserts evaluate an expression as true or false to determine if a unit test has * passed or failed. true means the test passed, false means the test failed. - * - All asserts return a boolen result to indicate the pass fail status. + * - All asserts return a boolean result to indicate the pass fail status. * - All asserts are implemented as macros to hide the __LINE__ and __FILE__ macros. * - All asserts must call the function UtAssert. */ @@ -129,7 +129,7 @@ typedef struct #define UtAssert_Simple(Expression) UtAssert(Expression, #Expression, __FILE__, __LINE__) /** - * \brief Evaluates a expression as either true or false. + * \brief Evaluates an expression as either true or false. * * true means the test passed, false means the test failed. */ @@ -546,7 +546,7 @@ UtAssert_CaseType_t UtAssert_GetContext(void); * * This is the name that was previously set via UtAssert_BeginTest() * - * \note the appliction should not store this pointer, it may become + * \note the application should not store this pointer, it may become * invalid after the next call to UtAssert_EndTest() * * \returns pointer to current segment name @@ -573,7 +573,7 @@ bool UtAssert(bool Expression, const char *Description, const char *File, uint32 /** * \brief Assert function with specific CaseType (supports MIR, TSF, NA in addition to FAIL). * - * This assert routine allows more consise description of the test case, as it supports + * This assert routine allows more concise description of the test case, as it supports * printf-style message strings to allow dynamic content in the messages. * * \param Expression a boolean value which evaluates "true" if the test passes @@ -650,7 +650,7 @@ void UtAssert_DoReport(const char *File, uint32 LineNum, uint32 SegmentNum, uint /** * The BSP overall test reporting function. * - * Invokes the BSP-specific overall pass/fail reporting mechanism based the subsystem pass/fail counters. + * Invokes the BSP-specific overall pass/fail reporting mechanism based on the subsystem pass/fail counters. * * Like the UtAssert_DoReport() function, this is typically done as a message on the console/log however * it might be different for embedded targets. diff --git a/ut_assert/inc/utbsp.h b/ut_assert/inc/utbsp.h index bec41899a..85c88c97a 100644 --- a/ut_assert/inc/utbsp.h +++ b/ut_assert/inc/utbsp.h @@ -89,7 +89,7 @@ void UT_BSP_DoText(uint8 MessageType, const char *OutputMessage); /** * The BSP overall test end function. * - * Invokes the BSP-specific global pass/fail reporting mechanism based the global overall pass/fail counters. + * Invokes the BSP-specific global pass/fail reporting mechanism based on the global overall pass/fail counters. * * This function ends the current test process and returns to the controlling process. * diff --git a/ut_assert/inc/utstubs.h b/ut_assert/inc/utstubs.h index ed593b208..0a214cfa1 100644 --- a/ut_assert/inc/utstubs.h +++ b/ut_assert/inc/utstubs.h @@ -42,7 +42,7 @@ /** * Using a generic memory address as a key into table - * this should allow the function name (with a cast) to be used as the key, - * but allow allows a fancier hash algorithm if needed. + * but allows a fancier hash algorithm if needed. * Note - in pedantic mode using a "void *" here triggers a warning * if used with a function address, but no warning is generated if using * an integer memory address type. diff --git a/ut_assert/scripts/generate_stubs.pl b/ut_assert/scripts/generate_stubs.pl index 9dff1e610..4a0792a24 100755 --- a/ut_assert/scripts/generate_stubs.pl +++ b/ut_assert/scripts/generate_stubs.pl @@ -300,7 +300,7 @@ # Now actually write the output stub source file # NOTE: no need to be too fussy about whitespace and formatting here - # as the output file will be passed to clang-fomat at the end. + # as the output file will be passed to clang-format at the end. open(OUT, ">$stubfile") || die "Cannot open $stubfile for writing"; print OUT $boilerplate . "\n"; From 0531bcab5703bd74af2c34b8814903b9298dc0be Mon Sep 17 00:00:00 2001 From: Jake Hageman Date: Wed, 15 Sep 2021 11:15:43 -0400 Subject: [PATCH 010/178] Fix #1148, Enable symbol api test and MIR dump too large --- src/tests/symbol-api-test/symbol-api-test.c | 46 +++++++++++++++------ 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/src/tests/symbol-api-test/symbol-api-test.c b/src/tests/symbol-api-test/symbol-api-test.c index bfe43ea0d..9546824e3 100644 --- a/src/tests/symbol-api-test/symbol-api-test.c +++ b/src/tests/symbol-api-test/symbol-api-test.c @@ -32,7 +32,6 @@ void TestSymbolApi(void) { -#ifdef OS_INCLUDE_MODULE_LOADER int32 status; cpuaddr SymAddress; @@ -50,7 +49,11 @@ void TestSymbolApi(void) status = OS_SymbolTableDump("/ram/SymbolTable32k.dat", 32768); if (status == OS_ERR_NOT_IMPLEMENTED) { - UtAssert_NA("Module API not implemented"); + UtAssert_NA("OS_SymbolTableDump API not implemented"); + } + else if (status == OS_ERR_OUTPUT_TOO_LARGE) + { + UtAssert_MIR("32k too small for OS_SymbolTableDump"); } else { @@ -64,7 +67,11 @@ void TestSymbolApi(void) status = OS_SymbolTableDump("/ram/SymbolTable128k.dat", 131072); if (status == OS_ERR_NOT_IMPLEMENTED) { - UtAssert_NA("Module API not implemented"); + UtAssert_NA("OS_SymbolTableDump API not implemented"); + } + else if (status == OS_ERR_OUTPUT_TOO_LARGE) + { + UtAssert_MIR("128k too small for OS_SymbolTableDump"); } else { @@ -78,7 +85,11 @@ void TestSymbolApi(void) status = OS_SymbolTableDump("/ram/SymbolTable512k.dat", 524288); if (status == OS_ERR_NOT_IMPLEMENTED) { - UtAssert_NA("Module API not implemented"); + UtAssert_NA("OS_SymbolTableDump API not implemented"); + } + else if (status == OS_ERR_OUTPUT_TOO_LARGE) + { + UtAssert_MIR("512k too small for OS_SymbolTableDump"); } else { @@ -89,20 +100,29 @@ void TestSymbolApi(void) ** Test the symbol lookup */ status = OS_SymbolLookup(&SymAddress, "OS_Application_Startup"); - UtAssert_True(status == OS_SUCCESS, "OS_SymbolLookup(OS_Application_Startup) = %d, Addr = %lx", (int)status, - (unsigned long)SymAddress); + if (status == OS_ERR_NOT_IMPLEMENTED) + { + UtAssert_NA("OS_SymbolLookup API not implemented"); + } + else + { + UtAssert_True(status == OS_SUCCESS, "OS_SymbolLookup(OS_Application_Startup) = %d, Addr = %lx", (int)status, + (unsigned long)SymAddress); + } /* ** Test a symbol lookup that does not exist */ status = OS_SymbolLookup(&SymAddress, "ShouldNotExist"); - UtAssert_True(status != OS_SUCCESS, "OS_SymbolLookup(ShouldNotExist) = %d, Addr = %lx", (int)status, - (unsigned long)SymAddress); - -#else - /* If the module loader is not present, generate an N/A test case just to indicate that the test ran */ - UtAssert_True(1, "Module loader not present"); -#endif + if (status == OS_ERR_NOT_IMPLEMENTED) + { + UtAssert_NA("OS_SymbolLookup API not implemented"); + } + else + { + UtAssert_True(status != OS_SUCCESS, "OS_SymbolLookup(ShouldNotExist) = %d, Addr = %lx", (int)status, + (unsigned long)SymAddress); + } } /* end TestSymbolApi */ void UtTest_Setup(void) From 0f5454d017eec45f4da9ba515e8afe8406fd4bcf Mon Sep 17 00:00:00 2001 From: Jake Hageman Date: Wed, 15 Sep 2021 16:56:29 -0400 Subject: [PATCH 011/178] Fix #1148, MIR symbol name too long in symbol-api-test --- src/tests/symbol-api-test/symbol-api-test.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/tests/symbol-api-test/symbol-api-test.c b/src/tests/symbol-api-test/symbol-api-test.c index 9546824e3..e762dd946 100644 --- a/src/tests/symbol-api-test/symbol-api-test.c +++ b/src/tests/symbol-api-test/symbol-api-test.c @@ -55,6 +55,10 @@ void TestSymbolApi(void) { UtAssert_MIR("32k too small for OS_SymbolTableDump"); } + else if (status == OS_ERR_NAME_TOO_LONG) + { + UtAssert_MIR("OS_SymbolTableDump name to long, consider increasing OSAL_CONFIG_MAX_SYM_LEN"); + } else { UtAssert_True(status == OS_SUCCESS, "status after 32k OS_SymbolTableDump = %d", (int)status); @@ -73,6 +77,10 @@ void TestSymbolApi(void) { UtAssert_MIR("128k too small for OS_SymbolTableDump"); } + else if (status == OS_ERR_NAME_TOO_LONG) + { + UtAssert_MIR("OS_SymbolTableDump name to long, consider increasing OSAL_CONFIG_MAX_SYM_LEN"); + } else { UtAssert_True(status == OS_SUCCESS, "status after 128k OS_SymbolTableDump = %d", (int)status); @@ -91,6 +99,10 @@ void TestSymbolApi(void) { UtAssert_MIR("512k too small for OS_SymbolTableDump"); } + else if (status == OS_ERR_NAME_TOO_LONG) + { + UtAssert_MIR("OS_SymbolTableDump name to long, consider increasing OSAL_CONFIG_MAX_SYM_LEN"); + } else { UtAssert_True(status == OS_SUCCESS, "status after 512k OS_SymbolTableDump = %d", (int)status); From 6fd967c3b9ef2c9635a55c12480043b9a325f59c Mon Sep 17 00:00:00 2001 From: Jake Hageman Date: Wed, 15 Sep 2021 17:08:36 -0400 Subject: [PATCH 012/178] Fix #1151, MIR symbol too long or table to long for osloader test --- .../osloader-test/ut_osloader_symtable_test.c | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/src/unit-tests/osloader-test/ut_osloader_symtable_test.c b/src/unit-tests/osloader-test/ut_osloader_symtable_test.c index 1a5f8bc88..d96d9fe1a 100644 --- a/src/unit-tests/osloader-test/ut_osloader_symtable_test.c +++ b/src/unit-tests/osloader-test/ut_osloader_symtable_test.c @@ -177,6 +177,7 @@ void UT_os_module_symbol_lookup_test() **--------------------------------------------------------------------------------*/ void UT_os_symbol_table_dump_test() { + int32 status; /* * Note that even if the functionality is not implemented, * the API still validates the input pointers (not null) and @@ -196,7 +197,25 @@ void UT_os_symbol_table_dump_test() /*-----------------------------------------------------*/ /* #3 Nominal */ - if (UT_NOMINAL_OR_NOTIMPL(OS_SymbolTableDump(UT_OS_GENERIC_MODULE_DIR "SymbolReal.dat", UT_SYMTABLE_SIZE_LIMIT))) + status = OS_SymbolTableDump(UT_OS_GENERIC_MODULE_DIR "SymbolReal.dat", UT_SYMTABLE_SIZE_LIMIT); + if (status == OS_ERR_NOT_IMPLEMENTED) + { + UtAssert_NA("OS_SymbolTableDump API not implemented"); + } + else if (status == OS_ERR_OUTPUT_TOO_LARGE) + { + UtAssert_MIR("UT_SYMTABLE_SIZE_LIMIT too small for OS_SymbolTableDump"); + } + else if (status == OS_ERR_NAME_TOO_LONG) + { + UtAssert_MIR("OSAL_CONFIG_MAX_SYM_LEN too small for OS_SymbolTableDump"); + } + else + { + UtAssert_True(status == OS_SUCCESS, "status after 128k OS_SymbolTableDump = %d", (int)status); + } + + if (status == OS_SUCCESS) { UT_RETVAL(OS_SymbolTableDump(UT_OS_GENERIC_MODULE_DIR "SymbolZero.dat", 0), OS_ERR_OUTPUT_TOO_LARGE); } From 52afadadee67bf01e5a08da9d91e864b39ef935d Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Mon, 20 Sep 2021 16:19:00 -0400 Subject: [PATCH 013/178] Fix #1154, add bsp-specific configuration flag registry Adds a simple BSP API to get/set integer flags for each resource type. All bits are platform-defined, so this can be used to store any arbitrary platform flag. Initial use case is for setting task flags on vxWorks platforms which require a certain task flag to be set. --- CMakeLists.txt | 1 + src/bsp/shared/inc/bsp-impl.h | 9 +++ src/bsp/shared/src/bsp_default_resourcecfg.c | 65 ++++++++++++++++++++ src/os/inc/osapi-bsp.h | 16 +++++ src/os/vxworks/src/os-impl-tasks.c | 3 +- src/ut-stubs/osapi-bsp-stubs.c | 29 +++++++++ 6 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 src/bsp/shared/src/bsp_default_resourcecfg.c diff --git a/CMakeLists.txt b/CMakeLists.txt index 519183d1e..a2648e725 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -175,6 +175,7 @@ set(BSP_SRCLIST src/bsp/shared/src/bsp_default_app_run.c src/bsp/shared/src/bsp_default_app_startup.c src/bsp/shared/src/bsp_default_symtab.c + src/bsp/shared/src/bsp_default_resourcecfg.c ) # Define the external "osal_bsp" static library target diff --git a/src/bsp/shared/inc/bsp-impl.h b/src/bsp/shared/inc/bsp-impl.h index d2e7cfcbc..2604dea18 100644 --- a/src/bsp/shared/inc/bsp-impl.h +++ b/src/bsp/shared/inc/bsp-impl.h @@ -47,6 +47,7 @@ #include "osapi-common.h" #include "osapi-bsp.h" #include "osapi-error.h" +#include "osapi-idmap.h" /* * A set of simplified console control options @@ -97,6 +98,14 @@ typedef struct char ** ArgV; /* strings for boot/startup parameters */ int32 AppStatus; /* value which can be returned to the OS (0=nominal) */ osal_blockcount_t MaxQueueDepth; /* Queue depth limit supported by BSP (0=no limit) */ + + /* + * Configuration registry - abstract integer flags to select platform-specific options + * for each resource type. Flags are all platform-defined, and not every platform uses this + * feature. + */ + uint32 ResoureConfig[OS_OBJECT_TYPE_USER]; + } OS_BSP_GlobalData_t; /* diff --git a/src/bsp/shared/src/bsp_default_resourcecfg.c b/src/bsp/shared/src/bsp_default_resourcecfg.c new file mode 100644 index 000000000..69f0807bc --- /dev/null +++ b/src/bsp/shared/src/bsp_default_resourcecfg.c @@ -0,0 +1,65 @@ +/* + * NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer" + * + * Copyright (c) 2019 United States Government as represented by + * the Administrator of the National Aeronautics and Space Administration. + * All Rights Reserved. + * + * Licensed 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. + */ + +/* + * File: bsp_default_resourcecfg.c + * + * Purpose: + * Simple integer key/value table lookup to allow BSP-specific flags/options + * to be set for various resource types. Meanings are all platform-defined. + * + */ + +#include "osapi-idmap.h" +#include "bsp-impl.h" + +/* --------------------------------------------------------- + OS_BSP_SetResourceTypeConfig() + + Helper function to register BSP-specific options. + --------------------------------------------------------- */ +void OS_BSP_SetResourceTypeConfig(uint32 ResourceType, uint32 ConfigOptionValue) +{ + if (ResourceType < OS_OBJECT_TYPE_USER) + { + OS_BSP_Global.ResoureConfig[ResourceType] = ConfigOptionValue; + } +} + +/* --------------------------------------------------------- + OS_BSP_GetResourceTypeConfig() + + Helper function to register BSP-specific options. + --------------------------------------------------------- */ +uint32 OS_BSP_GetResourceTypeConfig(uint32 ResourceType) +{ + uint32 ConfigOptionValue; + + if (ResourceType < OS_OBJECT_TYPE_USER) + { + ConfigOptionValue = OS_BSP_Global.ResoureConfig[ResourceType]; + } + else + { + ConfigOptionValue = 0; + } + + return ConfigOptionValue; +} diff --git a/src/os/inc/osapi-bsp.h b/src/os/inc/osapi-bsp.h index 4f4c7ee18..eac7f8c03 100644 --- a/src/os/inc/osapi-bsp.h +++ b/src/os/inc/osapi-bsp.h @@ -44,6 +44,22 @@ * @{ */ +/*---------------------------------------------------------------- + Function: OS_BSP_SetResourceTypeConfig + + Purpose: Sets BSP/platform-specific flags for the given resource type + Flags and bit meanings are all platform defined. + ------------------------------------------------------------------*/ +void OS_BSP_SetResourceTypeConfig(uint32 ResourceType, uint32 ConfigOptionValue); + +/*---------------------------------------------------------------- + Function: OS_BSP_SetResourceTypeConfig + + Purpose: Gets BSP/platform-specific flags for the given resource type + Flags and bit meanings are all platform defined. + ------------------------------------------------------------------*/ +uint32 OS_BSP_GetResourceTypeConfig(uint32 ResourceType); + /*---------------------------------------------------------------- Function: OS_BSP_GetArgC diff --git a/src/os/vxworks/src/os-impl-tasks.c b/src/os/vxworks/src/os-impl-tasks.c index e05524f33..07dae3c5a 100644 --- a/src/os/vxworks/src/os-impl-tasks.c +++ b/src/os/vxworks/src/os-impl-tasks.c @@ -34,6 +34,7 @@ #include "os-shared-task.h" #include "os-shared-idmap.h" #include "os-shared-timebase.h" +#include "osapi-bsp.h" #include #include @@ -132,7 +133,7 @@ int32 OS_TaskCreate_Impl(const OS_object_token_t *token, uint32 flags) /* see if the user wants floating point enabled. If * so, then se the correct option. */ - vxflags = 0; + vxflags = OS_BSP_GetResourceTypeConfig(OS_OBJECT_TYPE_OS_TASK); if (flags & OS_FP_ENABLED) { vxflags |= VX_FP_TASK; diff --git a/src/ut-stubs/osapi-bsp-stubs.c b/src/ut-stubs/osapi-bsp-stubs.c index 6e8347327..e70a7637a 100644 --- a/src/ut-stubs/osapi-bsp-stubs.c +++ b/src/ut-stubs/osapi-bsp-stubs.c @@ -55,6 +55,22 @@ char *const *OS_BSP_GetArgV(void) return UT_GenStub_GetReturnValue(OS_BSP_GetArgV, char *const *); } +/* + * ---------------------------------------------------- + * Generated stub function for OS_BSP_GetResourceTypeConfig() + * ---------------------------------------------------- + */ +uint32 OS_BSP_GetResourceTypeConfig(uint32 ResourceType) +{ + UT_GenStub_SetupReturnBuffer(OS_BSP_GetResourceTypeConfig, uint32); + + UT_GenStub_AddParam(OS_BSP_GetResourceTypeConfig, uint32, ResourceType); + + UT_GenStub_Execute(OS_BSP_GetResourceTypeConfig, Basic, NULL); + + return UT_GenStub_GetReturnValue(OS_BSP_GetResourceTypeConfig, uint32); +} + /* * ---------------------------------------------------- * Generated stub function for OS_BSP_SetExitCode() @@ -66,3 +82,16 @@ void OS_BSP_SetExitCode(int32 code) UT_GenStub_Execute(OS_BSP_SetExitCode, Basic, NULL); } + +/* + * ---------------------------------------------------- + * Generated stub function for OS_BSP_SetResourceTypeConfig() + * ---------------------------------------------------- + */ +void OS_BSP_SetResourceTypeConfig(uint32 ResourceType, uint32 ConfigOptionValue) +{ + UT_GenStub_AddParam(OS_BSP_SetResourceTypeConfig, uint32, ResourceType); + UT_GenStub_AddParam(OS_BSP_SetResourceTypeConfig, uint32, ConfigOptionValue); + + UT_GenStub_Execute(OS_BSP_SetResourceTypeConfig, Basic, NULL); +} From 009abc1303cd5350aa3c99ad233185de84a71d74 Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Mon, 20 Sep 2021 20:40:12 -0400 Subject: [PATCH 014/178] Fix #1153, add os-specifc socket flag function Adds the capability for the bsd sockets implementation to use a function provided by the OS layer to set the socket flags. This allows VxWorks to have an alternative implementation that uses ioctl rather than fcntl to set the flags. --- src/os/portable/os-impl-bsd-sockets.c | 93 ++++++++++--------- src/os/shared/inc/os-shared-sockets.h | 1 + src/os/vxworks/CMakeLists.txt | 1 + src/os/vxworks/inc/os-impl-sockets.h | 23 ++--- src/os/vxworks/src/os-impl-sockets.c | 64 +++++++++++++ .../portable/src/coveragetest-bsd-sockets.c | 34 +++---- .../ut-stubs/inc/OCS_ioLib.h | 1 + .../ut-stubs/override_inc/ioLib.h | 1 + .../src/os-shared-sockets-impl-stubs.c | 12 +++ src/unit-test-coverage/vxworks/CMakeLists.txt | 1 + .../vxworks/adaptors/CMakeLists.txt | 1 + .../vxworks/adaptors/inc/ut-adaptor-sockets.h | 35 +++++++ .../vxworks/adaptors/src/ut-adaptor-sockets.c | 44 +++++++++ .../vxworks/src/coveragetest-sockets.c | 68 ++++++++++++++ .../vxworks/ut-stubs/CMakeLists.txt | 1 + .../src/vxworks-os-impl-sockets-stubs.c | 33 +++++++ 16 files changed, 338 insertions(+), 75 deletions(-) create mode 100644 src/os/vxworks/src/os-impl-sockets.c create mode 100644 src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-sockets.h create mode 100644 src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-sockets.c create mode 100644 src/unit-test-coverage/vxworks/src/coveragetest-sockets.c create mode 100644 src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c diff --git a/src/os/portable/os-impl-bsd-sockets.c b/src/os/portable/os-impl-bsd-sockets.c index cb31211a6..1d8d8f4f5 100644 --- a/src/os/portable/os-impl-bsd-sockets.c +++ b/src/os/portable/os-impl-bsd-sockets.c @@ -63,6 +63,22 @@ DEFINES ****************************************************************************************/ +/* + * The OS layer may define a macro to set the proper flags on newly-opened sockets. + * If not set, then a default implementation is used, which uses fcntl() to set O_NONBLOCK + */ +#ifndef OS_IMPL_SOCKET_FLAGS +#ifdef O_NONBLOCK +#define OS_IMPL_SOCKET_FLAGS O_NONBLOCK +#else +#define OS_IMPL_SOCKET_FLAGS 0 /* do not set any flags */ +#endif +#endif + +#ifndef OS_IMPL_SET_SOCKET_FLAGS +#define OS_IMPL_SET_SOCKET_FLAGS(tok) OS_SetSocketDefaultFlags_Impl(tok) +#endif + typedef union { char data[OS_SOCKADDR_MAX_LEN]; @@ -82,6 +98,37 @@ typedef union */ CompileTimeAssert(sizeof(OS_SockAddr_Accessor_t) == OS_SOCKADDR_MAX_LEN, SockAddrSize); +/* + * Default flags implementation: Set the O_NONBLOCK flag via fcntl(). + * An implementation can also elect custom configuration by setting + * the OS_IMPL_SET_SOCKET_FLAGS macro to point to an alternate function. + */ +void OS_SetSocketDefaultFlags_Impl(const OS_object_token_t *token) +{ + OS_impl_file_internal_record_t *impl; + int os_flags; + + impl = OS_OBJECT_TABLE_GET(OS_impl_filehandle_table, *token); + + os_flags = fcntl(impl->fd, F_GETFL); + if (os_flags == -1) + { + /* No recourse if F_GETFL fails - just report the error and move on. */ + OS_DEBUG("fcntl(F_GETFL): %s\n", strerror(errno)); + } + else + { + os_flags |= OS_IMPL_SOCKET_FLAGS; + if (fcntl(impl->fd, F_SETFL, os_flags) == -1) + { + /* No recourse if F_SETFL fails - just report the error and move on. */ + OS_DEBUG("fcntl(F_SETFL): %s\n", strerror(errno)); + } + } + + impl->selectable = true; +} + /**************************************************************************************** Sockets API ***************************************************************************************/ @@ -160,23 +207,7 @@ int32 OS_SocketOpen_Impl(const OS_object_token_t *token) * nonblock mode does improve robustness in the event that multiple tasks * attempt to accept new connections from the same server socket at the same time. */ - os_flags = fcntl(impl->fd, F_GETFL); - if (os_flags == -1) - { - /* No recourse if F_GETFL fails - just report the error and move on. */ - OS_DEBUG("fcntl(F_GETFL): %s\n", strerror(errno)); - } - else - { - os_flags |= OS_IMPL_SOCKET_FLAGS; - if (fcntl(impl->fd, F_SETFL, os_flags) == -1) - { - /* No recourse if F_SETFL fails - just report the error and move on. */ - OS_DEBUG("fcntl(F_SETFL): %s\n", strerror(errno)); - } - } - - impl->selectable = OS_IMPL_SOCKET_SELECTABLE; + OS_IMPL_SET_SOCKET_FLAGS(token); return OS_SUCCESS; } /* end OS_SocketOpen_Impl */ @@ -397,7 +428,6 @@ int32 OS_SocketAccept_Impl(const OS_object_token_t *sock_token, const OS_object_ int32 return_code; uint32 operation; socklen_t addrlen; - int os_flags; OS_impl_file_internal_record_t *sock_impl; OS_impl_file_internal_record_t *conn_impl; @@ -432,32 +462,7 @@ int32 OS_SocketAccept_Impl(const OS_object_token_t *sock_token, const OS_object_ { Addr->ActualLength = addrlen; - /* - * Set the standard options on the filehandle by default -- - * this may set it to non-blocking mode if the implementation supports it. - * any blocking would be done explicitly via the select() wrappers - * - * NOTE: The implementation still generally works without this flag set, but - * nonblock mode does improve robustness in the event that multiple tasks - * attempt to read from the same socket at the same time. - */ - os_flags = fcntl(conn_impl->fd, F_GETFL); - if (os_flags == -1) - { - /* No recourse if F_GETFL fails - just report the error and move on. */ - OS_DEBUG("fcntl(F_GETFL): %s\n", strerror(errno)); - } - else - { - os_flags |= OS_IMPL_SOCKET_FLAGS; - if (fcntl(conn_impl->fd, F_SETFL, os_flags) == -1) - { - /* No recourse if F_SETFL fails - just report the error and move on. */ - OS_DEBUG("fcntl(F_SETFL): %s\n", strerror(errno)); - } - } - - conn_impl->selectable = OS_IMPL_SOCKET_SELECTABLE; + OS_IMPL_SET_SOCKET_FLAGS(conn_token); } } } diff --git a/src/os/shared/inc/os-shared-sockets.h b/src/os/shared/inc/os-shared-sockets.h index 032339fa5..3d9933eab 100644 --- a/src/os/shared/inc/os-shared-sockets.h +++ b/src/os/shared/inc/os-shared-sockets.h @@ -188,5 +188,6 @@ int32 OS_SocketAddrSetPort_Impl(OS_SockAddr_t *Addr, uint16 PortNum); * Not normally called outside the local unit, except during unit test */ void OS_CreateSocketName(const OS_object_token_t *token, const OS_SockAddr_t *Addr, const char *parent_name); +void OS_SetSocketDefaultFlags_Impl(const OS_object_token_t *token); #endif /* OS_SHARED_SOCKETS_H */ diff --git a/src/os/vxworks/CMakeLists.txt b/src/os/vxworks/CMakeLists.txt index 912f3e74c..fb4f56c36 100644 --- a/src/os/vxworks/CMakeLists.txt +++ b/src/os/vxworks/CMakeLists.txt @@ -65,6 +65,7 @@ if (OSAL_CONFIG_INCLUDE_NETWORK) list(APPEND VXWORKS_IMPL_SRCLIST src/os-impl-network.c ../portable/os-impl-bsd-sockets.c # Use BSD socket layer implementation + src/os-impl-sockets.c # Additional vxworks-specific code to handle socket flags ) else() list(APPEND VXWORKS_IMPL_SRCLIST diff --git a/src/os/vxworks/inc/os-impl-sockets.h b/src/os/vxworks/inc/os-impl-sockets.h index bf7c716f6..6b1a05d5a 100644 --- a/src/os/vxworks/inc/os-impl-sockets.h +++ b/src/os/vxworks/inc/os-impl-sockets.h @@ -29,6 +29,7 @@ #define OS_IMPL_SOCKETS_H #include "os-impl-io.h" +#include "os-shared-globaldefs.h" #include #include @@ -37,25 +38,19 @@ #include #include #include +#include /* - * Socket descriptors should be usable with the select() API + * Override the socket flag set routine on this platform. + * This is required because some versions of VxWorks do not support + * the standard POSIX fcntl() opcodes, and must use ioctl() instead. */ -#define OS_IMPL_SOCKET_SELECTABLE true - -/* - * Use the O_NONBLOCK flag on sockets - * - * NOTE: the fcntl() F_GETFL/F_SETFL opcodes that set descriptor flags may not - * work correctly on some version of VxWorks. - * - * This flag is not strictly required, things still mostly work without it, - * but lack of this mode does introduce some potential race conditions if more - * than one task attempts to use the same descriptor handle at the same time. - */ -#define OS_IMPL_SOCKET_FLAGS O_NONBLOCK +#define OS_IMPL_SET_SOCKET_FLAGS(impl) OS_VxWorks_SetSocketFlags_Impl(impl) /* The "in.h" header file supplied in VxWorks 6.9 is missing the "in_port_t" typedef */ typedef u_short in_port_t; +/* VxWorks-specific helper function to configure the socket flags on a connection */ +void OS_VxWorks_SetSocketFlags_Impl(const OS_object_token_t *token); + #endif /* OS_IMPL_SOCKETS_H */ diff --git a/src/os/vxworks/src/os-impl-sockets.c b/src/os/vxworks/src/os-impl-sockets.c new file mode 100644 index 000000000..5b51ecd02 --- /dev/null +++ b/src/os/vxworks/src/os-impl-sockets.c @@ -0,0 +1,64 @@ +/* + * NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer" + * + * Copyright (c) 2019 United States Government as represented by + * the Administrator of the National Aeronautics and Space Administration. + * All Rights Reserved. + * + * Licensed 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. + */ + +/** + * \file os-impl-sockets.c + * \ingroup vxworks + * \author joseph.p.hickey@nasa.gov + * + */ + +/**************************************************************************************** + INCLUDE FILES + ***************************************************************************************/ + +#include "os-vxworks.h" +#include "os-shared-idmap.h" +#include "os-impl-io.h" +#include "os-impl-sockets.h" + +/**************************************************************************************** + INITIALIZATION FUNCTION + ***************************************************************************************/ + +/*---------------------------------------------------------------- + * + * Function: OS_VxWorks_ModuleAPI_Impl_Init + * + * Purpose: Local helper routine, not part of OSAL API. + * + *-----------------------------------------------------------------*/ +void OS_VxWorks_SetSocketFlags_Impl(const OS_object_token_t *token) +{ + OS_impl_file_internal_record_t *impl; + int os_flags; + + impl = OS_OBJECT_TABLE_GET(OS_impl_filehandle_table, *token); + + /* Use ioctl/FIONBIO on this platform, rather than standard fcntl() */ + os_flags = 1; + if (ioctl(impl->fd, FIONBIO, &os_flags) == -1) + { + /* No recourse if ioctl fails - just report the error and move on. */ + OS_DEBUG("ioctl(FIONBIO): %s\n", strerror(errno)); + } + + impl->selectable = true; +} diff --git a/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c b/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c index 7abcd2bbe..9322fa2bc 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c +++ b/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c @@ -100,21 +100,34 @@ void Test_OS_SocketOpen_Impl(void) OS_stream_table[0].socket_type = OS_SocketType_STREAM; OS_stream_table[0].socket_domain = OS_SocketDomain_INET6; OSAPI_TEST_FUNCTION_RC(OS_SocketOpen_Impl, (&token), OS_SUCCESS); - UtAssert_True(UT_PortablePosixIOTest_Get_Selectable(token.obj_idx), "Socket is selectable"); +} + +void Test_OS_SetSocketDefaultFlags_Impl(void) +{ + OS_object_token_t token = {0}; /* Failure in fcntl() GETFL */ UT_PortablePosixIOTest_ResetImpl(token.obj_idx); UT_ResetState(UT_KEY(OCS_fcntl)); UT_SetDeferredRetcode(UT_KEY(OCS_fcntl), 1, -1); - OSAPI_TEST_FUNCTION_RC(OS_SocketOpen_Impl, (&token), OS_SUCCESS); + UtAssert_VOIDCALL(OS_SetSocketDefaultFlags_Impl(&token)); UtAssert_STUB_COUNT(OCS_fcntl, 1); + UtAssert_True(UT_PortablePosixIOTest_Get_Selectable(token.obj_idx), "Socket is selectable"); /* Failure in fcntl() SETFL */ UT_PortablePosixIOTest_ResetImpl(token.obj_idx); UT_ResetState(UT_KEY(OCS_fcntl)); UT_SetDeferredRetcode(UT_KEY(OCS_fcntl), 2, -1); - OSAPI_TEST_FUNCTION_RC(OS_SocketOpen_Impl, (&token), OS_SUCCESS); + UtAssert_VOIDCALL(OS_SetSocketDefaultFlags_Impl(&token)); + UtAssert_STUB_COUNT(OCS_fcntl, 2); + UtAssert_True(UT_PortablePosixIOTest_Get_Selectable(token.obj_idx), "Socket is selectable"); + + /* Nominal path */ + UT_PortablePosixIOTest_ResetImpl(token.obj_idx); + UT_ResetState(UT_KEY(OCS_fcntl)); + UtAssert_VOIDCALL(OS_SetSocketDefaultFlags_Impl(&token)); UtAssert_STUB_COUNT(OCS_fcntl, 2); + UtAssert_True(UT_PortablePosixIOTest_Get_Selectable(token.obj_idx), "Socket is selectable"); } void Test_OS_SocketBind_Impl(void) @@ -255,20 +268,6 @@ void Test_OS_SocketAccept_Impl(void) /* Success case */ OSAPI_TEST_FUNCTION_RC(OS_SocketAccept_Impl, (&sock_token, &conn_token, &addr, 0), OS_SUCCESS); - - /* Failure in fcntl() GETFL */ - UT_PortablePosixIOTest_ResetImpl(conn_token.obj_idx); - UT_ResetState(UT_KEY(OCS_fcntl)); - UT_SetDeferredRetcode(UT_KEY(OCS_fcntl), 1, -1); - OSAPI_TEST_FUNCTION_RC(OS_SocketAccept_Impl, (&sock_token, &conn_token, &addr, 0), OS_SUCCESS); - UtAssert_STUB_COUNT(OCS_fcntl, 1); - - /* Failure in fcntl() SETFL */ - UT_PortablePosixIOTest_ResetImpl(conn_token.obj_idx); - UT_ResetState(UT_KEY(OCS_fcntl)); - UT_SetDeferredRetcode(UT_KEY(OCS_fcntl), 2, -1); - OSAPI_TEST_FUNCTION_RC(OS_SocketAccept_Impl, (&sock_token, &conn_token, &addr, 0), OS_SUCCESS); - UtAssert_STUB_COUNT(OCS_fcntl, 2); } void Test_OS_SocketRecvFrom_Impl(void) @@ -484,6 +483,7 @@ void Osapi_Test_Teardown(void) {} void UtTest_Setup(void) { ADD_TEST(OS_SocketOpen_Impl); + ADD_TEST(OS_SetSocketDefaultFlags_Impl); ADD_TEST(OS_SocketBind_Impl); ADD_TEST(OS_SocketConnect_Impl); ADD_TEST(OS_SocketShutdown_Impl); diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_ioLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_ioLib.h index f864eb8a4..43cced0db 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_ioLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_ioLib.h @@ -37,6 +37,7 @@ #define OCS_FIOCHKDSK 0x1E01 #define OCS_FIOUNMOUNT 0x1E02 +#define OCS_FIONBIO 0x1E03 /* ----------------------------------------- */ /* types normally defined in ioLib.h */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/ioLib.h b/src/unit-test-coverage/ut-stubs/override_inc/ioLib.h index a9ba0f0cc..2fdfe6419 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/ioLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/ioLib.h @@ -37,6 +37,7 @@ #define FIOCHKDSK OCS_FIOCHKDSK #define FIOUNMOUNT OCS_FIOUNMOUNT +#define FIONBIO OCS_FIONBIO #define ioctl OCS_ioctl #endif /* OVERRIDE_IOLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-stubs.c b/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-stubs.c index 227fcde60..6ffd258f0 100644 --- a/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-stubs.c @@ -27,6 +27,18 @@ #include "os-shared-sockets.h" #include "utgenstub.h" +/* + * ---------------------------------------------------- + * Generated stub function for OS_SetSocketDefaultFlags_Impl() + * ---------------------------------------------------- + */ +void OS_SetSocketDefaultFlags_Impl(const OS_object_token_t *token) +{ + UT_GenStub_AddParam(OS_SetSocketDefaultFlags_Impl, const OS_object_token_t *, token); + + UT_GenStub_Execute(OS_SetSocketDefaultFlags_Impl, Basic, NULL); +} + /* * ---------------------------------------------------- * Generated stub function for OS_SocketAccept_Impl() diff --git a/src/unit-test-coverage/vxworks/CMakeLists.txt b/src/unit-test-coverage/vxworks/CMakeLists.txt index b97b2edd1..0124d3e23 100644 --- a/src/unit-test-coverage/vxworks/CMakeLists.txt +++ b/src/unit-test-coverage/vxworks/CMakeLists.txt @@ -15,6 +15,7 @@ set(VXWORKS_MODULE_LIST network queues shell + sockets symtab tasks timebase diff --git a/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt b/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt index eb22c05de..b0789bdb6 100644 --- a/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt +++ b/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt @@ -21,6 +21,7 @@ add_library(ut-adaptor-${SETNAME} STATIC src/ut-adaptor-mutex.c src/ut-adaptor-queues.c src/ut-adaptor-filetable-stub.c + src/ut-adaptor-sockets.c src/ut-adaptor-symtab.c src/ut-adaptor-tasks.c src/ut-adaptor-timebase.c diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-sockets.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-sockets.h new file mode 100644 index 000000000..755fe063e --- /dev/null +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-sockets.h @@ -0,0 +1,35 @@ +/* + * NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer" + * + * Copyright (c) 2019 United States Government as represented by + * the Administrator of the National Aeronautics and Space Administration. + * All Rights Reserved. + * + * Licensed 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. + */ + +/** + * \file + * \ingroup adaptors + * + * Declarations and prototypes for ut-adaptor-symtab + */ + +#ifndef UT_ADAPTOR_SOCKETS_H +#define UT_ADAPTOR_SOCKETS_H + +#include "common_types.h" + +void UT_SocketTest_CallVxWorksSetFlags_Impl(uint32 index); + +#endif /* UT_ADAPTOR_SOCKETS_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-sockets.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-sockets.c new file mode 100644 index 000000000..d13d0f39e --- /dev/null +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-sockets.c @@ -0,0 +1,44 @@ +/* + * NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer" + * + * Copyright (c) 2019 United States Government as represented by + * the Administrator of the National Aeronautics and Space Administration. + * All Rights Reserved. + * + * Licensed 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. + */ + +/** + * \file ut-adaptor-sockets.c + * \ingroup adaptors + * \author joseph.p.hickey@nasa.gov + * + */ + +/* pull in the OSAL configuration */ +#include "osconfig.h" +#include "ut-adaptor-sockets.h" + +#include "os-vxworks.h" +#include "os-shared-idmap.h" +#include "os-impl-sockets.h" + +/* + * A UT-specific wrapper function to invoke the VxWorks "SetFlag" helper + */ +void UT_SocketTest_CallVxWorksSetFlags_Impl(uint32 index) +{ + OS_object_token_t token = {.obj_idx = index}; + + OS_VxWorks_SetSocketFlags_Impl(&token); +} diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-sockets.c b/src/unit-test-coverage/vxworks/src/coveragetest-sockets.c new file mode 100644 index 000000000..f83b11db3 --- /dev/null +++ b/src/unit-test-coverage/vxworks/src/coveragetest-sockets.c @@ -0,0 +1,68 @@ +/* + * NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer" + * + * Copyright (c) 2019 United States Government as represented by + * the Administrator of the National Aeronautics and Space Administration. + * All Rights Reserved. + * + * Licensed 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. + */ + +/** + * \file coveragetest-no-module.c + * \ingroup vxworks + * \author joseph.p.hickey@nasa.gov + * + */ +#include "os-vxworks-coveragetest.h" +#include "ut-adaptor-sockets.h" + +#include "OCS_ioLib.h" + +void Test_OS_VxWorks_SetSocketFlags_Impl(void) +{ + UtAssert_VOIDCALL(UT_SocketTest_CallVxWorksSetFlags_Impl(0)); + + UT_SetDefaultReturnValue(UT_KEY(OCS_ioctl), OCS_ERROR); + UtAssert_VOIDCALL(UT_SocketTest_CallVxWorksSetFlags_Impl(0)); +} + +/* ------------------- End of test cases --------------------------------------*/ + +/* Osapi_Test_Setup + * + * Purpose: + * Called by the unit test tool to set up the app prior to each test + */ +void Osapi_Test_Setup(void) +{ + UT_ResetState(0); +} + +/* + * Osapi_Test_Teardown + * + * Purpose: + * Called by the unit test tool to tear down the app after each test + */ +void Osapi_Test_Teardown(void) {} + +/* UtTest_Setup + * + * Purpose: + * Registers the test cases to execute with the unit test tool + */ +void UtTest_Setup(void) +{ + ADD_TEST(OS_VxWorks_SetSocketFlags_Impl); +} diff --git a/src/unit-test-coverage/vxworks/ut-stubs/CMakeLists.txt b/src/unit-test-coverage/vxworks/ut-stubs/CMakeLists.txt index f19cd1b93..c24c1d8e5 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/CMakeLists.txt +++ b/src/unit-test-coverage/vxworks/ut-stubs/CMakeLists.txt @@ -8,6 +8,7 @@ add_library(ut_vxworks_impl_stubs src/vxworks-os-impl-module-stubs.c src/vxworks-os-impl-mutex-stubs.c src/vxworks-os-impl-queue-stubs.c + src/vxworks-os-impl-sockets-stubs.c src/vxworks-os-impl-task-stubs.c src/vxworks-os-impl-timer-stubs.c ) diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c new file mode 100644 index 000000000..0c68f6524 --- /dev/null +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c @@ -0,0 +1,33 @@ +/* + * NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer" + * + * Copyright (c) 2019 United States Government as represented by + * the Administrator of the National Aeronautics and Space Administration. + * All Rights Reserved. + * + * Licensed 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. + */ + +/** + * \file vxworks-os-impl-socket-stubs.c + * \ingroup ut-stubs + * \author joseph.p.hickey@nasa.gov + * + */ +#include +#include +#include "utstubs.h" + +#include "os-shared-idmap.h" + +void OS_VxWorks_SetSocketFlags_Impl(const OS_object_token_t *token) {} From 9bac3612c61b3dfe3ed5b8ef601f8eece02d8fb3 Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Tue, 21 Sep 2021 22:07:34 -0400 Subject: [PATCH 015/178] IC:2021-09-21, v5.1.0-rc1+dev619 --- README.md | 7 +++++++ src/os/inc/osapi-version.h | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f05ba709e..7d1deac5e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ The autogenerated OSAL user's guide can be viewed at and ### Development Build: v5.1.0-rc1+dev604 - Add typecast to memchr call diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index 62fe1162e..9c1ad5b6e 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -36,7 +36,7 @@ /* * Development Build Macro Definitions */ -#define OS_BUILD_NUMBER 604 +#define OS_BUILD_NUMBER 619 #define OS_BUILD_BASELINE "v5.1.0-rc1" /* From a2ad51e984d5bd365b8e75bf8f474d183a1486c6 Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Tue, 28 Sep 2021 09:15:09 -0400 Subject: [PATCH 016/178] Fix #1167, vxWorks intLib stub aliasing issue Use a separate local variable rather than casting to (void **). --- src/unit-test-coverage/ut-stubs/src/vxworks-intLib-stubs.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/unit-test-coverage/ut-stubs/src/vxworks-intLib-stubs.c b/src/unit-test-coverage/ut-stubs/src/vxworks-intLib-stubs.c index 2b22aba0b..bae886686 100644 --- a/src/unit-test-coverage/ut-stubs/src/vxworks-intLib-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/vxworks-intLib-stubs.c @@ -54,10 +54,12 @@ OCS_VOIDFUNCPTR *OCS_INUM_TO_IVEC(unsigned int ui) OCS_VOIDFUNCPTR * VecTbl; static OCS_VOIDFUNCPTR DummyVec; size_t VecTblSize; + void * GenericPtr; if (Status == 0) { - UT_GetDataBuffer(UT_KEY(OCS_INUM_TO_IVEC), (void **)&VecTbl, &VecTblSize, NULL); + UT_GetDataBuffer(UT_KEY(OCS_INUM_TO_IVEC), &GenericPtr, &VecTblSize, NULL); + VecTbl = GenericPtr; if (VecTbl != NULL && ui < (VecTblSize / sizeof(OCS_VOIDFUNCPTR))) { VecTbl += ui; From f2fbc904c8454162f35c4ef7e97b3ba55dd56a2d Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Tue, 28 Sep 2021 09:06:58 -0400 Subject: [PATCH 017/178] Fix #1166, recognize ifdef __cplusplus Add feature to generate_stubs.pl input phase to recognize and skip over `#ifdef __cplusplus` blocks. This makes it so it can be used on C headers which are C++-enabled too. --- ut_assert/scripts/generate_stubs.pl | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/ut_assert/scripts/generate_stubs.pl b/ut_assert/scripts/generate_stubs.pl index 4a0792a24..32879ab16 100755 --- a/ut_assert/scripts/generate_stubs.pl +++ b/ut_assert/scripts/generate_stubs.pl @@ -110,6 +110,7 @@ my $file = ""; my $file_boilerplate; my $file_variadic; + my @ifdef_level = (1); # All header files start with some legal boilerplate comments # Take the first one and save it, so it can be put into the output. @@ -125,7 +126,31 @@ # so it will be in a single "line" in the result. chomp if (s/\\$//); } - push(@lines, $_); + + # detect "#ifdef" lines - some may need to be recognized. + # at the very least, any C++-specific bits need to be skipped. + # for now this just specifically looks for __cplusplus + if (/^\#(if\w+)\s+(.*)$/) { + my $check = $1; + my $cond = $2; + my $result = $ifdef_level[0]; + + if ($cond eq "__cplusplus" && $check eq "ifdef") { + $result = 0; + } + + unshift(@ifdef_level, $result); + } + elsif (/^\#else/) { + # invert the last preprocessor condition + $ifdef_level[0] = $ifdef_level[0] ^ $ifdef_level[1]; + } + elsif (/^\#endif/) { + shift(@ifdef_level); + } + elsif ($ifdef_level[0]) { + push(@lines, $_) ; + } } close(HDR); @@ -164,7 +189,6 @@ next if (/\btypedef\b/); # ignore typedefs next if (/\bstatic inline\b/); # ignore - # discard "extern" qualifier # (but other qualifiers like "const" are OK and should be preserved, as # it is part of return type). @@ -408,4 +432,3 @@ print "Generated $stubfile\n"; } - From 5cba5aedc8d40bff010cd7563dc40a7766cb99c9 Mon Sep 17 00:00:00 2001 From: Sam Price Date: Thu, 7 Oct 2021 10:40:51 -0400 Subject: [PATCH 018/178] Fix #1177 Rename OS_XXXTime to OS_XXXLocalTime in comments. --- src/os/portable/os-impl-posix-gettime.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/os/portable/os-impl-posix-gettime.c b/src/os/portable/os-impl-posix-gettime.c index 0bd232200..07fd7e3f9 100644 --- a/src/os/portable/os-impl-posix-gettime.c +++ b/src/os/portable/os-impl-posix-gettime.c @@ -22,7 +22,7 @@ * \file os-impl-posix-gettime.c * \author joseph.p.hickey@nasa.gov * - * This file contains implementation for OS_GetTime() and OS_SetTime() + * This file contains implementation for OS_GetLocalTime() and OS_SetLocalTime() * that map to the C library clock_gettime() and clock_settime() calls. * This should be usable on any OS that supports those standard calls. * The OS-specific code must \#include the correct headers that define the From b16c6f149aae0ffb73c868255c518dd9c3698b50 Mon Sep 17 00:00:00 2001 From: Shefali321 <53991521+Shefali321@users.noreply.github.com> Date: Sun, 10 Oct 2021 02:21:56 +0530 Subject: [PATCH 019/178] Update generate_stubs.pl --- ut_assert/scripts/generate_stubs.pl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ut_assert/scripts/generate_stubs.pl b/ut_assert/scripts/generate_stubs.pl index 4a0792a24..1a0323bb5 100755 --- a/ut_assert/scripts/generate_stubs.pl +++ b/ut_assert/scripts/generate_stubs.pl @@ -327,7 +327,7 @@ if ($fileapi->{$funcname}->{variadic}) { $args .= ", va_list"; } - print OUT "extern void ".$handler_func->{$funcname}."($args);\n"; + print OUT "void ".$handler_func->{$funcname}."($args);\n"; } } From 9157b7845a8e35fc10e75b11dac860aa766fe0e5 Mon Sep 17 00:00:00 2001 From: ArielSAdamsNASA Date: Wed, 13 Oct 2021 08:50:30 -0500 Subject: [PATCH 020/178] Fix #1175, Use fstat and fchmod for TOCTOU Bug --- ut_assert/src/uttools.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/ut_assert/src/uttools.c b/ut_assert/src/uttools.c index 291edda9f..895a8530f 100644 --- a/ut_assert/src/uttools.c +++ b/ut_assert/src/uttools.c @@ -57,14 +57,15 @@ typedef struct bool UtMem2BinFile(const void *Memory, const char *Filename, uint32 Length) { FILE * fp; + int fd; struct stat dststat; if ((fp = fopen(Filename, "w"))) { - if (stat(Filename, &dststat) == 0) + fd = fileno(fp); + if (fstat(fd, &dststat) == 0) { - chmod(Filename, dststat.st_mode & ~(S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH)); - stat(Filename, &dststat); + fchmod(fd, dststat.st_mode & ~(S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH)); } fwrite(Memory, Length, 1, fp); @@ -106,14 +107,15 @@ bool UtMem2HexFile(const void *Memory, const char *Filename, uint32 Length) FILE * fp; uint32 i; uint32 j; + int fd; struct stat dststat; if ((fp = fopen(Filename, "w"))) { - if (stat(Filename, &dststat) == 0) + fd = fileno(fp); + if (fstat(fd, &dststat) == 0) { - chmod(Filename, dststat.st_mode & ~(S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH)); - stat(Filename, &dststat); + fchmod(fd, dststat.st_mode & ~(S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH)); } for (i = 0; i < Length; i += 16) From 9d1ba83e5fb50bd89f7b22d2ccb75aa77d7de679 Mon Sep 17 00:00:00 2001 From: ArielSAdamsNASA Date: Fri, 22 Oct 2021 10:16:19 -0500 Subject: [PATCH 021/178] Fix #1183, Add Duplicate Check to Local Unit Test --- .github/workflows/local_unit_test.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.github/workflows/local_unit_test.yml b/.github/workflows/local_unit_test.yml index 17da300b9..7be29b6ca 100644 --- a/.github/workflows/local_unit_test.yml +++ b/.github/workflows/local_unit_test.yml @@ -5,8 +5,23 @@ on: pull_request: jobs: + #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action. + check-for-duplicates: + runs-on: ubuntu-latest + # Map a step output to a job output + outputs: + should_skip: ${{ steps.skip_check.outputs.should_skip }} + steps: + - id: skip_check + uses: fkirc/skip-duplicate-actions@master + with: + concurrent_skipping: 'same_content' + skip_after_successful_duplicate: 'true' + do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]' Local-Unit-Test: + needs: check-for-duplicates + if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }} runs-on: ubuntu-18.04 timeout-minutes: 15 From 2abd8e69ee434752cf7e5f3c3e8f290a97168c2a Mon Sep 17 00:00:00 2001 From: ArielSAdamsNASA Date: Wed, 27 Oct 2021 12:27:52 -0500 Subject: [PATCH 022/178] Fix #1188, Reuse CodeQL, Static Analysis, Format Check --- .github/workflows/codeql-cfe-build.yml | 110 ++-------------------- .github/workflows/codeql-osal-default.yml | 84 ++--------------- .github/workflows/format-check.yml | 46 +-------- .github/workflows/static-analysis.yml | 50 +--------- 4 files changed, 21 insertions(+), 269 deletions(-) diff --git a/.github/workflows/codeql-cfe-build.yml b/.github/workflows/codeql-cfe-build.yml index 62b6e6a0b..a0d6db0f2 100644 --- a/.github/workflows/codeql-cfe-build.yml +++ b/.github/workflows/codeql-cfe-build.yml @@ -4,107 +4,11 @@ on: push: pull_request: -env: - SIMULATION: native - ENABLE_UNIT_TESTS: true - OMIT_DEPRECATED: true - BUILDTYPE: release - jobs: - #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action. - check-for-duplicates: - runs-on: ubuntu-latest - # Map a step output to a job output - outputs: - should_skip: ${{ steps.skip_check.outputs.should_skip }} - steps: - - id: skip_check - uses: fkirc/skip-duplicate-actions@master - with: - concurrent_skipping: 'same_content' - skip_after_successful_duplicate: 'true' - do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]' - - CodeQL-Security-Build: - needs: check-for-duplicates - if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }} - runs-on: ubuntu-18.04 - timeout-minutes: 15 - - steps: - - name: Checkout bundle - uses: actions/checkout@v2 - with: - repository: nasa/cFS - submodules: true - - - name: Checkout submodule - uses: actions/checkout@v2 - with: - path: osal - - - name: Check versions - run: git submodule - - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: c - config-file: nasa/cFS/.github/codeql/codeql-security.yml@main - - - name: Set up for build - run: | - cp ./cfe/cmake/Makefile.sample Makefile - cp -r ./cfe/cmake/sample_defs sample_defs - make prep - - - name: Build - run: make -j native/default_cpu1/osal/ - - - name: Run tests - run: (cd build/native/default_cpu1/osal && make test) - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 - - CodeQL-Coding-Standard-Build: - needs: check-for-duplicates - if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }} - runs-on: ubuntu-18.04 - timeout-minutes: 15 - - steps: - - name: Checkout bundle - uses: actions/checkout@v2 - with: - repository: nasa/cFS - submodules: true - - - name: Checkout submodule - uses: actions/checkout@v2 - with: - path: osal - - - name: Check versions - run: git submodule - - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: c - config-file: nasa/cFS/.github/codeql/codeql-coding-standard.yml@main - - - name: Set up for build - run: | - cp ./cfe/cmake/Makefile.sample Makefile - cp -r ./cfe/cmake/sample_defs sample_defs - make prep - - - name: Build - run: make -j native/default_cpu1/osal/ - - - name: Run tests - run: (cd build/native/default_cpu1/osal && make test) - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 + codeql: + name: CodeQl Analysis + uses: nasa/cFS/.github/workflows/codeql-build.yml@main + with: + make-prep: 'make prep' + make: 'make -j native/default_cpu1/osal/' + tests: '(cd build/native/default_cpu1/osal && make test)' \ No newline at end of file diff --git a/.github/workflows/codeql-osal-default.yml b/.github/workflows/codeql-osal-default.yml index 3cb8146e3..0509f7280 100644 --- a/.github/workflows/codeql-osal-default.yml +++ b/.github/workflows/codeql-osal-default.yml @@ -4,81 +4,11 @@ on: push: pull_request: -env: - SIMULATION: native - ENABLE_UNIT_TESTS: true - OMIT_DEPRECATED: true - BUILDTYPE: release - PERMISSIVE_MODE: true - jobs: - - #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action. - check-for-duplicates: - runs-on: ubuntu-latest - # Map a step output to a job output - outputs: - should_skip: ${{ steps.skip_check.outputs.should_skip }} - steps: - - id: skip_check - uses: fkirc/skip-duplicate-actions@master - with: - concurrent_skipping: 'same_content' - skip_after_successful_duplicate: 'true' - do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]' - - CodeQL-Security-Build: - #Continue if check-for-duplicates found no duplicates. Always runs for pull-requests. - needs: check-for-duplicates - if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }} - runs-on: ubuntu-18.04 - timeout-minutes: 15 - - steps: - - name: Checkout submodule - uses: actions/checkout@v2 - - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: c - config-file: nasa/cFS/.github/codeql/codeql-security.yml@main - - - name: Set up for build - run: | - cp Makefile.sample Makefile - make prep - - - name: Build - run: make -j - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 - - CodeQL-Coding-Standard-Build: - #Continue if check-for-duplicates found no duplicates. Always runs for pull-requests. - needs: check-for-duplicates - if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }} - runs-on: ubuntu-18.04 - timeout-minutes: 15 - - steps: - - name: Checkout submodule - uses: actions/checkout@v2 - - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: c - config-file: nasa/cFS/.github/codeql/codeql-coding-standard.yml@main - - - name: Set up for build - run: | - cp Makefile.sample Makefile - make prep - - - name: Build - run: make -j - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 \ No newline at end of file + codeql: + name: CodeQl Analysis + uses: nasa/cFS/.github/workflows/codeql-build.yml@main + with: + setup: 'cd osal && cp Makefile.sample Makefile' + make-prep: 'cd osal && make prep' + make: 'cd osal && make -j' \ No newline at end of file diff --git a/.github/workflows/format-check.yml b/.github/workflows/format-check.yml index 0a998eccb..d5fd74250 100644 --- a/.github/workflows/format-check.yml +++ b/.github/workflows/format-check.yml @@ -1,6 +1,6 @@ name: Format Check -# Run on main push and pull requests +# Run on all push and pull requests on: push: branches: @@ -8,46 +8,6 @@ on: pull_request: jobs: - - static-analysis: + format-check: name: Run format check - runs-on: ubuntu-18.04 - timeout-minutes: 15 - - steps: - - - name: Install format checker - run: | - wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add - - sudo add-apt-repository 'deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-10 main' - sudo apt-get update && sudo apt-get install clang-format-10 - - - name: Checkout bundle - uses: actions/checkout@v2 - with: - repository: nasa/cFS - - - name: Checkout - uses: actions/checkout@v2 - with: - path: repo - - - name: Generate format differences - run: | - cd repo - find . -name "*.[ch]" -exec clang-format-10 -i -style=file {} + - git diff > $GITHUB_WORKSPACE/style_differences.txt - - - name: Archive Static Analysis Artifacts - uses: actions/upload-artifact@v2 - with: - name: style_differences - path: style_differences.txt - - - name: Error on differences - run: | - if [[ -s style_differences.txt ]]; - then - cat style_differences.txt - exit -1 - fi + uses: nasa/cFS/.github/workflows/format-check.yml@main \ No newline at end of file diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml index 5016ac33f..ac905d695 100644 --- a/.github/workflows/static-analysis.yml +++ b/.github/workflows/static-analysis.yml @@ -1,55 +1,13 @@ name: Static Analysis -# Run this workflow every time a new commit pushed to your repository +# Run on all push and pull requests on: push: - branches: - - main pull_request: jobs: - static-analysis: name: Run cppcheck - runs-on: ubuntu-18.04 - timeout-minutes: 15 - - strategy: - fail-fast: false - matrix: - cppcheck: [all, osal] - - steps: - - - name: Install cppcheck - run: sudo apt-get install cppcheck -y - - # Checks out a copy of the cfs bundle - - name: Checkout code - uses: actions/checkout@v2 - with: - submodules: true - - - name: Run bundle cppcheck - if: ${{matrix.cppcheck =='all'}} - run: cppcheck --force --inline-suppr . 2> ${{matrix.cppcheck}}_cppcheck_err.txt - - # Run strict static analysis for embedded portions of osal - - name: osal strict cppcheck - if: ${{matrix.cppcheck =='osal'}} - run: | - cppcheck --force --inline-suppr --std=c99 --language=c --enable=warning,performance,portability,style --suppress=variableScope --inconclusive ./src/bsp ./src/os 2> ./${{matrix.cppcheck}}_cppcheck_err.txt - - - name: Archive Static Analysis Artifacts - uses: actions/upload-artifact@v2 - with: - name: ${{matrix.cppcheck}}-cppcheck-err - path: ./*cppcheck_err.txt - - - name: Check for errors - run: | - if [[ -s ${{matrix.cppcheck}}_cppcheck_err.txt ]]; - then - cat ${{matrix.cppcheck}}_cppcheck_err.txt - exit -1 - fi + uses: nasa/cFS/.github/workflows/static-analysis.yml@main + with: + strict-dir-list: './src/bsp ./src/os' From 30635f856d28177ed2fcea0b3dd1512e7f8cdf9d Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Wed, 17 Nov 2021 21:31:06 -0500 Subject: [PATCH 023/178] Update build baseline and bump to v6.0.0-rc4+dev15 - Set new build baseline for cFS-Caelum-rc4: v6.0.0-rc4 --- README.md | 13 +++++++++++++ src/os/inc/osapi-version.h | 6 +++--- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7d1deac5e..cbbb80a25 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,18 @@ The autogenerated OSAL user's guide can be viewed at and + + ### Development Build: v5.1.0-rc1+dev619 - Enable symbol api test and MIR dump too large @@ -18,6 +30,7 @@ The autogenerated OSAL user's guide can be viewed at and + ### Development Build: v5.1.0-rc1+dev604 - Add typecast to memchr call diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index 9c1ad5b6e..6e4ce779a 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -36,8 +36,8 @@ /* * Development Build Macro Definitions */ -#define OS_BUILD_NUMBER 619 -#define OS_BUILD_BASELINE "v5.1.0-rc1" +#define OS_BUILD_NUMBER 15 +#define OS_BUILD_BASELINE "v6.0.0-rc4" /* * Version Macro Definitions @@ -68,7 +68,7 @@ /*! @brief Version code name * All modular components which are tested/validated together should share the same code name */ -#define OS_VERSION_CODENAME "Bootes" +#define OS_VERSION_CODENAME "Draco" /*! @brief Development Build Version String. * @details Reports the current development build's baseline, number, and name. Also includes a note about the latest From 09032eea305ed0c5c3c782c46b0f9d8350b26100 Mon Sep 17 00:00:00 2001 From: KurtJD Date: Fri, 7 Jan 2022 07:27:58 -0800 Subject: [PATCH 024/178] Fix #1200, Add missing space to UtAssert_STUB_COUNT --- ut_assert/inc/utassert.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ut_assert/inc/utassert.h b/ut_assert/inc/utassert.h index 35861ca13..cca0469a3 100644 --- a/ut_assert/inc/utassert.h +++ b/ut_assert/inc/utassert.h @@ -498,7 +498,7 @@ typedef struct */ #define UtAssert_STUB_COUNT(stub, expected) \ UtAssert_GenericSignedCompare(UT_GetStubCount(UT_KEY(stub)), UtAssert_Compare_EQ, expected, \ - UtAssert_Radix_DECIMAL, __FILE__, __LINE__, "CallCount", #stub "()", #expected) + UtAssert_Radix_DECIMAL, __FILE__, __LINE__, "CallCount ", #stub "()", #expected) /* * Exported Functions From 7aa674ce760e1bccf77c173240f5b3d4995734c6 Mon Sep 17 00:00:00 2001 From: KurtJD Date: Sat, 8 Jan 2022 18:04:07 -0800 Subject: [PATCH 025/178] Fix #1196, Add UINT16 equivalents for UtAssert_UINT32_ macros --- ut_assert/inc/utassert.h | 78 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/ut_assert/inc/utassert.h b/ut_assert/inc/utassert.h index 35861ca13..fba1e6c0e 100644 --- a/ut_assert/inc/utassert.h +++ b/ut_assert/inc/utassert.h @@ -406,6 +406,84 @@ typedef struct UtAssert_GenericUnsignedCompare((uint32)(expr), UtAssert_Compare_GT, (uint32)(ref), UtAssert_Radix_DECIMAL, \ __FILE__, __LINE__, "", #expr, #ref) +/** + * \brief Compare two 16-bit values for equality with an auto-generated description message + * + * This macro confirms that the given expression is equal to the reference value + * The generated log message will include the actual and reference values in decimal notation + * Values will be compared in an "uint16" type context. + */ +#define UtAssert_UINT16_EQ(actual, ref) \ + UtAssert_GenericUnsignedCompare((uint16)(actual), UtAssert_Compare_EQ, (uint16)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT16: ", #actual, #ref) + +/** + * \brief Compare two 16-bit values for inequality with an auto-generated description message + * + * This macro confirms that the given expression is _not_ equal to the reference value + * The generated log message will include the actual and reference values in decimal notation + * Values will be compared in an "uint16" type context. + */ +#define UtAssert_UINT16_NEQ(actual, ref) \ + UtAssert_GenericUnsignedCompare((uint16)(actual), UtAssert_Compare_NEQ, (uint16)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT16: ", #actual, #ref) + +/** + * \brief Asserts the minimum 16-bit value of a given function or expression + * + * \par Description + * This macro confirms that the given expression is at least the minimum 16-bit value (inclusive) + * + * \par Assumptions, External Events, and Notes: + * None + * + */ +#define UtAssert_UINT16_GTEQ(expr, ref) \ + UtAssert_GenericUnsignedCompare((uint16)(expr), UtAssert_Compare_GTEQ, (uint16)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT16: ", #expr, #ref) + +/** + * \brief Asserts the maximum 16-bit value of a given function or expression + * + * \par Description + * This macro confirms that the given expression is at most the maximum 16-bit value (inclusive) + * + * \par Assumptions, External Events, and Notes: + * None + * + */ +#define UtAssert_UINT16_LTEQ(expr, ref) \ + UtAssert_GenericUnsignedCompare((uint16)(expr), UtAssert_Compare_LTEQ, (uint16)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT16: ", #expr, #ref) + +/** + * \brief Asserts the 16-bit value of a given function or expression is less than the 16-bit reference value + * + * \par Description + * This macro confirms that the given expression is less than the maximum 16-bit value (exclusive) + * + * \par Assumptions, External Events, and Notes: + * None + * + */ +#define UtAssert_UINT16_LT(expr, ref) \ + UtAssert_GenericUnsignedCompare((uint16)(expr), UtAssert_Compare_LT, (uint16)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT16: ", #expr, #ref) + +/** + * \brief Asserts the 16-bit value of a given function or expression is greater than the 16-bit reference value + * + * \par Description + * This macro confirms that the given expression is greater than the minimum 16-bit value (exclusive) + * + * \par Assumptions, External Events, and Notes: + * None + * + */ +#define UtAssert_UINT16_GT(expr, ref) \ + UtAssert_GenericUnsignedCompare((uint16)(expr), UtAssert_Compare_GT, (uint16)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT16: ", #expr, #ref) + /** * \brief Macro for checking that bits in a bit field are set * From a3bf24592347510972a25285f60db7396a85cd66 Mon Sep 17 00:00:00 2001 From: KurtJD Date: Sat, 8 Jan 2022 18:12:46 -0800 Subject: [PATCH 026/178] Fix #1196, Add UINT8 equivalents for UtAssert_UINT32_ macros --- ut_assert/inc/utassert.h | 78 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/ut_assert/inc/utassert.h b/ut_assert/inc/utassert.h index fba1e6c0e..b40c884f3 100644 --- a/ut_assert/inc/utassert.h +++ b/ut_assert/inc/utassert.h @@ -484,6 +484,84 @@ typedef struct UtAssert_GenericUnsignedCompare((uint16)(expr), UtAssert_Compare_GT, (uint16)(ref), UtAssert_Radix_DECIMAL, \ __FILE__, __LINE__, "Compare UINT16: ", #expr, #ref) +/** + * \brief Compare two 8-bit values for equality with an auto-generated description message + * + * This macro confirms that the given expression is equal to the reference value + * The generated log message will include the actual and reference values in decimal notation + * Values will be compared in an "uint8" type context. + */ +#define UtAssert_UINT8_EQ(actual, ref) \ + UtAssert_GenericUnsignedCompare((uint8)(actual), UtAssert_Compare_EQ, (uint8)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT8: ", #actual, #ref) + +/** + * \brief Compare two 8-bit values for inequality with an auto-generated description message + * + * This macro confirms that the given expression is _not_ equal to the reference value + * The generated log message will include the actual and reference values in decimal notation + * Values will be compared in an "uint8" type context. + */ +#define UtAssert_UINT8_NEQ(actual, ref) \ + UtAssert_GenericUnsignedCompare((uint8)(actual), UtAssert_Compare_NEQ, (uint8)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT8: ", #actual, #ref) + +/** + * \brief Asserts the minimum 8-bit value of a given function or expression + * + * \par Description + * This macro confirms that the given expression is at least the minimum 8-bit value (inclusive) + * + * \par Assumptions, External Events, and Notes: + * None + * + */ +#define UtAssert_UINT8_GTEQ(expr, ref) \ + UtAssert_GenericUnsignedCompare((uint8)(expr), UtAssert_Compare_GTEQ, (uint8)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT8: ", #expr, #ref) + +/** + * \brief Asserts the maximum 8-bit value of a given function or expression + * + * \par Description + * This macro confirms that the given expression is at most the maximum 8-bit value (inclusive) + * + * \par Assumptions, External Events, and Notes: + * None + * + */ +#define UtAssert_UINT8_LTEQ(expr, ref) \ + UtAssert_GenericUnsignedCompare((uint8)(expr), UtAssert_Compare_LTEQ, (uint8)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT8: ", #expr, #ref) + +/** + * \brief Asserts the 8-bit value of a given function or expression is less than the 8-bit reference value + * + * \par Description + * This macro confirms that the given expression is less than the maximum 8-bit value (exclusive) + * + * \par Assumptions, External Events, and Notes: + * None + * + */ +#define UtAssert_UINT8_LT(expr, ref) \ + UtAssert_GenericUnsignedCompare((uint8)(expr), UtAssert_Compare_LT, (uint8)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT8: ", #expr, #ref) + +/** + * \brief Asserts the 8-bit value of a given function or expression is greater than the 8-bit reference value + * + * \par Description + * This macro confirms that the given expression is greater than the minimum 8-bit value (exclusive) + * + * \par Assumptions, External Events, and Notes: + * None + * + */ +#define UtAssert_UINT8_GT(expr, ref) \ + UtAssert_GenericUnsignedCompare((uint8)(expr), UtAssert_Compare_GT, (uint8)(ref), UtAssert_Radix_DECIMAL, \ + __FILE__, __LINE__, "Compare UINT8: ", #expr, #ref) + /** * \brief Macro for checking that bits in a bit field are set * From e51cbe33794e5245df0567ba472444e9883f6fda Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Mon, 10 Jan 2022 11:16:07 -0500 Subject: [PATCH 027/178] Fix #1199, correct warnings on gcc11 These new warnings are detected by the new compiler. They are all places in unit test where an uninitialized value is passed via "const" pointer into a unit under test. By definition a "const" pointer is always an input. While the warning is pedantically true - should not pass an uninitialized struct as an input - these were all unit tests where the object value is a don't-care value, so it does not matter. But to fix the warning, simply need to initialize a value before making the call. --- .../portable/src/coveragetest-bsd-sockets.c | 14 +++++++------- .../shared/src/coveragetest-clock.c | 6 +++--- .../vxworks/src/coveragetest-tasks.c | 2 +- src/unit-tests/oscore-test/ut_oscore_task_test.c | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c b/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c index 9322fa2bc..e3f2ac551 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c +++ b/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c @@ -316,10 +316,10 @@ void Test_OS_SocketRecvFrom_Impl(void) void Test_OS_SocketSendTo_Impl(void) { - OS_object_token_t token = {0}; - uint8 buffer[UT_BUFFER_SIZE]; - OS_SockAddr_t addr = {0}; - struct OCS_sockaddr *sa = (struct OCS_sockaddr *)&addr.AddrData; + OS_object_token_t token = {0}; + const uint8 buffer[UT_BUFFER_SIZE] = {0}; + OS_SockAddr_t addr = {0}; + struct OCS_sockaddr *sa = (struct OCS_sockaddr *)&addr.AddrData; /* Set up token */ token.obj_idx = UT_INDEX_0; @@ -393,9 +393,9 @@ void Test_OS_SocketAddrToString_Impl(void) void Test_OS_SocketAddrFromString_Impl(void) { - char buffer[UT_BUFFER_SIZE]; - OS_SockAddr_t addr = {0}; - struct OCS_sockaddr *sa = (struct OCS_sockaddr *)&addr.AddrData; + const char buffer[UT_BUFFER_SIZE] = "UT"; + OS_SockAddr_t addr = {0}; + struct OCS_sockaddr *sa = (struct OCS_sockaddr *)&addr.AddrData; /* Bad family */ sa->sa_family = -1; diff --git a/src/unit-test-coverage/shared/src/coveragetest-clock.c b/src/unit-test-coverage/shared/src/coveragetest-clock.c index 244f8b2e1..2490ddbdb 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-clock.c +++ b/src/unit-test-coverage/shared/src/coveragetest-clock.c @@ -50,9 +50,9 @@ void Test_OS_SetLocalTime(void) * Test Case For: * int32 OS_SetLocalTime(OS_time_t *time_struct) */ - OS_time_t time_struct; - int32 expected = OS_SUCCESS; - int32 actual = OS_SetLocalTime(&time_struct); + OS_time_t time_struct = OS_TimeAssembleFromMicroseconds(5, 12345); + int32 expected = OS_SUCCESS; + int32 actual = OS_SetLocalTime(&time_struct); UtAssert_True(actual == expected, "OS_SetLocalTime() (%ld) == OS_SUCCESS", (long)actual); diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c b/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c index afd7c3184..c99965219 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c @@ -145,7 +145,7 @@ void Test_OS_TaskDetach_Impl(void) * Test Case For: * int32 OS_TaskDetach_Impl(const OS_object_token_t *token) */ - OS_object_token_t token; + OS_object_token_t token = UT_TOKEN_0; /* no-op on VxWorks - always returns success */ OSAPI_TEST_FUNCTION_RC(OS_TaskDetach_Impl(&token), OS_SUCCESS); diff --git a/src/unit-tests/oscore-test/ut_oscore_task_test.c b/src/unit-tests/oscore-test/ut_oscore_task_test.c index 3c4fb1e2e..879cd7093 100644 --- a/src/unit-tests/oscore-test/ut_oscore_task_test.c +++ b/src/unit-tests/oscore-test/ut_oscore_task_test.c @@ -605,7 +605,7 @@ void UT_os_task_get_info_test() **--------------------------------------------------------------------------------*/ void UT_os_task_getid_by_sysdata_test() { - uint8 sysdata; + uint8 sysdata = 0; osal_id_t task_id; /* From 82487f9441abc3ccfd5f6d36bdd27ef85e7c4a4f Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Wed, 12 Jan 2022 14:29:42 -0700 Subject: [PATCH 028/178] Fix #1204, Search global and local symbol tables - Refactors symbol table searching to include both local and global symbol tables for POSIX - Renamed global search to generic since there isn't currently a use case for global only search --- src/os/portable/os-impl-no-symtab.c | 2 +- src/os/portable/os-impl-posix-dl-symtab.c | 25 ++++++++++++++++--- src/os/shared/inc/os-shared-module.h | 7 +++--- src/os/shared/src/osapi-module.c | 4 +-- src/os/vxworks/src/os-impl-symtab.c | 8 +++--- .../portable/src/coveragetest-no-symtab.c | 2 +- .../shared/src/coveragetest-module.c | 4 +-- .../src/os-shared-module-impl-stubs.c | 14 +++++------ .../vxworks/src/coveragetest-symtab.c | 14 +++++------ .../osloader-test/ut_osloader_symtable_test.c | 15 ++++++++++- 10 files changed, 64 insertions(+), 31 deletions(-) diff --git a/src/os/portable/os-impl-no-symtab.c b/src/os/portable/os-impl-no-symtab.c index 270fd598d..5a36ecee9 100644 --- a/src/os/portable/os-impl-no-symtab.c +++ b/src/os/portable/os-impl-no-symtab.c @@ -35,7 +35,7 @@ * * See prototype for argument/return detail *-----------------------------------------------------------------*/ -int32 OS_GlobalSymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) +int32 OS_SymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) { return OS_ERR_NOT_IMPLEMENTED; } diff --git a/src/os/portable/os-impl-posix-dl-symtab.c b/src/os/portable/os-impl-posix-dl-symtab.c index 629ba8d8e..81d578ad3 100644 --- a/src/os/portable/os-impl-posix-dl-symtab.c +++ b/src/os/portable/os-impl-posix-dl-symtab.c @@ -134,18 +134,37 @@ int32 OS_GenericSymbolLookup_Impl(void *dl_handle, cpuaddr *SymbolAddress, const /*---------------------------------------------------------------- * - * Function: OS_GlobalSymbolLookup_Impl + * Function: OS_SymbolLookup_Impl * * Purpose: Implemented per internal OSAL API * See prototype for argument/return detail * *-----------------------------------------------------------------*/ -int32 OS_GlobalSymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) +int32 OS_SymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) { - int32 status; + int32 status; + int32 local_status = OS_ERROR; + OS_object_iter_t iter; + /* First search global table */ status = OS_GenericSymbolLookup_Impl(OSAL_DLSYM_DEFAULT_HANDLE, SymbolAddress, SymbolName); + /* If not found iterate through module local symbols and break if found */ + if (status != OS_SUCCESS) + { + OS_ObjectIdIterateActive(OS_OBJECT_TYPE_OS_MODULE, &iter); + while (OS_ObjectIdIteratorGetNext(&iter)) + { + local_status = OS_ModuleSymbolLookup_Impl(&iter.token, SymbolAddress, SymbolName); + if (local_status == OS_SUCCESS) + { + status = local_status; + break; + } + } + OS_ObjectIdIteratorDestroy(&iter); + } + return status; } /* end OS_SymbolLookup_Impl */ diff --git a/src/os/shared/inc/os-shared-module.h b/src/os/shared/inc/os-shared-module.h index 86811e8e7..b43ded2a5 100644 --- a/src/os/shared/inc/os-shared-module.h +++ b/src/os/shared/inc/os-shared-module.h @@ -95,14 +95,15 @@ int32 OS_ModuleUnload_Impl(const OS_object_token_t *token); int32 OS_ModuleGetInfo_Impl(const OS_object_token_t *token, OS_module_prop_t *module_prop); /*---------------------------------------------------------------- - Function: OS_GlobalSymbolLookup_Impl + Function: OS_SymbolLookup_Impl - Purpose: Find the Address of a Symbol in the global symbol table. + Purpose: Find the Address of a Symbol in the symbol table. If global and + local tables exist all are checked. The address of the symbol will be stored in the pointer that is passed in. Returns: OS_SUCCESS on success, or relevant error code ------------------------------------------------------------------*/ -int32 OS_GlobalSymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName); +int32 OS_SymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName); /*---------------------------------------------------------------- Function: OS_SymbolLookup_Impl diff --git a/src/os/shared/src/osapi-module.c b/src/os/shared/src/osapi-module.c index 720da42ed..236006c24 100644 --- a/src/os/shared/src/osapi-module.c +++ b/src/os/shared/src/osapi-module.c @@ -361,9 +361,9 @@ int32 OS_SymbolLookup(cpuaddr *SymbolAddress, const char *SymbolName) OS_CHECK_POINTER(SymbolName); /* - * attempt to find the symbol in the global symbol table. + * attempt to find the symbol in the symbol table */ - return_code = OS_GlobalSymbolLookup_Impl(SymbolAddress, SymbolName); + return_code = OS_SymbolLookup_Impl(SymbolAddress, SymbolName); /* * If the OS call did not find the symbol or the loader is diff --git a/src/os/vxworks/src/os-impl-symtab.c b/src/os/vxworks/src/os-impl-symtab.c index 3956f0541..35ed770d9 100644 --- a/src/os/vxworks/src/os-impl-symtab.c +++ b/src/os/vxworks/src/os-impl-symtab.c @@ -108,16 +108,16 @@ int32 OS_GenericSymbolLookup_Impl(SYMTAB_ID SymTab, cpuaddr *SymbolAddress, cons /*---------------------------------------------------------------- * - * Function: OS_GlobalSymbolLookup_Impl + * Function: OS_SymbolLookup_Impl * * Purpose: Implemented per internal OSAL API * See prototype for argument/return detail * *-----------------------------------------------------------------*/ -int32 OS_GlobalSymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) +int32 OS_SymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) { return OS_GenericSymbolLookup_Impl(sysSymTbl, SymbolAddress, SymbolName); -} /* end OS_GlobalSymbolLookup_Impl */ +} /* end OS_SymbolLookup_Impl */ /*---------------------------------------------------------------- * @@ -130,7 +130,7 @@ int32 OS_GlobalSymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) int32 OS_ModuleSymbolLookup_Impl(const OS_object_token_t *token, cpuaddr *SymbolAddress, const char *SymbolName) { /* - * NOTE: this is currently exactly the same as OS_GlobalSymbolLookup_Impl(). + * NOTE: this is currently exactly the same as OS_SymbolLookup_Impl(). * * Ideally this should get a SYMTAB_ID from the MODULE_ID and search only * for the symbols provided by that module - but it is not clear if vxWorks diff --git a/src/unit-test-coverage/portable/src/coveragetest-no-symtab.c b/src/unit-test-coverage/portable/src/coveragetest-no-symtab.c index ad7009970..f08ff8c9b 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-no-symtab.c +++ b/src/unit-test-coverage/portable/src/coveragetest-no-symtab.c @@ -28,7 +28,7 @@ void Test_No_Symtab(void) { - OSAPI_TEST_FUNCTION_RC(OS_GlobalSymbolLookup_Impl, (NULL, NULL), OS_ERR_NOT_IMPLEMENTED); + OSAPI_TEST_FUNCTION_RC(OS_SymbolLookup_Impl, (NULL, NULL), OS_ERR_NOT_IMPLEMENTED); OSAPI_TEST_FUNCTION_RC(OS_ModuleSymbolLookup_Impl, (NULL, NULL, NULL), OS_ERR_NOT_IMPLEMENTED); OSAPI_TEST_FUNCTION_RC(OS_SymbolTableDump_Impl, (NULL, 0), OS_ERR_NOT_IMPLEMENTED); } diff --git a/src/unit-test-coverage/shared/src/coveragetest-module.c b/src/unit-test-coverage/shared/src/coveragetest-module.c index 4eace72c0..63644fc7e 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-module.c +++ b/src/unit-test-coverage/shared/src/coveragetest-module.c @@ -136,8 +136,8 @@ void Test_OS_SymbolLookup(void) actual = OS_SymbolLookup(&symaddr, "uttestsym0"); UtAssert_True(actual == expected, "OS_SymbolLookup(name=%s) (%ld) == OS_SUCCESS", "uttestsym0", (long)actual); - UT_ResetState(UT_KEY(OS_GlobalSymbolLookup_Impl)); - UT_SetDefaultReturnValue(UT_KEY(OS_GlobalSymbolLookup_Impl), OS_ERROR); + UT_ResetState(UT_KEY(OS_SymbolLookup_Impl)); + UT_SetDefaultReturnValue(UT_KEY(OS_SymbolLookup_Impl), OS_ERROR); /* this lookup should always fail */ symaddr = 0; diff --git a/src/unit-test-coverage/ut-stubs/src/os-shared-module-impl-stubs.c b/src/unit-test-coverage/ut-stubs/src/os-shared-module-impl-stubs.c index 6413b0b05..bc7bcf2aa 100644 --- a/src/unit-test-coverage/ut-stubs/src/os-shared-module-impl-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/os-shared-module-impl-stubs.c @@ -29,19 +29,19 @@ /* * ---------------------------------------------------- - * Generated stub function for OS_GlobalSymbolLookup_Impl() + * Generated stub function for OS_SymbolLookup_Impl() * ---------------------------------------------------- */ -int32 OS_GlobalSymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) +int32 OS_SymbolLookup_Impl(cpuaddr *SymbolAddress, const char *SymbolName) { - UT_GenStub_SetupReturnBuffer(OS_GlobalSymbolLookup_Impl, int32); + UT_GenStub_SetupReturnBuffer(OS_SymbolLookup_Impl, int32); - UT_GenStub_AddParam(OS_GlobalSymbolLookup_Impl, cpuaddr *, SymbolAddress); - UT_GenStub_AddParam(OS_GlobalSymbolLookup_Impl, const char *, SymbolName); + UT_GenStub_AddParam(OS_SymbolLookup_Impl, cpuaddr *, SymbolAddress); + UT_GenStub_AddParam(OS_SymbolLookup_Impl, const char *, SymbolName); - UT_GenStub_Execute(OS_GlobalSymbolLookup_Impl, Basic, NULL); + UT_GenStub_Execute(OS_SymbolLookup_Impl, Basic, NULL); - return UT_GenStub_GetReturnValue(OS_GlobalSymbolLookup_Impl, int32); + return UT_GenStub_GetReturnValue(OS_SymbolLookup_Impl, int32); } /* diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c b/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c index 9d2e84397..ea5fca3cb 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c @@ -33,18 +33,18 @@ #include "OCS_fcntl.h" #include "OCS_symLib.h" -void Test_OS_GlobalSymbolLookup_Impl(void) +void Test_OS_SymbolLookup_Impl(void) { /* Test Case For: - * int32 OS_GlobalSymbolLookup_Impl( cpuaddr *SymbolAddress, const char *SymbolName ) + * int32 OS_SymbolLookup_Impl( cpuaddr *SymbolAddress, const char *SymbolName ) */ cpuaddr SymAddr; - OSAPI_TEST_FUNCTION_RC(OS_GlobalSymbolLookup_Impl(&SymAddr, "symname"), OS_SUCCESS); - OSAPI_TEST_FUNCTION_RC(OS_GlobalSymbolLookup_Impl(NULL, "symname"), OS_INVALID_POINTER); - OSAPI_TEST_FUNCTION_RC(OS_GlobalSymbolLookup_Impl(&SymAddr, NULL), OS_INVALID_POINTER); + OSAPI_TEST_FUNCTION_RC(OS_SymbolLookup_Impl(&SymAddr, "symname"), OS_SUCCESS); + OSAPI_TEST_FUNCTION_RC(OS_SymbolLookup_Impl(NULL, "symname"), OS_INVALID_POINTER); + OSAPI_TEST_FUNCTION_RC(OS_SymbolLookup_Impl(&SymAddr, NULL), OS_INVALID_POINTER); UT_SetDefaultReturnValue(UT_KEY(OCS_symFind), OCS_ERROR); - OSAPI_TEST_FUNCTION_RC(OS_GlobalSymbolLookup_Impl(&SymAddr, "symname"), OS_ERROR); + OSAPI_TEST_FUNCTION_RC(OS_SymbolLookup_Impl(&SymAddr, "symname"), OS_ERROR); } void Test_OS_ModuleSymbolLookup_Impl(void) @@ -144,7 +144,7 @@ void Osapi_Test_Teardown(void) {} void UtTest_Setup(void) { ADD_TEST(OS_SymTableIterator_Impl); - ADD_TEST(OS_GlobalSymbolLookup_Impl); + ADD_TEST(OS_SymbolLookup_Impl); ADD_TEST(OS_ModuleSymbolLookup_Impl); ADD_TEST(OS_SymbolTableDump_Impl); } diff --git a/src/unit-tests/osloader-test/ut_osloader_symtable_test.c b/src/unit-tests/osloader-test/ut_osloader_symtable_test.c index d96d9fe1a..5cbe943f1 100644 --- a/src/unit-tests/osloader-test/ut_osloader_symtable_test.c +++ b/src/unit-tests/osloader-test/ut_osloader_symtable_test.c @@ -96,7 +96,7 @@ void UT_os_symbol_lookup_test() UT_RETVAL(OS_SymbolLookup(&symbol_addr, 0), OS_INVALID_POINTER); /*-----------------------------------------------------*/ - /* Setup for remainder of tests */ + /* Setup for global symbol test */ if (UT_SETUP(OS_ModuleLoad(&module_id, "Mod1", UT_OS_GENERIC_MODULE_NAME2, OS_MODULE_FLAG_GLOBAL_SYMBOLS))) { /*-----------------------------------------------------*/ @@ -112,6 +112,19 @@ void UT_os_symbol_lookup_test() /* Reset test environment */ UT_TEARDOWN(OS_ModuleUnload(module_id)); } + + /*-----------------------------------------------------*/ + /* Setup for local symbol test */ + if (UT_SETUP(OS_ModuleLoad(&module_id, "Mod1", UT_OS_GENERIC_MODULE_NAME2, OS_MODULE_FLAG_LOCAL_SYMBOLS))) + { + /*-----------------------------------------------------*/ + /* #5 Nominal, Local Symbols */ + + UT_NOMINAL(OS_SymbolLookup(&symbol_addr, "module1")); + + /* Reset test environment */ + UT_TEARDOWN(OS_ModuleUnload(module_id)); + } } /*--------------------------------------------------------------------------------* From bd4c65022e76280d380fde46aa82c5e4fe5fc09f Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Wed, 19 Aug 2020 10:39:37 -0400 Subject: [PATCH 029/178] Fix #1208, typesafe definition of osal_id_t Modifies the osal_id_t typedef to be a non-integer value. The intent is to catch cases where it inappropriately being used as an integer value. This is transparent so long as the osal_id_t typedef and provided check and conversion routines are used. --- src/os/inc/common_types.h | 16 +++++++++++++++- src/os/inc/osapi-idmap.h | 12 ++++++++++-- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/src/os/inc/common_types.h b/src/os/inc/common_types.h index 277c85ec9..b9749e9ad 100644 --- a/src/os/inc/common_types.h +++ b/src/os/inc/common_types.h @@ -91,10 +91,24 @@ extern "C" typedef size_t cpusize; typedef ptrdiff_t cpudiff; +#ifdef OSAL_OMIT_DEPRECATED /** * A type to be used for OSAL resource identifiers. + * This is a type-safe ID, and cannot be implicitly converted to an integer. + * Use the provided inline functions in osapi-idmap.h to interpret ID values. */ - typedef uint32_t osal_id_t; + typedef struct + { + uint32_t v; + } osal_id_t; +#else + +/** + * A type to be used for OSAL resource identifiers. + * This typedef is backward compatible with the IDs from older versions of OSAL + */ +typedef uint32 osal_id_t; +#endif /** * A type used to represent a number of blocks or buffers diff --git a/src/os/inc/osapi-idmap.h b/src/os/inc/osapi-idmap.h index 93048c4b9..bf9ef7619 100644 --- a/src/os/inc/osapi-idmap.h +++ b/src/os/inc/osapi-idmap.h @@ -80,7 +80,11 @@ */ static inline unsigned long OS_ObjectIdToInteger(osal_id_t object_id) { +#ifdef OSAL_OMIT_DEPRECATED + return object_id.v; +#else return object_id; +#endif } /*-------------------------------------------------------------------------------------*/ @@ -98,7 +102,11 @@ static inline unsigned long OS_ObjectIdToInteger(osal_id_t object_id) */ static inline osal_id_t OS_ObjectIdFromInteger(unsigned long value) { +#ifdef OSAL_OMIT_DEPRECATED + return (osal_id_t) {value}; +#else return (osal_id_t)value; +#endif } /*-------------------------------------------------------------------------------------*/ @@ -119,7 +127,7 @@ static inline osal_id_t OS_ObjectIdFromInteger(unsigned long value) */ static inline bool OS_ObjectIdEqual(osal_id_t object_id1, osal_id_t object_id2) { - return (object_id1 == object_id2); + return (OS_ObjectIdToInteger(object_id1) == OS_ObjectIdToInteger(object_id2)); } /*-------------------------------------------------------------------------------------*/ @@ -140,7 +148,7 @@ static inline bool OS_ObjectIdEqual(osal_id_t object_id1, osal_id_t object_id2) */ static inline bool OS_ObjectIdDefined(osal_id_t object_id) { - return (object_id != 0); + return (OS_ObjectIdToInteger(object_id) != 0); } /*-------------------------------------------------------------------------------------*/ From 45ab4e140953e56f77a460aee7d1ec7a20433e81 Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Tue, 18 Jan 2022 15:34:58 -0700 Subject: [PATCH 030/178] Fix #1210, Set output in OS_stat handler --- src/ut-stubs/osapi-file-handlers.c | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/ut-stubs/osapi-file-handlers.c b/src/ut-stubs/osapi-file-handlers.c index ac200dbcf..b62428f65 100644 --- a/src/ut-stubs/osapi-file-handlers.c +++ b/src/ut-stubs/osapi-file-handlers.c @@ -192,13 +192,20 @@ void UT_DefaultHandler_OS_TimedWrite(void *UserObj, UT_EntryKey_t FuncKey, const void UT_DefaultHandler_OS_stat(void *UserObj, UT_EntryKey_t FuncKey, const UT_StubContext_t *Context) { os_fstat_t *filestats = UT_Hook_GetArgValueByName(Context, "filestats", os_fstat_t *); + size_t CopySize; int32 Status; UT_Stub_GetInt32StatusCode(Context, &Status); if (Status == OS_SUCCESS) { - UT_Stub_CopyToLocal(UT_KEY(OS_stat), filestats, sizeof(*filestats)); + CopySize = UT_Stub_CopyToLocal(UT_KEY(OS_stat), filestats, sizeof(*filestats)); + + /* Ensure memory is set if not provided by test */ + if (CopySize < sizeof(*filestats)) + { + memset(filestats, 0, sizeof(*filestats)); + } } } From 6375bbf608c21bc1153afbe2cb6238ccceb2de2b Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Fri, 21 Jan 2022 14:41:43 -0500 Subject: [PATCH 031/178] Bump to v6.0.0-rc4+dev29 --- README.md | 9 +++++++++ src/os/inc/osapi-version.h | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cbbb80a25..b8fd9d657 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,15 @@ The autogenerated OSAL user's guide can be viewed at and ### Development Build: v6.0.0-rc4+dev15 - Add Duplicate Check to Local Unit Test diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index 6e4ce779a..8b9fd2e14 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -36,7 +36,7 @@ /* * Development Build Macro Definitions */ -#define OS_BUILD_NUMBER 15 +#define OS_BUILD_NUMBER 29 #define OS_BUILD_BASELINE "v6.0.0-rc4" /* From b0958583748eedd776622f0a873c769b7c554d48 Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Thu, 3 Feb 2022 15:47:09 -0500 Subject: [PATCH 032/178] Bump to v6.0.0-rc4+dev32 --- README.md | 5 +++++ src/os/inc/osapi-version.h | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b8fd9d657..730d25e0c 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,11 @@ The autogenerated OSAL user's guide can be viewed at and + ### Development Build: v6.0.0-rc4+dev29 - Search global and local symbol tables diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index 8b9fd2e14..9aaf2915f 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -36,7 +36,7 @@ /* * Development Build Macro Definitions */ -#define OS_BUILD_NUMBER 29 +#define OS_BUILD_NUMBER 32 #define OS_BUILD_BASELINE "v6.0.0-rc4" /* From 49ca8bec9b49b9f12ecadc60c6e9e69599cb52ca Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Thu, 10 Feb 2022 16:09:34 -0700 Subject: [PATCH 033/178] Fix #1214, Resolve UT uninitialized variable warnings --- .../ut-stubs/CMakeLists.txt | 1 + .../src/os-shared-sockets-impl-handlers.c | 53 +++++++++++++++++++ .../src/os-shared-sockets-impl-stubs.c | 4 +- 3 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-handlers.c diff --git a/src/unit-test-coverage/ut-stubs/CMakeLists.txt b/src/unit-test-coverage/ut-stubs/CMakeLists.txt index 8cadb7f1d..4593df9eb 100644 --- a/src/unit-test-coverage/ut-stubs/CMakeLists.txt +++ b/src/unit-test-coverage/ut-stubs/CMakeLists.txt @@ -172,6 +172,7 @@ add_library(ut_osapi_impl_stubs STATIC EXCLUDE_FROM_ALL src/os-shared-queue-impl-stubs.c src/os-shared-select-impl-stubs.c src/os-shared-shell-impl-stubs.c + src/os-shared-sockets-impl-handlers.c src/os-shared-sockets-impl-stubs.c src/os-shared-task-impl-stubs.c src/os-shared-timebase-impl-stubs.c diff --git a/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-handlers.c b/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-handlers.c new file mode 100644 index 000000000..186d334aa --- /dev/null +++ b/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-handlers.c @@ -0,0 +1,53 @@ +/* + * NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer" + * + * Copyright (c) 2019 United States Government as represented by + * the Administrator of the National Aeronautics and Space Administration. + * All Rights Reserved. + * + * Licensed 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. + */ + +/** + * \file + * + * Stub implementations for the functions defined in the OSAL API + * + * The stub implementation can be used for unit testing applications built + * on top of OSAL. The stubs do not do any real function, but allow + * the return code to be crafted such that error paths in the application + * can be executed. + */ + +#include "osapi-sockets.h" /* OSAL public API for this subsystem */ +#include "os-shared-sockets.h" +#include "utstubs.h" + +/* + * ----------------------------------------------------------------- + * Default handler implementation + * ----------------------------------------------------------------- + */ +void UT_DefaultHandler_OS_SocketAddrGetPort_Impl(void *UserObj, UT_EntryKey_t FuncKey, const UT_StubContext_t *Context) +{ + uint16 *PortNum = UT_Hook_GetArgValueByName(Context, "PortNum", uint16 *); + int32 status; + + UT_Stub_GetInt32StatusCode(Context, &status); + + if (status == OS_SUCCESS && + UT_Stub_CopyToLocal(UT_KEY(OS_SocketAddrGetPort_Impl), PortNum, sizeof(*PortNum)) < sizeof(*PortNum)) + { + *PortNum = 0; + } +} diff --git a/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-stubs.c b/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-stubs.c index 6ffd258f0..990932a0d 100644 --- a/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/os-shared-sockets-impl-stubs.c @@ -27,6 +27,8 @@ #include "os-shared-sockets.h" #include "utgenstub.h" +void UT_DefaultHandler_OS_SocketAddrGetPort_Impl(void *, UT_EntryKey_t, const UT_StubContext_t *); + /* * ---------------------------------------------------- * Generated stub function for OS_SetSocketDefaultFlags_Impl() @@ -88,7 +90,7 @@ int32 OS_SocketAddrGetPort_Impl(uint16 *PortNum, const OS_SockAddr_t *Addr) UT_GenStub_AddParam(OS_SocketAddrGetPort_Impl, uint16 *, PortNum); UT_GenStub_AddParam(OS_SocketAddrGetPort_Impl, const OS_SockAddr_t *, Addr); - UT_GenStub_Execute(OS_SocketAddrGetPort_Impl, Basic, NULL); + UT_GenStub_Execute(OS_SocketAddrGetPort_Impl, Basic, UT_DefaultHandler_OS_SocketAddrGetPort_Impl); return UT_GenStub_GetReturnValue(OS_SocketAddrGetPort_Impl, int32); } From 99d6f487704e1dccc593762d510e403fa5bc70ea Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Thu, 17 Feb 2022 14:14:52 -0700 Subject: [PATCH 034/178] Fix #1216, Remove explicit filename doxygen comments --- src/bsp/shared/src/osapi-bsp.c | 2 +- src/os/portable/os-impl-bsd-select.c | 2 +- src/os/portable/os-impl-bsd-sockets.c | 2 +- src/os/portable/os-impl-console-bsp.c | 2 +- src/os/portable/os-impl-no-loader.c | 2 +- src/os/portable/os-impl-no-network.c | 2 +- src/os/portable/os-impl-no-shell.c | 2 +- src/os/portable/os-impl-no-sockets.c | 2 +- src/os/portable/os-impl-no-symtab.c | 2 +- src/os/portable/os-impl-posix-dirs.c | 2 +- src/os/portable/os-impl-posix-dl-loader.c | 2 +- src/os/portable/os-impl-posix-dl-symtab.c | 2 +- src/os/portable/os-impl-posix-files.c | 2 +- src/os/portable/os-impl-posix-gettime.c | 2 +- src/os/portable/os-impl-posix-io.c | 2 +- src/os/portable/os-impl-posix-network.c | 2 +- src/os/posix/src/os-impl-binsem.c | 2 +- src/os/posix/src/os-impl-common.c | 2 +- src/os/posix/src/os-impl-console.c | 2 +- src/os/posix/src/os-impl-countsem.c | 2 +- src/os/posix/src/os-impl-dirs.c | 2 +- src/os/posix/src/os-impl-errors.c | 2 +- src/os/posix/src/os-impl-files.c | 2 +- src/os/posix/src/os-impl-filesys.c | 2 +- src/os/posix/src/os-impl-heap.c | 2 +- src/os/posix/src/os-impl-idmap.c | 2 +- src/os/posix/src/os-impl-loader.c | 2 +- src/os/posix/src/os-impl-mutex.c | 2 +- src/os/posix/src/os-impl-no-module.c | 2 +- src/os/posix/src/os-impl-queues.c | 2 +- src/os/posix/src/os-impl-shell.c | 2 +- src/os/posix/src/os-impl-tasks.c | 2 +- src/os/posix/src/os-impl-timebase.c | 2 +- src/os/rtems/src/os-impl-binsem.c | 2 +- src/os/rtems/src/os-impl-common.c | 2 +- src/os/rtems/src/os-impl-console.c | 2 +- src/os/rtems/src/os-impl-countsem.c | 2 +- src/os/rtems/src/os-impl-dirs.c | 2 +- src/os/rtems/src/os-impl-errors.c | 2 +- src/os/rtems/src/os-impl-files.c | 2 +- src/os/rtems/src/os-impl-filesys.c | 2 +- src/os/rtems/src/os-impl-heap.c | 2 +- src/os/rtems/src/os-impl-idmap.c | 2 +- src/os/rtems/src/os-impl-loader.c | 2 +- src/os/rtems/src/os-impl-mutex.c | 2 +- src/os/rtems/src/os-impl-network.c | 2 +- src/os/rtems/src/os-impl-no-module.c | 2 +- src/os/rtems/src/os-impl-queues.c | 2 +- src/os/rtems/src/os-impl-tasks.c | 2 +- src/os/rtems/src/os-impl-timebase.c | 2 +- src/os/shared/src/osapi-binsem.c | 2 +- src/os/shared/src/osapi-clock.c | 2 +- src/os/shared/src/osapi-common.c | 2 +- src/os/shared/src/osapi-countsem.c | 2 +- src/os/shared/src/osapi-debug.c | 2 +- src/os/shared/src/osapi-dir.c | 2 +- src/os/shared/src/osapi-errors.c | 2 +- src/os/shared/src/osapi-file.c | 2 +- src/os/shared/src/osapi-filesys.c | 2 +- src/os/shared/src/osapi-heap.c | 2 +- src/os/shared/src/osapi-idmap.c | 2 +- src/os/shared/src/osapi-module.c | 2 +- src/os/shared/src/osapi-mutex.c | 2 +- src/os/shared/src/osapi-network.c | 2 +- src/os/shared/src/osapi-printf.c | 2 +- src/os/shared/src/osapi-queue.c | 2 +- src/os/shared/src/osapi-select.c | 2 +- src/os/shared/src/osapi-shell.c | 2 +- src/os/shared/src/osapi-sockets.c | 2 +- src/os/shared/src/osapi-task.c | 2 +- src/os/shared/src/osapi-time.c | 2 +- src/os/shared/src/osapi-timebase.c | 2 +- src/os/shared/src/osapi-version.c | 2 +- src/os/vxworks/src/os-impl-binsem.c | 2 +- src/os/vxworks/src/os-impl-common.c | 2 +- src/os/vxworks/src/os-impl-console.c | 2 +- src/os/vxworks/src/os-impl-countsem.c | 2 +- src/os/vxworks/src/os-impl-dirs-globals.c | 2 +- src/os/vxworks/src/os-impl-errors.c | 2 +- src/os/vxworks/src/os-impl-files.c | 2 +- src/os/vxworks/src/os-impl-filesys.c | 2 +- src/os/vxworks/src/os-impl-heap.c | 2 +- src/os/vxworks/src/os-impl-idmap.c | 2 +- src/os/vxworks/src/os-impl-loader.c | 2 +- src/os/vxworks/src/os-impl-mutex.c | 2 +- src/os/vxworks/src/os-impl-network.c | 2 +- src/os/vxworks/src/os-impl-no-module.c | 2 +- src/os/vxworks/src/os-impl-queues.c | 2 +- src/os/vxworks/src/os-impl-shell.c | 2 +- src/os/vxworks/src/os-impl-sockets.c | 2 +- src/os/vxworks/src/os-impl-symtab.c | 2 +- src/os/vxworks/src/os-impl-tasks.c | 2 +- src/os/vxworks/src/os-impl-timebase.c | 2 +- .../portable/adaptors/src/ut-adaptor-portable-posix-files.c | 2 +- .../portable/adaptors/src/ut-adaptor-portable-posix-io.c | 2 +- src/unit-test-coverage/portable/src/coveragetest-bsd-select.c | 2 +- src/unit-test-coverage/portable/src/coveragetest-console-bsp.c | 2 +- src/unit-test-coverage/portable/src/coveragetest-no-loader.c | 2 +- src/unit-test-coverage/portable/src/coveragetest-no-shell.c | 2 +- src/unit-test-coverage/portable/src/coveragetest-posix-dirs.c | 2 +- src/unit-test-coverage/portable/src/coveragetest-posix-files.c | 2 +- .../portable/src/coveragetest-posix-gettime.c | 2 +- src/unit-test-coverage/portable/src/coveragetest-posix-io.c | 2 +- src/unit-test-coverage/shared/adaptors/src/ut-adaptor-module.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-binsem.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-clock.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-common.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-countsem.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-dir.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-errors.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-file.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-filesys.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-heap.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-idmap.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-module.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-mutex.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-network.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-printf.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-queue.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-select.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-shell.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-sockets.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-task.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-time.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-timebase.c | 2 +- src/unit-test-coverage/shared/src/coveragetest-version.c | 2 +- src/unit-test-coverage/shared/src/os-shared-coverage-support.c | 2 +- src/unit-test-coverage/ut-stubs/src/bsp-console-impl-stubs.c | 2 +- .../ut-stubs/src/os-shared-file-impl-handlers.c | 2 +- .../ut-stubs/src/os-shared-filesys-impl-handlers.c | 2 +- src/unit-test-coverage/ut-stubs/src/os-shared-idmap-handlers.c | 2 +- .../ut-stubs/src/os-shared-network-impl-handlers.c | 2 +- .../ut-stubs/src/osapi-shared-binsem-table-stubs.c | 2 +- src/unit-test-coverage/ut-stubs/src/osapi-shared-common-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-console-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-countsem-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-dir-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-error-impl-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-filesys-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-idmap-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-module-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-mutex-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-queue-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-stream-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-task-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-timebase-table-stubs.c | 2 +- .../ut-stubs/src/osapi-shared-timecb-table-stubs.c | 2 +- src/unit-test-coverage/ut-stubs/src/sys-select-stubs.c | 2 +- src/unit-test-coverage/ut-stubs/src/vxworks-hostLib-stubs.c | 2 +- src/unit-test-coverage/ut-stubs/src/vxworks-symLib-stubs.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-binsem.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-common.c | 2 +- .../vxworks/adaptors/src/ut-adaptor-console.c | 2 +- .../vxworks/adaptors/src/ut-adaptor-countsem.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirs.c | 2 +- .../vxworks/adaptors/src/ut-adaptor-dirtable-stub.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-files.c | 2 +- .../vxworks/adaptors/src/ut-adaptor-filesys.c | 2 +- .../vxworks/adaptors/src/ut-adaptor-filetable-stub.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-idmap.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-loader.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-mutex.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-queues.c | 2 +- .../vxworks/adaptors/src/ut-adaptor-sockets.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-symtab.c | 2 +- src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-tasks.c | 2 +- .../vxworks/adaptors/src/ut-adaptor-timebase.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-binsem.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-common.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-console.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-countsem.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-dirs-globals.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-files.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-filesys.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-heap.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-idmap.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-loader.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-mutex.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-network.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-no-module.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-queues.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-shell.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-sockets.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-symtab.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-tasks.c | 2 +- src/unit-test-coverage/vxworks/src/coveragetest-timebase.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-binsem-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-common-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-countsem-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-dir-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-file-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-idmap-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-module-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-mutex-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-queue-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-task-stubs.c | 2 +- .../vxworks/ut-stubs/src/vxworks-os-impl-timer-stubs.c | 2 +- src/ut-stubs/utstub-helpers.h | 2 +- ut_assert/src/utstubs.c | 2 +- 200 files changed, 200 insertions(+), 200 deletions(-) diff --git a/src/bsp/shared/src/osapi-bsp.c b/src/bsp/shared/src/osapi-bsp.c index 015b738c9..dac87a425 100644 --- a/src/bsp/shared/src/osapi-bsp.c +++ b/src/bsp/shared/src/osapi-bsp.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-bsp.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains some of the OS APIs abstraction layer code diff --git a/src/os/portable/os-impl-bsd-select.c b/src/os/portable/os-impl-bsd-select.c index b41832f24..3ad40d20b 100644 --- a/src/os/portable/os-impl-bsd-select.c +++ b/src/os/portable/os-impl-bsd-select.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-bsd-select.c + * \file * \author joseph.p.hickey@nasa.gov * * Purpose: This file contains wrappers around the select() system call diff --git a/src/os/portable/os-impl-bsd-sockets.c b/src/os/portable/os-impl-bsd-sockets.c index 1d8d8f4f5..53cac5237 100644 --- a/src/os/portable/os-impl-bsd-sockets.c +++ b/src/os/portable/os-impl-bsd-sockets.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-bsd-sockets.c + * \file * \author joseph.p.hickey@nasa.gov * * Purpose: This file contains the network functionality for diff --git a/src/os/portable/os-impl-console-bsp.c b/src/os/portable/os-impl-console-bsp.c index cf628950c..946a8c056 100644 --- a/src/os/portable/os-impl-console-bsp.c +++ b/src/os/portable/os-impl-console-bsp.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-console-bsp.c + * \file * \author joseph.p.hickey@nasa.gov * * Purpose: diff --git a/src/os/portable/os-impl-no-loader.c b/src/os/portable/os-impl-no-loader.c index b576bff62..59e0b8aeb 100644 --- a/src/os/portable/os-impl-no-loader.c +++ b/src/os/portable/os-impl-no-loader.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-no-loader.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains a module loader implementation for systems diff --git a/src/os/portable/os-impl-no-network.c b/src/os/portable/os-impl-no-network.c index b25a6faf9..434e9b8a8 100644 --- a/src/os/portable/os-impl-no-network.c +++ b/src/os/portable/os-impl-no-network.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-no-network.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains the network implementation for diff --git a/src/os/portable/os-impl-no-shell.c b/src/os/portable/os-impl-no-shell.c index 77ca23208..f551e9f22 100644 --- a/src/os/portable/os-impl-no-shell.c +++ b/src/os/portable/os-impl-no-shell.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-no-shell.c + * \file * * No shell implementation, returns OS_ERR_NOT_IMPLEMENTED for calls */ diff --git a/src/os/portable/os-impl-no-sockets.c b/src/os/portable/os-impl-no-sockets.c index 49143764e..f04caef3d 100644 --- a/src/os/portable/os-impl-no-sockets.c +++ b/src/os/portable/os-impl-no-sockets.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-no-sockets.c + * \file * \author joseph.p.hickey@nasa.gov * * Purpose: All functions return OS_ERR_NOT_IMPLEMENTED. diff --git a/src/os/portable/os-impl-no-symtab.c b/src/os/portable/os-impl-no-symtab.c index 5a36ecee9..97e6c3ca6 100644 --- a/src/os/portable/os-impl-no-symtab.c +++ b/src/os/portable/os-impl-no-symtab.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-no-symtab.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains a symbol table implementation for systems diff --git a/src/os/portable/os-impl-posix-dirs.c b/src/os/portable/os-impl-posix-dirs.c index 87467960d..ef57a7ca0 100644 --- a/src/os/portable/os-impl-posix-dirs.c +++ b/src/os/portable/os-impl-posix-dirs.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-posix-dirs.c + * \file * \author joseph.p.hickey@nasa.gov * * This file Contains all of the api calls for manipulating files diff --git a/src/os/portable/os-impl-posix-dl-loader.c b/src/os/portable/os-impl-posix-dl-loader.c index 3843d5050..d2c6aad52 100644 --- a/src/os/portable/os-impl-posix-dl-loader.c +++ b/src/os/portable/os-impl-posix-dl-loader.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-posix-dl-loader.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains a module loader implementation for systems diff --git a/src/os/portable/os-impl-posix-dl-symtab.c b/src/os/portable/os-impl-posix-dl-symtab.c index 81d578ad3..261932355 100644 --- a/src/os/portable/os-impl-posix-dl-symtab.c +++ b/src/os/portable/os-impl-posix-dl-symtab.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-posix-dl-symtab.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains a module loader implementation for systems diff --git a/src/os/portable/os-impl-posix-files.c b/src/os/portable/os-impl-posix-files.c index 52da3a36e..dc3db7724 100644 --- a/src/os/portable/os-impl-posix-files.c +++ b/src/os/portable/os-impl-posix-files.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-posix-files.c + * \file * \author joseph.p.hickey@nasa.gov * * This file Contains all of the api calls for manipulating files diff --git a/src/os/portable/os-impl-posix-gettime.c b/src/os/portable/os-impl-posix-gettime.c index 07fd7e3f9..3fe5eb310 100644 --- a/src/os/portable/os-impl-posix-gettime.c +++ b/src/os/portable/os-impl-posix-gettime.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-posix-gettime.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains implementation for OS_GetLocalTime() and OS_SetLocalTime() diff --git a/src/os/portable/os-impl-posix-io.c b/src/os/portable/os-impl-posix-io.c index f6b2e3107..bc12baf00 100644 --- a/src/os/portable/os-impl-posix-io.c +++ b/src/os/portable/os-impl-posix-io.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-posix-io.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains generic calls for manipulating filehandles diff --git a/src/os/portable/os-impl-posix-network.c b/src/os/portable/os-impl-posix-network.c index f6d5f540a..9f74b5607 100644 --- a/src/os/portable/os-impl-posix-network.c +++ b/src/os/portable/os-impl-posix-network.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-posix-network.c + * \file * \author joseph.p.hickey@nasa.gov * * This file contains the network functionality for diff --git a/src/os/posix/src/os-impl-binsem.c b/src/os/posix/src/os-impl-binsem.c index c794407ce..7c7c19bf4 100644 --- a/src/os/posix/src/os-impl-binsem.c +++ b/src/os/posix/src/os-impl-binsem.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-binsem.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-common.c b/src/os/posix/src/os-impl-common.c index 8fbd44ea4..6f54e8510 100644 --- a/src/os/posix/src/os-impl-common.c +++ b/src/os/posix/src/os-impl-common.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-common.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-console.c b/src/os/posix/src/os-impl-console.c index b6770fa25..3716acb66 100644 --- a/src/os/posix/src/os-impl-console.c +++ b/src/os/posix/src/os-impl-console.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-console.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-countsem.c b/src/os/posix/src/os-impl-countsem.c index ea79b88e3..d7374c424 100644 --- a/src/os/posix/src/os-impl-countsem.c +++ b/src/os/posix/src/os-impl-countsem.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-countsem.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-dirs.c b/src/os/posix/src/os-impl-dirs.c index 0e5b9b644..0dbc72138 100644 --- a/src/os/posix/src/os-impl-dirs.c +++ b/src/os/posix/src/os-impl-dirs.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-dirs.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-errors.c b/src/os/posix/src/os-impl-errors.c index 4b32d8207..a34a9783e 100644 --- a/src/os/posix/src/os-impl-errors.c +++ b/src/os/posix/src/os-impl-errors.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-errors.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-files.c b/src/os/posix/src/os-impl-files.c index c828947b0..7fae2a057 100644 --- a/src/os/posix/src/os-impl-files.c +++ b/src/os/posix/src/os-impl-files.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-files.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-filesys.c b/src/os/posix/src/os-impl-filesys.c index 4213b39ad..d80d77f4b 100644 --- a/src/os/posix/src/os-impl-filesys.c +++ b/src/os/posix/src/os-impl-filesys.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-filesys.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-heap.c b/src/os/posix/src/os-impl-heap.c index db330bc1a..8587a0be7 100644 --- a/src/os/posix/src/os-impl-heap.c +++ b/src/os/posix/src/os-impl-heap.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-heap.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-idmap.c b/src/os/posix/src/os-impl-idmap.c index 60c7ce0c2..7cc7dfc3e 100644 --- a/src/os/posix/src/os-impl-idmap.c +++ b/src/os/posix/src/os-impl-idmap.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-idmap.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-loader.c b/src/os/posix/src/os-impl-loader.c index 8e8f7f606..40d3333c1 100644 --- a/src/os/posix/src/os-impl-loader.c +++ b/src/os/posix/src/os-impl-loader.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-loader.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-mutex.c b/src/os/posix/src/os-impl-mutex.c index 5a0e43593..a4914f077 100644 --- a/src/os/posix/src/os-impl-mutex.c +++ b/src/os/posix/src/os-impl-mutex.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-mutex.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-no-module.c b/src/os/posix/src/os-impl-no-module.c index c7c2c0ffb..8ed70970c 100644 --- a/src/os/posix/src/os-impl-no-module.c +++ b/src/os/posix/src/os-impl-no-module.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-no-module.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-queues.c b/src/os/posix/src/os-impl-queues.c index 87ce7e935..55a004b58 100644 --- a/src/os/posix/src/os-impl-queues.c +++ b/src/os/posix/src/os-impl-queues.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-queues.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-shell.c b/src/os/posix/src/os-impl-shell.c index 4b5d7cf23..265396a04 100644 --- a/src/os/posix/src/os-impl-shell.c +++ b/src/os/posix/src/os-impl-shell.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-shell.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-tasks.c b/src/os/posix/src/os-impl-tasks.c index e45beefa9..235b7d758 100644 --- a/src/os/posix/src/os-impl-tasks.c +++ b/src/os/posix/src/os-impl-tasks.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-tasks.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/posix/src/os-impl-timebase.c b/src/os/posix/src/os-impl-timebase.c index fd30f78fa..d23be616a 100644 --- a/src/os/posix/src/os-impl-timebase.c +++ b/src/os/posix/src/os-impl-timebase.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-timebase.c + * \file * \ingroup posix * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-binsem.c b/src/os/rtems/src/os-impl-binsem.c index 8d15204fa..a4067a63c 100644 --- a/src/os/rtems/src/os-impl-binsem.c +++ b/src/os/rtems/src/os-impl-binsem.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-binsem.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-common.c b/src/os/rtems/src/os-impl-common.c index 5e32e286b..6b81b65b9 100644 --- a/src/os/rtems/src/os-impl-common.c +++ b/src/os/rtems/src/os-impl-common.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-common.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-console.c b/src/os/rtems/src/os-impl-console.c index 02458693a..895a69010 100644 --- a/src/os/rtems/src/os-impl-console.c +++ b/src/os/rtems/src/os-impl-console.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-console.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-countsem.c b/src/os/rtems/src/os-impl-countsem.c index 33b1719b6..9512d330a 100644 --- a/src/os/rtems/src/os-impl-countsem.c +++ b/src/os/rtems/src/os-impl-countsem.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-countsem.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-dirs.c b/src/os/rtems/src/os-impl-dirs.c index e5ede708b..16c027d7e 100644 --- a/src/os/rtems/src/os-impl-dirs.c +++ b/src/os/rtems/src/os-impl-dirs.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-dirs.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-errors.c b/src/os/rtems/src/os-impl-errors.c index c0f59f2c8..3ef729a62 100644 --- a/src/os/rtems/src/os-impl-errors.c +++ b/src/os/rtems/src/os-impl-errors.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-errors.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-files.c b/src/os/rtems/src/os-impl-files.c index 48e76807d..0f6f0b751 100644 --- a/src/os/rtems/src/os-impl-files.c +++ b/src/os/rtems/src/os-impl-files.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-files.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-filesys.c b/src/os/rtems/src/os-impl-filesys.c index 4bdea8453..4fd8d7f25 100644 --- a/src/os/rtems/src/os-impl-filesys.c +++ b/src/os/rtems/src/os-impl-filesys.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-filesys.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-heap.c b/src/os/rtems/src/os-impl-heap.c index 4e67125cb..64769eec9 100644 --- a/src/os/rtems/src/os-impl-heap.c +++ b/src/os/rtems/src/os-impl-heap.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-heap.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-idmap.c b/src/os/rtems/src/os-impl-idmap.c index cdce72602..8e1e77773 100644 --- a/src/os/rtems/src/os-impl-idmap.c +++ b/src/os/rtems/src/os-impl-idmap.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-idmap.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-loader.c b/src/os/rtems/src/os-impl-loader.c index 3c36c672e..1082fdb8d 100644 --- a/src/os/rtems/src/os-impl-loader.c +++ b/src/os/rtems/src/os-impl-loader.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-loader.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-mutex.c b/src/os/rtems/src/os-impl-mutex.c index 48874bdcc..db36169c1 100644 --- a/src/os/rtems/src/os-impl-mutex.c +++ b/src/os/rtems/src/os-impl-mutex.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-mutex.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-network.c b/src/os/rtems/src/os-impl-network.c index 19c92e485..3f04e6a82 100644 --- a/src/os/rtems/src/os-impl-network.c +++ b/src/os/rtems/src/os-impl-network.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-network.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-no-module.c b/src/os/rtems/src/os-impl-no-module.c index c70a0e8be..6b13b2c4a 100644 --- a/src/os/rtems/src/os-impl-no-module.c +++ b/src/os/rtems/src/os-impl-no-module.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-no-module.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-queues.c b/src/os/rtems/src/os-impl-queues.c index 2e8ec2188..066e5864a 100644 --- a/src/os/rtems/src/os-impl-queues.c +++ b/src/os/rtems/src/os-impl-queues.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-queues.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-tasks.c b/src/os/rtems/src/os-impl-tasks.c index 99407107c..e4e952715 100644 --- a/src/os/rtems/src/os-impl-tasks.c +++ b/src/os/rtems/src/os-impl-tasks.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-tasks.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/rtems/src/os-impl-timebase.c b/src/os/rtems/src/os-impl-timebase.c index b85151630..7db55ef49 100644 --- a/src/os/rtems/src/os-impl-timebase.c +++ b/src/os/rtems/src/os-impl-timebase.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-timebase.c + * \file * \ingroup rtems * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-binsem.c b/src/os/shared/src/osapi-binsem.c index c068f529c..1bd44580b 100644 --- a/src/os/shared/src/osapi-binsem.c +++ b/src/os/shared/src/osapi-binsem.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-binsem.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-clock.c b/src/os/shared/src/osapi-clock.c index d5a844376..26f1c4e7c 100644 --- a/src/os/shared/src/osapi-clock.c +++ b/src/os/shared/src/osapi-clock.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-clock.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-common.c b/src/os/shared/src/osapi-common.c index d466f4d03..606bc5657 100644 --- a/src/os/shared/src/osapi-common.c +++ b/src/os/shared/src/osapi-common.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-common.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-countsem.c b/src/os/shared/src/osapi-countsem.c index c8208ae6d..deeaad1b3 100644 --- a/src/os/shared/src/osapi-countsem.c +++ b/src/os/shared/src/osapi-countsem.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-countsem.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-debug.c b/src/os/shared/src/osapi-debug.c index f67fe48dc..bce7c9cf9 100644 --- a/src/os/shared/src/osapi-debug.c +++ b/src/os/shared/src/osapi-debug.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-debug.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-dir.c b/src/os/shared/src/osapi-dir.c index 90eab3223..ce1991b71 100644 --- a/src/os/shared/src/osapi-dir.c +++ b/src/os/shared/src/osapi-dir.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-dir.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-errors.c b/src/os/shared/src/osapi-errors.c index d60d1b011..33d7b7dbc 100644 --- a/src/os/shared/src/osapi-errors.c +++ b/src/os/shared/src/osapi-errors.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-errors.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-file.c b/src/os/shared/src/osapi-file.c index c2d3191b6..85ec2ae06 100644 --- a/src/os/shared/src/osapi-file.c +++ b/src/os/shared/src/osapi-file.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-file.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-filesys.c b/src/os/shared/src/osapi-filesys.c index f2a77f264..439fe11fc 100644 --- a/src/os/shared/src/osapi-filesys.c +++ b/src/os/shared/src/osapi-filesys.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-filesys.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-heap.c b/src/os/shared/src/osapi-heap.c index 888d0d7ec..703368f71 100644 --- a/src/os/shared/src/osapi-heap.c +++ b/src/os/shared/src/osapi-heap.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-heap.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-idmap.c b/src/os/shared/src/osapi-idmap.c index 725cbbdf0..da81c7d3e 100644 --- a/src/os/shared/src/osapi-idmap.c +++ b/src/os/shared/src/osapi-idmap.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-idmap.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-module.c b/src/os/shared/src/osapi-module.c index 236006c24..c80f43272 100644 --- a/src/os/shared/src/osapi-module.c +++ b/src/os/shared/src/osapi-module.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-module.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-mutex.c b/src/os/shared/src/osapi-mutex.c index 70c651db0..5658df7fa 100644 --- a/src/os/shared/src/osapi-mutex.c +++ b/src/os/shared/src/osapi-mutex.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-mutex.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-network.c b/src/os/shared/src/osapi-network.c index 70367fa16..0af03c651 100644 --- a/src/os/shared/src/osapi-network.c +++ b/src/os/shared/src/osapi-network.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-network.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-printf.c b/src/os/shared/src/osapi-printf.c index fe3dfe427..c60bdb052 100644 --- a/src/os/shared/src/osapi-printf.c +++ b/src/os/shared/src/osapi-printf.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-printf.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-queue.c b/src/os/shared/src/osapi-queue.c index c3a351934..45fe457e7 100644 --- a/src/os/shared/src/osapi-queue.c +++ b/src/os/shared/src/osapi-queue.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-queue.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-select.c b/src/os/shared/src/osapi-select.c index e03b7050f..8a7d8925f 100644 --- a/src/os/shared/src/osapi-select.c +++ b/src/os/shared/src/osapi-select.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-select.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-shell.c b/src/os/shared/src/osapi-shell.c index 0443259c1..f3ad83210 100644 --- a/src/os/shared/src/osapi-shell.c +++ b/src/os/shared/src/osapi-shell.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shell.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-sockets.c b/src/os/shared/src/osapi-sockets.c index 5619f120f..0b942be5f 100644 --- a/src/os/shared/src/osapi-sockets.c +++ b/src/os/shared/src/osapi-sockets.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-sockets.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-task.c b/src/os/shared/src/osapi-task.c index abeb839c4..c0c4fa25e 100644 --- a/src/os/shared/src/osapi-task.c +++ b/src/os/shared/src/osapi-task.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-task.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-time.c b/src/os/shared/src/osapi-time.c index 89b624399..4c2dc6d6c 100644 --- a/src/os/shared/src/osapi-time.c +++ b/src/os/shared/src/osapi-time.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-time.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-timebase.c b/src/os/shared/src/osapi-timebase.c index f6ba02f49..ac92d33df 100644 --- a/src/os/shared/src/osapi-timebase.c +++ b/src/os/shared/src/osapi-timebase.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-timebase.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/shared/src/osapi-version.c b/src/os/shared/src/osapi-version.c index d20d3101a..0d064f960 100644 --- a/src/os/shared/src/osapi-version.c +++ b/src/os/shared/src/osapi-version.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-version.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-binsem.c b/src/os/vxworks/src/os-impl-binsem.c index 4c9a1acd4..8c1e5a14a 100644 --- a/src/os/vxworks/src/os-impl-binsem.c +++ b/src/os/vxworks/src/os-impl-binsem.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-binsem.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-common.c b/src/os/vxworks/src/os-impl-common.c index acf2a2896..2e50b22f6 100644 --- a/src/os/vxworks/src/os-impl-common.c +++ b/src/os/vxworks/src/os-impl-common.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-common.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-console.c b/src/os/vxworks/src/os-impl-console.c index 0b880e660..1ebf42e66 100644 --- a/src/os/vxworks/src/os-impl-console.c +++ b/src/os/vxworks/src/os-impl-console.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-console.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-countsem.c b/src/os/vxworks/src/os-impl-countsem.c index 3f4ef65e7..d4e23eb97 100644 --- a/src/os/vxworks/src/os-impl-countsem.c +++ b/src/os/vxworks/src/os-impl-countsem.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-countsem.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-dirs-globals.c b/src/os/vxworks/src/os-impl-dirs-globals.c index aa53a3585..2e9349983 100644 --- a/src/os/vxworks/src/os-impl-dirs-globals.c +++ b/src/os/vxworks/src/os-impl-dirs-globals.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-dirs.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-errors.c b/src/os/vxworks/src/os-impl-errors.c index e98cf9bf6..08d3db00d 100644 --- a/src/os/vxworks/src/os-impl-errors.c +++ b/src/os/vxworks/src/os-impl-errors.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-errors.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-files.c b/src/os/vxworks/src/os-impl-files.c index c839fe469..09f4a1eb0 100644 --- a/src/os/vxworks/src/os-impl-files.c +++ b/src/os/vxworks/src/os-impl-files.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-files.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-filesys.c b/src/os/vxworks/src/os-impl-filesys.c index 638279e0e..6cc9a854d 100644 --- a/src/os/vxworks/src/os-impl-filesys.c +++ b/src/os/vxworks/src/os-impl-filesys.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-filesys.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-heap.c b/src/os/vxworks/src/os-impl-heap.c index 8931130c0..a4723aff7 100644 --- a/src/os/vxworks/src/os-impl-heap.c +++ b/src/os/vxworks/src/os-impl-heap.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-heap.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-idmap.c b/src/os/vxworks/src/os-impl-idmap.c index a8da5bd2d..e60e4c186 100644 --- a/src/os/vxworks/src/os-impl-idmap.c +++ b/src/os/vxworks/src/os-impl-idmap.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-idmap.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-loader.c b/src/os/vxworks/src/os-impl-loader.c index 2e0ef53ce..0f40b87ea 100644 --- a/src/os/vxworks/src/os-impl-loader.c +++ b/src/os/vxworks/src/os-impl-loader.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-loader.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-mutex.c b/src/os/vxworks/src/os-impl-mutex.c index 4b0f64271..984b94cb6 100644 --- a/src/os/vxworks/src/os-impl-mutex.c +++ b/src/os/vxworks/src/os-impl-mutex.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-mutex.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-network.c b/src/os/vxworks/src/os-impl-network.c index adfc911b0..fe8279d0a 100644 --- a/src/os/vxworks/src/os-impl-network.c +++ b/src/os/vxworks/src/os-impl-network.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-network.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-no-module.c b/src/os/vxworks/src/os-impl-no-module.c index bc20f3ccd..c53634927 100644 --- a/src/os/vxworks/src/os-impl-no-module.c +++ b/src/os/vxworks/src/os-impl-no-module.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-no-module.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-queues.c b/src/os/vxworks/src/os-impl-queues.c index 99e8a3002..0c7cef77f 100644 --- a/src/os/vxworks/src/os-impl-queues.c +++ b/src/os/vxworks/src/os-impl-queues.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-queues.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-shell.c b/src/os/vxworks/src/os-impl-shell.c index 39430e87d..d6f830e33 100644 --- a/src/os/vxworks/src/os-impl-shell.c +++ b/src/os/vxworks/src/os-impl-shell.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-shell.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-sockets.c b/src/os/vxworks/src/os-impl-sockets.c index 5b51ecd02..8dfeea37b 100644 --- a/src/os/vxworks/src/os-impl-sockets.c +++ b/src/os/vxworks/src/os-impl-sockets.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-sockets.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-symtab.c b/src/os/vxworks/src/os-impl-symtab.c index 35ed770d9..d403aced8 100644 --- a/src/os/vxworks/src/os-impl-symtab.c +++ b/src/os/vxworks/src/os-impl-symtab.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-symtab.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-tasks.c b/src/os/vxworks/src/os-impl-tasks.c index 07dae3c5a..6685f53f1 100644 --- a/src/os/vxworks/src/os-impl-tasks.c +++ b/src/os/vxworks/src/os-impl-tasks.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-tasks.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/os/vxworks/src/os-impl-timebase.c b/src/os/vxworks/src/os-impl-timebase.c index a68494c6b..e9d617aeb 100644 --- a/src/os/vxworks/src/os-impl-timebase.c +++ b/src/os/vxworks/src/os-impl-timebase.c @@ -19,7 +19,7 @@ */ /** - * \file os-impl-timebase.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/portable/adaptors/src/ut-adaptor-portable-posix-files.c b/src/unit-test-coverage/portable/adaptors/src/ut-adaptor-portable-posix-files.c index 31456820a..8cd268a01 100644 --- a/src/unit-test-coverage/portable/adaptors/src/ut-adaptor-portable-posix-files.c +++ b/src/unit-test-coverage/portable/adaptors/src/ut-adaptor-portable-posix-files.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-portable-posix-files.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/portable/adaptors/src/ut-adaptor-portable-posix-io.c b/src/unit-test-coverage/portable/adaptors/src/ut-adaptor-portable-posix-io.c index 29bdb535d..8ea789d90 100644 --- a/src/unit-test-coverage/portable/adaptors/src/ut-adaptor-portable-posix-io.c +++ b/src/unit-test-coverage/portable/adaptors/src/ut-adaptor-portable-posix-io.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-portable-posix-io.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c b/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c index 6329f80b7..01d76cd1c 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c +++ b/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-bsd-select.c + * \file * \author joseph.p.hickey@nasa.gov * */ diff --git a/src/unit-test-coverage/portable/src/coveragetest-console-bsp.c b/src/unit-test-coverage/portable/src/coveragetest-console-bsp.c index 7c8e9aba2..7f140e785 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-console-bsp.c +++ b/src/unit-test-coverage/portable/src/coveragetest-console-bsp.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-console-bsp.c + * \file * \ingroup portable * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/portable/src/coveragetest-no-loader.c b/src/unit-test-coverage/portable/src/coveragetest-no-loader.c index 7d64ed5c1..1d8030b01 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-no-loader.c +++ b/src/unit-test-coverage/portable/src/coveragetest-no-loader.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-no-loader.c + * \file * \author joseph.p.hickey@nasa.gov * */ diff --git a/src/unit-test-coverage/portable/src/coveragetest-no-shell.c b/src/unit-test-coverage/portable/src/coveragetest-no-shell.c index 776612532..fea47b7cb 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-no-shell.c +++ b/src/unit-test-coverage/portable/src/coveragetest-no-shell.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-no-shell.c + * \file * \ingroup portable * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/portable/src/coveragetest-posix-dirs.c b/src/unit-test-coverage/portable/src/coveragetest-posix-dirs.c index afc7b0e5b..62867764c 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-posix-dirs.c +++ b/src/unit-test-coverage/portable/src/coveragetest-posix-dirs.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-posix-dirs.c + * \file * \author joseph.p.hickey@nasa.gov * */ diff --git a/src/unit-test-coverage/portable/src/coveragetest-posix-files.c b/src/unit-test-coverage/portable/src/coveragetest-posix-files.c index ec22b57f2..be758a590 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-posix-files.c +++ b/src/unit-test-coverage/portable/src/coveragetest-posix-files.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-posix-files.c + * \file * \author joseph.p.hickey@nasa.gov * */ diff --git a/src/unit-test-coverage/portable/src/coveragetest-posix-gettime.c b/src/unit-test-coverage/portable/src/coveragetest-posix-gettime.c index f59717757..c2f211644 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-posix-gettime.c +++ b/src/unit-test-coverage/portable/src/coveragetest-posix-gettime.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-posix-gettime.c + * \file * \author joseph.p.hickey@nasa.gov * */ diff --git a/src/unit-test-coverage/portable/src/coveragetest-posix-io.c b/src/unit-test-coverage/portable/src/coveragetest-posix-io.c index 0619d1534..7719b28c9 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-posix-io.c +++ b/src/unit-test-coverage/portable/src/coveragetest-posix-io.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-posix-io.c + * \file * \ingroup portable * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/adaptors/src/ut-adaptor-module.c b/src/unit-test-coverage/shared/adaptors/src/ut-adaptor-module.c index 1be553798..689722808 100644 --- a/src/unit-test-coverage/shared/adaptors/src/ut-adaptor-module.c +++ b/src/unit-test-coverage/shared/adaptors/src/ut-adaptor-module.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-module.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-binsem.c b/src/unit-test-coverage/shared/src/coveragetest-binsem.c index fba1a268a..1e01fa755 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-binsem.c +++ b/src/unit-test-coverage/shared/src/coveragetest-binsem.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-binsem.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-clock.c b/src/unit-test-coverage/shared/src/coveragetest-clock.c index 2490ddbdb..17cc811f1 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-clock.c +++ b/src/unit-test-coverage/shared/src/coveragetest-clock.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-clock.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-common.c b/src/unit-test-coverage/shared/src/coveragetest-common.c index b05699a00..e16338c50 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-common.c +++ b/src/unit-test-coverage/shared/src/coveragetest-common.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-common.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-countsem.c b/src/unit-test-coverage/shared/src/coveragetest-countsem.c index 04926af0f..1059f4822 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-countsem.c +++ b/src/unit-test-coverage/shared/src/coveragetest-countsem.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-countsem.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-dir.c b/src/unit-test-coverage/shared/src/coveragetest-dir.c index 2ab4b6f79..ac1c12a7b 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-dir.c +++ b/src/unit-test-coverage/shared/src/coveragetest-dir.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-dir.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-errors.c b/src/unit-test-coverage/shared/src/coveragetest-errors.c index d31252df4..94695a89e 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-errors.c +++ b/src/unit-test-coverage/shared/src/coveragetest-errors.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-errors.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-file.c b/src/unit-test-coverage/shared/src/coveragetest-file.c index 251324fed..962f3231a 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-file.c +++ b/src/unit-test-coverage/shared/src/coveragetest-file.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-file.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-filesys.c b/src/unit-test-coverage/shared/src/coveragetest-filesys.c index 55b6218a1..0f220ec1a 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-filesys.c +++ b/src/unit-test-coverage/shared/src/coveragetest-filesys.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-filesys.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-heap.c b/src/unit-test-coverage/shared/src/coveragetest-heap.c index 31cfe970d..527e3978c 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-heap.c +++ b/src/unit-test-coverage/shared/src/coveragetest-heap.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-heap.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-idmap.c b/src/unit-test-coverage/shared/src/coveragetest-idmap.c index c42b4c823..f10e4beb2 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-idmap.c +++ b/src/unit-test-coverage/shared/src/coveragetest-idmap.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-idmap.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-module.c b/src/unit-test-coverage/shared/src/coveragetest-module.c index 63644fc7e..a4b0a73e2 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-module.c +++ b/src/unit-test-coverage/shared/src/coveragetest-module.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-module.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-mutex.c b/src/unit-test-coverage/shared/src/coveragetest-mutex.c index d66265ee4..23e1ba9da 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-mutex.c +++ b/src/unit-test-coverage/shared/src/coveragetest-mutex.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-mutex.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-network.c b/src/unit-test-coverage/shared/src/coveragetest-network.c index 5d9b11a1f..1f361cc40 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-network.c +++ b/src/unit-test-coverage/shared/src/coveragetest-network.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-network.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-printf.c b/src/unit-test-coverage/shared/src/coveragetest-printf.c index 5278c91f4..195a2d508 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-printf.c +++ b/src/unit-test-coverage/shared/src/coveragetest-printf.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-printf.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-queue.c b/src/unit-test-coverage/shared/src/coveragetest-queue.c index 873d768a9..2b9b6623d 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-queue.c +++ b/src/unit-test-coverage/shared/src/coveragetest-queue.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-queue.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-select.c b/src/unit-test-coverage/shared/src/coveragetest-select.c index 0d8389aff..5eb2b3bfe 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-select.c +++ b/src/unit-test-coverage/shared/src/coveragetest-select.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-select.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-shell.c b/src/unit-test-coverage/shared/src/coveragetest-shell.c index ddd96ef0c..a5bbd63a4 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-shell.c +++ b/src/unit-test-coverage/shared/src/coveragetest-shell.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-shell.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-sockets.c b/src/unit-test-coverage/shared/src/coveragetest-sockets.c index 82f447067..92adc5efb 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-sockets.c +++ b/src/unit-test-coverage/shared/src/coveragetest-sockets.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-sockets.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-task.c b/src/unit-test-coverage/shared/src/coveragetest-task.c index 4668594df..8d712ea0a 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-task.c +++ b/src/unit-test-coverage/shared/src/coveragetest-task.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-task.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-time.c b/src/unit-test-coverage/shared/src/coveragetest-time.c index 00aa2d030..7e1613d3e 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-time.c +++ b/src/unit-test-coverage/shared/src/coveragetest-time.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-time.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-timebase.c b/src/unit-test-coverage/shared/src/coveragetest-timebase.c index 6563f8ed8..3580563aa 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-timebase.c +++ b/src/unit-test-coverage/shared/src/coveragetest-timebase.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-timebase.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/coveragetest-version.c b/src/unit-test-coverage/shared/src/coveragetest-version.c index 20d2688c9..de053fac2 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-version.c +++ b/src/unit-test-coverage/shared/src/coveragetest-version.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-version.c + * \file * \ingroup shared * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/shared/src/os-shared-coverage-support.c b/src/unit-test-coverage/shared/src/os-shared-coverage-support.c index a857abb8a..c62bf12cb 100644 --- a/src/unit-test-coverage/shared/src/os-shared-coverage-support.c +++ b/src/unit-test-coverage/shared/src/os-shared-coverage-support.c @@ -19,7 +19,7 @@ */ /** - * \file os-shared-coverage-support.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/bsp-console-impl-stubs.c b/src/unit-test-coverage/ut-stubs/src/bsp-console-impl-stubs.c index 23f369b20..3d1c0346d 100644 --- a/src/unit-test-coverage/ut-stubs/src/bsp-console-impl-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/bsp-console-impl-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file bsp-console-impl-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/os-shared-file-impl-handlers.c b/src/unit-test-coverage/ut-stubs/src/os-shared-file-impl-handlers.c index ec4f1cd23..ed0c8e787 100644 --- a/src/unit-test-coverage/ut-stubs/src/os-shared-file-impl-handlers.c +++ b/src/unit-test-coverage/ut-stubs/src/os-shared-file-impl-handlers.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-utstub-idmap.c + * \file * \author joseph.p.hickey@nasa.gov * * Stub implementations for the functions defined in the OSAL API diff --git a/src/unit-test-coverage/ut-stubs/src/os-shared-filesys-impl-handlers.c b/src/unit-test-coverage/ut-stubs/src/os-shared-filesys-impl-handlers.c index b49982cf7..083bf5ab6 100644 --- a/src/unit-test-coverage/ut-stubs/src/os-shared-filesys-impl-handlers.c +++ b/src/unit-test-coverage/ut-stubs/src/os-shared-filesys-impl-handlers.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-utstub-idmap.c + * \file * \author joseph.p.hickey@nasa.gov * * Stub implementations for the functions defined in the OSAL API diff --git a/src/unit-test-coverage/ut-stubs/src/os-shared-idmap-handlers.c b/src/unit-test-coverage/ut-stubs/src/os-shared-idmap-handlers.c index d6c91b80b..63e1f7fc8 100644 --- a/src/unit-test-coverage/ut-stubs/src/os-shared-idmap-handlers.c +++ b/src/unit-test-coverage/ut-stubs/src/os-shared-idmap-handlers.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-utstub-idmap.c + * \file * \author joseph.p.hickey@nasa.gov * * Stub implementations for the functions defined in the OSAL API diff --git a/src/unit-test-coverage/ut-stubs/src/os-shared-network-impl-handlers.c b/src/unit-test-coverage/ut-stubs/src/os-shared-network-impl-handlers.c index 5b7b8f3c4..75c931560 100644 --- a/src/unit-test-coverage/ut-stubs/src/os-shared-network-impl-handlers.c +++ b/src/unit-test-coverage/ut-stubs/src/os-shared-network-impl-handlers.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-utstub-idmap.c + * \file * \author joseph.p.hickey@nasa.gov * * Stub implementations for the functions defined in the OSAL API diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-binsem-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-binsem-table-stubs.c index 3118b32de..897879ecb 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-binsem-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-binsem-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-binsem-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-common-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-common-stubs.c index bba938912..cb42e9f85 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-common-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-common-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-common-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-console-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-console-table-stubs.c index fb979daf8..d453b4bbd 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-console-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-console-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-console-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-countsem-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-countsem-table-stubs.c index 3c5668f60..914e00b3e 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-countsem-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-countsem-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-countsem-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-dir-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-dir-table-stubs.c index 4593344e2..e12008f24 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-dir-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-dir-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-dir-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-error-impl-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-error-impl-table-stubs.c index b52c51ac7..b7a6447f2 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-error-impl-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-error-impl-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-error-impl-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-filesys-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-filesys-table-stubs.c index 3974890b2..d26620251 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-filesys-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-filesys-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-filesys-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-idmap-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-idmap-table-stubs.c index 354e78a2c..ea43c7aa8 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-idmap-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-idmap-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-idmap-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-module-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-module-table-stubs.c index 981bd0b4c..3bc7ceda1 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-module-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-module-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-module-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-mutex-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-mutex-table-stubs.c index ba57a1248..dbf511817 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-mutex-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-mutex-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-mutex-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-queue-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-queue-table-stubs.c index 872daee22..f0128ed61 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-queue-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-queue-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-queue-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-stream-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-stream-table-stubs.c index 3dfd30a41..b11684ee0 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-stream-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-stream-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-stream-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-task-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-task-table-stubs.c index c2aabc9cb..425af146f 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-task-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-task-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-task-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-timebase-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-timebase-table-stubs.c index 005bebfcc..7ec3da397 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-timebase-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-timebase-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-timebase-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/osapi-shared-timecb-table-stubs.c b/src/unit-test-coverage/ut-stubs/src/osapi-shared-timecb-table-stubs.c index 34d1b2229..33c6c2376 100644 --- a/src/unit-test-coverage/ut-stubs/src/osapi-shared-timecb-table-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/osapi-shared-timecb-table-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file osapi-shared-timecb-table-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/sys-select-stubs.c b/src/unit-test-coverage/ut-stubs/src/sys-select-stubs.c index d726576e5..4de561996 100644 --- a/src/unit-test-coverage/ut-stubs/src/sys-select-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/sys-select-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file bsd-select-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/vxworks-hostLib-stubs.c b/src/unit-test-coverage/ut-stubs/src/vxworks-hostLib-stubs.c index f1448981c..b8c287e02 100644 --- a/src/unit-test-coverage/ut-stubs/src/vxworks-hostLib-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/vxworks-hostLib-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-hostLib-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/ut-stubs/src/vxworks-symLib-stubs.c b/src/unit-test-coverage/ut-stubs/src/vxworks-symLib-stubs.c index 765168ac8..8ffc54133 100644 --- a/src/unit-test-coverage/ut-stubs/src/vxworks-symLib-stubs.c +++ b/src/unit-test-coverage/ut-stubs/src/vxworks-symLib-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-symLib-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-binsem.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-binsem.c index 10988edc4..cfcf418ed 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-binsem.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-binsem.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-binsem.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-common.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-common.c index ede317707..3b70a5406 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-common.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-common.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-common.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-console.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-console.c index 806093688..e1cd4e6b8 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-console.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-console.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-console.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-countsem.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-countsem.c index 0997c7a11..7a53c067a 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-countsem.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-countsem.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-countsem.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirs.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirs.c index 9df04dd8b..e37c1c30f 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirs.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirs.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-dirs.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirtable-stub.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirtable-stub.c index 406b4c5e8..ae9f405c5 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirtable-stub.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-dirtable-stub.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-filetable-stub.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-files.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-files.c index be3e13f93..c5c5c241a 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-files.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-files.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-files.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-filesys.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-filesys.c index 45ffc5720..265bbf242 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-filesys.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-filesys.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-filesys.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-filetable-stub.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-filetable-stub.c index cf867d685..4adcca00b 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-filetable-stub.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-filetable-stub.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-filetable-stub.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-idmap.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-idmap.c index a80cc6d41..86416a541 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-idmap.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-idmap.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-idmap.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-loader.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-loader.c index 6e35f7e9a..95a14bd74 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-loader.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-loader.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-loader.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-mutex.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-mutex.c index 8a8fd08b2..263751cc5 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-mutex.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-mutex.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-mutex.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-queues.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-queues.c index 60aa8ea45..d02496304 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-queues.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-queues.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-queues.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-sockets.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-sockets.c index d13d0f39e..54e47d770 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-sockets.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-sockets.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-sockets.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-symtab.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-symtab.c index b71468a85..b3d14fcba 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-symtab.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-symtab.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-symtab.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-tasks.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-tasks.c index e448ebe44..444833adc 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-tasks.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-tasks.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-tasks.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-timebase.c b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-timebase.c index 943592520..16b3ba923 100644 --- a/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-timebase.c +++ b/src/unit-test-coverage/vxworks/adaptors/src/ut-adaptor-timebase.c @@ -19,7 +19,7 @@ */ /** - * \file ut-adaptor-timebase.c + * \file * \ingroup adaptors * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-binsem.c b/src/unit-test-coverage/vxworks/src/coveragetest-binsem.c index ed49bb969..24458a11b 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-binsem.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-binsem.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-binsem.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-common.c b/src/unit-test-coverage/vxworks/src/coveragetest-common.c index 01c353439..b35a202d3 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-common.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-common.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-common.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-console.c b/src/unit-test-coverage/vxworks/src/coveragetest-console.c index 1c7a4a033..17b3baa37 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-console.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-console.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-console.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-countsem.c b/src/unit-test-coverage/vxworks/src/coveragetest-countsem.c index e09a9ee78..9ab3cc6db 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-countsem.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-countsem.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-countsem.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-dirs-globals.c b/src/unit-test-coverage/vxworks/src/coveragetest-dirs-globals.c index 7bc42b3ab..a2cc521b3 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-dirs-globals.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-dirs-globals.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-dirs-globals.c + * \file * \ingroup vxworks * \author steven.seeger@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-files.c b/src/unit-test-coverage/vxworks/src/coveragetest-files.c index 18a3a82d7..402b8eadd 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-files.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-files.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-files.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-filesys.c b/src/unit-test-coverage/vxworks/src/coveragetest-filesys.c index 64c7b3eb6..b0dd76c30 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-filesys.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-filesys.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-filesys.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-heap.c b/src/unit-test-coverage/vxworks/src/coveragetest-heap.c index b701cea70..3908e17b3 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-heap.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-heap.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-heap.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-idmap.c b/src/unit-test-coverage/vxworks/src/coveragetest-idmap.c index a5da6f09f..00c9024e2 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-idmap.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-idmap.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-idmap.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-loader.c b/src/unit-test-coverage/vxworks/src/coveragetest-loader.c index bb3e14f8f..80b9f42b4 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-loader.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-loader.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-loader.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-mutex.c b/src/unit-test-coverage/vxworks/src/coveragetest-mutex.c index c606a95fb..14fa4a483 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-mutex.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-mutex.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-mutex.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-network.c b/src/unit-test-coverage/vxworks/src/coveragetest-network.c index 52933fa97..867dd0e9e 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-network.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-network.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-network.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-no-module.c b/src/unit-test-coverage/vxworks/src/coveragetest-no-module.c index 4c6925d5b..fbd5191c5 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-no-module.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-no-module.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-no-module.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-queues.c b/src/unit-test-coverage/vxworks/src/coveragetest-queues.c index 8a3b6241a..cc4d468b2 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-queues.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-queues.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-queues.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-shell.c b/src/unit-test-coverage/vxworks/src/coveragetest-shell.c index 4c6d3b1ff..2c2262b78 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-shell.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-shell.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-shell.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-sockets.c b/src/unit-test-coverage/vxworks/src/coveragetest-sockets.c index f83b11db3..1c3dacd82 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-sockets.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-sockets.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-no-module.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c b/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c index ea5fca3cb..f1c396f4f 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-symtab.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c b/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c index c99965219..5959e1425 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-tasks.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c b/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c index 359c61fd7..9ce46ffe0 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c @@ -19,7 +19,7 @@ */ /** - * \file coveragetest-timebase.c + * \file * \ingroup vxworks * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-binsem-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-binsem-stubs.c index ab1704489..3ac3edf3b 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-binsem-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-binsem-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-binsem-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-common-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-common-stubs.c index 464843b13..0d329b82c 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-common-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-common-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-common-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-countsem-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-countsem-stubs.c index 2aee6b7e3..bff2a95a3 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-countsem-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-countsem-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-countsem-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-dir-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-dir-stubs.c index 5aea2429f..aafada4c2 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-dir-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-dir-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-dir-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-file-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-file-stubs.c index ccdf80fbb..1ee10abb4 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-file-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-file-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-file-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-idmap-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-idmap-stubs.c index 5c1acef5f..5423232b4 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-idmap-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-idmap-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-idmap-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-module-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-module-stubs.c index f28c9cb54..9c9f4e560 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-module-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-module-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-module-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-mutex-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-mutex-stubs.c index 1314327af..6a1a9be03 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-mutex-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-mutex-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-mutex-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-queue-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-queue-stubs.c index e6b727e49..391db84a4 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-queue-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-queue-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-queue-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c index 0c68f6524..ca5077220 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-sockets-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-socket-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-task-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-task-stubs.c index 4cd1debf8..af8605e6e 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-task-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-task-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-task-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-timer-stubs.c b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-timer-stubs.c index 228ae5921..6c4241e2f 100644 --- a/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-timer-stubs.c +++ b/src/unit-test-coverage/vxworks/ut-stubs/src/vxworks-os-impl-timer-stubs.c @@ -19,7 +19,7 @@ */ /** - * \file vxworks-os-impl-timer-stubs.c + * \file * \ingroup ut-stubs * \author joseph.p.hickey@nasa.gov * diff --git a/src/ut-stubs/utstub-helpers.h b/src/ut-stubs/utstub-helpers.h index a44cd1c1e..8e1435432 100644 --- a/src/ut-stubs/utstub-helpers.h +++ b/src/ut-stubs/utstub-helpers.h @@ -19,7 +19,7 @@ */ /** - * \file utstub-helpers.h + * \file * * Internal header file for OSAL UT stub functions * diff --git a/ut_assert/src/utstubs.c b/ut_assert/src/utstubs.c index 2d67be29c..947556294 100644 --- a/ut_assert/src/utstubs.c +++ b/ut_assert/src/utstubs.c @@ -19,7 +19,7 @@ */ /** - * \file utstubs.c + * \file * * Created on: Feb 25, 2015 * Author: joseph.p.hickey@nasa.gov From 7676b89f9e0ed9cd885a95f45a1f8adf4b4698fc Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Thu, 17 Feb 2022 15:44:28 -0700 Subject: [PATCH 035/178] Fix #1218, Add ut_assert to doxygen and fix warnings --- docs/osal-detaildesign.doxyfile.in | 2 ++ src/os/portable/os-impl-bsd-select.c | 7 ++++--- ut_assert/inc/utassert.h | 4 ++-- ut_assert/inc/utbsp.h | 3 ++- ut_assert/inc/utstubs.h | 24 +++++++++++++++--------- ut_assert/inc/uttest.h | 8 ++++---- ut_assert/src/utstubs.c | 12 ++++++------ 7 files changed, 35 insertions(+), 25 deletions(-) diff --git a/docs/osal-detaildesign.doxyfile.in b/docs/osal-detaildesign.doxyfile.in index 5eaf80d47..ee0602016 100644 --- a/docs/osal-detaildesign.doxyfile.in +++ b/docs/osal-detaildesign.doxyfile.in @@ -5,3 +5,5 @@ INPUT += @osal_MISSION_DIR@/src/os INPUT += @osal_MISSION_DIR@/src/bsp +# Include ut_assert documentation in detail design document +INPUT += @osal_MISSION_DIR@/ut_assert diff --git a/src/os/portable/os-impl-bsd-select.c b/src/os/portable/os-impl-bsd-select.c index b41832f24..a83742b53 100644 --- a/src/os/portable/os-impl-bsd-select.c +++ b/src/os/portable/os-impl-bsd-select.c @@ -126,9 +126,10 @@ static int32 OS_FdSet_ConvertIn_Impl(int *os_maxfd, fd_set *os_set, const OS_FdS * * This un-sets bits in OSAL_set that are set in the OS_set * - * \param[in] OS_set The fd_set from select - * \param[in, out] OSAL_set The OS_FdSet updated by this helper - *-----------------------------------------------------------------*/ + * \param[in] OS_set The fd_set from select + * \param[in,out] OSAL_set The OS_FdSet updated by this helper + */ +/*-----------------------------------------------------------------*/ static void OS_FdSet_ConvertOut_Impl(fd_set *OS_set, OS_FdSet *OSAL_set) { size_t offset; diff --git a/ut_assert/inc/utassert.h b/ut_assert/inc/utassert.h index be59ca3c3..bd5f250b5 100644 --- a/ut_assert/inc/utassert.h +++ b/ut_assert/inc/utassert.h @@ -818,7 +818,7 @@ void UtAssert_Message(uint8 MessageType, const char *File, uint32 Line, const ch * \param SubsysName The subsystem under test (abbreviated name) * \param ShortDesc Short description of the test case * \param SegmentNum Sequence among the overall/global test Segments - * \param TestDescr Sequence within the current test Segment + * \param SegmentSeq Sequence within the current test Segment */ void UtAssert_DoReport(const char *File, uint32 LineNum, uint32 SegmentNum, uint32 SegmentSeq, uint8 MessageType, const char *SubsysName, const char *ShortDesc); @@ -831,7 +831,7 @@ void UtAssert_DoReport(const char *File, uint32 LineNum, uint32 SegmentNum, uint * Like the UtAssert_DoReport() function, this is typically done as a message on the console/log however * it might be different for embedded targets. * - * \param Appname The application under test + * \param SegmentName The segment under test * \param TestCounters Counter object for the completed test */ void UtAssert_DoTestSegmentReport(const char *SegmentName, const UtAssert_TestCounter_t *TestCounters); diff --git a/ut_assert/inc/utbsp.h b/ut_assert/inc/utbsp.h index 85c88c97a..c27541317 100644 --- a/ut_assert/inc/utbsp.h +++ b/ut_assert/inc/utbsp.h @@ -67,7 +67,8 @@ void UT_BSP_Setup(void); * * This is just a hook for the BSP to be informed of the start-of-test event and may be a no-op. * - * \param Appname Name of current test segment + * \param[in] SegmentNumber Number of current test segment + * \param[in] SegmentName Name of current test segment */ void UT_BSP_StartTestSegment(uint32 SegmentNumber, const char *SegmentName); diff --git a/ut_assert/inc/utstubs.h b/ut_assert/inc/utstubs.h index 0a214cfa1..c100830b8 100644 --- a/ut_assert/inc/utstubs.h +++ b/ut_assert/inc/utstubs.h @@ -212,7 +212,7 @@ void UT_SetDataBuffer(UT_EntryKey_t FuncKey, void *DataBuffer, size_t BufferSize * * \param FuncKey The stub function to reference. * \param DataBuffer Set to Pointer to data buffer that is associated with the stub function (output) - * \param BufferSize Set to Maximum Size of data buffer (output) + * \param MaxSize Set to Maximum Size of data buffer (output) * \param Position Set to current position in data buffer (output) */ void UT_GetDataBuffer(UT_EntryKey_t FuncKey, void **DataBuffer, size_t *MaxSize, size_t *Position); @@ -557,9 +557,10 @@ void UT_Stub_RegisterContextWithMetaData(UT_EntryKey_t FuncKey, const char *Name * * This does not return NULL, such that the returned value can always be dereferenced. * - * \param ContextPtr The context structure containing arguments - * \param Name Argument name to find - * \param ExpectedSize The size of the expected object type + * \param ContextPtr The context structure containing arguments + * \param Name Argument name to find + * \param ExpectedTypeSize The size of the expected object type + * * \returns Pointer to buffer containing the value. */ const void *UT_Hook_GetArgPtr(const UT_StubContext_t *ContextPtr, const char *Name, size_t ExpectedTypeSize); @@ -588,8 +589,10 @@ const void *UT_Hook_GetArgPtr(const UT_StubContext_t *ContextPtr, const char *Na * \param FunctionName The printable name of the actual function called, for the debug message. If * NULL then no debug message will be generated. * \param FuncKey The Key to look up in the table + * \param DefaultRc Default return code + * \param ArgList Argument list */ -int32 UT_DefaultStubImplWithArgs(const char *FunctionName, UT_EntryKey_t FuncKey, int32 DefaultRc, va_list va); +int32 UT_DefaultStubImplWithArgs(const char *FunctionName, UT_EntryKey_t FuncKey, int32 DefaultRc, va_list ArgList); /** * Handles a stub call for a variadic function @@ -605,8 +608,10 @@ int32 UT_DefaultStubImplWithArgs(const char *FunctionName, UT_EntryKey_t FuncKey * * \sa UT_DefaultStubImplWithArgs() * - * \param FuncKey The key of the stub being executed - * \param FunctionName The printable name of the actual function called, for the debug message. + * \param FuncKey The key of the stub being executed + * \param FunctionName The printable name of the actual function called, for the debug message. + * \param DefaultHandler The default handler + * \param VaList Argument list */ void UT_ExecuteVaHandler(UT_EntryKey_t FuncKey, const char *FunctionName, UT_VaHandlerFunc_t DefaultHandler, va_list VaList); @@ -637,8 +642,9 @@ int32 UT_DefaultStubImpl(const char *FunctionName, UT_EntryKey_t FuncKey, int32 * * \sa UT_DefaultStubImplWithArgs() * - * \param FuncKey The key of the stub being executed - * \param FunctionName The printable name of the actual function called, for the debug message. + * \param FuncKey The key of the stub being executed + * \param FunctionName The printable name of the actual function called, for the debug message. + * \param DefaultHandler The default handler */ void UT_ExecuteBasicHandler(UT_EntryKey_t FuncKey, const char *FunctionName, UT_HandlerFunc_t DefaultHandler); diff --git a/ut_assert/inc/uttest.h b/ut_assert/inc/uttest.h index aba937de2..a9af45363 100644 --- a/ut_assert/inc/uttest.h +++ b/ut_assert/inc/uttest.h @@ -61,8 +61,8 @@ void UtTest_Add(void (*Test)(void), void (*Setup)(void), void (*Teardown)(void), * This group of functions are invoked BEFORE normal test routines added with UtTest_Add. * Within the group, functions are executed in the order registered. * - * \param Setup Setup function, called before the test function - * \param TestName Name of function for logging purposes + * \param Setup Setup function, called before the test function + * \param SequenceName Name of sequence for logging purposes */ void UtTest_AddSetup(void (*Setup)(void), const char *SequenceName); @@ -72,8 +72,8 @@ void UtTest_AddSetup(void (*Setup)(void), const char *SequenceName); * This group of functions is invoked AFTER normal test routines added with UtTest_Add. * Within the group, functions are executed in the order registered. * - * \param Teardown Teardown function, called before the test function - * \param TestName Name of function for logging purposes + * \param Teardown Teardown function, called before the test function + * \param SequenceName Name of sequence for logging purposes */ void UtTest_AddTeardown(void (*Teardown)(void), const char *SequenceName); diff --git a/ut_assert/src/utstubs.c b/ut_assert/src/utstubs.c index 2d67be29c..5347acd81 100644 --- a/ut_assert/src/utstubs.c +++ b/ut_assert/src/utstubs.c @@ -1037,24 +1037,24 @@ int32 UT_DefaultStubImpl(const char *FunctionName, UT_EntryKey_t FuncKey, int32 return Retcode; } -void UT_ExecuteBasicHandler(UT_EntryKey_t FuncKey, const char *FunctionName, UT_HandlerFunc_t DefaultHook) +void UT_ExecuteBasicHandler(UT_EntryKey_t FuncKey, const char *FunctionName, UT_HandlerFunc_t DefaultHandler) { /* Check if the test case registered a hook, and use the default if not */ - if (UT_GetStubEntry(FuncKey, UT_ENTRYTYPE_FINAL_HANDLER) == NULL && DefaultHook != NULL) + if (UT_GetStubEntry(FuncKey, UT_ENTRYTYPE_FINAL_HANDLER) == NULL && DefaultHandler != NULL) { - UT_SetHandlerFunction(FuncKey, DefaultHook, NULL); + UT_SetHandlerFunction(FuncKey, DefaultHandler, NULL); } UT_DefaultStubImpl(FunctionName, FuncKey, 0, NULL); } -void UT_ExecuteVaHandler(UT_EntryKey_t FuncKey, const char *FunctionName, UT_VaHandlerFunc_t DefaultHook, +void UT_ExecuteVaHandler(UT_EntryKey_t FuncKey, const char *FunctionName, UT_VaHandlerFunc_t DefaultHandler, va_list VaList) { /* Check if the test case registered a hook, and use the default if not */ - if (UT_GetStubEntry(FuncKey, UT_ENTRYTYPE_FINAL_HANDLER) == NULL && DefaultHook != NULL) + if (UT_GetStubEntry(FuncKey, UT_ENTRYTYPE_FINAL_HANDLER) == NULL && DefaultHandler != NULL) { - UT_SetVaHandlerFunction(FuncKey, DefaultHook, NULL); + UT_SetVaHandlerFunction(FuncKey, DefaultHandler, NULL); } UT_DefaultStubImplWithArgs(FunctionName, FuncKey, 0, VaList); From 21cc7f59be4abf9b6448b70ead6f62afdf5b69d8 Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Wed, 23 Feb 2022 11:37:44 -0500 Subject: [PATCH 036/178] Fix #1222, protect if OS_FDGetInfo called on socket Datagram sockets do not have a name_entry, it is set NULL. If the user calls OS_FDGetInfo() on this type of ID, it will pass the first test, so this needs to be checked for non-NULL. --- src/os/shared/src/osapi-file.c | 5 ++++- src/unit-test-coverage/shared/src/coveragetest-file.c | 4 ++++ .../shared/src/os-shared-coverage-support.c | 2 +- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/src/os/shared/src/osapi-file.c b/src/os/shared/src/osapi-file.c index c2d3191b6..283e8f1cb 100644 --- a/src/os/shared/src/osapi-file.c +++ b/src/os/shared/src/osapi-file.c @@ -532,7 +532,10 @@ int32 OS_FDGetInfo(osal_id_t filedes, OS_file_prop_t *fd_prop) { record = OS_OBJECT_TABLE_GET(OS_global_stream_table, token); - strncpy(fd_prop->Path, record->name_entry, sizeof(fd_prop->Path) - 1); + if (record->name_entry != NULL) + { + strncpy(fd_prop->Path, record->name_entry, sizeof(fd_prop->Path) - 1); + } fd_prop->User = record->creator; fd_prop->IsValid = true; diff --git a/src/unit-test-coverage/shared/src/coveragetest-file.c b/src/unit-test-coverage/shared/src/coveragetest-file.c index 251324fed..01f82fdca 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-file.c +++ b/src/unit-test-coverage/shared/src/coveragetest-file.c @@ -310,6 +310,10 @@ void Test_OS_FDGetInfo(void) OSAPI_TEST_FUNCTION_RC(OS_FDGetInfo(UT_OBJID_1, &file_prop), OS_SUCCESS); UtAssert_True(strcmp(file_prop.Path, "ABC") == 0, "file_prop.Path (%s) == ABC", file_prop.Path); + OS_UT_SetupBasicInfoTest(OS_OBJECT_TYPE_OS_STREAM, UT_INDEX_1, NULL, UT_OBJID_OTHER); + OSAPI_TEST_FUNCTION_RC(OS_FDGetInfo(UT_OBJID_1, &file_prop), OS_SUCCESS); + UtAssert_STRINGBUF_EQ(file_prop.Path, 1, "", 1); + OSAPI_TEST_FUNCTION_RC(OS_FDGetInfo(UT_OBJID_1, NULL), OS_INVALID_POINTER); UT_SetDefaultReturnValue(UT_KEY(OS_ObjectIdGetById), OS_ERR_INVALID_ID); diff --git a/src/unit-test-coverage/shared/src/os-shared-coverage-support.c b/src/unit-test-coverage/shared/src/os-shared-coverage-support.c index a857abb8a..99a252698 100644 --- a/src/unit-test-coverage/shared/src/os-shared-coverage-support.c +++ b/src/unit-test-coverage/shared/src/os-shared-coverage-support.c @@ -108,7 +108,7 @@ void OS_UT_SetupBasicInfoTest(osal_objtype_t obj_type, osal_index_t test_idx, co rptr += test_idx; memset(rptr, 0, sizeof(*rptr)); rptr->creator = UT_OBJID_OTHER; - rptr->name_entry = "ABC"; + rptr->name_entry = name; OS_UT_SetupTestTargetIndex(obj_type, test_idx); } From 776de0729b5c728818e9640b1a91cc951d84ba55 Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Fri, 25 Feb 2022 12:24:14 -0500 Subject: [PATCH 037/178] Bump to v6.0.0-rc4+dev42 Part of IC:Caelum+dev4, nasa/cFS#432 **Includes** PR #1215 - Resolve UT uninitialized variable warnings PR #1219 - Add ut_assert to doxygen and fix warnings PR #1223 - Protect if OS_FDGetInfo called on socket --- README.md | 7 +++++++ src/os/inc/osapi-version.h | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 730d25e0c..937320ce8 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ The autogenerated OSAL user's guide can be viewed at and + ### Development Build: v6.0.0-rc4+dev32 - Typesafe definition of osal_id_t diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index 9aaf2915f..fa668d038 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -36,7 +36,7 @@ /* * Development Build Macro Definitions */ -#define OS_BUILD_NUMBER 32 +#define OS_BUILD_NUMBER 42 #define OS_BUILD_BASELINE "v6.0.0-rc4" /* From 1c6aa9df30faa067e4d278ba6dcf0dbac83524c4 Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Thu, 24 Feb 2022 13:40:01 -0700 Subject: [PATCH 038/178] Fix #1227, Refactor doxygen and remove mainpage --- docs/osal-detaildesign.doxyfile.in | 7 ++ docs/src/CMakeLists.txt | 7 +- docs/src/default-settings.doxyfile | 55 +++++++++++++ docs/src/osal-apiguide.doxyfile.in | 5 -- docs/src/osal-common.doxyfile.in | 81 +++---------------- docs/src/{osalmain.dox => osal_frontpage.dox} | 2 +- 6 files changed, 78 insertions(+), 79 deletions(-) create mode 100644 docs/src/default-settings.doxyfile rename docs/src/{osalmain.dox => osal_frontpage.dox} (98%) diff --git a/docs/osal-detaildesign.doxyfile.in b/docs/osal-detaildesign.doxyfile.in index ee0602016..f5efaf070 100644 --- a/docs/osal-detaildesign.doxyfile.in +++ b/docs/osal-detaildesign.doxyfile.in @@ -1,3 +1,10 @@ +#--------------------------------------------------------------------------- +# Doxygen Configuration options for mission detailed documentation +#--------------------------------------------------------------------------- + +# Common files +@INCLUDE = @MISSION_BINARY_DIR@/docs/osalguide/osal-common.doxyfile + # All of the OSAL FSW code relevant for a detail design document is under # src/os and src/bsp, everything else is test and examples/support # Note this will include ALL OS/BSP layers, it does not currently filter diff --git a/docs/src/CMakeLists.txt b/docs/src/CMakeLists.txt index 589da9a30..a8e5191d1 100644 --- a/docs/src/CMakeLists.txt +++ b/docs/src/CMakeLists.txt @@ -34,7 +34,7 @@ project(OSAL_DOCS NONE) # List of dox files to include - # note that order is relevant here, doxygen processes in the order listed. set(OSAL_DOCFILE_LIST - ${CMAKE_CURRENT_SOURCE_DIR}/osalmain.dox + ${CMAKE_CURRENT_SOURCE_DIR}/osal_frontpage.dox ${CMAKE_CURRENT_SOURCE_DIR}/osal_fs.dox ${CMAKE_CURRENT_SOURCE_DIR}/osal_timer.dox ) @@ -63,6 +63,7 @@ endforeach() file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/osal-apiguide-warnings.log OSAL_NATIVE_LOGFILE) file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/osal-common.doxyfile OSAL_NATIVE_COMMON_CFGFILE) file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/osal-apiguide.doxyfile OSAL_NATIVE_APIGUIDE_CFGFILE) +file(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/default-settings.doxyfile OSAL_NATIVE_DEFAULT_SETTINGS) # generate the configuration files configure_file( @@ -70,6 +71,7 @@ configure_file( ${CMAKE_CURRENT_BINARY_DIR}/osal-common.doxyfile @ONLY ) + configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/osal-apiguide.doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/osal-apiguide.doxyfile @@ -78,7 +80,8 @@ configure_file( add_custom_command(OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/apiguide/html/index.html" COMMAND doxygen ${OSAL_NATIVE_APIGUIDE_CFGFILE} - DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/osal-apiguide.doxyfile ${OSAL_DOCFILE_LIST} ${OSAL_DOC_DEPENDENCY_LIST} + DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/osal-apiguide.doxyfile ${CMAKE_CURRENT_BINARY_DIR}/osal-common.doxyfile + ${OSAL_DOCFILE_LIST} ${OSAL_DOC_DEPENDENCY_LIST} WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}" ) diff --git a/docs/src/default-settings.doxyfile b/docs/src/default-settings.doxyfile new file mode 100644 index 000000000..9b7f9ef9e --- /dev/null +++ b/docs/src/default-settings.doxyfile @@ -0,0 +1,55 @@ +#--------------------------------------------------------------------------- +# Default Doxygen settings +#--------------------------------------------------------------------------- + +# Common aliases +ALIASES += nonnull="(must not be null)" +ALIASES += nonzero="(must not be zero)" +ALIASES += covtest="(return value only verified in coverage test)" + +# Source options +OPTIMIZE_OUTPUT_FOR_C = YES + +# Build related +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +CASE_SENSE_NAMES = NO +GENERATE_TODOLIST = NO +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES + +# Warnings +WARN_NO_PARAMDOC = YES + +# Matching +FILE_PATTERNS = *.c *.cpp *.cc *.C *.h *.hh *.hpp *.H *.dox *.md +RECURSIVE = YES + +# Source browsing +SOURCE_BROWSER = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES + +# LaTeX output +GENERATE_LATEX = YES +LATEX_CMD_NAME = latex +COMPACT_LATEX = YES +PAPER_TYPE = letter + +# RTF output +COMPACT_RTF = YES + +# Dot tool +CLASS_DIAGRAMS = NO +HAVE_DOT = YES +CLASS_GRAPH = NO +COLLABORATION_GRAPH = NO +INCLUDE_GRAPH = NO +INCLUDED_BY_GRAPH = NO +CALL_GRAPH = YES +GRAPHICAL_HIERARCHY = NO +MAX_DOT_GRAPH_DEPTH = 1000 + +# Search engine +SEARCHENGINE = NO diff --git a/docs/src/osal-apiguide.doxyfile.in b/docs/src/osal-apiguide.doxyfile.in index 86c0de81b..b6bde31e9 100644 --- a/docs/src/osal-apiguide.doxyfile.in +++ b/docs/src/osal-apiguide.doxyfile.in @@ -2,15 +2,10 @@ # Doxygen Configuration options to generate the "OSAL API Guide" #--------------------------------------------------------------------------- -# Complete list of input files -INPUT += @OSAL_NATIVE_APIGUIDE_SOURCEFILES@ - - # Common definitions, some of which are extended or overridden here. @INCLUDE = @OSAL_NATIVE_COMMON_CFGFILE@ PROJECT_NAME = "OSAL User's Guide" OUTPUT_DIRECTORY = apiguide -GENERATE_LATEX = YES # output the warnings to a separate file WARN_LOGFILE = @OSAL_NATIVE_LOGFILE@ diff --git a/docs/src/osal-common.doxyfile.in b/docs/src/osal-common.doxyfile.in index 39bbba061..32ff2099f 100644 --- a/docs/src/osal-common.doxyfile.in +++ b/docs/src/osal-common.doxyfile.in @@ -1,76 +1,15 @@ #--------------------------------------------------------------------------- -# Project related configuration options, shared for all cFE doxygen outputs +# OSAL common setup for including in stand alone or mission documentation #--------------------------------------------------------------------------- -@INCLUDE_PATH = @OSAL_NATIVE_INCLUDE_DIRS@ -OUTPUT_DIRECTORY = . -ABBREVIATE_BRIEF = "The $name class " \ - "The $name widget " \ - "The $name file " \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the -TAB_SIZE = 4 -OPTIMIZE_OUTPUT_FOR_C = YES -ALIASES += nonnull="(must not be null)" -ALIASES += nonzero="(must not be zero)" -ALIASES += covtest="(return value only verified in coverage test)" +# Allow overrides +@INCLUDE_PATH = @MISSION_SOURCE_DIR@ + +# Default settings from cFE +@INCLUDE = @OSAL_NATIVE_DEFAULT_SETTINGS@ + +# Include any passed in predefines PREDEFINED += @OSALDOC_PREDEFINED@ -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = YES -EXTRACT_PRIVATE = YES -EXTRACT_STATIC = YES -CASE_SENSE_NAMES = NO -GENERATE_TODOLIST = NO -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -WARN_NO_PARAMDOC = YES -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -STRIP_FROM_PATH = @OSAL_SOURCE_NATIVE_DIR@ -FILE_PATTERNS = *.c *.cpp *.cc *.C *.h *.hh *.hpp *.H *.dox *.md -RECURSIVE = YES -EXAMPLE_PATTERNS = * -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = YES -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = NO -LATEX_CMD_NAME = latex -COMPACT_LATEX = YES -PAPER_TYPE = letter -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- -COMPACT_RTF = YES -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = NO -HAVE_DOT = YES -CLASS_GRAPH = NO -COLLABORATION_GRAPH = NO -INCLUDE_GRAPH = NO -INCLUDED_BY_GRAPH = NO -CALL_GRAPH = YES -GRAPHICAL_HIERARCHY = NO -MAX_DOT_GRAPH_DEPTH = 1000 -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- -SEARCHENGINE = NO +# Minimum set of source files (includes *.dox, followed by public headers) +INPUT += @OSAL_NATIVE_APIGUIDE_SOURCEFILES@ diff --git a/docs/src/osalmain.dox b/docs/src/osal_frontpage.dox similarity index 98% rename from docs/src/osalmain.dox rename to docs/src/osal_frontpage.dox index fee3a1c72..b05a8eac3 100644 --- a/docs/src/osalmain.dox +++ b/docs/src/osal_frontpage.dox @@ -1,5 +1,5 @@ /** - \mainpage Osal API Documentation + \page osalfrontpage Osal API Documentation