Merge branch 'development' into switch-doc-theme-to-rtd

Reviewed-on: fsfw/fsfw#755

CHANGELOG.md

@@ -22,14 +22,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/745
 - Small tweak for version getter
   https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/744
+- Important bugfix for `LocalPool::delete` function, where an overflow could possibly lead to UB.
 
 ## Added
 
 - add CFDP subsystem ID
   https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/742
 - New object ID for persistent TM store PUS 15
+- `EventManager`: Add function to print all listeners.
 
 ## Changed
+
 - Bump ETL version to 20.35.14
   https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/748
 - Renamed `PCDU_2` subsystem ID to `POWER_SWITCH_IF`.
@@ -38,14 +41,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/743
 - Assert that `FixedArrayList` is larger than 0 at compile time.
   https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/740
-
-## Added
-
-- `EventManager`: Add function to print all listeners.
-
-## Changed
-
 - `EventManager`: Queue depth is configurable now
+- `ActionHelper`: Allow execution of actions without additional data
 
 # [v6.0.0] 2023-02-10
 

automation/Jenkinsfile

@@ -90,16 +90,17 @@ pipeline {
                 branch 'development'
             }
             steps {
+                sh 'pip install -r docs/requirements.txt'
                 dir(DOCDDIR) {
                     sh 'cmake -DFSFW_BUILD_DOCS=ON -DFSFW_OSAL=host ..'
                     sh 'make Sphinx'
                     sshagent(credentials: ['documentation-buildfix']) {
-                        sh 'rsync -r --delete docs/sphinx/* buildfix@documentation.irs.uni-stuttgart.de:/fsfw/development'
+                        sh 'rsync -r --delete docs/sphinx/* buildfix@documentation.irs.uni-stuttgart.de:/projects/fsfw/development'
                     }
                 }
                 dir(BUILDDIR_LINUX) {
                     sshagent(credentials: ['documentation-buildfix']) {
-                        sh 'rsync -r --delete fsfw-tests_coverage/* buildfix@documentation.irs.uni-stuttgart.de:/fsfw/coverage/development'
+                        sh 'rsync -r --delete fsfw-tests_coverage/* buildfix@documentation.irs.uni-stuttgart.de:/projects/fsfw/coverage/development'
                     }
                 }
             }
@@ -109,16 +110,17 @@ pipeline {
                 branch 'master'
             }
             steps {
+                sh 'pip install -r docs/requirements.txt'
                 dir(DOCDDIR) {
                     sh 'cmake -DFSFW_BUILD_DOCS=ON -DFSFW_OSAL=host ..'
                     sh 'make Sphinx'
                     sshagent(credentials: ['documentation-buildfix']) {
-                        sh 'rsync -r --delete docs/sphinx/* buildfix@documentation.irs.uni-stuttgart.de:/fsfw/master'
+                        sh 'rsync -r --delete docs/sphinx/* buildfix@documentation.irs.uni-stuttgart.de:/projects/fsfw/master'
                     }
                 }
                 dir(BUILDDIR_LINUX) {
                     sshagent(credentials: ['documentation-buildfix']) {
-                        sh 'rsync -r --delete fsfw-tests_coverage/* buildfix@documentation.irs.uni-stuttgart.de:/fsfw/coverage/master'
+                        sh 'rsync -r --delete fsfw-tests_coverage/* buildfix@documentation.irs.uni-stuttgart.de:/projects/fsfw/coverage/master'
                     }
                 }
             }

docs/conf.py

@@ -21,6 +21,7 @@ project = "Flight Software Framework"
 copyright = "2021, Institute of Space Systems (IRS)"
 author = "Institute of Space Systems (IRS)"
 
+# TODO: Should try to read this from CMakeLists.txt automatically..
 # The full version, including alpha/beta/rc tags
 release = "5.0.0"
 
