nasa/fprime
1
0
Fork 0
mirror of https://github.com/nasa/fprime.git synced 2025-12-10 00:44:37 -06:00
Code Issues Packages Projects Releases 34 Wiki Activity

Fix FPrimeRouter potential usage of invalid buffer (#4493)

Browse Source 
* Fix #4491

* Formatting and enum size
This commit is contained in:
M Starch 2025-12-03 12:17:00 -08:00 committed by GitHub
parent 3a293cd705
commit a8fe137283
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 75 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Svc/FprimeRouter/FprimeRouter.cpp
View File

@ -51,12 +51,18 @@ void FprimeRouter ::dataIn_handler(FwIndexType portNum, Fw::Buffer& packetBuffer
// Copy buffer into a new allocated buffer. This lets us return the original buffer with dataReturnOut,
// and FprimeRouter can handle the deallocation of the file buffer when it returns on fileBufferReturnIn
Fw::Buffer packetBufferCopy = this->bufferAllocate_out(0, packetBuffer.getSize());
auto copySerializer = packetBufferCopy.getSerializer();
status = copySerializer.serializeFrom(packetBuffer.getData(), packetBuffer.getSize(),
Fw::Serialization::OMIT_LENGTH);
FW_ASSERT(status == Fw::FW_SERIALIZE_OK, status);
// Send the copied buffer out. It will come back on fileBufferReturnIn once the receiver is done with it
this->fileOut_out(0, packetBufferCopy);
// Confirm we got a valid buffer before using it
if (packetBufferCopy.isValid()) {
auto copySerializer = packetBufferCopy.getSerializer();
status = copySerializer.serializeFrom(packetBuffer.getData(), packetBuffer.getSize(),
Fw::Serialization::OMIT_LENGTH);
FW_ASSERT(status == Fw::FW_SERIALIZE_OK, status);
// Send the copied buffer out. It will come back on fileBufferReturnIn once the receiver is done
// with it
this->fileOut_out(0, packetBufferCopy);
} else {
this->log_WARNING_HI_AllocationError(FprimeRouter_AllocationReason::FILE_UPLINK);
}
}
break;
}
@ -67,13 +73,20 @@ void FprimeRouter ::dataIn_handler(FwIndexType portNum, Fw::Buffer& packetBuffer
// Copy buffer into a new allocated buffer. This lets us return the original buffer with dataReturnOut,
// and FprimeRouter can handle the deallocation of the unknown buffer when it returns on bufferReturnIn
Fw::Buffer packetBufferCopy = this->bufferAllocate_out(0, packetBuffer.getSize());
auto copySerializer = packetBufferCopy.getSerializer();
status = copySerializer.serializeFrom(packetBuffer.getData(), packetBuffer.getSize(),
Fw::Serialization::OMIT_LENGTH);
FW_ASSERT(status == Fw::FW_SERIALIZE_OK, status);
// Send the copied buffer out. It will come back on fileBufferReturnIn once the receiver is done with it
this->unknownDataOut_out(0, packetBufferCopy, context);
// Confirm we got a valid buffer before using it
if (packetBufferCopy.isValid()) {
auto copySerializer = packetBufferCopy.getSerializer();
status = copySerializer.serializeFrom(packetBuffer.getData(), packetBuffer.getSize(),
Fw::Serialization::OMIT_LENGTH);
FW_ASSERT(status == Fw::FW_SERIALIZE_OK, status);
// Send the copied buffer out. It will come back on fileBufferReturnIn once the receiver is done
// with it
this->unknownDataOut_out(0, packetBufferCopy, context);
} else {
this->log_WARNING_HI_AllocationError(FprimeRouter_AllocationReason::USER_BUFFER);
}
}
break;
}
}

9
Svc/FprimeRouter/FprimeRouter.fpp
View File

