Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cFE Integration candidate: 2021-06-01 #1584

Merged
merged 48 commits into from
Jun 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
6de6d24
Fix #1446, Remove unused EVS LogMode defines
pepepr08 May 18, 2021
41dff63
Fix #1554, add doxygen aliases for OSAL parameter/retvals
jphickey May 20, 2021
be1d5d5
Fix #1441, Replace Header Content Type magic number.
zanzaben May 20, 2021
849eed3
Fix #1548, Include verify headers to validate config
skliper May 20, 2021
18152c3
Fix #1507, Document TblName as app specific
skliper May 20, 2021
202c122
Fix #1494, Documentation cleanup in TBL/TIME
skliper May 20, 2021
ee19f18
Fix #1485, Document CFE_ES_PoolCreateEx NumBlockSizes error handling
skliper May 20, 2021
a98d831
Fix #1561, use OSAL script to generate API guide
jphickey May 20, 2021
2e0bc9f
Fix #1561, also remove dox files now in OSAL
jphickey May 20, 2021
6333d25
Fix #1476, Use CFE_MSG_SequenceCount_t for seqcnt type
skliper May 21, 2021
8c84e57
Fix #1455, Add CFE_SB_DestinationD tag and use for pointers
skliper May 21, 2021
4652c0d
Fix #1423, Remove deprecated elements
skliper May 21, 2021
d7c2b24
Fix #1435, Consistent use of uint16 for EventID
skliper May 24, 2021
6ce0230
Fix #1394, Remove shell file subtype and clarify scope
skliper May 25, 2021
b9aa9ca
Fix #1391, EVS/FS documentation cleanup
skliper May 25, 2021
8280c27
Fix #1386, Remove CFE_EVS_Unregister API
skliper May 25, 2021
8128384
Fix #1366, Resolve mismatched endforeach of CMakeList.txt
skliper May 25, 2021
18e4d06
Fix #1390, Improve event filter documentation
skliper May 25, 2021
251267a
Fix #1364, Update ES verify errors to match test
skliper May 25, 2021
ee6c43d
Fix #1569, Remove unused CFE_SB_NO_SUBSCRIBERS
skliper May 24, 2021
d6c0091
Fix #1452, Document cleanup from SB/MSG/SBR review
skliper May 24, 2021
560111c
Fix #1362, Simplify file open/truncate logic
skliper May 26, 2021
13eb53f
Fix #1512, Add Coding Standard Rules in CodeQL
arielswalker May 13, 2021
b7bfaba
Merge pull request #1580 from skliper/fix1364-es_verify_errors
astrogeco May 27, 2021
41d6eaa
Merge pull request #1578 from skliper/fix1366-mismatch_endforeach
astrogeco May 27, 2021
6d8b907
Merge pull request #1579 from skliper/fix1390-event_filter_doc
astrogeco May 27, 2021
de3af04
Merge pull request #1576 from skliper/fix1391-evs_fs_doc_cleanup
astrogeco May 27, 2021
5febad7
Merge pull request #1575 from skliper/fix1394-file_subtype
astrogeco May 27, 2021
2a93eaf
Merge pull request #1582 from skliper/fix1362-open_truncate
astrogeco May 27, 2021
7f08fc3
Merge pull request #1567 from skliper/fix1423-remove_deprecated
astrogeco May 27, 2021
517a18f
Merge pull request #1556 from zanzaben/fix1441_Replace_File_content_m…
astrogeco May 27, 2021
0cab138
Merge pull request #1553 from pepepr08/fix1446-logmode-defines
astrogeco May 27, 2021
786125e
Merge pull request #1570 from skliper/fix1452-sb_msg_sbr_comments
astrogeco May 27, 2021
9a01dcc
Merge pull request #1565 from skliper/fix1455-destination_tag
astrogeco May 27, 2021
b1f36ee
Merge pull request #1564 from skliper/fix1476-sequencecounttype
astrogeco May 27, 2021
efd72a0
Merge pull request #1562 from skliper/fix1485-numblocksize_error_doc
astrogeco May 27, 2021
1344f7f
Merge pull request #1560 from skliper/fix1494-tbltime_doc_cleanup
astrogeco May 27, 2021
3fdecc6
Merge pull request #1558 from skliper/fix1507-tblname_processor_specific
astrogeco May 27, 2021
d71583a
Merge pull request #1563 from jphickey/fix-1561-osal-apiguide
astrogeco May 27, 2021
acea60e
IC:2021-06-01, Remove deprecated doxygen reference
astrogeco May 27, 2021
16196d4
Fix #1585, Fix Calculate CRC header return description.
zanzaben Jun 1, 2021
df3d75f
Merge pull request #1557 from skliper/fix1548-include_verify
astrogeco Jun 2, 2021
41d552c
Merge pull request #1513 from ArielSAdamsNASA/fix-1512-coding-standar…
astrogeco Jun 2, 2021
2d97cb2
Merge pull request #1591 from zanzaben/fix1585_fix_crc_header
astrogeco Jun 2, 2021
00d1a39
Merge pull request #1572 from skliper/fix1435-eventid_type
astrogeco Jun 2, 2021
4a3129c
Merge pull request #1577 from skliper/fix1386-remove_evs_unregister
astrogeco Jun 2, 2021
51ecd53
Merge pull request #1555 from jphickey/fix-1554-doc-tags
jphickey Jun 3, 2021
66378f9
IC:2021-06-01, Bump to v6.8.0-rc1+dev642
astrogeco Jun 8, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 68 additions & 5 deletions .github/workflows/codeql-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,23 @@ env:
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-Build:
CodeQL-Security-Build:
needs: check-for-duplicates
if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }}
runs-on: ubuntu-18.04
timeout-minutes: 15

Expand All @@ -35,20 +50,68 @@ jobs:
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: c
queries: +security-extended, security-and-quality
languages: c
config-file: nasa/cFS/.github/codeql/codeql-security.yml@main

# 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 -C build/native/default_cpu1 core_api core_private es evs fs msg resourceid sb sbr tbl time

- 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:
# 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: cfe

- name: Check versions
run: git submodule

- name: Checkout codeql code
uses: actions/checkout@v2
with:
repository: github/codeql
submodules: true
path: codeql

- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: c
config-file: nasa/cFS/.github/codeql/codeql-coding-standard.yml@main

# 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 -C build/native/default_cpu1 core_api core_private es evs fs msg resourceid sb sbr tbl time
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -122,5 +122,5 @@ prepare()
# Call the process_arch macro for each architecture
foreach(SYSVAR ${TGTSYS_LIST})
process_arch(${SYSVAR})
endforeach(SYSVAR IN LISTS TGTSYS_LIST)
endforeach(SYSVAR ${TGTSYS_LIST})

26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,32 @@ The detailed cFE user's guide can be viewed at <https://github.com/nasa/cFS/blob

## Version History

### Development Build: v6.8.0-rc1+dev642

- Update ES verify errors to match
- Ensures error messages in `cfe_es_verify.h` match test logic.
- Resolve mismatched `endforeach` of `CMakeList.txt`
- Improve event filter documentation
- Adds documentation for the behavior of CFE_EVS_ResetFilter and explains how Event Filter Mask Values work.
- EVS/FS documentation cleanup
- Remove shell file subtype and clarify scope
- Removes CFE_FS_SubType_ES_SHELL and clarifies the scope of CFE_FS_SubType_Enum_t so that it only includes the cFE-defined file types
- Simplify CFE_ES_QueryAllCmd file open logic
- Removes the obsolete OS_OpenCreate and file-remove-on-success logic from `CFE_ES_QueryAllCmd`
- Remove deprecated elements
- Replace Header Content Type magic number
- Remove unused EVS LogMode defines
- Clean up SB, MSG, and SBR documentation and remove unused `CFE_SB_NO_SUBSCRIBERS`
- Add `CFE_SB_DestinationD` tag and use for pointers
- Use `CFE_MSG_SequenceCount_t` for seqcnt type
- Document `CFE_ES_PoolCreateEx` NumBlockSizes error handling
- Documentation cleanup in TBL/TIME
- Document `TblName` as app specific
- Use OSAL script to generate API guide
- Include verify headers to validate config
- Add doxygen aliases for OSAL parameter/retvals
- See <https://github.com/nasa/cFE/pull/1584> and <https://github.com/nasa/cFS/pull/263/>

### Development Build: v6.8.0-rc1+dev593

- Uses `int` with %d conversions inUtAssert_True and UtPrintf for platform portability.
Expand Down
1 change: 0 additions & 1 deletion cmake/Makefile.sample
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,6 @@ usersguide:

osalguide:
$(MAKE) --no-print-directory -C "$(O)" osalguide
@/bin/echo -e "\n\nOsal Users Guide: \nfile://$(CURDIR)/$(O)/doc/osalguide/html/index.html\n"

# Make all the commands that use the build tree depend on a flag file
# that is used to indicate the prep step has been done. This way
Expand Down
5 changes: 5 additions & 0 deletions cmake/cfe-common.doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ ALIASES += "event=\xrefitem cfeevents \"Event Message\" \"cFE Even
"cfetimetlm=\xrefitem cfetimetlm \"Name\" \"cFE Time Services Telemetry\" " \
"cfecmdmnemonic=\xrefitem cfecmdmnems \"Command Mnemonic(s)\" \"cFE Command Mnemonic Cross Reference\" " \
"cfetlmmnemonic=\xrefitem cfetlmmnems \"Telemetry Mnemonic(s)\" \"cFE Telemetry Mnemonic Cross Reference\" "

ALIASES += nonnull="(must not be null)"
ALIASES += nonzero="(must not be zero)"
ALIASES += covtest="(return value only verified in coverage test)"

OPTIMIZE_OUTPUT_FOR_C = YES
#---------------------------------------------------------------------------
# Build related configuration options
Expand Down
23 changes: 8 additions & 15 deletions cmake/mission_build.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,6 @@ function(prepare)
configure_file("${CFE_SOURCE_DIR}/cmake/cfe-common.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/cfe-common.doxyfile")

configure_file("${CFE_SOURCE_DIR}/cmake/osal-common.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/osal-common.doxyfile")

configure_file("${CFE_SOURCE_DIR}/cmake/mission-detaildesign.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/mission-detaildesign.doxyfile")

Expand All @@ -298,18 +295,9 @@ function(prepare)

string(REPLACE ";" " \\\n" MISSION_USERGUIDE_HEADERFILES "${MISSION_USERGUIDE_HEADERFILES}")

# OSAL API GUIDE include PUBLIC API
file(GLOB MISSION_OSAL_HEADERFILES
"${osal_MISSION_DIR}/src/os/inc/*.h"
"${CMAKE_BINARY_DIR}/doc/osconfig-example.h")
string(REPLACE ";" " \\\n" MISSION_OSAL_HEADERFILES "${MISSION_OSAL_HEADERFILES}")

configure_file("${CFE_SOURCE_DIR}/cmake/cfe-usersguide.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/cfe-usersguide.doxyfile")

configure_file("${CFE_SOURCE_DIR}/cmake/osalguide.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/osalguide.doxyfile")

