Travis-CI:

This repository contains NASA's Core Flight Executive (cFE), which is a framework component of the Core Flight System.

This is a collection of services and associated framework to be located in the cfe subdirectory of a cFS Mission Tree. The Core Flight System is bundled at https://github.com/nasa/cFS, which includes build and execution instructions.

The detailed cFE user's guide can be viewed at https://github.com/nasa/cFS/blob/gh-pages/cFE_Users_Guide.pdf.

• Replace OS_FileSysStatVolume() withOS_fsBlocksFree() which will be deprecated. This call reports the number of total blocks, not just the free blocks, making the check more accurate and removing the need for a workaround for desktop machines.
• Instead of accessing OS_time_t values directly, use the OSAL-provided conversion and access methods. This provides independence and abstraction from the specific OS_time_t definition and allows OSAL to transition to a 64 bit value.
• Removes the spurious CFE_SB_TimeOut_t typedef from cfe_sb.h. May affect any apps that inappropriately rely on the private typedef.
• Removes unused network_includes.h. Not used by the framework anywhere, apps should use OSAL Socket APIs instead.
• Fixes deprecation directive typos
• See #1088

• Resolved doxygen warnings for osalguide and updated header file references
• Corrects the documentation for the CFE_SB_GetPipeName() unit test stub function.
• Adds a new github actions workflow file to run cppcheck
• See #1066

• Remove use of osapi-os-loader.h from ES UT.
• Use volatile sig_atomic_t for system state to avoid race issue if uint32 isn't atomic on a system
• Set the flags parameter on the OS_ModuleLoad() properly to allow an app to be properly unloaded, which in turn allows the reload command to work as expected. Fixes problem where unload comand resulted in continuous restarting of the same app code.
• Replaced Test_MSG_PrintMsg with UT_DisplayPkt. Also removed unused Test_MSG_Sum.
• See #1047

• Adds CFE_SB_TransmitMsg, CFE_SB_TransmitBuffer, CFE_SB_ReceiveBuffer
  • Main change is to utilize CFE_SB_Buffer_t and CFE_MSG_Message_t in a consistent manner to facilitate alignment
  • Deprecates multiple CFE_SB_* items
  • Redefines CFE_MSG_Size_t as size_t to minimize duplicated work and facilitate transition to size_t
• Use a generic void* as the interface type for the pool buffer pointers. This reduces the need for local type casting in the apps and makes it generally easier to use.
• Remove reference to CEXP in RTEMS 4.11 i686 toolchain. Add an RTEMS 5.1 i686 toolchain file.
• See #1045

• Backward compatible API change. Replace many uses of generic uint16 and uint32 with a more purpose-specific type. Replace all sizes with size_t across the API.
• Rename UT_SetForceFail to UT_SetDefaultReturnValue since some functions that retain more than 1 value are not necessarily failing
• Deprecates many SB Elements and replaces them with the new MSG module. See #777 for list.
• App and Lib info telemetry structures no longer contain the ModuleId value from OSAL.
• Add an extra write of a null char after strncpy which squelches a warning and appease compiler warning logic.
• Uses CFE_PLATFORM_ES_DEFAULT_STACK_SIZE as a default instead of a minimum. Affects the Start App command; if stack size is specified as zero, then the default stack size value from platform config is used. Otherwise the value in the command will be passed through and used as-is.
• Changes the type of the AppID parameter on "Cleanup" routines from uint32 to CFE_ES_ResourceID_t.
• See #1027

• Adds macros for more compact calls to CFE_EVS_SendEvent, making the type be part of the function name.
• The sample configs leap seconds default value is now up to date. (As of Oct 2020)
• Removed the clear=false logic (and clear parameter) CFE_MSG_Init() now always zeroes entire message and sets defaults.
• Adds flags parameter to calls to OS_ModuleLoad(). Initially just pass 0 (GLOBAL) to maintain old behavior.
• Updates CFE_ES_RegisterCDSEx stub to match current signature
• Includes cfe_private.h for stubs that implement related elements.
• See #1008

• Keeps task names under 16 chars to make more debugger friendly, regardless of the OSAL limit. Task name shows up as ES_BG_TASK
• Move ES typedefs shared across API and telemetry messages into the cfe_es_extern_typedefs.h.
• Move all ES typedefs that define the telemetry interface and structures that define the output of commands that write data files into this group (query all apps, query all tasks, query all CDS).
• Remove some localized definitions and replace with MISSION scope definitions where appropriate/necessary.
• Adjust strncpy() call to avoid compiler warning
• Cast fixed width types to the type used in the printf call. Removes printf type warnings on the 32-bit RTEMS build.
• See #991

• Provide new Library API similar to App API
• Allows the existing CFE_ES_AppInfo_t structure to be extended to libraries as well as applications by introducing a new value (3) for the Type field.
• Allows Libraries to be queried via API calls similar to App API.
• Extends the Query All/Query One commands to operate on Libraries or Applications.
• Breaks up the monolithic AppCreate and LoadLibrary functions and have these call subroutines that operate on the common components.
• Fix race conditions in app request processing state machine.
• Adds SBR module which includes message map and routing table. The access APIs are on the SB side which still owns the destination logic
• Removes passing of route index or pointers being. Everything is now based on route and message id
• Oversized the hash message map (4x) to minimize collisions
• Hash designed for 32 bit, a change in CFE_SB_MsgId_Atom_t size may require implementation updates
• Adds debug event for collisions during add
• Dropped routing push/pop, dropped "key" in direct implementation
• Deletes unused code CFE_SB_FindGlobalMsgIdCnt
• Fixes variable declaration violations of coding standard
• Individual events for deleting destinations when deleting a pipe removed to avoid a race condition around a 10-20% performance hit to hash via rough comparison on a linux box, no memory impact
• See #975

• For all resource types which have names, IDs are not re-issued after deletion, helping ensure safety as previously deleted IDs will not validate. Provides a consistent Name-ID translation API for all resource types. Enforces consistent argument/name validation on all resource types, and also enforces name uniqueness where relevant.
• Enhancement to use the full 16 bits of resource ID space, which avoids repeating ID values that have already been used. This significantly decreases the likelihood that a previously deleted ID will alias a newly allocated/valid ID.
• See #959

• Rather than having a second pool implementation only for CDS, use the generic pool implementation. This also uses the abstract resource identifiers to identify CDS blocks, rather than a direct reference.
• Add the system-specific module suffix (.o, .so, .obj, etc) and the default CFE core executable name to the configdata structure.
• See #944

• Adds the field UnregAppID to track whether an "unregistered" event was generated, un-overloading the EventCount field to serve its primary purpose of counting actual events generated from a valid/registered AppID.
• Move the AppID lookup execution to be early in the CFE_SB_SendMsgFull implementation. This avoids double locking between SB+ES and avoids a block-scope local variable.
• Instead of identifying a memory pool by its memory address, use a resource ID. IDs are a constant size, regardless of whether the host machine is 32 or 64 bits.
  • IDs can be put into commands/telemetry and maintain a more consistent format with consistent alignment requirements.
  • IDs can be independently verified without dereferencing memory. Previously the only way to validate a memory pool was to read the address pointed to, which results in a segfault if the address was bad.
• Change from OS_MAX* defines to appropriately-scoped CFE defines for array sizing
• This creates the new CFE_Status_t typedef for function's return status codes. Also adds a note to CFE_TBL_GetStatus since its behavior will likely change in the future in the hopes of not having a non-zero "info" status.
• See #936

• Add a new typedef CFE_ES_ResourceID_t that can replace uint32 for all ID storage and manipulation. Initially this is just an alias to uint32 for backward compatibility.
• See #916

• Removes dependency on CCSDS version define.

• Removes old name and id defines.

• CFE_ES_CalculateCRC default stub behavior.

• Replaces calls to OS_open and OS_creat

• Replaces UT_Text with UtPrintf

• Updates variable checks in read_targetconfig

• See #912

• Sets Revision to 99 for development build.
• Installs unit test to target directory.
• Returns processor ID to default to unbreak toolchain
• Applies the appid/taskid/counterid pattern to Library resources.
• See #891

• Deconflict CFE_ES_LIB_ALREADY_LOADED and CFE_ES_ERR_SYS_LOG_TRUNCATED EIDs
• Scrub all CFE references/uses of OSAL IDs to use the proper osal_id_t type. Any place that an OSAL ID is stored in memory or passed in an API call are changed to the osal_id_t type, rather than uint32. Conversions between this and other types (e.g. bare integer) is done using the OSAL-supplied conversion helpers.
• After the changes implemented in #101, there may be routing table entries with no subscribers (RoutePtr->ListHeadPtr would be NULL.) This could cause a seg-fault. Also, even if there are entries in the routing table, there will be no event generated if the unsubscribe does not find a matching route entry.
• Adds debug message.
• Applies the appid/taskid pattern to Generic Counter resources.
• Adds test for SB subscribe/unusubscribe/unsubscribe.
• See #876