@@ -48,7 +49,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 
 html_theme_options = {
     "extra_nav_links": {"Impressum" : "https://www.uni-stuttgart.de/impressum", "Datenschutz": "https://info.irs.uni-stuttgart.de/datenschutz/datenschutzWebmit.html"}

docs/requirements.txt

@@ -0,0 +1 @@
+sphinx-rtd-theme==1.3.0

src/fsfw/action/ActionHelper.cpp

@@ -59,8 +59,12 @@ void ActionHelper::setQueueToUse(MessageQueueIF* queue) { queueToUse = queue; }
 
 void ActionHelper::prepareExecution(MessageQueueId_t commandedBy, ActionId_t actionId,
                                     store_address_t dataAddress) {
+  bool hasAdditionalData = false;
   const uint8_t* dataPtr = nullptr;
   size_t size = 0;
+  ReturnValue_t result;
+  if (dataAddress != store_address_t::invalid()) {
+    hasAdditionalData = true;
     ReturnValue_t result = ipcStore->getData(dataAddress, &dataPtr, &size);
     if (result != returnvalue::OK) {
       CommandMessage reply;
@@ -68,8 +72,11 @@ void ActionHelper::prepareExecution(MessageQueueId_t commandedBy, ActionId_t act
       queueToUse->sendMessage(commandedBy, &reply);
       return;
     }
+  }
   result = owner->executeAction(actionId, commandedBy, dataPtr, size);
+  if (hasAdditionalData) {
     ipcStore->deleteData(dataAddress);
+  }
   if (result == HasActionsIF::EXECUTION_FINISHED) {
     CommandMessage reply;
     ActionMessage::setCompletionReply(&reply, actionId, true, result);

src/fsfw/action/CommandActionHelper.h

@@ -16,8 +16,8 @@ class CommandActionHelper {
  public:
   explicit CommandActionHelper(CommandsActionsIF* owner);
   virtual ~CommandActionHelper();
-  ReturnValue_t commandAction(object_id_t commandTo, ActionId_t actionId, const uint8_t* data,
-                              uint32_t size);
+  ReturnValue_t commandAction(object_id_t commandTo, ActionId_t actionId,
+                              const uint8_t* data = nullptr, uint32_t size = 0);
   ReturnValue_t commandAction(object_id_t commandTo, ActionId_t actionId, SerializeIF* data);
   ReturnValue_t initialize();
   ReturnValue_t handleReply(CommandMessage* reply);

src/fsfw/storagemanager/LocalPool.cpp

@@ -89,7 +89,7 @@ ReturnValue_t LocalPool::deleteData(store_address_t storeId) {
   ReturnValue_t status = returnvalue::OK;
   size_type pageSize = getSubpoolElementSize(storeId.poolIndex);
   if ((pageSize != 0) and (storeId.packetIndex < numberOfElements[storeId.poolIndex])) {
-    uint16_t packetPosition = getRawPosition(storeId);
+    size_type packetPosition = getRawPosition(storeId);
     uint8_t* ptr = &store[storeId.poolIndex][packetPosition];
     std::memset(ptr, 0, pageSize);
     // Set free list

unittests/action/TestActionHelper.cpp

@@ -27,12 +27,7 @@ TEST_CASE("Action Helper", "[action]") {
     CHECK(not testDhMock.executeActionCalled);
     REQUIRE(actionHelper.handleActionMessage(&actionMessage) == returnvalue::OK);
     CHECK(testDhMock.executeActionCalled);
-    // No message is sent if everything is alright.
     CHECK(not testMqMock.wasMessageSent());
-    store_address_t invalidAddress;
-    ActionMessage::setCommand(&actionMessage, testActionId, invalidAddress);
-    actionHelper.handleActionMessage(&actionMessage);
-    CHECK(testMqMock.wasMessageSent());
     const uint8_t* ptr = nullptr;
     size_t size = 0;
     REQUIRE(ipcStore->getData(paramAddress, &ptr, &size) ==
@@ -44,6 +39,10 @@ TEST_CASE("Action Helper", "[action]") {
     for (uint8_t i = 0; i < 3; i++) {
       REQUIRE(ptr[i] == (i + 1));
     }
+    // Action message without application data is also valid
+    store_address_t invalidAddress;
+    ActionMessage::setCommand(&actionMessage, testActionId, invalidAddress);
+    actionHelper.handleActionMessage(&actionMessage);
     testDhMock.clearBuffer();
   }
 
@@ -95,17 +94,5 @@ TEST_CASE("Action Helper", "[action]") {
     REQUIRE(ActionMessage::getActionId(&testMessage) == testActionId);
   }
 
-  SECTION("Missing IPC Data") {
-    ActionMessage::setCommand(&actionMessage, testActionId, store_address_t::invalid());
-    CHECK(not testDhMock.executeActionCalled);
-    REQUIRE(actionHelper.handleActionMessage(&actionMessage) == returnvalue::OK);
-    CommandMessage testMessage;
-    REQUIRE(testMqMock.getNextSentMessage(testMessage) == returnvalue::OK);
-    REQUIRE(testMessage.getCommand() == static_cast<uint32_t>(ActionMessage::STEP_FAILED));
-    REQUIRE(ActionMessage::getReturnCode(&testMessage) ==
-            static_cast<uint32_t>(StorageManagerIF::ILLEGAL_STORAGE_ID));
-    REQUIRE(ActionMessage::getStep(&testMessage) == 0);
-  }
-
   SECTION("Data Reply") {}
 }