add_custom_target(mission-doc
doxygen mission-detaildesign.doxyfile
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")
Expand All @@ -318,9 +306,14 @@ function(prepare)
doxygen cfe-usersguide.doxyfile
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")

add_custom_target(osalguide
doxygen osalguide.doxyfile
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")
# OSAL API GUIDE include PUBLIC API
set(OSAL_API_INCLUDE_DIRECTORIES
"${osal_MISSION_DIR}/src/os/inc"
"${CMAKE_BINARY_DIR}/doc"
)
add_subdirectory(${osal_MISSION_DIR}/doc/src ${CMAKE_BINARY_DIR}/doc/osalguide)
add_custom_target(osalguide)
add_dependencies(osalguide osal-apiguide)

# Pull in any application-specific mission-scope configuration
# This may include user configuration files such as cfe_mission_cfg.h,
Expand Down
78 changes: 0 additions & 78 deletions cmake/osal-common.doxyfile.in

This file was deleted.

18 changes: 0 additions & 18 deletions cmake/osalguide.doxyfile.in

This file was deleted.

14 changes: 1 addition & 13 deletions docs/cFE Application Developers Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2365,19 +2365,7 @@ consistent style of writing in all messages. One should consult, if
possible, with members of the Flight Operations team and scientists to
find what kind of messages are required and how they should be worded.

## 7.6 Event Service Un-registration

Applications that have registered with the EVS can un-register
themselves. The cFE, however, will automatically un-register an
Application when the Application is terminated. An example of the
function call to perform un-registration from within an Application is
shown below:

```
CFE_EVS_Unregister ();
```

## 7.7 Best Practices for using Event Services
## 7.6 Best Practices for using Event Services

The following are recommended "best practices" for applications using EVS.
1. Event Message IDs should be unique across an application so that an
Expand Down
8 changes: 0 additions & 8 deletions docs/cFE_FunctionalRequirements.csv
Original file line number Diff line number Diff line change
Expand Up @@ -259,14 +259,6 @@ EVS: Register App,cEVS3100,"Upon receipt of Request, the cFE shall register an A
EVS: Register App - Create Filter Counter,cEVS3100.1,"Upon receipt of Request to register an Application for event service, the cFE shall create one Application Binary Filter Counter per registered Event ID.",Supports the cFE's Binary Filtering Algorithm.
EVS: Register App - Create Sent Message Counter,cEVS3100.2,"Upon receipt of Request to register an Application for event service, the cFE shall create an Application Event Message Sent Counter.",Supports the cFE's dynamic Application model.
EVS: Register App - Default Event Enable Status,cEVS3100.3,"Upon receipt of Request to register an Application for event service, the cFE shall use the `<PLATFORM_DEFINED>` Application Event Type Enable Statuses for each event.","By default each platform should have a standard configuration for each event message type (eg. DEBUGs disable. INFO, ERROR and CRITICAL events DISABLED) that should be applied to all events. Commands are available to modify the settings."
EVS: Unregister App,cEVS3101,"Upon receipt of Request, the cFE shall un-register an Application from using event services, deleting the following Application data:

- Application Event Message Sent Counter
- Application Event Service Enable Status
- Application Event Type Enable Statuses (one for each Event Type)
- Application Filtered Event IDs
- Application Binary Filter Masks (one per registered Event ID)
- Application Binary Filter Counters (one per registered Event ID)",Supports the cFE's dynamic Application model allowing applications to clean up after themselves.
EVS: Message Types,cEVS3102,The cFE shall support the following Event Message Types: Debug Informational Error Critical.,Supports cFE event services.
EVS: Create Message,cEVS3103,"Upon receipt of a Request to send an Event Message, the cFE shall create a Short or Long Event Message, as specified by the SB Event Format Mode, ONLY if the following cFE conditions are met:

Expand Down
1 change: 0 additions & 1 deletion docs/src/cfe_api.dox
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@
<LI> \ref CFEAPIEVSReg
<UL>
<LI> #CFE_EVS_Register - \copybrief CFE_EVS_Register
<LI> #CFE_EVS_Unregister - \copybrief CFE_EVS_Unregister
</UL>
<LI> \ref CFEAPIEVSSend
<UL>
Expand Down
Loading