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.

Sign up for GitHub

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

Jump to bottom

Fix #1447, Fix #1438: Event type bitmask derivation and handling improvements #2613

Open

thnkslprpt wants to merge 1 commit into nasa:main from thnkslprpt:fix-1447-derive-event-type-bitmasks-from-enum-definitions

Contributor

thnkslprpt commented Oct 13, 2024 •

edited

Loading

Checklist

I reviewed the Contributing Guide.
I signed and emailed the appropriate Contributor License Agreement to GSFC-SoftwareRelease@mail.nasa.gov and copied cfs-program@lists.nasa.gov.

Describe the contribution

Fixes Both enums (index) and defines (mask) exist for event type #1447
- Note: the CFE_EVS_EventOutput_Enum_t labels (CFE_EVS_EventOutput_PORT1 etc.) are not actually used - so could potentially just be completely removed.

Edit: Ended up combining with the fix for this one, given that the changes are related:

Simplify handling/checking of event type in commands and use a defined mask #1438
- Centralize bitmask range-checking to a single location and send the error event there (this reduces the range-check duplication and call to EVS_SendEvent() from 6 down to 1).
- Replace magic-number max in bitmask range-check (0x0F) with a new macro CFE_EVS_ALL_EVENT_TYPES_MASK

Testing performed
GitHub CI actions all passing successfully (incl. Build + Run, Unit/Functional Tests etc.).

Expected behavior changes
Logic unchanged.
Will make it impossible for these to get out-of-sync in the future.

System(s) tested on
Debian 12 using the current main branch of cFS bundle.

Contributor Info
Avi Weiss @thnkslprpt

thnkslprpt force-pushed the fix-1447-derive-event-type-bitmasks-from-enum-definitions branch 3 times, most recently from 8dbbd0b to ed52649 Compare

October 13, 2024 10:20

github-advanced-security bot found potential problems

View reviewed changes

modules/evs/fsw/src/cfe_evs_task.c

    
                  /* Need to check for an out of range bitmask, since oue bit masks are only 4 bits */

                  if (CmdPtr->BitMask == 0x0 || CmdPtr->BitMask > 0x0F)

                  if (EVS_IsInvalidBitMask(CmdPtr->BitMask, CFE_EVS_ENABLE_PORTS_CC))

Check warning

Code scanning / CodeQL

Side effect in a Boolean expression Warning

This Boolean expression is not side-effect free.

modules/evs/fsw/src/cfe_evs_task.c

    
                  /* Need to check for an out of range bitmask, since oue bit masks are only 4 bits */

                  if (CmdPtr->BitMask == 0x0 || CmdPtr->BitMask > 0x0F)

                  if (EVS_IsInvalidBitMask(CmdPtr->BitMask, CFE_EVS_DISABLE_PORTS_CC))

Check warning

Code scanning / CodeQL

Side effect in a Boolean expression Warning

This Boolean expression is not side-effect free.

modules/evs/fsw/src/cfe_evs_task.c

    
                  EVS_AppData_t *                     AppDataPtr;

                  /* Need to check for an out of range bitmask, since our bit masks are only 4 bits */

                  if (CmdPtr->BitMask == 0x0 || CmdPtr->BitMask > 0x0F)

                  if (EVS_IsInvalidBitMask(CmdPtr->BitMask, CFE_EVS_ENABLE_EVENT_TYPE_CC))

Check warning

Code scanning / CodeQL

Side effect in a Boolean expression Warning

This Boolean expression is not side-effect free.

modules/evs/fsw/src/cfe_evs_task.c

    
                  /* Need to check for an out of range bitmask, since our bit masks are only 4 bits */

                  if (CmdPtr->BitMask == 0x0 || CmdPtr->BitMask > 0x0F)

                  if (EVS_IsInvalidBitMask(CmdPtr->BitMask, CFE_EVS_DISABLE_EVENT_TYPE_CC))

Check warning

Code scanning / CodeQL

Side effect in a Boolean expression Warning

This Boolean expression is not side-effect free.

modules/evs/fsw/src/cfe_evs_task.c

    
            @@ -676,11 +656,8 @@
          
                  if (Status == CFE_SUCCESS)

                  {

                      /* Need to check for an out of range bitmask, since our bit masks are only 4 bits */

                      if (CmdPtr->BitMask == 0x0 || CmdPtr->BitMask > 0x0F)

                      if (EVS_IsInvalidBitMask(CmdPtr->BitMask, CFE_EVS_ENABLE_APP_EVENT_TYPE_CC))

Check warning

Code scanning / CodeQL

Side effect in a Boolean expression Warning

This Boolean expression is not side-effect free.

modules/evs/fsw/src/cfe_evs_task.c

    
            @@ -738,11 +715,8 @@
          
                  if (Status == CFE_SUCCESS)

                  {

                      /* Need to check for an out of range bitmask, since our bit masks are only 4 bits */

                      if (CmdPtr->BitMask == 0x0 || CmdPtr->BitMask > 0x0F)

                      if (EVS_IsInvalidBitMask(CmdPtr->BitMask, CFE_EVS_DISABLE_APP_EVENT_TYPE_CC))

Check warning

Code scanning / CodeQL

Side effect in a Boolean expression Warning

This Boolean expression is not side-effect free.


          Fix nasa#1447, Fix nasa#1438: Event type bitmask derivation and handl…

0b1fe43

…ing improvements

thnkslprpt force-pushed the fix-1447-derive-event-type-bitmasks-from-enum-definitions branch from ed52649 to 0b1fe43 Compare

October 13, 2024 11:35

thnkslprpt changed the title ~~Fix #1447, Derive event type bitmasks directly from enum definitions~~ Fix #1447, Fix #1438: Event type bitmask derivation and handling improvements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet