Add DpWriter (#2593)

* Pull in framework changes from data-products branch

* Pull in changes to DpManager from data-products branch

* Pull in DpWriter from data-products branch

* Fix spelling

* Revise FileNameString

* Fix warnings in CI

* Fix static analysis warnings

* Fix static analysis warnings

* Revise formatting and comments

* Revise banner comments

* Revise FileNameString per PR comment

* Revise path names in config headers

If a header H.hpp exists in the F Prime source base, then

is dangerous. Because [project root] and [fprime root] are both
in the list of include paths, it's not clear whether this means "include
[project root]/config/H.hpp" or "include [fprime root]/config/H.hpp."

On the other hand,

or

has no such ambiguity, because only one of [project root]/config
and [fprime root]/config is in the list of include paths.

* Revise path names in config headers

If a header H.hpp exists in the F Prime source base, then

`#include "config/H.hpp"`

is dangerous. Because [project root] and [fprime root] are both
in the list of include paths, it's not clear whether this means "include
[project root]/config/H.hpp" or "include [fprime root]/config/H.hpp."

On the other hand,

include <config/H.hpp>

or

`#include "config/H.hpp"`

has no such ambiguity, because only one of [project root]/config
and [fprime root]/config is in the list of include paths.

.github/actions/spelling/expect.txt

@@ -94,6 +94,7 @@ BUFFERALLOCATIONFAILED
 BUFFERGETOUT
 BUFFERMANAGERCOMPONENTIMPLCFG
 BUFFERMGR
+BUFFERTOOSMALLFORPACKET
 BUFFQUEUEIN
 buffsize
 BUGLIST
@@ -267,6 +268,7 @@ doxyindexer
 doxyrules
 doxysearch
 Doxywizard
+DPCFG
 dpi
 DPMANAGER
 DPWRITER
@@ -330,6 +332,7 @@ fadvise
 FAKELOGGER
 fallocate
 fbuild
+fdp
 fdset
 FEEDNAME
 ffff
@@ -338,8 +341,11 @@ filedown
 FILEDOWNLINK
 FILEDOWNLINKCFG
 FILEID
+FILENAMESTRING
 fileopen
+FILEOPENERROR
 FILESTUBS
+FILEWRITEERROR
 fio
 Firefox
 FLDP
@@ -480,6 +486,9 @@ integertypename
 interoperate
 intlimits
 inttype
+INVALIDBUFFER
+INVALIDHEADER
+INVALIDHEADERHASH
 invisi
 ioc
 ioctl
@@ -774,6 +783,7 @@ PRMDBIMPLTESTER
 PRMDBLIMPLCFG
 prmname
 probs
+PROCBUFFERSENDOUT
 PRODUCTGETIN
 PRODUCTREQUESTIN
 PRODUCTRESPONSEOUT

Fw/Cfg/SerIds.hpp

@@ -58,6 +58,7 @@ namespace Fw {
         FW_TYPEID_INTERNAL_INTERFACE_STRING =   51, //!< interface string Buffer type id
         FW_TYPEID_FIXED_LENGTH_STRING = 52, //!< 256 char string Buffer type id
         FW_TYPEID_OBJECT_NAME = 53, //!< ObjectName string Buffer type id
+        FW_TYPEID_FILE_NAME_STRING = 54, //!< FileName string Buffer type id
     };
 }
 

Fw/Types/CMakeLists.txt

@@ -7,18 +7,20 @@
 # Note: using PROJECT_NAME as EXECUTABLE_NAME
 ####
 