• In the next major CFE release, this code will be no longer supported at all. It should be removed early in the cycle to avoid needing to maintain this compatibility code.
• The CFE_ES_FindCDSInRegistry function had an unusual loop control structure with mixed types of signed and unsigned. This has the possibility of being infinite if the MaxNumRegEntries is zero due to the way the end condition is structured. Simplify to be like other loops and use unsigned int control variable.
• Fixes the cast-align error (use the aligned Msg since it's available already).
• HOTFIX-20200902 - Fix sb unit test setup issue.
• HOTFIX 20200902 - Update documentation links for deprecated symbols.
• HOTFIX 20200902 - Fix SB Test_CleanupApp_API AppID.
• See #861

• Removes reference from documentation.
• CFE_SB_SendMsg stub now behaves the same as CFE_SB_TimeStampMsg (copies message pointer from local). No longer need to emulate CFE_SB_InitMsg from test code, set the API/stub data buffers directly.
• Removed iterator modification from within the loop... replaced with break.
• Resolves loop iterator size too small for comparison.
• Replaced CFE_MISSION_SPACECRAFT_ID use with CFE_PSP_GetSpacecraftId() and updated unit test
• See #849

• Add msg stubs, update SB_UT to use them, and remove msg module include from unit tests
• Collapses time options down to just 32 bit second, 16 bit subsecond, always big endian. Removes old defines, and triggers an error if the configuration is set to a format that was removed.
• Enables source selection and out-of-tree mission-defined overrides in the msg directory
• Unit tests added from within unit tests will not execute, replaced this pattern with direct calls to the main subtest setup routine.
• See #833

• Deprecates CFE_SB_GetLastSenderId() API by introducing new CFE_OMIT_DEPRECATED_6_8 tag
• Documentation update remove deleted requiremements
• Add a new cfe_assert module for functional testing by making it possible to load the UT assert object code as a CFE library. These are compiled as separate, independent modules and only loaded on demand. Also includes a draft example for cFE testing, which calls some basic ES AppId functions.
• See #816

• Add missing include path to the target/h and wrn/coreip directory. Set and clarify difference between WIND_HOME and WIND_BASE variables. Remove unrelated comment about CEXP (remnant from RTEMS). No more errors about missing headers.
• Version reporting is does not span multiple lines.
• See #792

• Update CFE_SB_TimeStampMsg to save the message pointer argument UT_Stub_CopyFromLocal so that unit tests can check it
• Only affects build system. Fully backward compatible. The defaults are applied if a user has nothing specifically configured in their targets.cmake. The defaults will select osal, cfe-core, and psp as before. The user now has the option to explicitly configure and control the inclusion of these modules and also provide mission-specific search paths to override them as desired.
• Note this only affects UT stubs. Change the internal names of some stub arguments to match prototype. Ensure that:
  • All functions in the CFE public API have a stub function implemented
  • All parameters to the stub function are registered in the context object, so the values will be available to hook functions.
  • The names of all parameters match the prototype/documentation, so hook functions that use name-based argument value retrieval will work.
• Adds to table search path in arch_build.cmake
• Calls to OS_open() now use the OSAL-defined symbol, not the POSIX symbol.
• Defines new macros to report the build number and build baseline and new strings containing the version number of cFE and a combined string with the version number for OSAL, PSP, and CFE.
• Allow explicitly setting of the processor ID in targets.cmake. The TGTx_PROCESSOR_ID setting will be passed to the final build/link of CFE core as the CPU ID. If unspecified, then the CMake index value is used instead (backward compatible).
• cmake now detects conditions where no files were present to fulfill an config include file requirement and reports an error during make prep lists the files it checked for rather than generating an empty file.
• See #765

• If a string is exactly the size of the field when using the CFE_TBL_FILEDEF() macro it will produce a compiler error
• Added cFE User's Guide Reference to README.md
• Removes old license
• See #743

• SB Unit use of the UT assert framework is closer to original design intent
• See #743

• API Change: cFE ut_sb_stubs now has CFE_SB_DeletePipe available. Behavior Change: App unit tests requiring this will not fail to build due to undefined reference to CFE_SB_DeletePipe
• Hook functions may now use the va_list form and obtain the full set of variable arguments passed to CFE_EVS_SendEvent and variants.
• Replace all direct references to data types defined in ccsds.h with the abstract type defined in cfe_sb.h.
• See #729 for details.

• Using ut stubs CFE_EVS_SendEvent and CFE_ES_WriteToSysLog, the register buffer will have the correct size. access to register buffer element will exist
• Both the main task and the child task(s) are successfully deleted and restarted after the exception occurs.
• Fixes doxygen warnings for the tbl subsystem.
• No compiler warnings or errors on cross build.
• Changes Message Key from uint16 to uint32 to avoid rollover and system hang
• See #712 for more details

• No longer automatically decompresses apps/libraries as part of load
• Deletes now unused CFE_ES_CountObjectCallback and CFE_ES_ListResourcesDebug. Flags were unused
• Removes all conditional preprocessing blocks related to CFE_ARINC653.
• Ensure clean build, no warnings on string operations using GCC 9.3.0.
• When OMIT_DEPRECATED = true attempt to send output to shell command will result in command error counter increment (unrecognized function code)
• SBN will need to init command with new MID
• Documentation links and references will now work properly
• API CFE_ES_ProcessCoreException is removed, replaced with async event.
• Removed duplicate prototype in cfe_time_utils.h
• Removes unused defines and adds documentation to TBL event defines.
• Deprecates CFE_TIME_CFE2FSSeconds and CFE_TIME_FS2CFESeconds.
• Unit tests now build and run when MESSAGE_FORMAT_IS_CCSDS_VER_2 is configured.
• Build now works with both extended headers and OMIT_DEPRECATED options set.
• No more alignment warnings
• Adds new unit test macros
• See #692 for more details

• Users must now select OSAL options via the CMake file in their defs directory, rather than the osconfig.h file.
• See #672 for more details

• Upon power on reset, default system log mode set to overwrite. Upon processor reset, default system log mode set to discard.
• No longer locks while locked (no issue observed on linux/posix, but user reported issue on FreeRTOS 10)
• Internal CFE_TBL_LoadFromFile() API changed slightly to add AppName as a parameter. Return value from LoadFromFile() no longer relevant for event generation.
• Updates CFE_TBL_CleanUpApp such that it now checks the 'used flag' prior to calling CFE_TBL_RemoveAccessLink for a given TblHandle. Also sets the AppId to CFE_TBL_NOT_OWNED after removing the access descriptor link from linked list.
• Removed OS_FS_SUCCESS, OS_FS_ERROR , OS_FS_ERR_INVALID_POINTER, OS_FS_ERR_NO_FREE_FDS , OS_FS_ERR_INVALID_FD, and OS_FS_UNIMPLEMENTED from osapi-os-filesys.h
• See #649 for more details

• Exposes the CFE_SB_IsValidMsgId() for application usage.
• CFE_SB_GetLastSenderID will now detect if it is being called prior to a message being sent on a given pipe.
• Mismatches between PSP/BSP/OS are now detected and warned about during make prep. Only the CFE_SYSTEM_PSPNAME is actually required to be specified for a CFE build now. Others can be omitted.
• See #635 for more details

• RTEMS builds without error.
• Use the INTERFACE_COMPILE_DEFINITIONS and INTERFACE_INCLUDE_DIRECTORIES properties from the osal target and apply them to the entire CFE build as a directory-scope property. No impact until these are set in OSAL.
• Minor other updates (see #615)

• Cmd code (and checksum) are always in the same place (matches GSFC spec for command secondary header)
• No impact to behavior. Previously the perf log dump file frequently contained errors due to out of order or otherwise corrupted entries, which is now fixed.
• Minor other updates (see #586)

• Improve documentation
• Update makefile to report branch coverage
• Minor other updates (see #566)

• Fix potential unit test problems with name collisions
• Improve documentation
• Minor other updates (see #563)

• No longer requires sed "hack" to change the setting in default_config.h
• Minor other updates (see #544)

• Updates and cleaned up documentation and requirements
• Fixes incorrect debug messages
• Decrease child task count when one is deleted
• Minor other updates (see #530)

• Adds a new function, CFE_SB_GetPipeIdByName, which retrieves the pipe ID given a name of a pipe.
• Improvement in error reporting when using a pipe name that is already in use, or when the queue limit has been reached.
• Added userguide and osalguide to the local target list to avoid makefile warning
• Minor other updates (see #511)

• Adds OMIT_DEPRECATED prep flag
• Adds and enforces strict warnings
• Software Bus now increments sequence counter even if there are no subscribers
• Warning, comment, and code coverage cleanup (see #490)

• Added CI static analysis check
• Resolved static analysis warnings
• Minor other updates (see #479)

• Minor updates (see #448)

• Minor updates (see #413)

• Minor bugs and enhancements (see #388)

• Fix strlen in CFE_ES_TaskInit #23
• Minor bug fixes (see #378)

• This is a point release from an internal repository
• Changes are detailed in cFS repo release documentation
• Apache 2.0

• This is a point release from an internal repository
• Apache 2.0
• Additional release notes are found in release notes
• See the version description document for the full document
• Test results can be found in test results

See all open issues and closed to milestones later than this version.

For best results, submit issues:questions or issues:help wanted requests at https://github.com/nasa/cFS.

Official cFS page: http:https://cfs.gsfc.nasa.gov