Merge pull request nasa#1521 from nasa/draco-integration

Open Source Draco Release

Author: dzbaker

.github/actions/check-coverage/action.yml

@@ -27,7 +27,6 @@ runs:
       shell: bash
       run: lcov
         --capture --rc lcov_branch_coverage=1
-        --include '${{ github.workspace }}/*'
         --directory '${{ inputs.binary-dir }}'
         --output-file '${{ inputs.binary-dir }}/coverage.info' |
         tee '${{ inputs.binary-dir }}/lcov_out.txt'

.github/workflows/build-osal-documentation.yml

@@ -2,7 +2,15 @@ name: "Build OSAL Documentation (API Guide)"
 
 on:
   push:
+    branches:
+      - dev
+      - main
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+  workflow_dispatch:
 
 jobs:
 

.github/workflows/codeql-cfe-build.yml

@@ -2,12 +2,20 @@ name: "CodeQL cFE Build Analysis"
 
 on:
   push:
+    branches:
+      - dev
+      - main
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+  workflow_dispatch:
 
 jobs:
   codeql:
     name: CodeQl Analysis
     uses: nasa/cFS/.github/workflows/codeql-reusable.yml@main
-    with: 
+    with:
       component-path: osal
       make: 'make -C build/native/default_cpu1/osal'

.github/workflows/codeql-osal-default.yml

@@ -2,13 +2,21 @@ name: "CodeQL Analysis OSAL Default Build"
 
 on:
   push:
+    branches:
+      - dev
+      - main
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+  workflow_dispatch:
 
 jobs:
   codeql:
     name: CodeQl Analysis
     uses: nasa/cFS/.github/workflows/codeql-reusable.yml@main
-    with: 
+    with:
       component-path: cFS  # Causes reusable workflow to not checkout bundle
       setup: 'cp Makefile.sample Makefile'
       prep: 'make prep'

.github/workflows/format-check.yml

@@ -2,8 +2,11 @@ name: Format Check
 
 # Run on all push and pull requests
 on:
-  push:
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
 
 jobs:
   format-check:

.github/workflows/standalone-build.yml

@@ -1,16 +1,24 @@
 name: Build and Test Standalone OSAL package
 
 on:
-  workflow_dispatch:
+  push:
+    branches:
+      - dev
+      - main
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+  workflow_dispatch:
 
 defaults:
   run:
     shell: bash
 
 env:
   allowed_ncov_lines: 0
-  allowed_ncov_branches: 2
+  allowed_ncov_branches: 0
   allowed_ncov_functions: 0
 
 jobs:

.github/workflows/static-analysis.yml

@@ -3,13 +3,20 @@ name: Static Analysis
 # Run on all push and pull requests
 on:
   push:
+    branches:
+      - dev
+      - main
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
   workflow_dispatch:
 
 jobs:
   static-analysis:
     name: Run Static Analysis
     uses: nasa/cFS/.github/workflows/static-analysis.yml@main
-    with: 
+    with:
       strict-dir-list: './src/bsp ./src/os'
       cmake-project-options: -DENABLE_UNIT_TESTS=TRUE -DOSAL_OMIT_DEPRECATED=TRUE -DOSAL_SYSTEM_BSPTYPE=generic-linux

.gitignore

@@ -1,2 +1,13 @@
 build
 Makefile
+
+# Ignore macOS generated files types
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+.fuse_hidden*
+

CMakeLists.txt

@@ -88,7 +88,7 @@
 # OSAL resources.
 #
 ######################################################################
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 # Set the policy dictating use of target_link_libraries across directories
 # Either OLD or NEW should work here but setting it to something avoids a
@@ -355,6 +355,7 @@ set(OSAL_SRCLIST
     src/os/shared/src/osapi-network.c
     src/os/shared/src/osapi-printf.c
     src/os/shared/src/osapi-queue.c
+    src/os/shared/src/osapi-rwlock.c
     src/os/shared/src/osapi-select.c
     src/os/shared/src/osapi-shell.c
     src/os/shared/src/osapi-sockets.c
@@ -370,7 +371,6 @@ if (OSAL_CONFIG_DEBUG_PRINTF)
     )
 endif (OSAL_CONFIG_DEBUG_PRINTF)
 
-
 # Define the external "osal" static library target
 # This is a combination of the generic parts with the low level
 # system-specific parts
@@ -419,7 +419,7 @@ if (ENABLE_UNIT_TESTS)
       target_link_libraries(${TGTNAME} PUBLIC ut_assert osal)
       add_test(${TGTNAME} ${TGTNAME})
       foreach(TGT ${INSTALL_TARGET_LIST})
-        install(TARGETS ${TGTNAME} DESTINATION ${TGT}/${UT_INSTALL_SUBDIR})
+        install(TARGETS ${TGTNAME} DESTINATION ${TGT})
       endforeach()
 
     endfunction(add_osal_ut_exe)

default_config.cmake

@@ -206,6 +206,33 @@ set(OSAL_CONFIG_CONSOLE_ASYNC                   TRUE
     CACHE BOOL "Controls spawning of a separate utility task for OS_printf"
 )
 
+#
+# OS_CONFIG_RWLOCK
+# ----------------------------------
+#
+# Controls whether the readers-writer lock object is included in the compilation
+# process of the OSAL.
+#
+# If set FALSE, the relevant source and header files will be excluded in the compilation
+# of OSAL, such that the object is still registered with the Object ID system
+# but its associated functions won't be defined or declared.
+#
+# If set TRUE, the relevant source and header files will be included in the compilation
+# of OSAL, and all it's associated functions will be callable.
+#
+# When this is TRUE (default), it gives the ability to create a readers-writer lock as
+# an alternative to synchronization with mutexes for data structures that are read-heavy.
+# It allows for either an infinite number of readers to be accessing a data structure or 
+# a single writer.
+#
+# This option is available since some platforms may not support readers-writer locks, so
+# any use of a readers-writer lock should also create an implementation using solely 
+# mutexes.
+#
+set(OSAL_CONFIG_RWLOCK                          TRUE
+    CACHE BOOL "Controls the inclusion of readers-writer lock objects in the code"
+)
+
 #############################################
 # Resource Limits for the OS API
 #############################################
@@ -238,6 +265,11 @@ set(OSAL_CONFIG_MAX_MUTEXES             20
     CACHE STRING "Maximum Number of Mutexes to support"
 )
 
+# The maximum number of rwlocks to support
+set(OSAL_CONFIG_MAX_RWLOCKS             20
+    CACHE STRING "Maximum Number of RwLocks to support"
+)
+
 # The maximum number of condition variables to support
 set(OSAL_CONFIG_MAX_CONDVARS             4
     CACHE STRING "Maximum Number of Condition Variables to support"