Skip to content

(De)Serialization clean up of temporary workarounds #3971

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

Merged
merged 22 commits into from
Aug 6, 2025
Merged

(De)Serialization clean up of temporary workarounds #3971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
cc3971b
Staging DEPRECATE changes in preparation for new FPP alpha. Removed b…
vincewoo Aug 1, 2025
fbf2415
Remove declaration of serialize and deserialize from RawTime as those…
vincewoo Aug 1, 2025
b72aa95
Merge branch 'devel' into FP-3944
vincewoo Aug 1, 2025
50e63d2
Removing FW_SERIALIZE_UNIMPLEMENTED and FW_DESERIALIZE_UNIMPLEMENTED …
vincewoo Aug 1, 2025
c1f32a3
Removing superfluous comma
vincewoo Aug 1, 2025
6f3fb0f
Missed AmpcsEvrLogPacket. Fixing a minor whitespace issue in Serializ…
vincewoo Aug 1, 2025
0097e7d
Un-deprecating serialize/deserialize for this release
vincewoo Aug 1, 2025
286d638
Restoring DEPRECATED for the noLength functions
vincewoo Aug 1, 2025
0bf050b
Merge branch 'devel' into FP-3944
vincewoo Aug 4, 2025
cca2976
Pulling in fpp 3.0.0a17. Fixing some lingering issues with refactoring.
vincewoo Aug 4, 2025
68dd73c
Format files
thomas-bc Aug 4, 2025
8cf22f0
Update fprime-fpp package
thomas-bc Aug 4, 2025
38c4702
Merge branch 'devel' into FP-3944
vincewoo Aug 5, 2025
c686be0
Fixing some lingering issues with serialization modernization.
vincewoo Aug 5, 2025
782d772
Merge branch 'devel' into FP-3944
vincewoo Aug 5, 2025
fa7ba9e
Fixing weird merge issue with AmpcsEvrLogPacket
vincewoo Aug 5, 2025
30f62d9
More clang issue fixes
vincewoo Aug 5, 2025
73e43fe
Still pesky clang formatting issues. Superfluous whitespace.
vincewoo Aug 5, 2025
fe88650
Removing redundant virtuals for overriden methods
vincewoo Aug 5, 2025
5abe3d1
Incorporating PR comments
vincewoo Aug 6, 2025
3972a41
clang formatted Serializable.hpp
vincewoo Aug 6, 2025
c32ffca
Removing redundant serialize and deserialize methods in TestAbsType. …
vincewoo Aug 6, 2025
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
16 changes: 1 addition & 15 deletions FppTestProject/FppTest/state_machine/internal/harness/TestAbsType.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,24 +56,10 @@ struct TestAbsType final : public Fw::Serializable {
//! Deserialize method
//! \return status
Fw::SerializeStatus deserializeFrom(Fw::SerializeBufferBase& sbb //!< The serialize buffer base
) final {
) final {
return sbb.deserializeTo(this->m_data);
}

// ----------------------------------------------------------------------
// Methods
// ----------------------------------------------------------------------

Fw::SerializeStatus serialize(Fw::SerializeBufferBase& sbb) const final
{
return this->serializeTo(sbb);
}

Fw::SerializeStatus deserialize(Fw::SerializeBufferBase& sbb) final
{
return this->deserializeFrom(sbb);
}

#if FW_SERIALIZABLE_TO_STRING
//! Convert TestAbsType to string
void toString(Fw::StringBase& sb //!< The StringBase object to hold the result
Expand Down
8 changes: 0 additions & 8 deletions Fw/Buffer/Buffer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,12 +189,4 @@ std::ostream& operator<<(std::ostream& os, const Buffer& obj) {
}
#endif

Fw::SerializeStatus Buffer::serialize(Fw::SerializeBufferBase& serialBuffer) const {
return this->serializeTo(serialBuffer);
}

Fw::SerializeStatus Buffer::deserialize(Fw::SerializeBufferBase& buffer) {
return this->deserializeFrom(buffer);
}

} // end namespace Fw
8 changes: 0 additions & 8 deletions Fw/Buffer/Buffer.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,6 @@ class Buffer : public Fw::Serializable {
//! \return: status of serialization
Fw::SerializeStatus deserializeFrom(Fw::SerializeBufferBase& buffer);

// ----------------------------------------------------------------------
// Deprecated methods
// ----------------------------------------------------------------------

Fw::SerializeStatus serialize(Fw::SerializeBufferBase& serialBuffer) const;

Fw::SerializeStatus deserialize(Fw::SerializeBufferBase& buffer);

// ----------------------------------------------------------------------
// Accessor functions
// ----------------------------------------------------------------------
Expand Down
11 changes: 1 addition & 10 deletions Fw/Cmd/CmdPacket.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ SerializeStatus CmdPacket::deserializeFrom(SerializeBufferBase& buffer) {
return FW_DESERIALIZE_TYPE_MISMATCH;
}

stat = buffer.deserialize(this->m_opcode);
stat = buffer.deserializeTo(this->m_opcode);
if (stat != FW_SERIALIZE_OK) {
return stat;
}
Expand All @@ -49,15 +49,6 @@ SerializeStatus CmdPacket::deserializeFrom(SerializeBufferBase& buffer) {
return stat;
}

// Deprecated methods for backward compatibility - these call the new interface
SerializeStatus CmdPacket::serialize(SerializeBufferBase& buffer) const {
return this->serializeTo(buffer);
}

SerializeStatus CmdPacket::deserialize(SerializeBufferBase& buffer) {
return this->deserializeFrom(buffer);
}

FwOpcodeType CmdPacket::getOpCode() const {
return this->m_opcode;
}
Expand Down
3 changes: 0 additions & 3 deletions Fw/Cmd/CmdPacket.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ class CmdPacket : public ComPacket {
SerializeStatus serializeTo(SerializeBufferBase& buffer) const;
SerializeStatus deserializeFrom(SerializeBufferBase& buffer);

// Legacy serialization methods (backward compatibility)
SerializeStatus serialize(SerializeBufferBase& buffer) const; //!< serialize contents
SerializeStatus deserialize(SerializeBufferBase& buffer);
FwOpcodeType getOpCode() const;
CmdArgBuffer& getArgBuffer();

Expand Down
23 changes: 2 additions & 21 deletions Fw/Com/ComPacket.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,16 @@
ComPacket::~ComPacket() {}

SerializeStatus ComPacket::serializeBase(SerializeBufferBase& buffer) const {
return buffer.serialize(static_cast<FwPacketDescriptorType>(this->m_type));
return buffer.serializeFrom(static_cast<FwPacketDescriptorType>(this->m_type));

Check warning

Code scanning / CodeQL

Unchecked function argument Warning

This use of parameter buffer has not been checked.
}

SerializeStatus ComPacket::deserializeBase(SerializeBufferBase& buffer) {
FwPacketDescriptorType serVal;
SerializeStatus stat = buffer.deserialize(serVal);
SerializeStatus stat = buffer.deserializeTo(serVal);

Check warning

Code scanning / CodeQL

Unchecked function argument Warning

This use of parameter buffer has not been checked.
if (FW_SERIALIZE_OK == stat) {
this->m_type = static_cast<ComPacketType>(serVal);
}
return stat;
}

SerializeStatus ComPacket::serializeTo(SerializeBufferBase& buffer) const {
// Default implementation for base class - derived classes should override this method
return FW_SERIALIZE_UNIMPLEMENTED;
}

SerializeStatus ComPacket::deserializeFrom(SerializeBufferBase& buffer) {
// Default implementation for base class - derived classes should override this method
return FW_DESERIALIZE_UNIMPLEMENTED;
}

// Deprecated methods for backward compatibility
SerializeStatus ComPacket::serialize(SerializeBufferBase& buffer) const {
return this->serializeTo(buffer);
}

SerializeStatus ComPacket::deserialize(SerializeBufferBase& buffer) {
return this->deserializeFrom(buffer);
}

} /* namespace Fw */
8 changes: 0 additions & 8 deletions Fw/Com/ComPacket.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,6 @@ class ComPacket : public Serializable {
ComPacket();
virtual ~ComPacket();

// New serialization interface
SerializeStatus serializeTo(SerializeBufferBase& buffer) const override;
SerializeStatus deserializeFrom(SerializeBufferBase& buffer) override;

// Deprecated methods for backward compatibility
SerializeStatus serialize(SerializeBufferBase& buffer) const override;
SerializeStatus deserialize(SerializeBufferBase& buffer) override;

protected:
ComPacketType m_type;
SerializeStatus serializeBase(
Expand Down
34 changes: 12 additions & 22 deletions Fw/Log/AmpcsEvrLogPacket.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,74 +14,64 @@ namespace Fw {
AmpcsEvrLogPacket::AmpcsEvrLogPacket() : m_eventID(0), m_overSeqNum(0), m_catSeqNum(0) {
this->m_type = FW_PACKET_LOG;
}

AmpcsEvrLogPacket::~AmpcsEvrLogPacket() {}

SerializeStatus AmpcsEvrLogPacket::serialize(SerializeBufferBase& buffer) const {
// Deprecated method - calls new interface for backward compatibility
return this->serializeTo(buffer);
}

SerializeStatus AmpcsEvrLogPacket::deserialize(SerializeBufferBase& buffer) {
// Deprecated method - calls new interface for backward compatibility
return this->deserializeFrom(buffer);
}

SerializeStatus AmpcsEvrLogPacket::serializeTo(SerializeBufferBase& buffer) const {
SerializeStatus stat;

stat = buffer.serialize(this->m_taskName, AMPCS_EVR_TASK_NAME_LEN, Fw::Serialization::OMIT_LENGTH);
stat = buffer.serializeFrom(this->m_taskName, AMPCS_EVR_TASK_NAME_LEN, Fw::Serialization::OMIT_LENGTH);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.serialize(this->m_eventID);
stat = buffer.serializeFrom(this->m_eventID);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.serialize(this->m_overSeqNum);
stat = buffer.serializeFrom(this->m_overSeqNum);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.serialize(this->m_catSeqNum);
stat = buffer.serializeFrom(this->m_catSeqNum);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

return buffer.serialize(this->m_logBuffer.getBuffAddr(), m_logBuffer.getBuffLength(),
Fw::Serialization::OMIT_LENGTH);
return buffer.serializeFrom(this->m_logBuffer.getBuffAddr(), m_logBuffer.getBuffLength(),
Fw::Serialization::OMIT_LENGTH);
}

SerializeStatus AmpcsEvrLogPacket::deserializeFrom(SerializeBufferBase& buffer) {
FwSizeType len;

SerializeStatus stat;
SerializeStatus stat;

len = AMPCS_EVR_TASK_NAME_LEN;
stat = buffer.deserialize(this->m_taskName, len, true);
stat = buffer.deserializeTo(this->m_taskName, len, true);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.deserialize(this->m_eventID);
stat = buffer.deserializeTo(this->m_eventID);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.deserialize(this->m_overSeqNum);
stat = buffer.deserializeTo(this->m_overSeqNum);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.deserialize(this->m_catSeqNum);
stat = buffer.deserializeTo(this->m_catSeqNum);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

FwSizeType size = buffer.getBuffLeft();
stat = buffer.deserialize(this->m_logBuffer.getBuffAddr(), size, true);
stat = buffer.deserializeTo(this->m_logBuffer.getBuffAddr(), size, true);
if (stat == FW_SERIALIZE_OK) {
// Shouldn't fail
stat = this->m_logBuffer.setBuffLen(size);
Expand Down
7 changes: 2 additions & 5 deletions Fw/Log/AmpcsEvrLogPacket.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,8 @@ class AmpcsEvrLogPacket : public ComPacket {
AmpcsEvrLogPacket();
virtual ~AmpcsEvrLogPacket();

SerializeStatus serialize(SerializeBufferBase& buffer) const override; //!< serialize contents
SerializeStatus deserialize(SerializeBufferBase& buffer) override;

SerializeStatus serializeTo(SerializeBufferBase& buffer) const override; //!< serialize contents
SerializeStatus deserializeFrom(SerializeBufferBase& buffer) override;
SerializeStatus serializeTo(SerializeBufferBase& buffer) const; //!< serialize contents
SerializeStatus deserializeFrom(SerializeBufferBase& buffer);

void setTaskName(U8* taskName, U8 len);
void setId(U32 eventID);
Expand Down
24 changes: 7 additions & 17 deletions Fw/Log/LogPacket.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,25 @@ LogPacket::LogPacket() : m_id(0) {

LogPacket::~LogPacket() {}

SerializeStatus LogPacket::serialize(SerializeBufferBase& buffer) const {
// Deprecated method - calls new interface for backward compatibility
return this->serializeTo(buffer);
}

SerializeStatus LogPacket::deserialize(SerializeBufferBase& buffer) {
// Deprecated method - calls new interface for backward compatibility
return this->deserializeFrom(buffer);
}

SerializeStatus LogPacket::serializeTo(SerializeBufferBase& buffer) const {
SerializeStatus stat = ComPacket::serializeBase(buffer);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.serialize(this->m_id);
stat = buffer.serializeFrom(this->m_id);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.serialize(this->m_timeTag);
stat = buffer.serializeFrom(this->m_timeTag);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

// We want to add data but not size for the ground software
return buffer.serialize(this->m_logBuffer.getBuffAddr(), m_logBuffer.getBuffLength(),
Fw::Serialization::OMIT_LENGTH);
return buffer.serializeFrom(this->m_logBuffer.getBuffAddr(), m_logBuffer.getBuffLength(),
Fw::Serialization::OMIT_LENGTH);
}

SerializeStatus LogPacket::deserializeFrom(SerializeBufferBase& buffer) {
Expand All @@ -53,19 +43,19 @@ SerializeStatus LogPacket::deserializeFrom(SerializeBufferBase& buffer) {
return stat;
}

stat = buffer.deserialize(this->m_id);
stat = buffer.deserializeTo(this->m_id);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

stat = buffer.deserialize(this->m_timeTag);
stat = buffer.deserializeTo(this->m_timeTag);
if (stat != FW_SERIALIZE_OK) {
return stat;
}

// remainder of buffer must be telemetry value
FwSizeType size = buffer.getBuffLeft();
stat = buffer.deserialize(this->m_logBuffer.getBuffAddr(), size, Fw::Serialization::OMIT_LENGTH);
stat = buffer.deserializeTo(this->m_logBuffer.getBuffAddr(), size, Fw::Serialization::OMIT_LENGTH);
if (stat == FW_SERIALIZE_OK) {
// Shouldn't fail
stat = this->m_logBuffer.setBuffLen(size);
Expand Down
3 changes: 0 additions & 3 deletions Fw/Log/LogPacket.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@ class LogPacket : public ComPacket {
LogPacket();
virtual ~LogPacket();

SerializeStatus serialize(SerializeBufferBase& buffer) const override; //!< serialize contents
SerializeStatus deserialize(SerializeBufferBase& buffer) override;

SerializeStatus serializeTo(SerializeBufferBase& buffer) const override; //!< serialize contents
SerializeStatus deserializeFrom(SerializeBufferBase& buffer) override;

Expand Down
30 changes: 2 additions & 28 deletions Fw/Time/Time.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,37 +76,11 @@
}

SerializeStatus Time::serializeTo(SerializeBufferBase& buffer) const {
// Fallback approach for backward compatibility:
// Try new interface first, but if it returns UNIMPLEMENTED (indicating default implementation),
// fall back to old interface. This bridges auto-generated enums/structs (old interface only)
// with new serialization infrastructure.
SerializeStatus status = this->m_val.serializeTo(buffer);
if (status == FW_SERIALIZE_UNIMPLEMENTED) {
// Fallback to old interface for backward compatibility
status = this->m_val.serialize(buffer);
}
return status;
return this->m_val.serializeTo(buffer);

Check warning

Code scanning / CodeQL

Unchecked function argument Warning

This use of parameter buffer has not been checked.
}

SerializeStatus Time::deserializeFrom(SerializeBufferBase& buffer) {
// Fallback approach for backward compatibility:
// Try new interface first, but if it returns UNIMPLEMENTED (indicating default implementation),
// fall back to old interface.
SerializeStatus status = this->m_val.deserializeFrom(buffer);
if (status == FW_DESERIALIZE_UNIMPLEMENTED) {
// Fallback to old interface for backward compatibility
status = this->m_val.deserialize(buffer);
}
return status;
}

// Deprecated methods for backward compatibility - these call the new interface
SerializeStatus Time::serialize(SerializeBufferBase& buffer) const {
return this->serializeTo(buffer);
}

SerializeStatus Time::deserialize(SerializeBufferBase& buffer) {
return this->deserializeFrom(buffer);
return this->m_val.deserializeFrom(buffer);

Check warning

Code scanning / CodeQL

Unchecked function argument Warning

This use of parameter buffer has not been checked.
}

U32 Time::getSeconds() const {
Expand Down
2 changes: 0 additions & 2 deletions Fw/Time/Time.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ class Time : public Serializable {
FwTimeContextStoreType getContext() const; // !< get the context value
SerializeStatus serializeTo(SerializeBufferBase& buffer) const override; // !< Serialize method
SerializeStatus deserializeFrom(SerializeBufferBase& buffer) override; // !< Deserialize method
SerializeStatus serialize(SerializeBufferBase& buffer) const override; // !< Serialize method (deprecated)
SerializeStatus deserialize(SerializeBufferBase& buffer) override; // !< Deserialize method (deprecated)
bool operator==(const Time& other) const;
bool operator!=(const Time& other) const;
bool operator>(const Time& other) const;
Expand Down
10 changes: 0 additions & 10 deletions Fw/Time/TimeInterval.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,6 @@ bool TimeInterval::operator<=(const TimeInterval& other) const {
return ((LT == c) or (EQ == c));
}

SerializeStatus TimeInterval::serialize(SerializeBufferBase& buffer) const {
// Deprecated method - calls new interface for backward compatibility
return this->serializeTo(buffer);
}

SerializeStatus TimeInterval::deserialize(SerializeBufferBase& buffer) {
// Deprecated method - calls new interface for backward compatibility
return this->deserializeFrom(buffer);
}

SerializeStatus TimeInterval::serializeTo(SerializeBufferBase& buffer) const {
// Use TimeIntervalValue's built-in serialization
return this->m_val.serializeTo(buffer);
Expand Down
2 changes: 0 additions & 2 deletions Fw/Time/TimeInterval.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ class TimeInterval : public Serializable {
void set(U32 seconds, U32 useconds); // !< Sets value of time stored
U32 getSeconds() const; // !< Gets seconds part of time
U32 getUSeconds() const; // !< Gets microseconds part of time
SerializeStatus serialize(SerializeBufferBase& buffer) const override; // !< Serialize method
SerializeStatus deserialize(SerializeBufferBase& buffer) override; // !< Deserialize method

SerializeStatus serializeTo(SerializeBufferBase& buffer) const override; // !< Serialize method
SerializeStatus deserializeFrom(SerializeBufferBase& buffer) override; // !< Deserialize method
Expand Down
Loading
Loading