handling of space packets which are too short

Reviewed-on: #100

CMakeLists.txt

@@ -182,7 +182,10 @@ if(FSFW_BUILD_UNITTESTS)
   endif()
 endif()
 
-message(STATUS "${MSG_PREFIX} Finding and/or providing etl library with version ${FSFW_ETL_LIB_MAJOR_VERSION}")
+message(
+  STATUS
+    "${MSG_PREFIX} Finding and/or providing etl library with version ${FSFW_ETL_LIB_MAJOR_VERSION}"
+)
 
 # Check whether the user has already installed ETL first
 find_package(${FSFW_ETL_LIB_NAME} ${FSFW_ETL_LIB_MAJOR_VERSION} CONFIG QUIET)

src/fsfw/datapoollocal/LocalDataPoolManager.cpp

@@ -577,8 +577,9 @@ ReturnValue_t LocalDataPoolManager::handleHousekeepingMessage(CommandMessage* me
 
   CommandMessage reply;
   if (result != HasReturnvaluesIF::RETURN_OK) {
-    if(result == WRONG_HK_PACKET_TYPE) {
-      printWarningOrError(sif::OutputTypes::OUT_WARNING, "handleHousekeepingMessage", WRONG_HK_PACKET_TYPE);
+    if (result == WRONG_HK_PACKET_TYPE) {
+      printWarningOrError(sif::OutputTypes::OUT_WARNING, "handleHousekeepingMessage",
+                          WRONG_HK_PACKET_TYPE);
     }
     HousekeepingMessage::setHkRequestFailureReply(&reply, sid, result);
   } else {
@@ -699,9 +700,10 @@ void LocalDataPoolManager::performPeriodicHkGeneration(HkReceiver& receiver) {
   if (result != HasReturnvaluesIF::RETURN_OK) {
     /* Configuration error */
 #if FSFW_CPP_OSTREAM_ENABLED == 1
-    sif::warning << "LocalDataPoolManager::performHkOperation: HK generation failed." << std::endl;
+    sif::warning << "LocalDataPoolManager::performPeriodicHkOperation: HK generation failed."
+                 << std::endl;
 #else
-    sif::printWarning("LocalDataPoolManager::performHkOperation: HK generation failed.\n");
+    sif::printWarning("LocalDataPoolManager::performPeriodicHkOperation: HK generation failed.\n");
 #endif
   }
 }

src/fsfw/devicehandlers/DeviceHandlerBase.cpp

@@ -572,6 +572,9 @@ void DeviceHandlerBase::setMode(Mode_t newMode, uint8_t newSubmode) {
   mode = newMode;
   modeChanged();
   setNormalDatapoolEntriesInvalid();
+  if (newMode == MODE_OFF) {
+    disableCommandsAndReplies();
+  }
   if (!isTransitionalMode()) {
     modeHelper.modeChanged(newMode, newSubmode);
     announceMode(false);
@@ -1567,3 +1570,21 @@ void DeviceHandlerBase::setParent(object_id_t parent) { this->parent = parent; }
 void DeviceHandlerBase::setPowerSwitcher(PowerSwitchIF* switcher) {
   this->powerSwitcher = switcher;
 }
+
+void DeviceHandlerBase::disableCommandsAndReplies() {
+  for (auto& command : deviceCommandMap) {
+    if (command.second.isExecuting) {
+      command.second.isExecuting = false;
+    }
+  }
+  for (auto& reply : deviceReplyMap) {
+    if (!reply.second.periodic) {
+      if (reply.second.countdown != nullptr) {
+        reply.second.countdown->timeOut();
+      } else {
+        reply.second.delayCycles = 0;
+      }
+      reply.second.active = false;
+    }
+  }
+}

src/fsfw/devicehandlers/DeviceHandlerBase.h

@@ -1325,6 +1325,11 @@ class DeviceHandlerBase : public DeviceHandlerIF,
   void printWarningOrError(sif::OutputTypes errorType, const char *functionName,
                            ReturnValue_t errorCode = HasReturnvaluesIF::RETURN_FAILED,
                            const char *errorPrint = nullptr);
+
+  /**
+   * @brief Disables all commands and replies when device is set to MODE_OFF
+   */
+  void disableCommandsAndReplies();
 };
 
 #endif /* FSFW_DEVICEHANDLERS_DEVICEHANDLERBASE_H_ */

src/fsfw/osal/CMakeLists.txt

@@ -16,7 +16,9 @@ elseif(FSFW_OSAL MATCHES "host")
 
 else()
 
-  message(WARNING "${MSG_PREFIX} The FSFW_OSAL variable was not set. Assuming host OS..")
+  message(
+    WARNING
+      "${MSG_PREFIX} The FSFW_OSAL variable was not set. Assuming host OS..")
   # Not set. Assumuing this is a host build, try to determine host OS
   if(WIN32)
     add_subdirectory(host)

src/fsfw/osal/host/PeriodicTask.h

@@ -53,6 +53,7 @@ class PeriodicTask : public PeriodicTaskBase {
   ReturnValue_t sleepFor(uint32_t ms) override;
 
   bool isEmpty() const override;
+
  protected:
   using chron_ms = std::chrono::milliseconds;
   bool started;

src/fsfw/power/PowerSwitchIF.h

@@ -29,9 +29,9 @@ class PowerSwitchIF : public HasReturnvaluesIF {
   static const ReturnValue_t FUSE_ON = MAKE_RETURN_CODE(3);
   static const ReturnValue_t FUSE_OFF = MAKE_RETURN_CODE(4);
   static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::PCDU_2;
-  static const Event SWITCH_WENT_OFF = MAKE_EVENT(
-      0, severity::LOW);  //!< Someone detected that a switch went off which shouldn't. Severity:
-                          //!< Low, Parameter1: switchId1, Parameter2: switchId2
+  //!< Someone detected that a switch went off which shouldn't. Severity:
+  //!< Low, Parameter1: switchId1, Parameter2: switchId2
+  static const Event SWITCH_WENT_OFF = MAKE_EVENT(0, severity::LOW);
   /**
    * send a direct command to the Power Unit to enable/disable the specified switch.
    *

src/fsfw/pus/Service3Housekeeping.cpp

@@ -248,16 +248,18 @@ void Service3Housekeeping::handleUnrequestedReply(CommandMessage* reply) {
     case (HousekeepingMessage::HK_REQUEST_FAILURE): {
       break;
     }
-    case(CommandMessage::REPLY_REJECTED): {
+    case (CommandMessage::REPLY_REJECTED): {
       sif::warning << "Service3Housekeeping::handleUnrequestedReply: Unexpected reply "
-          "rejected with error code" << reply->getParameter() << std::endl;
+                      "rejected with error code"
+                   << reply->getParameter() << std::endl;
       break;
     }
 
     default: {
 #if FSFW_CPP_OSTREAM_ENABLED == 1
       sif::warning << "Service3Housekeeping::handleUnrequestedReply: Invalid reply with reply "
-                      "command " << command << "" << std::endl;
+                      "command "
+                   << command << "" << std::endl;
 #else
       sif::printWarning(
           "Service3Housekeeping::handleUnrequestedReply: Invalid reply with "

src/fsfw/tcdistribution/CFDPDistributor.cpp

@@ -33,7 +33,11 @@ CFDPDistributor::TcMqMapIter CFDPDistributor::selectDestination() {
   if (this->currentPacket == nullptr) {
     return queueMapIt;
   }
-  this->currentPacket->setStoreAddress(this->currentMessage.getStorageId());
+  ReturnValue_t result = this->currentPacket->setStoreAddress(this->currentMessage.getStorageId());
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    tcStatus = PACKET_TOO_SHORT;
+    return this->queueMap.end();
+  }
   if (currentPacket->getWholeData() != nullptr) {
     tcStatus = checker.checkPacket(currentPacket);
     if (tcStatus != HasReturnvaluesIF::RETURN_OK) {

src/fsfw/tcdistribution/PUSDistributor.cpp

@@ -27,7 +27,12 @@ PUSDistributor::TcMqMapIter PUSDistributor::selectDestination() {
     if (this->currentPacket == nullptr) {
       return queueMapIt;
     }
-    this->currentPacket->setStoreAddress(this->currentMessage.getStorageId(), currentPacket);
+    ReturnValue_t result =
+        this->currentPacket->setStoreAddress(this->currentMessage.getStorageId(), currentPacket);
+    if (result != HasReturnvaluesIF::RETURN_OK) {
+      tcStatus = PACKET_TOO_SHORT;
+      return this->queueMap.end();
+    }
     if (currentPacket->getWholeData() != nullptr) {
       tcStatus = checker.checkPacket(currentPacket);
       if (tcStatus != HasReturnvaluesIF::RETURN_OK) {
@@ -106,6 +111,14 @@ ReturnValue_t PUSDistributor::registerService(AcceptsTelecommandsIF* service) {
 MessageQueueId_t PUSDistributor::getRequestQueue() { return tcQueue->getId(); }
 
 ReturnValue_t PUSDistributor::callbackAfterSending(ReturnValue_t queueStatus) {
+  if (tcStatus == PACKET_LOST or tcStatus == PACKET_TOO_SHORT) {
+    // The ack flags, packet id and sequence control are unknown for a packet which is too short or
+    // has been lost
+    this->verifyChannel.sendFailureReport(tc_verification::ACCEPTANCE_FAILURE, UNKNOWN_ACK_FLAGS,
+                                          UNKNOWN_PACKET_ID, UNKNOWN_SEQUENCE_CONTROL, tcStatus);
+    currentPacket->deletePacket();
+    return RETURN_FAILED;
+  }
   if (queueStatus != RETURN_OK) {
     tcStatus = queueStatus;
   }

src/fsfw/tcdistribution/PUSDistributor.h

@@ -72,6 +72,11 @@ class PUSDistributor : public TcDistributor, public PUSDistributorIF, public Acc
    * success/failure messages.
    */
   ReturnValue_t callbackAfterSending(ReturnValue_t queueStatus) override;
+
+ private:
+  static const uint8_t UNKNOWN_ACK_FLAGS = 0;
+  static const uint8_t UNKNOWN_PACKET_ID = 0;
+  static const uint8_t UNKNOWN_SEQUENCE_CONTROL = 0;
 };
 
 #endif /* FSFW_TCDISTRIBUTION_PUSDISTRIBUTOR_H_ */

src/fsfw/tcdistribution/TcDistributor.h

@@ -36,6 +36,7 @@ class TcDistributor : public SystemObject, public ExecutableObjectIF, public Has
   static constexpr ReturnValue_t PACKET_LOST = MAKE_RETURN_CODE(1);
   static constexpr ReturnValue_t DESTINATION_NOT_FOUND = MAKE_RETURN_CODE(2);
   static constexpr ReturnValue_t SERVICE_ID_ALREADY_EXISTS = MAKE_RETURN_CODE(3);
+  static constexpr ReturnValue_t PACKET_TOO_SHORT = MAKE_RETURN_CODE(4);
   /**
    * Within the default constructor, the SystemObject id is set and the
    * message queue is initialized.

src/fsfw/thermal/ThermalComponentIF.h

@@ -13,9 +13,9 @@ class ThermalComponentIF : public HasParametersIF {
   static const Event COMPONENT_TEMP_HIGH = MAKE_EVENT(2, severity::LOW);
   static const Event COMPONENT_TEMP_OOL_LOW = MAKE_EVENT(3, severity::LOW);
   static const Event COMPONENT_TEMP_OOL_HIGH = MAKE_EVENT(4, severity::LOW);
-  static const Event TEMP_NOT_IN_OP_RANGE = MAKE_EVENT(
-      5, severity::LOW);  //!< Is thrown when a device should start-up, but the temperature is out
-                          //!< of OP range. P1: thermalState of the component, P2: 0
+  //!< Is thrown when a device should start-up, but the temperature is out
+  //!< of OP range. P1: thermalState of the component, P2: 0
+  static const Event TEMP_NOT_IN_OP_RANGE = MAKE_EVENT(5, severity::LOW);
 
   static const uint8_t INTERFACE_ID = CLASS_ID::THERMAL_COMPONENT_IF;
   static const ReturnValue_t INVALID_TARGET_STATE = MAKE_RETURN_CODE(1);

src/fsfw/tmtcpacket/cfdp/CFDPPacketStored.cpp

@@ -37,7 +37,7 @@ ReturnValue_t CFDPPacketStored::deletePacket() {
 // CFDPPacket* CFDPPacketStored::getPacketBase() {
 //     return this;
 // }
-void CFDPPacketStored::setStoreAddress(store_address_t setAddress) {
+ReturnValue_t CFDPPacketStored::setStoreAddress(store_address_t setAddress) {
   this->storeAddress = setAddress;
   const uint8_t* tempData = nullptr;
   size_t tempSize;
@@ -46,11 +46,11 @@ void CFDPPacketStored::setStoreAddress(store_address_t setAddress) {
     status = this->store->getData(this->storeAddress, &tempData, &tempSize);
   }
   if (status == StorageManagerIF::RETURN_OK) {
-    this->setData(const_cast<uint8_t*>(tempData), tempSize);
+    return this->setData(const_cast<uint8_t*>(tempData), tempSize);
   } else {
-    // To circumvent size checks
-    this->setData(nullptr, -1);
     this->storeAddress.raw = StorageManagerIF::INVALID_ADDRESS;
+    // To circumvent size checks
+    return this->setData(nullptr, -1);
   }
 }
 

src/fsfw/tmtcpacket/cfdp/CFDPPacketStored.h

@@ -29,7 +29,7 @@ class CFDPPacketStored : public CFDPPacket, public TcPacketStoredBase {
    */
   ReturnValue_t getData(const uint8_t** dataPtr, size_t* dataSize);
 
-  void setStoreAddress(store_address_t setAddress);
+  ReturnValue_t setStoreAddress(store_address_t setAddress);
 
   store_address_t getStoreAddress();
 

src/fsfw/tmtcpacket/pus/tc/TcPacketStoredBase.cpp

@@ -42,7 +42,7 @@ bool TcPacketStoredBase::checkAndSetStore() {
   return true;
 }
 
-void TcPacketStoredBase::setStoreAddress(store_address_t setAddress,
+ReturnValue_t TcPacketStoredBase::setStoreAddress(store_address_t setAddress,
                                          RedirectableDataPointerIF* packet) {
   this->storeAddress = setAddress;
   const uint8_t* tempData = nullptr;
@@ -53,10 +53,10 @@ void TcPacketStoredBase::setStoreAddress(store_address_t setAddress,
   }
 
   if (status == StorageManagerIF::RETURN_OK) {
-    packet->setData(const_cast<uint8_t*>(tempData), tempSize);
+    return packet->setData(const_cast<uint8_t*>(tempData), tempSize);
   } else {
-    packet->setData(nullptr, -1);
     this->storeAddress.raw = StorageManagerIF::INVALID_ADDRESS;
+    return packet->setData(nullptr, -1);
   }
 }
 

src/fsfw/tmtcpacket/pus/tc/TcPacketStoredBase.h

@@ -38,7 +38,8 @@ class TcPacketStoredBase : public TcPacketStoredIF {
    */
   ReturnValue_t getData(const uint8_t** dataPtr, size_t* dataSize) override;
 
-  void setStoreAddress(store_address_t setAddress, RedirectableDataPointerIF* packet) override;
+  ReturnValue_t setStoreAddress(store_address_t setAddress,
+                                RedirectableDataPointerIF* packet) override;
   store_address_t getStoreAddress() override;
 
   /**

src/fsfw/tmtcpacket/pus/tc/TcPacketStoredIF.h

@@ -16,8 +16,11 @@ class TcPacketStoredIF {
    * With this call, the stored packet can be set to another packet in a store. This is useful
    * if the packet is a class member and used for more than one packet.
    * @param setAddress    The new packet id to link to.
+   *
+   * @return RETURN_OK if successful otherwise error return code.
    */
-  virtual void setStoreAddress(store_address_t setAddress, RedirectableDataPointerIF* packet) = 0;
+  virtual ReturnValue_t setStoreAddress(store_address_t setAddress,
+                                        RedirectableDataPointerIF* packet) = 0;
 
   virtual store_address_t getStoreAddress() = 0;