Unclaimed project
Are you a maintainer of fprime? Claim this project to take control of your public changelog and roadmap.
dictionary specifiersFw::MemAllocatorUsers with custom config in their project need to understand these changes:
FpConfig.h Break-UpMany FpConfig.h's constants were needed in the model and have been moved into .fpp model files FpConfig.fpp, FpConstants.fpp, and PlatformCfg.fpp.
[!WARNING] Users shipping custom
FpConfig.has ofv4.0.0must update to these new files.
config/MemoryAllocation.hppconfig/ActiveTextLoggerCfg.hppconfig/FileManagerConfig.hppconfig/PassiveTextLoggerCfg.hppconfig/MemoryAllocation.hppWe've added configuration for a new default memory allocator. This is used by clients of Fw::MemAllocatorRegistry calling getAnAllocator() when no appropriate allocator has been defined.
config/MemoryAllocation.hpp
+using DefaultMemoryAllocatorType = Fw::MallocAllocator;
Users wanting a different default (other than MallocAllocator) should override this definition.
config/ActiveTextLoggerCfg.hpp and config/PassiveTextLoggerCfg.hppThese files control the number of filter slots for these componnets.
config/FileManagerConfig.hppStandard projects should update to the following changes:
LinuxTimer has been updated to tak Fw::TimeInterval(seconds, microseconds); instead of an integer number of milliseconds.
- linuxTimer.startTimer(milliseconds);
+ Fw::TimeInterval(milliseconds/1000, (milliseconds % 1000) * 1000);
+ linuxTimer.startTimer(interval);
Queued and Active components now have a deinit() function used to clean-up memory/resource allocation. Unit Tests run under leak checking will produce memory leak warnings. To fix this, add this->component.deinit() to the Tester destructor.
- ComponentTester::~ComponentTester() {}
+ ComponentTester::~ComponentTester() {
+ this->component.deinit();
+ }
Developers shipping custom OSAL implementations must update to meet these interface changes:
Os::QueueInterface ChangesThe Os::QueueInterface has had three changes that implementers must update to support.
StringBase has been changed to ConstStringBase in the create methodid via the create method for use in potential allocationteardown method for use in resource clean-upOs::QueueInterface implementers should update to support both of these changes.
-QueueInterface::Status create(const Fw::StringBase& name, FwSizeType depth, FwSizeType messageSize);
+QueueInterface::Status create(FwEnumStoreType id, const Fw::ConstStringBase& name, FwSizeType depth, FwSizeType messageSize);
+ void teardown();
Implementers of driver interfaces found in Drv/Interfaces should meet these following changes:
The former SPI interface did not support returning a status, which meant that the calling component was blind to problems arising within SPI. The interface now specifies a new WriteRead port that includes a status. Implementers of SPI components must add this port to their components.
//! Handler implementation for SpiWriteRead
//!
SpiStatus SpiWriteRead_handler(const FwIndexType portNum, /*!< The port number*/
Fw::Buffer& WriteBuffer,
Fw::Buffer& readBuffer);
We recommend deprecating the old void function as well.
There are a few changes to misc interfaces in F Prime. Developers to those interfaces must update:
Fw::MemAllocator Requires AlignmentDevelopers of custom Fw::MemAllocator objects must now support the alignment parameter. Alignment communicates the minimum Byte alignment for the object being allocated. Returned void* allocations must guarantee this alignment.
-void* allocate(const FwEnumStoreType identifier, FwSizeType& size, bool& recoverable);
+void* allocate(const FwEnumStoreType identifier, FwSizeType& size, bool& recoverable, FwSizeType alignment);
F Prime now supports a mode flag to serialization that communicates the desired endianness. This was done to better support external libraries, technologies, and products that use little endian format. Hand-coded serializables should update to accept this new parameter.
This affects both the serializeTo and deserializeFrom function.
-Fw::SerializeStatus Buffer::serializeTo(Fw::SerializeBufferBase& buffer) const;
+Fw::SerializeStatus serializeTo(Fw::SerialBufferBase& buffer, Fw::Endianness mode) const;
-Fw::SerializeStatus Buffer::deserializeFrom(Fw::SerializeBufferBase& buffer);
+Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase& buffer, Fw::Endianness mode);
There are several optional changes. Users should consider these changes.
Subtopology and Ref priorities have been updated to better reflect Linux priority space. Users should consider their own priorities and ajust accordingly.
serialize and deserialize Deprecatedserialize and deserialize methods were renamed in v4.0.0 to serializeTo, serializeFrom, deserializeTo, and deserializeFrom. We have now DEPRECATED these serialize and deserialize functions. Users should update as these will now produce compiler warnings and will be removed in future releases.
dictionary SpecifiersFPP now supports the dictionary specifier, allowing developers to annotate model elements for inclusion in generated JSON dictionaries. This feature allows developers to extend flight/ground tooling.
F´ introduces unified configuration between flight and ground (fprime-gds). This significantly reduces duplication, improves consistency, and centralizes configuration.
Fw::MemAllocatorFw::MemAllocator now supports aligned allocation, allowing components and platform adapters to request memory with specific alignment boundaries.
A new throttling policy allows events to be rate-limited over a configurable time window. Rather than suppressing events indefinitely, the system now restores visibility after the throttle period elapses.
F´ adds explicit support for little-endian serialization paths. This allows users to leverage F Prime serialization for external interfaces.
The framework, libraries, and autocoders now require and fully support C++14. This enables safer and more expressive language features for more reliable software.
Svc::PrmDb now supports loading parameters from a secondary file.
AssertFatalAdapter by @kyleajones in https://github.com/nasa/fprime/pull/4042Checks is supposed to be a comma separated list by @Saransh-cpp in https://github.com/nasa/fprime/pull/4379Full Changelog: https://github.com/nasa/fprime/compare/v4.0.0...v4.1.0