-set(SOURCE_FILES "${CMAKE_CURRENT_LIST_DIR}/Types.fpp"
+set(SOURCE_FILES
   "${CMAKE_CURRENT_LIST_DIR}/Assert.cpp"
-  "${CMAKE_CURRENT_LIST_DIR}/String.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/FileNameString.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/InternalInterfaceString.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/MallocAllocator.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/MemAllocator.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/ObjectName.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/PolyType.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/SerialBuffer.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/Serializable.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/String.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/StringType.cpp"
   "${CMAKE_CURRENT_LIST_DIR}/StringUtils.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/Types.fpp"
 )
 set(MOD_DEPS
   Fw/Cfg

Fw/Types/FileNameString.cpp

@@ -0,0 +1,54 @@
+#include "Fw/Types/FileNameString.hpp"
+#include "Fw/Types/StringUtils.hpp"
+
+namespace Fw {
+
+FileNameString::FileNameString(const char* src) : StringBase() {
+    (void)Fw::StringUtils::string_copy(this->m_buf, src, sizeof(this->m_buf));
+}
+
+FileNameString::FileNameString(const StringBase& src) : StringBase() {
+    (void)Fw::StringUtils::string_copy(this->m_buf, src.toChar(), sizeof(this->m_buf));
+}
+
+FileNameString::FileNameString(const FileNameString& src) : StringBase() {
+    (void)Fw::StringUtils::string_copy(this->m_buf, src.toChar(), sizeof(this->m_buf));
+}
+
+FileNameString::FileNameString() : StringBase() {
+    this->m_buf[0] = 0;
+}
+
+FileNameString& FileNameString::operator=(const FileNameString& other) {
+    if (this == &other) {
+        return *this;
+    }
+
+    (void)Fw::StringUtils::string_copy(this->m_buf, other.toChar(), sizeof(this->m_buf));
+    return *this;
+}
+
+FileNameString& FileNameString::operator=(const StringBase& other) {
+    if (this == &other) {
+        return *this;
+    }
+
+    (void)Fw::StringUtils::string_copy(this->m_buf, other.toChar(), sizeof(this->m_buf));
+    return *this;
+}
+
+FileNameString& FileNameString::operator=(const char* other) {
+    Fw::StringUtils::string_copy(this->m_buf, other, sizeof(this->m_buf));
+    return *this;
+}
+
+FileNameString::~FileNameString() {}
+
+const char* FileNameString::toChar() const {
+    return this->m_buf;
+}
+
+NATIVE_UINT_TYPE FileNameString::getCapacity() const {
+    return STRING_SIZE;
+}
+}  // namespace Fw

Fw/Types/FileNameString.hpp

@@ -0,0 +1,37 @@
+#ifndef FW_FILENAMESTRING_HPP
+#define FW_FILENAMESTRING_HPP
+
+#include <FpConfig.hpp>
+
+#include "Fw/Cfg/SerIds.hpp"
+#include "Fw/Types/StringType.hpp"
+#include "config/FppConstantsAc.hpp"
+
+namespace Fw {
+
+class FileNameString : public Fw::StringBase {
+  public:
+    enum {
+        SERIALIZED_TYPE_ID = FW_TYPEID_FILE_NAME_STRING,        //!< typeid for string type
+        STRING_SIZE = FileNameStringSize,                       //!< Storage for string
+        SERIALIZED_SIZE = STRING_SIZE + sizeof(FwBuffSizeType)  //!< Serialized size is size of buffer + size field
+    };
+
+    explicit FileNameString(const char* src);                //!< char* source constructor
+    explicit FileNameString(const StringBase& src);          //!< other string constructor
+    explicit FileNameString(const FileNameString& src);      //!< String string constructor
+    FileNameString();                                        //!< default constructor
+    FileNameString& operator=(const FileNameString& other);  //!< assignment operator
+    FileNameString& operator=(const StringBase& other);      //!< other string assignment operator
+    FileNameString& operator=(const char* other);            //!< char* assignment operator
+    ~FileNameString();                                       //!< destructor
+
+    const char* toChar() const;            //!< gets char buffer
+    NATIVE_UINT_TYPE getCapacity() const;  //!< return buffer size
+
+  private:
+    char m_buf[FileNameString::STRING_SIZE];  //!< storage for string data
+};
+}  // namespace Fw
+
+#endif

Os/Stub/test/File.cpp

@@ -9,7 +9,14 @@ namespace Test {
 StaticData StaticData::data;
 
 void StaticData::setNextStatus(Os::File::Status status) {
-    StaticData::data.nextStatus = status;
+    StaticData::data.openStatus = status;
+    StaticData::data.sizeStatus = status;
+    StaticData::data.positionStatus = status;
+    StaticData::data.preallocateStatus = status;
+    StaticData::data.seekStatus = status;
+    StaticData::data.flushStatus = status;
+    StaticData::data.readStatus = status;
+    StaticData::data.writeStatus = status;
 }
 
 void StaticData::setSizeResult(FwSignedSizeType size) {
@@ -52,7 +59,7 @@ FileInterface::Status TestFile::open(const char *filepath, Mode open_mode, Overw
     StaticData::data.openOverwrite = overwrite;
     StaticData::data.lastCalled = StaticData::OPEN_FN;
     StaticData::data.pointer = 0;
-    return StaticData::data.nextStatus;
+    return StaticData::data.openStatus;
 }
 
 void TestFile::close() {
@@ -62,32 +69,32 @@ void TestFile::close() {
 FileInterface::Status TestFile::size(FwSignedSizeType& size_result) {
     StaticData::data.lastCalled = StaticData::SIZE_FN;
     size_result = StaticData::data.sizeResult;
-    return StaticData::data.nextStatus;
+    return StaticData::data.sizeStatus;
 }
 
 FileInterface::Status TestFile::position(FwSignedSizeType& position_result) {
     StaticData::data.lastCalled = StaticData::POSITION_FN;
     position_result = StaticData::data.positionResult;
-    return StaticData::data.nextStatus;
+    return StaticData::data.positionStatus;
 }
 
 FileInterface::Status TestFile::preallocate(FwSignedSizeType offset, FwSignedSizeType length) {
     StaticData::data.preallocateOffset = offset;
     StaticData::data.preallocateLength = length;
     StaticData::data.lastCalled = StaticData::PREALLOCATE_FN;
-    return StaticData::data.nextStatus;
+    return StaticData::data.preallocateStatus;
 }
 
 FileInterface::Status TestFile::seek(FwSignedSizeType offset, SeekType seekType) {
     StaticData::data.seekOffset = offset;
     StaticData::data.seekType = seekType;
     StaticData::data.lastCalled = StaticData::SEEK_FN;
-    return StaticData::data.nextStatus;
+    return StaticData::data.seekStatus;
 }
 
 FileInterface::Status TestFile::flush() {
     StaticData::data.lastCalled = StaticData::FLUSH_FN;
-    return StaticData::data.nextStatus;
+    return StaticData::data.flushStatus;
 }
 
 FileInterface::Status TestFile::read(U8 *buffer, FwSignedSizeType &size, WaitType wait) {
@@ -103,7 +110,7 @@ FileInterface::Status TestFile::read(U8 *buffer, FwSignedSizeType &size, WaitTyp
     } else {
         size = StaticData::data.readSizeResult;
     }
-    return StaticData::data.nextStatus;
+    return StaticData::data.readStatus;
 }
 
 FileInterface::Status TestFile::write(const U8* buffer, FwSignedSizeType &size, WaitType wait) {
@@ -119,7 +126,7 @@ FileInterface::Status TestFile::write(const U8* buffer, FwSignedSizeType &size,
     } else {
         size = StaticData::data.writeSizeResult;
     }
-    return StaticData::data.nextStatus;
+    return StaticData::data.writeStatus;
 }
 
 FileHandle* TestFile::getHandle() {

Os/Stub/test/File.hpp

@@ -60,8 +60,23 @@ struct StaticData {
     //! File pointer
     FwSignedSizeType pointer = 0;
 
-    //! Next status to be returned
-    Os::File::Status nextStatus = Os::File::Status::OTHER_ERROR;
+    //! Status to return from open
+    Os::File::Status openStatus = Os::File::Status::OP_OK;
+    //! Status to return from size
+    Os::File::Status sizeStatus = Os::File::Status::OP_OK;
+    //! Status to return from position
+    Os::File::Status positionStatus = Os::File::Status::OP_OK;
+    //! Status to return from preallocate
+    Os::File::Status preallocateStatus = Os::File::Status::OP_OK;
+    //! Status to return from seek
+    Os::File::Status seekStatus = Os::File::Status::OP_OK;
+    //! Status to return from flush
+    Os::File::Status flushStatus = Os::File::Status::OP_OK;
+    //! Status to return from read
+    Os::File::Status readStatus = Os::File::Status::OP_OK;
+    //! Status to return from write
+    Os::File::Status writeStatus = Os::File::Status::OP_OK;
+
     //! Return of next size call
     FwSignedSizeType sizeResult = -1;
     //! Return of next position call

Os/test/ut/file/SyntheticFileSystem.hpp

@@ -2,7 +2,7 @@
 // \title Os/test/ut/file/SyntheticFileSystem.hpp
 // \brief standard template library driven synthetic file system definitions
 // ======================================================================
-#include "config/FpConfig.h"
+#include <FpConfig.h>
 #include "Os/File.hpp"
 #include <map>
 #include <memory>

Svc/CMakeLists.txt

@@ -26,6 +26,8 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/CmdSequencer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/CmdSplitter/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Deframer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/DpManager/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/DpPorts/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/DpWriter/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FatalHandler/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FileDownlinkPorts/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FileDownlink/")

Svc/Deframer/Deframer.hpp

@@ -13,11 +13,12 @@
 #ifndef Svc_Deframer_HPP
 #define Svc_Deframer_HPP
 
+#include <DeframerCfg.hpp>
+
 #include "Svc/Deframer/DeframerComponentAc.hpp"
 #include "Svc/FramingProtocol/DeframingProtocol.hpp"
 #include "Svc/FramingProtocol/DeframingProtocolInterface.hpp"
 #include "Utils/Types/CircularBuffer.hpp"
-#include "config/DeframerCfg.hpp"
 
 namespace Svc {
 

Svc/DpManager/DpManager.cpp

@@ -52,7 +52,7 @@ void DpManager::productSendIn_handler(const NATIVE_INT_TYPE portNum, FwDpIdType
     this->productSendOut_out(portNum, sendBuffer);
 }
 
-void DpManager::schedIn_handler(const NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context) {
+void DpManager::schedIn_handler(const NATIVE_INT_TYPE portNum, U32 context) {
     // Emit telemetry
     this->tlmWrite_NumSuccessfulAllocations(this->numSuccessfulAllocations);
     this->tlmWrite_NumFailedAllocations(this->numFailedAllocations);

Svc/DpManager/DpManager.hpp

@@ -83,7 +83,7 @@ class DpManager : public DpManagerComponentBase {
 
     //! Handler implementation for schedIn
     void schedIn_handler(const NATIVE_INT_TYPE portNum,  //!< The port number
-                         NATIVE_UINT_TYPE context        //!< The call order
+                         U32 context                     //!< The call order
                          ) final;
 
   PRIVATE:

Svc/DpManager/test/ut/AbstractState.hpp

@@ -5,9 +5,8 @@
 //
 // \copyright
 // Copyright (C) 2023 California Institute of Technology.
-// ALL RIGHTS RESERVED.  United States Government Sponsorship
-// acknowledged. Any commercial use must be negotiated with the Office
-// of Technology Transfer at the California Institute of Technology.
+// ALL RIGHTS RESERVED.  United States Government sponsorship
+// acknowledged.
 // ======================================================================
 
 #ifndef Svc_AbstractState_HPP

Svc/DpManager/test/ut/DpManagerTestMain.cpp

@@ -1,5 +1,7 @@
 // ======================================================================
-// TestMain.cpp
+// \title  DpWriterTestMain.cpp
+// \author bocchino
+// \brief  cpp file for DpWriter component test main function
 // ======================================================================
 
 #include "Fw/Test/UnitTest.hpp"

Svc/DpManager/test/ut/README.md

@@ -315,6 +315,9 @@ This rule sends the `CLEAR_EVENT_THROTTLE` command.
 1. Apply rule `CLEAR_EVENT_THROTTLE::OK`.
 1. Apply rule `ProductRequestIn::BufferInvalid`
 
+**Requirements tested:**
+`SVC-DPMANAGER-006`
+
 ## 3. Implementation
 
 ### 3.1. DpManagerTester and TestState

Svc/DpManager/test/ut/Rules/BufferGetStatus.cpp

@@ -5,9 +5,8 @@
 //
 // \copyright
 // Copyright (C) 2023 California Institute of Technology.
-// ALL RIGHTS RESERVED.  United States Government Sponsorship
-// acknowledged. Any commercial use must be negotiated with the Office
-// of Technology Transfer at the California Institute of Technology.
+// ALL RIGHTS RESERVED.  United States Government sponsorship
+// acknowledged.
 // ======================================================================
 
 #include "Svc/DpManager/test/ut/Rules/BufferGetStatus.hpp"

Svc/DpManager/test/ut/Rules/BufferGetStatus.hpp

@@ -5,9 +5,8 @@
 //
 // \copyright
 // Copyright (C) 2023 California Institute of Technology.
-// ALL RIGHTS RESERVED.  United States Government Sponsorship
-// acknowledged. Any commercial use must be negotiated with the Office
-// of Technology Transfer at the California Institute of Technology.
+// ALL RIGHTS RESERVED.  United States Government sponsorship
+// acknowledged.
 // ======================================================================
 
 #ifndef Svc_BufferGetStatus_HPP