@ -7,6 +7,11 @@ module Svc {
# ----------------------------------------------------------------------
import Router
enum AllocationReason : U8{
FILE_UPLINK, @< Buffer allocation for file uplink
USER_BUFFER @< Buffer allocation for user handled buffer
}
@ Port for forwarding non-recognized packet types
@ Ownership of the buffer is retained by the FprimeRouter, meaning receiving
@ components should either process data synchronously, or copy the data if needed
@ -31,6 +36,10 @@ module Svc {
) \
severity warning high \
format "Deserializing packet type failed with status {}"
@ An allocation error occurred
event AllocationError(reason: AllocationReason) severity warning high \
format "Buffer allocation for {} failed"
###############################################################################

10
Svc/FprimeRouter/test/ut/FprimeRouterTestMain.cpp
View File

@ -28,6 +28,16 @@ TEST(FprimeRouter, TestRouteUnknownPacketUnconnected) {
Svc::FprimeRouterTester tester(true);
tester.testRouteUnknownPacketUnconnected();
}
TEST(FprimeRouter, TestAllocationFailureFile) {
COMMENT("Test failure to allocate for files");
Svc::FprimeRouterTester tester;
tester.testAllocationFailureFile();
}
TEST(FprimeRouter, TestAllocationFailureUnknown) {
COMMENT("Test failure to allocate for unknown packets");
Svc::FprimeRouterTester tester;
tester.testAllocationFailureUnknown();
}
TEST(FprimeRouter, TestBufferReturn) {
COMMENT("Deallocate a returning buffer");
Svc::FprimeRouterTester tester;

27
Svc/FprimeRouter/test/ut/FprimeRouterTester.cpp
View File

@ -64,6 +64,22 @@ void FprimeRouterTester ::testRouteUnknownPacketUnconnected() {
ASSERT_from_bufferAllocate_SIZE(0); // no buffer allocation when port is unconnected
}
void FprimeRouterTester ::testAllocationFailureFile() {
this->m_forceAllocationError = true;
this->mockReceivePacketType(Fw::ComPacketType::FW_PACKET_FILE);
ASSERT_EVENTS_AllocationError_SIZE(1); // allocation error should be logged
ASSERT_EVENTS_AllocationError(0, FprimeRouter_AllocationReason::FILE_UPLINK);
ASSERT_from_dataReturnOut_SIZE(1); // data ownership should always be returned
}
void FprimeRouterTester ::testAllocationFailureUnknown() {
this->m_forceAllocationError = true;
this->mockReceivePacketType(Fw::ComPacketType::FW_PACKET_UNKNOWN);
ASSERT_EVENTS_AllocationError_SIZE(1); // allocation error should be logged
ASSERT_EVENTS_AllocationError(0, FprimeRouter_AllocationReason::USER_BUFFER);
ASSERT_from_dataReturnOut_SIZE(1); // data ownership should always be returned
}
void FprimeRouterTester ::testBufferReturn() {
U8 data[1];
Fw::Buffer buffer(data, sizeof(data));
@ -116,9 +132,14 @@ void FprimeRouterTester::connectPortsExceptUnknownData() {
// ----------------------------------------------------------------------
Fw::Buffer FprimeRouterTester::from_bufferAllocate_handler(FwIndexType portNum, FwSizeType size) {
this->pushFromPortEntry_bufferAllocate(size);
this->m_buffer.setData(this->m_buffer_slot);
this->m_buffer.setSize(size);
::memset(this->m_buffer.getData(), 0, size);
if (this->m_forceAllocationError) {
this->m_buffer.setData(nullptr);
this->m_buffer.setSize(0);
} else {
this->m_buffer.setData(this->m_buffer_slot);
this->m_buffer.setSize(size);
::memset(this->m_buffer.getData(), 0, size);
}
return this->m_buffer;
}

7
Svc/FprimeRouter/test/ut/FprimeRouterTester.hpp
View File

@ -56,6 +56,12 @@ class FprimeRouterTester : public FprimeRouterGTestBase {
//! Route a packet of unknown type
void testRouteUnknownPacketUnconnected();
//! Route a packet of unknown type
void testAllocationFailureFile();
//! Deallocate a returning buffer
void testAllocationFailureUnknown();
//! Deallocate a returning buffer
void testBufferReturn();
@ -95,6 +101,7 @@ class FprimeRouterTester : public FprimeRouterGTestBase {
Fw::Buffer m_buffer; // buffer to be returned by mocked bufferAllocate call
U8 m_buffer_slot[64];
bool m_forceAllocationError = false; // Flag to force allocation error
};
} // namespace Svc