Merge branch 'main' of github.com:nasa/osal into main

.github/workflows/codeql-build.yml

@@ -0,0 +1,58 @@
+name: "CodeQL Analysis"
+
+on:
+  push:
+  pull_request:
+
+env:
+  SIMULATION: native
+  ENABLE_UNIT_TESTS: true
+  OMIT_DEPRECATED: true
+  BUILDTYPE: release
+
+jobs:
+
+  CodeQL-Build:
+    runs-on: ubuntu-18.04
+    timeout-minutes: 15
+
+    steps:
+      # Checks out a copy of your repository on the ubuntu-latest machine
+      - 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
+         queries: +security-extended, security-and-quality
+
+      # Setup the build system
+      - name: Set up for build
+        run: |
+          cp ./cfe/cmake/Makefile.sample Makefile
+          cp -r ./cfe/cmake/sample_defs sample_defs
+          make prep
+
+      # Build the code
+      - name: Build
+        run: |
+          make osal
+          make native/default_cpu1/osal/tests/
+          make native/default_cpu1/osal/unit-test-coverage/
+          make native/default_cpu1/osal/unit-tests/
+          make native/default_cpu1/osal/ut-stubs/
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/format-check.yml

@@ -0,0 +1,53 @@
+name: Format Check
+
+# Run on main push and pull requests
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+
+  static-analysis:
+    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

.github/workflows/static-analysis.yml

@@ -0,0 +1,55 @@
+name: Static Analysis
+
+# Run this workflow every time a new commit pushed to your repository
+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 --quiet . 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

README.md

@@ -1,4 +1,5 @@
-Travis-CI: [![Build Status](https://travis-ci.com/nasa/osal.svg)](https://travis-ci.com/nasa/osal)
+![Static Analysis](https://github.com/nasa/osal/workflows/Static%20Analysis/badge.svg)
+![Format Check](https://github.com/nasa/osal/workflows/Format%20Check/badge.svg)
 
 # Core Flight System : Framework : Operating System Abstraction Layer
 
@@ -10,6 +11,138 @@ The autogenerated OSAL user's guide can be viewed at <https://github.com/nasa/cF
 
 ## Version History
 
+### Development Build: 5.1.0-rc1+dev262
+
+- Adds test cases for `OS_ObjectIdFinalizeDelete`, `OS_DeleteAllObjects`, and others to get 100% line and function coverage on VxWorks and shared/portable layers.
+- Ensures APIs check for `NULL` inputs or have documentation stating that a null value is allowed.
+- Adds timeout to static analysis check and adds format check. Removes old .travis.yml and updates badges in readme.
+- Adds Code QL analysis on push to main and pull requests (to main)
+- Cleans commented-out code in tests to address static analysis warnings
+- Initializes local variables to avoid returning uninitialized values from stubs and address static-analysis findings
+- Replaces two local return codes defined as `uint32` with `int32` to resolve static-analysis warnings
+- Simplifies switch statements based on previous checks. Removes unreachable, dead code to resolve static-analysis warnings
+- Terminates  unit test macros variadic lists with `NULL` to address CWE-121 CodeQL warning
+- Adds a check to send the semaphore to avoid unreachable code
+- Adds a status return to `OS_ConsoleAPI_Init` so debug warnings will get reported correctly on errors.
+- Declares `DummyVec` as static to avoid warning and returning stack allocated memory when returning `VecTbl` in `OSC_INUM_TO_IVEC` stub
+- Updates types in `os-impl-no-symtab.c` to match latest APIs
+- Updates types in `os-impl-no-symtab.c` to match latest APIs
+- Fixes missing `NULL` terminations and applies the standard "sizeof" pattern where appropriate. No longer truncates filename in `OS_ModuleInfo`.
+- Fixes `%u` conversion in RTEMS so to address build warning
+- Create a wrapper around `memchr()` that mimics the non-C99 function `strnlen()` defined in POSIX-2008. Use this instead of `strlen()` whenever the string being checked either originates in or will be copied into a fixed-length array buffer. No behavior changes except if a bug causes strings to be unterminated.
+- No behavior change, applies the standard formatting using `clang-format`
+- See <https://github.com/nasa/osal/pull/774>
+
+### Development Build: 5.1.0-rc1+dev221
+
+- Fixes `printf` format to correctly build in RTEMS-5.
+- **Deprecates `OS_fsBlocksFree()` and `OS_fsBytesFree()`** in favor of `OS_FileSysStatVolume()`.
+- Adds `Security.md` with instructions to report vulnerabilities.
+- Add `UtDebug` in `OS_printf` stub. Output the `OS_printf` input as a debug message from stub.
+- Documentation: Add note on `UtTest_Add` API. Nesting `UtTest_Add` from within an added test fails without error.
+- Unit Test: No more garbage characters written to test report log
+- Fix typo in `osapi.h` affecting C++ build. No other functional change
+- Unit Test: Rename `UT_ClearForceFail` as `UT_ClearDefaultValue`. Update the comments of `UT_SetDefaultReturnValue` to match the more general function.
+- Unit Test: Add test teardown failures to the test summary and changed the printout to use the same style as startup failures.
+- Unit Test: Removes no longer applicable `UT_CheckForOpenSockets` since the UT framework resets the state for each unit test.
+- Changes the file-create operation to read-write permissions to work on RTEMS
+- Unit Test: Fixes incorrect assertions in `network-api-test` to correctly check return values.
+- Unit Test: Generalizes queue timeout test to also test message queue functionality to validate settings and permissions to work with mqueues.
+- Implements `OS_time_t` with a single 64-bit tick counter rather than a split 32 bit seconds + 32 bit microseconds counter.
+- Unit Test: Installs the modules used in unit testing and adds removal of post-test, left-over files.
+- See <https://github.com/nasa/osal/pulls/767>
+
+### Development Build: 5.1.0-rc1+dev184
+
+- Address issues with OSAL global table management:
+  - use iterators whenever possible
+  - use an unlock key rather than task ID so OS_TaskExit() doesn't trigger a warning
+  - general cleanup of lock/unlock impl and remove redundant logic
+  - unlock global tables during create/delete
+  - keep threads "attached" in POSIX, so they can be joined when deleted.
+- No longer triggers warning with OS_TaskExit() on VxWorks (see #645)
+- `OS_TaskDelete()` on POSIX does not return until the task has actually exited (see #642)
+- The chmod test is now skipped on VxWorks rather than failing. The `OS_FileChmod_Impl()` function now returns `OS_ERR_NOT_IMPLEMENTED` when run on a file system that does not have permissions, which in turn causes the unit test to be skipped rather than fail.   
+- Corrects a file handle leak.
+-  Add parameter check to `OS_SocketSendTo` and adjust coverage test to validate.
+- Replace `OS_fsBytesFree` and `OS_fsBlocksFree` with `OS_FileSysStatVolume`. This new API for getting stats on file system. Uses existing `OS_FileSysStatVolume_Impl` call and exposes it in the public API.
+- When cleaning up for shutdown, delete resources that have a task/thread first, followed by other resource types. This helps avoid possible dependencies as running threads might be using the other resources. No detectable external impact; internally, the tasks are deleted first during shutdown, which only has an impact if/when tasks are actively using other OSAL resources.
+- The mount/unmount *VxWorks* implementation was not adequately checking for and handling the `FS_BASED` pass -through mapping type - which should be mostly a no-op. Create a mount point directory if it does not already exist when using this mapping type for consistency with POSIX.
+- Adds a documentation note to `OS_FileSysAddFixedMap()`: The virtual mount point cannot be empty - so `OS_FileSysAddFixedMap(.., "/", "/")` does not work but `OS_FileSysAddFixedMap(.., "/", "/root")` does work and allows one to open files in the root as `"/root/"` from OSAL applications. Mount-point directories do not need to previously exist when using OS_FileSysAddFixedMap
+- store `taskTCB` return in a `void *`, then cast to `OS_impl_task_internal_record_t *` to avoid a strict alignment compiler error
+- Removes the non-portable `OS_PACK` and `OS_ALIGNED` macros.
+- Uses the POSIX dir implementation on VxWorks 6.9. The only incompatibility is the prototype for `mkdir()`which is missing the second argument; this is worked around with a compatibility macro for VxWorks 6.x builds.
+- Translate and convert the VxWorks coverage test cases to the portable dir implementation, which benefits VxWorks7, RTEMS, and POSIX.
+- Fixes prototypes so they run on RTEMS by replacing uint32 with size_t
+- Adds` OS_CHECK_POINTER` macros to `OS_ConvertToArrayIndex` and `OS_TimeBaseGetFreeRun` so they can handle NULL pointers and return the correct error.
+- Adds access functions to convert/extract different units from an OS_time_t value - so that other code in CFE/PSP/Apps can be updated to use the access functions and thereby not break when the internal time definition changes. Replaces the `int32` with `OS_time_t` in the "stat" structure used by the file module. Updates the pointer argument to `OS_SetLocalTime()` to be `const`. Prototype change of `OS_SetLocalTime()` should be backward compatible.
+- See <https://github.com/nasa/osal/pulls/750>
+
+### Development Build: 5.1.0-rc1+dev149
+
+- Document UtAssert_Message parameters, also adds "see also" note for helper macros.
+- Fix doxygen typo
+- Replace `OS_BinSemFlush` with `OS_BinSemGive` to prevent a rare race condition. Change the port numbers to be different from network test for when tests are run in parallel.
+- Fix doxygen format errors. Usersguide now builds without warnings.
+- Suppress invalid cppcheck warning in `OS_WaitForStateChange`
+- Add cppcheck static analysis workflow to osal CI
+- See <https://github.com/nasa/osal/pull/744>
+
+### Development Build: 5.1.0-rc1+dev132
+
+- Convert the OSAL Configuration Guide from docx and pdf to a markdown file.
+- Test Tasks do not run at 100%. Move all definitions and instantiations out of the core-test header file and reuse the already-existing single task definition.
+- Break up `osapi-os-*.h` files into units that correspond to the implementation units. Kept old header file names for compatibility.
+- Reworks the POSIX global lock implementation. Does not change the POSIX signal mask when locking/unlocking the global.
+  - Fixes a race condition.
+  - Adds a condition variable to the global lock structure. improves handling of tasks competing for access to the same object.
+  - No longer changing signal masks repeatedly/unexpectedly. May be relevant to some BSP/driver developers.
+- Checks return of sysconf for error and reports them. Only sets PageSize on success. If sysconf fails it provides a mechanism to avoid error propagation.
+- Uses `errno` instead of status return from `clock_getres` with `strerror` reporting.
+- Adds support for VxWorks 7
+- See <https://github.com/nasa/osal/pull/690>
+
+### Development Build: 5.1.0-rc1+dev109
+
+- Add support for RTEMS 5.1 in the OSAL and provides defines and necessary ifdefs so RTEMS 4.11 can continue to be supported.
+- Adds functional test for OS_chmod
+- Refactor the table array access across OSAL. Use a token concept in combination with a macro to obtain the table entry instead of indexing arrays directly. All access is then done through this table pointer. Use the full object ID in the timer call back list. Update the timer sync callback prototype. Pass the entire OSAL ID to the sync function, not just the index. This is technically an API change.
+- Replaces condition on forever loops to end on shutdown. Loops now exit on shutdown.
+- Removes obsolete printf tests that didn't work
+- See <https://github.com/nasa/osal/pull/680>
+
+
+### Development Build: 5.1.0-rc1+dev91
+
+- Rename `UT_SetForceFail` to `UT_SetDefaultReturnValue` since some functions that retain more than 1 value are not necessarily failing
+- Add a 5th timer to TimerTest functional to test the one shot (zero-length time interval) case.
+- Ensure all APIs use the proper type. Sizes are now size_t; these will now be 64 bits on a 64 bit platform.
+- Fix build issue on VxWorks 6.9 by using the 3 argument form of `open()`. Passing `0` as the mode solves the build issue. This parameter is ignored when not creating a file.
+-  The address calculations now use `unsigned long` instead of `long` to ensure that all rounding and base address adjustments behave the same way in the event that the addresses lie in the upper half of memory (i.e. start with a 1 bit) which would put it in the negative range of a long type.
+- See <https://github.com/nasa/osal/pull/662>
+
+
+### Development Build: 5.1.0-rc1+dev75
+
+- Ensure that the handle is not NULL before invoking dlclose(). In particular the handle will be NULL for static modules. Shutdown after CTRL+C occurs normally (no segfault).
+- Add a "flags" parameter to OS_ModuleLoad() to indicate the desired symbol visibility:
+    - GLOBAL (0, the default, and matches current behavior)
+    - LOCAL which hides from other modules and prevents other modules from binding to symbols in this module, thereby ensuring/preserving the ability to unload in the future
+  - CFE should use LOCAL flag for apps, and GLOBAL flags for libraries.
+- See <https://github.com/nasa/osal/pull/652>
+
+### Development Build: 5.1.0-rc1+dev68
+
+- When `OS_DEBUG` is enabled, this adds a message if mutex give/take actions occur outside the expected sequence. This informs the user (via the debug console) if a lock is taken more than once or if a lock is given by a different task than the one that originally took it:
+```
+OS_MutSemTake():216:WARNING: Task 65547 taking mutex 327685 while owned by task 65547
+```
+- Removes all FIXME comments
+- Resolves security/filename race issue by opening file and acting on descriptor by adding fstat stub
+- Squashed the minor recommended bugs
+- UtAssert macros now accept variable string arguments.The `UtAssert_True` wrapper around call is no longer needed to accommodate dynamic string output, thus removing the double assert. UtAssert macros will now be able to offer more information by themselves.
+- See <https://github.com/nasa/osal/pull/639>
+
 ### Development Build: 5.1.0-rc1+dev60
 
 - Appliy standard formating, whitespace-only changes

SECURITY.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+To report a vulnerability for the OSAL subsystem please [submit an issue](https://github.com/nasa/osal/issues/new/choose).
+
+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).
+
+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.
+
+## Additional Support
+
+For additional support, email us at cfs-program@lists.nasa.gov. For help using OSAL and cFS, [subscribe to our mailing list](https://lists.nasa.gov/mailman/listinfo/cfs-community) that includes all the community members/users of the NASA core Flight Software (cFS) product line. The mailing list is used to communicate any information related to the cFS product such as current releases, bug findings and fixes, enhancement requests, community meeting notifications, sending out meeting minutes, etc.
+
+If you wish to report a cybersecurity incident or concern please contact the NASA Security Operations Center either by phone at 1-877-627-2732 or via email address soc@nasa.gov.