Merge branch 'mueller/refactor-tmtc-stack' into mueller/cfdp-routers

src/fsfw/monitoring/MonitoringMessageContent.h

@@ -8,7 +8,7 @@
 #include "../serialize/SerialLinkedListAdapter.h"
 #include "../serialize/SerializeElement.h"
 #include "../serviceinterface/ServiceInterface.h"
-#include "../timemanager/TimeStamperIF.h"
+#include "../timemanager/TimeWriterIF.h"
 #include "HasMonitorsIF.h"
 #include "MonitoringIF.h"
 #include "monitoringConf.h"
@@ -34,9 +34,9 @@ class MonitoringReportContent : public SerialLinkedListAdapter<SerializeIF> {
   SerializeElement<T> limitValue;
   SerializeElement<ReturnValue_t> oldState;
   SerializeElement<ReturnValue_t> newState;
-  uint8_t rawTimestamp[TimeStamperIF::MAXIMUM_TIMESTAMP_LEN] = {};
+  uint8_t rawTimestamp[TimeWriterIF::MAXIMUM_TIMESTAMP_LEN] = {};
   SerializeElement<SerialBufferAdapter<uint8_t>> timestampSerializer;
-  TimeStamperIF* timeStamper;
+  TimeWriterIF* timeStamper;
   MonitoringReportContent()
       : SerialLinkedListAdapter<SerializeIF>(&parameterObjectId),
         monitorId(0),
@@ -79,7 +79,7 @@ class MonitoringReportContent : public SerialLinkedListAdapter<SerializeIF> {
   }
   bool checkAndSetStamper() {
     if (timeStamper == nullptr) {
-      timeStamper = ObjectManager::instance()->get<TimeStamperIF>(timeStamperId);
+      timeStamper = ObjectManager::instance()->get<TimeWriterIF>(timeStamperId);
       if (timeStamper == nullptr) {
 #if FSFW_CPP_OSTREAM_ENABLED == 1
         sif::error << "MonitoringReportContent::checkAndSetStamper: "

src/fsfw/pus/Service1TelecommandVerification.cpp

@@ -11,7 +11,7 @@ Service1TelecommandVerification::Service1TelecommandVerification(object_id_t obj
                                                                  uint16_t apid, uint8_t serviceId,
                                                                  object_id_t targetDestination,
                                                                  uint16_t messageQueueDepth,
-                                                                 TimeStamperIF* timeStamper)
+                                                                 TimeWriterIF* timeStamper)
     : SystemObject(objectId),
       apid(apid),
       serviceId(serviceId),
@@ -134,7 +134,7 @@ ReturnValue_t Service1TelecommandVerification::initialize() {
     storeHelper.setTmStore(*tmStore);
   }
   if (timeStamper == nullptr) {
-    timeStamper = ObjectManager::instance()->get<TimeStamperIF>(objects::TIME_STAMPER);
+    timeStamper = ObjectManager::instance()->get<TimeWriterIF>(objects::TIME_STAMPER);
     if (timeStamper == nullptr) {
       return ObjectManagerIF::CHILD_INIT_FAILED;
     }

src/fsfw/pus/Service1TelecommandVerification.h

@@ -47,7 +47,7 @@ class Service1TelecommandVerification : public AcceptsVerifyMessageIF,
 
   Service1TelecommandVerification(object_id_t objectId, uint16_t apid, uint8_t serviceId,
                                   object_id_t targetDestination, uint16_t messageQueueDepth,
-                                  TimeStamperIF* timeStamper = nullptr);
+                                  TimeWriterIF* timeStamper = nullptr);
   ~Service1TelecommandVerification() override;
 
   /**
@@ -87,7 +87,7 @@ class Service1TelecommandVerification : public AcceptsVerifyMessageIF,
   TmStoreHelper storeHelper;
   TmStoreAndSendWrapper tmHelper;
   InternalErrorReporterIF* errReporter = nullptr;
-  TimeStamperIF* timeStamper = nullptr;
+  TimeWriterIF* timeStamper = nullptr;
   StorageManagerIF* tmStore = nullptr;
   MessageQueueIF* tmQueue = nullptr;
 

src/fsfw/timemanager/CdsShortTimeStamper.cpp

@@ -6,11 +6,6 @@
 
 CdsShortTimeStamper::CdsShortTimeStamper(object_id_t objectId) : SystemObject(objectId) {}
 
-ReturnValue_t CdsShortTimeStamper::addTimeStamp(uint8_t *buffer, const uint8_t maxSize) {
-  size_t serLen = 0;
-  return serialize(&buffer, &serLen, maxSize, SerializeIF::Endianness::NETWORK);
-}
-
 ReturnValue_t CdsShortTimeStamper::serialize(uint8_t **buffer, size_t *size, size_t maxSize,
                                              SerializeIF::Endianness streamEndianness) const {
   if (*size + getSerializedSize() > maxSize) {
@@ -33,15 +28,22 @@ size_t CdsShortTimeStamper::getSerializedSize() const { return getTimestampSize(
 
 ReturnValue_t CdsShortTimeStamper::deSerialize(const uint8_t **buffer, size_t *size,
                                                SerializeIF::Endianness streamEndianness) {
+  if (size == nullptr or buffer == nullptr) {
     return returnvalue::FAILED;
   }
-
+  if (*size < getTimestampSize()) {
-ReturnValue_t CdsShortTimeStamper::readTimeStamp(const uint8_t *buffer, size_t maxSize) {
-  if (maxSize < getTimestampSize()) {
     return SerializeIF::STREAM_TOO_SHORT;
   }
   size_t foundLen = 0;
-  return CCSDSTime::convertFromCcsds(&readTime, buffer, &foundLen, maxSize);
+  if (((**buffer >> 4) & 0b111) != CCSDSTime::TimeCodeIdentification::CDS) {
+    return BAD_TIMESTAMP;
+  }
+  auto res = CCSDSTime::convertFromCcsds(&readTime, *buffer, &foundLen, *size);
+  if (res == returnvalue::OK) {
+    *size -= getSerializedSize();
+    *buffer += getSerializedSize();
+  }
+  return res;
 }
 
 timeval &CdsShortTimeStamper::getTime() { return readTime; }

src/fsfw/timemanager/CdsShortTimeStamper.h

@@ -3,7 +3,7 @@
 
 #include "CCSDSTime.h"
 #include "TimeReaderIF.h"
-#include "TimeStamperIF.h"
+#include "TimeWriterIF.h"
 #include "fsfw/objectmanager/SystemObject.h"
 
 /**
@@ -15,7 +15,7 @@
  * overriding the #addTimeStamp function.
  * @ingroup utility
  */
-class CdsShortTimeStamper : public TimeStamperIF, public TimeReaderIF, public SystemObject {
+class CdsShortTimeStamper : public TimeWriterIF, public TimeReaderIF, public SystemObject {
  public:
   static constexpr size_t TIMESTAMP_LEN = 7;
   /**
@@ -25,20 +25,11 @@ class CdsShortTimeStamper : public TimeStamperIF, public TimeReaderIF, public Sy
    */
   explicit CdsShortTimeStamper(object_id_t objectId);
 
-  /**
-   * Adds a CCSDS CDC short 8 byte timestamp to the given buffer.
-   * This function can be overriden to use a custom timestamp.
-   * @param buffer
-   * @param maxSize
-   * @return
-   */
-  ReturnValue_t addTimeStamp(uint8_t *buffer, uint8_t maxSize) override;
   ReturnValue_t serialize(uint8_t **buffer, size_t *size, size_t maxSize,
                           Endianness streamEndianness) const override;
   [[nodiscard]] size_t getSerializedSize() const override;
   ReturnValue_t deSerialize(const uint8_t **buffer, size_t *size,
                             Endianness streamEndianness) override;
-  ReturnValue_t readTimeStamp(const uint8_t *buffer, size_t maxSize) override;
   timeval &getTime() override;
   [[nodiscard]] size_t getTimestampSize() const override;
 

src/fsfw/timemanager/TimeReaderIF.h

@@ -5,12 +5,28 @@
 
 #include "TimeStampIF.h"
 #include "fsfw/returnvalues/returnvalue.h"
+#include "fsfw/serialize/SerializeIF.h"
 
-class TimeReaderIF : public TimeStampIF {
+class TimeReaderIF : public SerializeIF, public TimeStampIF {
  public:
   ~TimeReaderIF() override = default;
-  virtual ReturnValue_t readTimeStamp(const uint8_t* buffer, size_t maxSize) = 0;
   virtual timeval& getTime() = 0;
+
+  [[nodiscard]] size_t getSerializedSize() const override { return getTimestampSize(); }
+
+  ReturnValue_t readTimeStamp(const uint8_t* buf, size_t maxSize) {
+    size_t dummy = 0;
+    return deSerialize(buf, dummy, maxSize, SerializeIF::Endianness::NETWORK);
+  }
+
+ private:
+  /**
+   *   Forbidden, use dedicated IF @TimeWriterIF
+   */
+  [[nodiscard]] ReturnValue_t serialize(uint8_t** buffer, size_t* size, size_t maxSize,
+                                        Endianness streamEndianness) const override {
+    return returnvalue::FAILED;
+  }
 };
 
 #endif  // FSFW_TIMEMANAGER_TIMEREADERIF_H

src/fsfw/timemanager/TimeStamperIF.h

@@ -1,23 +0,0 @@
-#ifndef FSFW_TIMEMANAGER_TIMESTAMPERIF_H_
-#define FSFW_TIMEMANAGER_TIMESTAMPERIF_H_
-
-#include "TimeStampIF.h"
-#include "fsfw/returnvalues/returnvalue.h"
-#include "fsfw/serialize/SerializeIF.h"
-
-/**
- * A class implementing this IF provides facilities to add a time stamp to the
- * buffer provided.
- * Implementors need to ensure that calling the method is thread-safe, i.e.
- * addTimeStamp may be called in parallel from a different context.
- */
-class TimeStamperIF : public SerializeIF, public TimeStampIF {
- public:
-  virtual ReturnValue_t addTimeStamp(uint8_t* buffer, uint8_t maxSize) = 0;
-  ~TimeStamperIF() override = default;
-  size_t getTimestampSize() const override { return getSerializedSize(); }
-
- protected:
-};
-
-#endif /* FSFW_TIMEMANAGER_TIMESTAMPERIF_H_ */

src/fsfw/timemanager/TimeWriterIF.h

@@ -0,0 +1,34 @@
+#ifndef FSFW_TIMEMANAGER_TIMESTAMPERIF_H_
+#define FSFW_TIMEMANAGER_TIMESTAMPERIF_H_
+
+#include "TimeStampIF.h"
+#include "fsfw/returnvalues/returnvalue.h"
+#include "fsfw/serialize/SerializeIF.h"
+
+/**
+ * A class implementing this IF provides facilities to add a time stamp to the
+ * buffer provided.
+ * Implementors need to ensure that calling the method is thread-safe, i.e.
+ * addTimeStamp may be called in parallel from a different context.
+ */
+class TimeWriterIF : public SerializeIF, public TimeStampIF {
+ public:
+  ~TimeWriterIF() override = default;
+  [[nodiscard]] size_t getTimestampSize() const override { return getSerializedSize(); }
+
+  ReturnValue_t addTimeStamp(uint8_t *buf, size_t maxSize) {
+    size_t dummy = 0;
+    return serialize(buf, dummy, maxSize, SerializeIF::Endianness::NETWORK);
+  }
+
+ private:
+  /**
+   *   Forbidden, use dedicated IF @TimeReaderIF
+   */
+  ReturnValue_t deSerialize(const uint8_t **buffer, size_t *size,
+                            Endianness streamEndianness) override {
+    return returnvalue::FAILED;
+  }
+};
+
+#endif /* FSFW_TIMEMANAGER_TIMESTAMPERIF_H_ */

src/fsfw/tmstorage/TmStorePackets.h

@@ -7,7 +7,7 @@
 #include "fsfw/serialize/SerialLinkedListAdapter.h"
 #include "fsfw/serialize/SerializeElement.h"
 #include "fsfw/timemanager/CCSDSTime.h"
-#include "fsfw/timemanager/TimeStamperIF.h"
+#include "fsfw/timemanager/TimeWriterIF.h"
 #include "fsfw/tmtcpacket/pus/tm/PusTmMinimal.h"
 #include "tmStorageConf.h"
 

src/fsfw/tmtcpacket/pus/tm/PusTmCreator.cpp

@@ -3,7 +3,7 @@
 #include <utility>
 
 #include "fsfw/globalfunctions/CRC.h"
-#include "fsfw/timemanager/TimeStamperIF.h"
+#include "fsfw/timemanager/TimeWriterIF.h"
 
 PusTmCreator::PusTmCreator(SpacePacketParams initSpParams, PusTmParams initPusParams)
     : pusParams(initPusParams), spCreator(std::move(initSpParams)) {
@@ -30,7 +30,7 @@ uint8_t PusTmCreator::getSubService() const { return pusParams.secHeader.subserv
 
 PusTmParams& PusTmCreator::getParams() { return pusParams; }
 
-void PusTmCreator::setTimeStamper(TimeStamperIF& timeStamper_) {
+void PusTmCreator::setTimeStamper(TimeWriterIF& timeStamper_) {
   pusParams.secHeader.timeStamper = &timeStamper_;
   updateSpLengthField();
 }
@@ -106,7 +106,7 @@ ReturnValue_t PusTmCreator::deSerialize(const uint8_t** buffer, size_t* size,
   return returnvalue::FAILED;
 }
 
-TimeStamperIF* PusTmCreator::getTimestamper() const { return pusParams.secHeader.timeStamper; }
+TimeWriterIF* PusTmCreator::getTimestamper() const { return pusParams.secHeader.timeStamper; }
 
 SpacePacketParams& PusTmCreator::getSpParams() { return spCreator.getParams(); }
 

src/fsfw/tmtcpacket/pus/tm/PusTmCreator.h

@@ -8,12 +8,12 @@
 
 struct PusTmSecHeader {
   PusTmSecHeader() = default;
-  PusTmSecHeader(uint8_t service, uint8_t subservice, TimeStamperIF* timeStamper)
+  PusTmSecHeader(uint8_t service, uint8_t subservice, TimeWriterIF* timeStamper)
       : service(service), subservice(subservice), timeStamper(timeStamper) {}
 
   uint8_t service = 0;
   uint8_t subservice = 0;
-  TimeStamperIF* timeStamper = nullptr;
+  TimeWriterIF* timeStamper = nullptr;
   uint8_t pusVersion = ecss::PusVersion::PUS_C;
   uint8_t scTimeRefStatus = 0;
   uint16_t messageTypeCounter = 0;
@@ -26,10 +26,10 @@ struct PusTmParams {
   PusTmParams(PusTmSecHeader secHeader, util::DataWrapper dataWrapper)
       : secHeader(secHeader), dataWrapper(dataWrapper) {}
 
-  PusTmParams(uint8_t service, uint8_t subservice, TimeStamperIF* timeStamper)
+  PusTmParams(uint8_t service, uint8_t subservice, TimeWriterIF* timeStamper)
       : secHeader(service, subservice, timeStamper) {}
 
-  PusTmParams(uint8_t service, uint8_t subservice, TimeStamperIF* timeStamper,
+  PusTmParams(uint8_t service, uint8_t subservice, TimeWriterIF* timeStamper,
               util::DataWrapper dataWrapper_)
       : PusTmParams(service, subservice, timeStamper) {
     dataWrapper = dataWrapper_;
@@ -38,7 +38,7 @@ struct PusTmParams {
   util::DataWrapper dataWrapper{};
 };
 
-class TimeStamperIF;
+class TimeWriterIF;
 
 /**
  * This class provides a high-level interface to create PUS TM packets and then @serialize
@@ -56,7 +56,7 @@ class PusTmCreator : public SerializeIF, public PusTmIF, public CustomUserDataIF
   PusTmCreator(SpacePacketParams initSpParams, PusTmParams initPusParams);
   ~PusTmCreator() override = default;
 
-  void setTimeStamper(TimeStamperIF& timeStamper);
+  void setTimeStamper(TimeWriterIF& timeStamper);
   /**
    * This function disables the CRC16 calculation on serialization. This is useful to avoid
    * duplicate calculation if some lower level component needs to update fields like the sequence
@@ -86,7 +86,7 @@ class PusTmCreator : public SerializeIF, public PusTmIF, public CustomUserDataIF
   ReturnValue_t serialize(uint8_t** buffer, size_t* size, size_t maxSize,
                           Endianness streamEndianness) const override;
   [[nodiscard]] size_t getSerializedSize() const override;
-  [[nodiscard]] TimeStamperIF* getTimestamper() const;
+  [[nodiscard]] TimeWriterIF* getTimestamper() const;
   ReturnValue_t setRawUserData(const uint8_t* data, size_t len) override;
   ReturnValue_t setSerializableUserData(SerializeIF& serializable) override;
 

src/fsfw/tmtcpacket/pus/tm/PusTmIF.h

@@ -4,7 +4,7 @@
 #include <cstddef>
 #include <cstdint>
 
-#include "fsfw/timemanager/TimeStamperIF.h"
+#include "fsfw/timemanager/TimeWriterIF.h"
 #include "fsfw/tmtcpacket/pus/PusIF.h"
 #include "fsfw/tmtcpacket/pus/defs.h"
 

src/fsfw/tmtcservices/CommandingServiceBase.cpp

@@ -106,7 +106,7 @@ ReturnValue_t CommandingServiceBase::initialize() {
   // This avoids duplicate calculation of the CRC16
   tmStoreHelper.disableCrcCalculation();
   if (tmTimeStamper == nullptr) {
-    tmTimeStamper = ObjectManager::instance()->get<TimeStamperIF>(objects::TIME_STAMPER);
+    tmTimeStamper = ObjectManager::instance()->get<TimeWriterIF>(objects::TIME_STAMPER);
     if (tmTimeStamper == nullptr) {
       return ObjectManagerIF::CHILD_INIT_FAILED;
     }

src/fsfw/tmtcservices/CommandingServiceBase.h

@@ -273,7 +273,7 @@ class CommandingServiceBase : public SystemObject,
   MessageQueueIF* commandQueue = nullptr;
   MessageQueueIF* requestQueue = nullptr;
 
-  TimeStamperIF* tmTimeStamper = nullptr;
+  TimeWriterIF* tmTimeStamper = nullptr;
   VerificationReporterIF* verificationReporter;
 
   InternalErrorReporterIF* errReporter = nullptr;

src/fsfw/tmtcservices/PusServiceBase.cpp

@@ -178,7 +178,7 @@ ReturnValue_t PusServiceBase::initializeTmStoreHelper(TmStoreHelper& tmStoreHelp
   }
 
   if (psbParams.timeStamper == nullptr) {
-    auto timerStamper = ObjectManager::instance()->get<TimeStamperIF>(objects::TIME_STAMPER);
+    auto timerStamper = ObjectManager::instance()->get<TimeWriterIF>(objects::TIME_STAMPER);
     if (timerStamper != nullptr) {
       tmStoreHelper.setTimeStamper(*timerStamper);
     }

src/fsfw/tmtcservices/PusServiceBase.h

@@ -68,8 +68,8 @@ struct PsbParams {
    * a suitable global distributor with the static ID @PusServiceBase::pusDistributor and
    * register itself at that object.
    */
-  PusDistributorIF* pusDistributor = nullptr;
+  PUSDistributorIF* pusDistributor = nullptr;
-  TimeStamperIF* timeStamper = nullptr;
+  TimeWriterIF* timeStamper = nullptr;
 };
 
 namespace Factory {

src/fsfw/tmtcservices/TmStoreHelper.cpp

@@ -11,7 +11,7 @@ TmStoreHelper::TmStoreHelper(uint16_t defaultApid, StorageManagerIF& tmStore) :
 }
 
 TmStoreHelper::TmStoreHelper(uint16_t defaultApid, StorageManagerIF& tmStore,
-                             TimeStamperIF& timeStamper)
+                             TimeWriterIF& timeStamper)
     : tmStore(&tmStore) {
   creator.setApid(defaultApid);
   creator.setTimeStamper(timeStamper);
@@ -59,7 +59,7 @@ ReturnValue_t TmStoreHelper::addPacketToStore() {
                            SerializeIF::Endianness::NETWORK);
 }
 
-void TmStoreHelper::setTimeStamper(TimeStamperIF& timeStamper_) {
+void TmStoreHelper::setTimeStamper(TimeWriterIF& timeStamper_) {
   creator.setTimeStamper(timeStamper_);
 }
 
@@ -67,7 +67,7 @@ void TmStoreHelper::setApid(uint16_t apid) { creator.setApid(apid); }
 
 PusTmCreator& TmStoreHelper::getCreatorRef() { return creator; }
 
-TimeStamperIF* TmStoreHelper::getTimeStamper() const { return creator.getTimestamper(); }
+TimeWriterIF* TmStoreHelper::getTimeStamper() const { return creator.getTimestamper(); }
 
 uint16_t TmStoreHelper::getApid() const { return creator.getApid(); }
 

src/fsfw/tmtcservices/TmStoreHelper.h

@@ -4,14 +4,14 @@
 #include "fsfw/internalerror/InternalErrorReporterIF.h"
 #include "fsfw/ipc/MessageQueueMessageIF.h"
 #include "fsfw/storagemanager/StorageManagerIF.h"
-#include "fsfw/timemanager/TimeStamperIF.h"
+#include "fsfw/timemanager/TimeWriterIF.h"
 #include "fsfw/tmtcpacket/pus/tm/PusTmCreator.h"
 
 class TmStoreHelper {
  public:
   explicit TmStoreHelper(uint16_t defaultApid);
   TmStoreHelper(uint16_t defaultApid, StorageManagerIF& tmStore);
-  TmStoreHelper(uint16_t defaultApid, StorageManagerIF& tmStore, TimeStamperIF& timeStamper);
+  TmStoreHelper(uint16_t defaultApid, StorageManagerIF& tmStore, TimeWriterIF& timeStamper);
 
   void disableCrcCalculation();
   [[nodiscard]] bool crcCalculationEnabled() const;
@@ -20,8 +20,8 @@ class TmStoreHelper {
 
   PusTmCreator& getCreatorRef();
 
-  void setTimeStamper(TimeStamperIF& timeStamper);
+  void setTimeStamper(TimeWriterIF& timeStamper);
-  [[nodiscard]] TimeStamperIF* getTimeStamper() const;
+  [[nodiscard]] TimeWriterIF* getTimeStamper() const;
 
   [[nodiscard]] StorageManagerIF* getTmStore() const;
   void setTmStore(StorageManagerIF& store);

unittests/mocks/CdsShortTimestamperMock.h

@@ -4,9 +4,9 @@
 #include <array>
 
 #include "fsfw/timemanager/TimeReaderIF.h"
-#include "fsfw/timemanager/TimeStamperIF.h"
+#include "fsfw/timemanager/TimeWriterIF.h"
 
-class CdsShortTimestamperMock : public TimeStamperIF, public TimeReaderIF {
+class CdsShortTimestamperMock : public TimeWriterIF, public TimeReaderIF {
  public:
   unsigned int serializeCallCount = 0;
   unsigned int deserializeCallCount = 0;
@@ -61,7 +61,6 @@ class CdsShortTimestamperMock : public TimeStamperIF, public TimeReaderIF {
   }
 
   [[nodiscard]] size_t getTimestampSize() const override { return getSerializedSize(); }
-  ReturnValue_t addTimeStamp(uint8_t *buffer, uint8_t maxSize) override { return 0; }
 
   void reset() {
     serializeCallCount = 0;
@@ -75,9 +74,6 @@ class CdsShortTimestamperMock : public TimeStamperIF, public TimeReaderIF {
     serFailRetval = returnvalue::FAILED;
   }
 
-  ReturnValue_t readTimeStamp(const uint8_t *buffer, size_t maxSize) override {
-    return deSerialize(&buffer, &maxSize, SerializeIF::Endianness::NETWORK);
-  }
   timeval &getTime() override { return dummyTime; }
 
  private: