Implement file transfer thread (#468)

Fixes #384

Author: PatrickKa

.devcontainer/devcontainer.json

@@ -1,6 +1,6 @@
 {
     "name": "STS1 COBC",
-    "image": "tuwienspaceteam/sts1-cobc:1.17.0",
+    "image": "tuwienspaceteam/sts1-cobc:1.20.1",
     "customizations": {
         "vscode": {
             "extensions": [

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ on:
 jobs:
   format-and-spell-check:
     runs-on: ubuntu-24.04
-    container: tuwienspaceteam/sts1-cobc:1.17.0-linux-x86
+    container: tuwienspaceteam/sts1-cobc:1.20.1-linux-x86
 
     steps:
     - uses: actions/checkout@v4
@@ -32,7 +32,7 @@ jobs:
     needs: format-and-spell-check
 
     runs-on: ubuntu-24.04
-    container: tuwienspaceteam/sts1-cobc:1.17.0-linux-x86
+    container: tuwienspaceteam/sts1-cobc:1.20.1-linux-x86
 
     steps:
     - uses: actions/checkout@v4
@@ -60,7 +60,7 @@ jobs:
     needs: format-and-spell-check
 
     runs-on: ubuntu-24.04
-    container: tuwienspaceteam/sts1-cobc:1.17.0-linux-x86
+    container: tuwienspaceteam/sts1-cobc:1.20.1-linux-x86
 
     steps:
     - uses: actions/checkout@v4
@@ -86,7 +86,7 @@ jobs:
     needs: format-and-spell-check
 
     runs-on: ubuntu-24.04
-    container: tuwienspaceteam/sts1-cobc:1.17.0
+    container: tuwienspaceteam/sts1-cobc:1.20.1
 
     steps:
     - uses: actions/checkout@v4
@@ -123,7 +123,7 @@ jobs:
     needs: format-and-spell-check
 
     runs-on: ubuntu-24.04
-    container: tuwienspaceteam/sts1-cobc:1.17.0
+    container: tuwienspaceteam/sts1-cobc:1.20.1
 
     steps:
     - uses: actions/checkout@v4
@@ -171,7 +171,7 @@ jobs:
     needs: format-and-spell-check
 
     runs-on: ubuntu-24.04
-    container: tuwienspaceteam/sts1-cobc:1.17.0-linux-x86
+    container: tuwienspaceteam/sts1-cobc:1.20.1-linux-x86
 
     steps:
     - uses: actions/checkout@v4

Sts1CobcSw/ChannelCoding/External/ConvolutionalCoding.hpp

@@ -16,7 +16,7 @@
 #include <etl/vector.h>
 
 #include <array>
-#include <climits>
+#include <climits>  // IWYU pragma: keep
 #include <cstddef>
 #include <cstdint>
 #include <span>
@@ -88,7 +88,7 @@ class ViterbiCodec
     static inline auto outputs = std::array<std::uint8_t, 1U << constraint>();
 
     unsigned int state_ = 0;
-    unsigned int bytes_ = 0;
+    [[maybe_unused]] unsigned int bytes_ = 0;
 #ifdef USE_PUNCTURING
     unsigned int nProcessedBytes_ = 0;
 #endif
@@ -113,7 +113,7 @@ constexpr auto ViterbiCodec::EncodedSize(std::size_t unencodedSize,
     #else
     auto bits = (unencodedSize * CHAR_BIT + flushingBits) * 2;
     #endif
-    auto size = (bits + CHAR_BIT - 1) / CHAR_BIT; // Round up
+    auto size = (bits + CHAR_BIT - 1) / CHAR_BIT;  // Round up
     return size;
 #endif
 }

Sts1CobcSw/Edu/CMakeLists.txt

@@ -16,6 +16,7 @@ if(CMAKE_SYSTEM_NAME STREQUAL Generic)
                 Sts1CobcSw_RodosTime
                 Sts1CobcSw_Vocabulary
     )
+    set_target_properties(Sts1CobcSw_Edu PROPERTIES INTERPROCEDURAL_OPTIMIZATION_MINSIZEREL OFF)
 endif()
 if(CMAKE_SYSTEM_NAME STREQUAL Linux)
     target_sources(Sts1CobcSw_Edu PRIVATE EduMock.cpp)

Sts1CobcSw/Edu/Edu.cpp

@@ -75,7 +75,10 @@ constexpr auto maxFileSize = maxNPackets * maxDataSize;
 
 constexpr auto nProgramIdDigits =
     std::numeric_limits<strong::underlying_type_t<ProgramId>>::digits10 + 1;
+constexpr auto nStartTimeDigits =
+    std::numeric_limits<strong::underlying_type_t<RealTime>>::digits10 + 1;
 constexpr auto * programFileExtension = ".zip";
+constexpr auto * resultFileExtension = ".cpio";
 
 // Data buffer for potentially large data packets (ReturnResult and StoreProgram)
 auto cepDataBuffer = etl::vector<Byte, maxDataSize>{};
@@ -109,9 +112,6 @@ template<>
 template<typename T>
 [[nodiscard]] auto Retry(auto (*communicationFunction)()->Result<T>, int nTries) -> Result<T>;
 auto FlushUartReceiveBuffer() -> void;
-
-auto BuildProgramFilePath(ProgramId programId) -> fs::Path;
-auto BuildResultFilePath(ProgramId programId, RealTime startTime) -> fs::Path;
 }
 
 
@@ -175,7 +175,8 @@ auto StoreProgram(StoreProgramData const & data) -> Result<void>
     OUTCOME_TRY(auto fileSize, file.Size());
     if(fileSize > maxFileSize)
     {
-        DEBUG_PRINT("Program file %s is too large: %d B\n", path.c_str(), fileSize);
+        DEBUG_PRINT(
+            "Program file %s is too large: %i B\n", path.c_str(), static_cast<int>(fileSize));
         return ErrorCode::fileTooLarge;
     }
     OUTCOME_TRY(SendDataPacket(Serialize(data)));
@@ -331,11 +332,42 @@ auto UpdateTime(UpdateTimeData const & data) -> Result<void>
 }
 
 
+auto BuildProgramFilePath(ProgramId programId) -> fs::Path
+{
+    auto path = programsDirectory;
+    path.append("/");
+    etl::to_string(value_of(programId),
+                   path,
+                   etl::format_spec().width(nProgramIdDigits).fill('0'),
+                   /*append=*/true);
+    path.append(programFileExtension);
+    return path;
+}
+
+
+auto BuildResultFilePath(ProgramId programId, RealTime startTime) -> fs::Path
+{
+    auto path = resultsDirectory;
+    path.append("/");
+    etl::to_string(value_of(programId),
+                   path,
+                   etl::format_spec().width(nProgramIdDigits).fill('0'),
+                   /*append=*/true);
+    path.append("_");
+    etl::to_string(value_of(startTime),
+                   path,
+                   etl::format_spec().width(nStartTimeDigits).fill('0'),
+                   /*append=*/true);
+    path.append(resultFileExtension);
+    return path;
+}
+
+
 auto GetProgramId(fs::Path const & filename) -> Result<ProgramId>
 {
     static constexpr auto programFilenameLength =
         nProgramIdDigits + std::char_traits<char>::length(programFileExtension);
-    if(filename.size() == programFilenameLength)
+    if(filename.size() == programFilenameLength and filename.ends_with(programFileExtension))
     {
         std::uint16_t value = 0;
         auto result = std::from_chars(filename.data(), filename.data() + nProgramIdDigits, value);
@@ -345,7 +377,7 @@ auto GetProgramId(fs::Path const & filename) -> Result<ProgramId>
         }
     }
     DEBUG_PRINT("Failed to get EDU program ID from file %s\n", filename.c_str());
-    return ErrorCode::invalidParameter;
+    return ErrorCode::invalidEduProgramFilename;
 }
 
 
@@ -362,8 +394,9 @@ auto ProgramsAreAvailableOnCobc() -> bool
                        directoryIterator.end(),
                        [](auto const & entryResult)
                        {
-                           return not entryResult.has_error()
-                              and entryResult.value().type == fs::EntryType::file;
+                           return entryResult.has_value()
+                              and entryResult.value().type == fs::EntryType::file
+                              and GetProgramId(entryResult.value().name).has_value();
                        });
 }
 
@@ -622,38 +655,5 @@ auto FlushUartReceiveBuffer() -> void
         }
     }
 }
-
-
-auto BuildProgramFilePath(ProgramId programId) -> fs::Path
-{
-    auto path = programsDirectory;
-    path.append("/");
-    etl::to_string(value_of(programId),
-                   path,
-                   etl::format_spec().width(nProgramIdDigits).fill('0'),
-                   /*append=*/true);
-    path.append(programFileExtension);
-    return path;
-}
-
-
-auto BuildResultFilePath(ProgramId programId, RealTime startTime) -> fs::Path
-{
-    auto path = resultsDirectory;
-    path.append("/");
-    etl::to_string(value_of(programId),
-                   path,
-                   etl::format_spec().width(nProgramIdDigits).fill('0'),
-                   /*append=*/true);
-    path.append("_");
-    static constexpr auto nStartTimeDigits =
-        std::numeric_limits<strong::underlying_type_t<RealTime>>::digits10 + 1;
-    etl::to_string(value_of(startTime),
-                   path,
-                   etl::format_spec().width(nStartTimeDigits).fill('0'),
-                   /*append=*/true);
-    path.append(programFileExtension);
-    return path;
-}
 }
 }

Sts1CobcSw/Edu/Edu.hpp

@@ -6,6 +6,7 @@
 #include <Sts1CobcSw/Hal/GpioPin.hpp>
 #include <Sts1CobcSw/Outcome/Outcome.hpp>
 #include <Sts1CobcSw/Vocabulary/Ids.hpp>
+#include <Sts1CobcSw/Vocabulary/Time.hpp>
 
 
 namespace sts1cobcsw::edu
