restructure repository

src/core/container/CMakeLists.txt

@@ -0,0 +1,5 @@
+target_sources(${LIB_FSFW_NAME} 
+    PRIVATE 
+        SharedRingBuffer.cpp
+        SimpleRingBuffer.cpp
+)

src/core/container/SharedRingBuffer.cpp

@@ -0,0 +1,60 @@
+#include "SharedRingBuffer.h"
+#include "../ipc/MutexFactory.h"
+#include "../ipc/MutexGuard.h"
+
+SharedRingBuffer::SharedRingBuffer(object_id_t objectId, const size_t size,
+        bool overwriteOld, size_t maxExcessBytes):
+        SystemObject(objectId), SimpleRingBuffer(size, overwriteOld,
+        maxExcessBytes) {
+    mutex = MutexFactory::instance()->createMutex();
+}
+
+
+SharedRingBuffer::SharedRingBuffer(object_id_t objectId, uint8_t *buffer,
+        const size_t size, bool overwriteOld, size_t maxExcessBytes):
+        SystemObject(objectId), SimpleRingBuffer(buffer, size, overwriteOld,
+        maxExcessBytes) {
+    mutex = MutexFactory::instance()->createMutex();
+}
+
+SharedRingBuffer::~SharedRingBuffer() {
+    MutexFactory::instance()->deleteMutex(mutex);
+}
+
+void SharedRingBuffer::setToUseReceiveSizeFIFO(size_t fifoDepth) {
+    this->fifoDepth = fifoDepth;
+}
+
+ReturnValue_t SharedRingBuffer::lockRingBufferMutex(
+        MutexIF::TimeoutType timeoutType, dur_millis_t timeout) {
+    return mutex->lockMutex(timeoutType, timeout);
+}
+
+ReturnValue_t SharedRingBuffer::unlockRingBufferMutex() {
+    return mutex->unlockMutex();
+}
+
+
+
+MutexIF* SharedRingBuffer::getMutexHandle() const {
+    return mutex;
+}
+
+ReturnValue_t SharedRingBuffer::initialize() {
+    if(fifoDepth > 0) {
+        receiveSizesFIFO = new DynamicFIFO<size_t>(fifoDepth);
+    }
+    return SystemObject::initialize();
+}
+
+DynamicFIFO<size_t>* SharedRingBuffer::getReceiveSizesFIFO() {
+    if(receiveSizesFIFO == nullptr) {
+        // Configuration error.
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+        sif::warning << "SharedRingBuffer::getReceiveSizesFIFO: Ring buffer"
+                << " was not configured to have sizes FIFO, returning nullptr!"
+                << std::endl;
+#endif
+    }
+    return receiveSizesFIFO;
+}

src/core/container/SimpleRingBuffer.cpp

@@ -0,0 +1,131 @@
+#include "SimpleRingBuffer.h"
+#include <cstring>
+
+SimpleRingBuffer::SimpleRingBuffer(const size_t size, bool overwriteOld,
+        size_t maxExcessBytes) :
+        RingBufferBase<>(0, size, overwriteOld),
+        maxExcessBytes(maxExcessBytes) {
+    if(maxExcessBytes > size) {
+        this->maxExcessBytes = size;
+    }
+    else {
+        this->maxExcessBytes = maxExcessBytes;
+    }
+    buffer = new uint8_t[size + maxExcessBytes];
+}
+
+SimpleRingBuffer::SimpleRingBuffer(uint8_t *buffer, const size_t size,
+        bool overwriteOld, size_t maxExcessBytes):
+        RingBufferBase<>(0, size, overwriteOld), buffer(buffer) {
+    if(maxExcessBytes > size) {
+        this->maxExcessBytes = size;
+    }
+    else {
+        this->maxExcessBytes = maxExcessBytes;
+    }
+}
+
+SimpleRingBuffer::~SimpleRingBuffer() {
+    delete[] buffer;
+}
+
+ReturnValue_t SimpleRingBuffer::getFreeElement(uint8_t **writePointer,
+        size_t amount) {
+    if (availableWriteSpace() >= amount or overwriteOld) {
+        size_t amountTillWrap = writeTillWrap();
+        if (amountTillWrap < amount) {
+            if((amount - amountTillWrap + excessBytes) > maxExcessBytes) {
+                return HasReturnvaluesIF::RETURN_FAILED;
+            }
+            excessBytes = amount - amountTillWrap;
+        }
+        *writePointer = &buffer[write];
+        return HasReturnvaluesIF::RETURN_OK;
+    }
+    else {
+        return HasReturnvaluesIF::RETURN_FAILED;
+    }
+}
+
+void SimpleRingBuffer::confirmBytesWritten(size_t amount) {
+    if(getExcessBytes() > 0) {
+        moveExcessBytesToStart();
+    }
+    incrementWrite(amount);
+
+}
+
+ReturnValue_t SimpleRingBuffer::writeData(const uint8_t* data,
+        size_t amount) {
+    if (availableWriteSpace() >= amount or overwriteOld) {
+        size_t amountTillWrap = writeTillWrap();
+        if (amountTillWrap >= amount) {
+            // remaining size in buffer is sufficient to fit full amount.
+            memcpy(&buffer[write], data, amount);
+        }
+        else {
+            memcpy(&buffer[write], data, amountTillWrap);
+            memcpy(buffer, data + amountTillWrap, amount - amountTillWrap);
+        }
+        incrementWrite(amount);
+        return HasReturnvaluesIF::RETURN_OK;
+    } else {
+        return HasReturnvaluesIF::RETURN_FAILED;
+    }
+}
+
+ReturnValue_t SimpleRingBuffer::readData(uint8_t* data, size_t amount,
+        bool incrementReadPtr, bool readRemaining, size_t* trueAmount) {
+    size_t availableData = getAvailableReadData(READ_PTR);
+    size_t amountTillWrap = readTillWrap(READ_PTR);
+    if (availableData < amount) {
+        if (readRemaining) {
+            // more data available than amount specified.
+            amount = availableData;
+        } else {
+            return HasReturnvaluesIF::RETURN_FAILED;
+        }
+    }
+    if (trueAmount != nullptr) {
+        *trueAmount = amount;
+    }
+    if (amountTillWrap >= amount) {
+        memcpy(data, &buffer[read[READ_PTR]], amount);
+    } else {
+        memcpy(data, &buffer[read[READ_PTR]], amountTillWrap);
+        memcpy(data + amountTillWrap, buffer, amount - amountTillWrap);
+    }
+
+    if(incrementReadPtr) {
+        deleteData(amount, readRemaining);
+    }
+    return HasReturnvaluesIF::RETURN_OK;
+}
+
+size_t SimpleRingBuffer::getExcessBytes() const {
+    return excessBytes;
+}
+
+void SimpleRingBuffer::moveExcessBytesToStart() {
+    if(excessBytes > 0) {
+        std::memcpy(buffer, &buffer[size], excessBytes);
+        excessBytes = 0;
+    }
+}
+
+ReturnValue_t SimpleRingBuffer::deleteData(size_t amount,
+        bool deleteRemaining, size_t* trueAmount) {
+    size_t availableData = getAvailableReadData(READ_PTR);
+    if (availableData < amount) {
+        if (deleteRemaining) {
+            amount = availableData;
+        } else {
+            return HasReturnvaluesIF::RETURN_FAILED;
+        }
+    }
+    if (trueAmount != nullptr) {
+        *trueAmount = amount;
+    }
+    incrementRead(amount, READ_PTR);
+    return HasReturnvaluesIF::RETURN_OK;
+}