@@ -29,6 +30,8 @@ auto TurnOff() -> void;
 [[nodiscard]] auto ReturnResult(ReturnResultData const & data) -> Result<void>;
 [[nodiscard]] auto UpdateTime(UpdateTimeData const & data) -> Result<void>;
 
+[[nodiscard]] auto BuildProgramFilePath(ProgramId programId) -> fs::Path;
+[[nodiscard]] auto BuildResultFilePath(ProgramId programId, RealTime startTime) -> fs::Path;
 [[nodiscard]] auto GetProgramId(fs::Path const & filename) -> Result<ProgramId>;
 [[nodiscard]] auto ProgramsAreAvailableOnCobc() -> bool;
 }

Sts1CobcSw/FileSystem/File.cpp

@@ -70,19 +70,42 @@ auto Open(Path const & path, unsigned int flags) -> Result<File>
 }
 
 
-auto File::SeekAbsolute(int offset) -> Result<int>
+auto File::Resize(std::size_t newSize) -> Result<void>
+{
+    if(not persistentVariables.Load<"flashIsWorking">())
+    {
+        return ErrorCode::io;
+    }
+    if(not isOpen_)
+    {
+        return ErrorCode::fileNotOpen;
+    }
+    if((openFlags_ & LFS_O_WRONLY) == 0U)
+    {
+        return ErrorCode::unsupportedOperation;
+    }
+    auto error = lfs_file_truncate(&lfs, &lfsFile_, newSize);
+    if(error < 0)
+    {
+        return static_cast<ErrorCode>(error);
+    }
+    return outcome_v2::success();
+}
+
+
+auto File::SeekAbsolute(int offset) const -> Result<int>
 {
     return Seek(offset, LFS_SEEK_SET);
 }
 
 
-auto File::SeekRelative(int offset) -> Result<int>
+auto File::SeekRelative(int offset) const -> Result<int>
 {
     return Seek(offset, LFS_SEEK_CUR);
 }
 
 
-auto File::Size() const -> Result<int>
+auto File::Size() const -> Result<std::size_t>
 {
     if(not persistentVariables.Load<"flashIsWorking">())
     {
@@ -95,7 +118,7 @@ auto File::Size() const -> Result<int>
     auto size = lfs_file_size(&lfs, &lfsFile_);
     if(size >= 0)
     {
-        return size;
+        return static_cast<std::size_t>(size);
     }
     return static_cast<ErrorCode>(size);
 }
@@ -249,7 +272,7 @@ auto File::Write(void const * buffer, std::size_t size) -> Result<int>
 }
 
 
-auto File::Seek(int offset, int whence) -> Result<int>
+auto File::Seek(int offset, int whence) const -> Result<int>
 {
     if(not persistentVariables.Load<"flashIsWorking">())
     {

Sts1CobcSw/FileSystem/File.hpp

@@ -30,9 +30,10 @@ class File
     [[nodiscard]] auto Read(std::span<Byte, extent> data) const -> Result<int>;
     template<std::size_t extent>
     [[nodiscard]] auto Write(std::span<Byte const, extent> data) -> Result<int>;
-    [[nodiscard]] auto SeekAbsolute(int offset) -> Result<int>;
-    [[nodiscard]] auto SeekRelative(int offset) -> Result<int>;
-    [[nodiscard]] auto Size() const -> Result<int>;
+    [[nodiscard]] auto Resize(std::size_t newSize) -> Result<void>;
+    [[nodiscard]] auto SeekAbsolute(int offset) const -> Result<int>;
+    [[nodiscard]] auto SeekRelative(int offset) const -> Result<int>;
+    [[nodiscard]] auto Size() const -> Result<std::size_t>;
     [[nodiscard]] auto Close() const -> Result<void>;
     [[nodiscard]] auto Flush() -> Result<void>;
 
@@ -44,7 +45,7 @@ class File
     [[nodiscard]] auto CreateLockFile() const noexcept -> Result<void>;
     [[nodiscard]] auto Read(void * buffer, std::size_t size) const -> Result<int>;
     [[nodiscard]] auto Write(void const * buffer, std::size_t size) -> Result<int>;
-    [[nodiscard]] auto Seek(int offset, int whence) -> Result<int>;
+    [[nodiscard]] auto Seek(int offset, int whence) const -> Result<int>;
     [[nodiscard]] auto CloseAndKeepLockFile() const -> Result<void>;
 
     Path path_ = "";

Sts1CobcSw/FileSystem/LfsMemoryDevice.hpp

@@ -10,7 +10,7 @@ namespace sts1cobcsw::fs
 {
 inline constexpr auto crcSize = sizeof(std::uint32_t);
 inline constexpr auto lfsCacheSize = 256 - crcSize;
-// Our longest path should be strlen("/results/65536_4294967295.zip.lock") = 34 characters long
+// Our longest path should be strlen("/results/65536_4294967295.cpio.lock") = 35 characters long
 inline constexpr auto maxPathLength = 35;
 extern lfs_config const lfsConfig;