ChecksumLayer.h

Go to the documentation of this file.

//
// Copyright 2015 - 2025 (C). Alex Robenko. All rights reserved.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 
#pragma once
 
#include "comms/cast.h"
#include "comms/CompileControl.h"
#include "comms/details/tag.h"
#include "comms/field/IntValue.h"
#include "comms/frame/details/ChecksumLayerBase.h"
#include "comms/frame/details/ChecksumLayerOptionsParser.h"
#include "comms/util/type_traits.h"
 
#include <iterator>
#include <type_traits>
 
COMMS_MSVC_WARNING_PUSH
COMMS_MSVC_WARNING_DISABLE(4189) // Disable erroneous initialized but not referenced variable warning
 
namespace comms
{
 
namespace frame
{
template <typename TField, typename TCalc, typename TNextLayer, typename... TOptions>
class ChecksumLayer : public comms::frame::details::ChecksumLayerBase<TField, TCalc, TNextLayer, TOptions...>
{
    using BaseImpl = comms::frame::details::ChecksumLayerBase<TField, TCalc, TNextLayer, TOptions...>;
    using ParsedOptionsInternal = details::ChecksumLayerOptionsParser<TOptions...>;
 
public:
    using Field = typename BaseImpl::Field;
 
    using ChecksumCalc = TCalc;
 
    using ExtendingClass = typename ParsedOptionsInternal::ExtendingClass;    
 
    ChecksumLayer() = default;
 
    ChecksumLayer(const ChecksumLayer&) = default;
 
    ChecksumLayer(ChecksumLayer&&) = default;
 
    ~ChecksumLayer() noexcept = default;
 
    ChecksumLayer& operator=(const ChecksumLayer&) = default;
 
    ChecksumLayer& operator=(ChecksumLayer&&) = default;
 
    static constexpr bool hasExtendingClass()
    {
        return ParsedOptionsInternal::HasExtendingClass;
    }   
 
    static constexpr bool hasVerifyBeforeRead()
    {
        return ParsedOptionsInternal::HasVerifyBeforeRead;
    }     
 
    template <typename TMsg, typename TIter, typename TNextLayerReader, typename... TExtraValues>
    ErrorStatus doRead(
        Field& field,
        TMsg& msg,
        TIter& iter,
        std::size_t size,
        TNextLayerReader&& nextLayerReader,
        TExtraValues... extraValues)
    {
        using IterType = typename std::decay<decltype(iter)>::type;
        static_assert(std::is_same<typename std::iterator_traits<IterType>::iterator_category, std::random_access_iterator_tag>::value,
            "The read operation is expected to use random access iterator");
 
        using VerifyTag = 
            typename comms::util::LazyShallowConditional<
                ParsedOptionsInternal::HasVerifyBeforeRead
            >::template Type<
                VerifyBeforeReadTag,
                VerifyAfterReadTag
            >;        
 
        return
            readInternal(
                field,
                msg,
                iter,
                size,
                std::forward<TNextLayerReader>(nextLayerReader),
                VerifyTag(),
                extraValues...);
    }
 
    template <typename TMsg, typename TIter, typename TNextLayerWriter>
    ErrorStatus doWrite(
        Field& field,
        const TMsg& msg,
        TIter& iter,
        std::size_t size,
        TNextLayerWriter&& nextLayerWriter) const
    {
        using IterType = typename std::decay<decltype(iter)>::type;
        using Tag = typename std::iterator_traits<IterType>::iterator_category;
 
        return writeInternal(field, msg, iter, size, std::forward<TNextLayerWriter>(nextLayerWriter), Tag());
    }
 
    template <typename TIter, typename TNextLayerUpdater>
    comms::ErrorStatus doUpdate(
        Field& field,
        TIter& iter,
        std::size_t size,
        TNextLayerUpdater&& nextLayerUpdater) const
    {
        auto fromIter = iter;
        auto es = nextLayerUpdater.update(iter, size - Field::maxLength());
        if (es != comms::ErrorStatus::Success) {
            return es;
        }
 
        using MsgPtr = typename BaseImpl::MsgPtr;
        static_assert(
            !std::is_void<MsgPtr>::value,
            "Please use update() overload that accepts message object as its first parameter");
 
        auto* msgPtr = static_cast<typename MsgPtr::element_type*>(nullptr);
        return fieldUpdateInternal(msgPtr, fromIter, iter, size, field);
    }
 
    template <typename TMsg, typename TIter, typename TNextLayerUpdater>
    comms::ErrorStatus doUpdate(
        const TMsg& msg,
        Field& field,
        TIter& iter,
        std::size_t size,
        TNextLayerUpdater&& nextLayerUpdater) const
    {
        auto fromIter = iter;
        auto& thisObj = BaseImpl::thisLayer();
        auto fieldLen = thisObj.doFieldLength(msg);
        auto es = nextLayerUpdater.update(msg, iter, size - fieldLen);
        if (es != comms::ErrorStatus::Success) {
            return es;
        }
 
        return fieldUpdateInternal(&msg, fromIter, iter, size, field);
    }
 
protected:
    template <typename TMsg, typename TIter>
    comms::ErrorStatus readField(const TMsg* msgPtr, Field& field, TIter& iter, std::size_t len)
    {
        return BaseImpl::thisLayer().doReadField(msgPtr, field, iter, len);
    }
 
    template <typename TMsg, typename TIter>
    comms::ErrorStatus writeField(const TMsg* msgPtr, const Field& field, TIter& iter, std::size_t len) const
    {
        return BaseImpl::thisLayer().doWriteField(msgPtr, field, iter, len);
    }
 
    template <typename TMsg, typename TIter>
    static auto calculateChecksum(const TMsg* msg, TIter& iter, std::size_t len, bool& checksumValid) -> decltype(TCalc()(iter, len))
    {
        static_cast<void>(msg);
        checksumValid = true;
        return TCalc()(iter, len);
    }
 
    static auto getChecksumFromField(const Field& field) -> decltype(field.getValue())
    {
        return field.getValue();
    }
 
    template <typename TChecksum, typename TMsg>
    static void prepareFieldForWrite(TChecksum checksum, const TMsg* msg, Field& field)
    {
        static_cast<void>(msg);
        field.setValue(checksum);
    }
 
private:
    template <typename... TParams>
    using VerifyBeforeReadTag = comms::details::tag::Tag1<>;
 
    template <typename... TParams>
    using VerifyAfterReadTag = comms::details::tag::Tag2<>;
 
    template <typename TMsg, typename TIter, typename TReader, typename... TExtraValues>
    ErrorStatus verifyRead(
        Field& field,
        TMsg& msg,
        TIter& iter,
        std::size_t size,
        TReader&& nextLayerReader,
        TExtraValues... extraValues)
    {
        auto fromIter = iter;
        auto* msgPtr = BaseImpl::toMsgPtr(msg);
        auto fieldLen = Field::minLength();
        auto& thisObj = BaseImpl::thisLayer();
        if (msgPtr != nullptr) {
            fieldLen = thisObj.doFieldLength(*msgPtr);
        }
        auto toIter = fromIter + (size - fieldLen);
        auto len = static_cast<std::size_t>(std::distance(fromIter, toIter));
        
        auto checksumEs = thisObj.readField(msgPtr, field, toIter, fieldLen);
        if (checksumEs != ErrorStatus::Success) {
            return checksumEs;
        }
 
        bool checksumValid = false;
        auto checksum = 
            thisObj.calculateChecksum(
                msgPtr,
                fromIter,
                len,
                checksumValid);
 
        if (!checksumValid) {
            return comms::ErrorStatus::ProtocolError;
        }
 
        auto expectedValue = thisObj.getChecksumFromField(field);
 
        if (expectedValue != static_cast<decltype(expectedValue)>(checksum)) {
            BaseImpl::resetMsg(msg);
            return ErrorStatus::ProtocolError;
        }
 
        auto es = nextLayerReader.read(msg, iter, size - fieldLen, extraValues...);
        if (es == ErrorStatus::Success) {
            iter = toIter;
        }
 
        return es;
    }
 
    template <typename TMsg, typename TIter, typename TReader, typename... TExtraValues>
    ErrorStatus readVerify(
        Field& field,
        TMsg& msg,
        TIter& iter,
        std::size_t size,
        TReader&& nextLayerReader,
        TExtraValues... extraValues)
    {
        auto fromIter = iter;
 
        auto es = nextLayerReader.read(msg, iter, size, extraValues...);
        if ((es == ErrorStatus::NotEnoughData) ||
            (es == ErrorStatus::ProtocolError)) {
            return es;
        }
 
        auto len = static_cast<std::size_t>(std::distance(fromIter, iter));
        COMMS_ASSERT(len <= size);
        auto remSize = size - len;
        auto* msgPtr = BaseImpl::toMsgPtr(msg);
        auto& thisObj = BaseImpl::thisLayer();
        auto checksumEs = thisObj.readField(msgPtr, field, iter, remSize);
        if (checksumEs == ErrorStatus::NotEnoughData) {
            BaseImpl::updateMissingSize(field, remSize, extraValues...);
        }
 
        if (checksumEs != ErrorStatus::Success) {
            BaseImpl::resetMsg(msg);
            return checksumEs;
        }
 
        bool checksumValid = false;
        auto checksum = 
            thisObj.calculateChecksum(
                BaseImpl::toMsgPtr(msg),
                fromIter,
                len,
                checksumValid);
 
        if (!checksumValid) {
            return comms::ErrorStatus::ProtocolError;
        }
 
        auto expectedValue = thisObj.getChecksumFromField(field);
 
        if (expectedValue != static_cast<decltype(expectedValue)>(checksum)) {
            BaseImpl::resetMsg(msg);
            return ErrorStatus::ProtocolError;
        }
 
        return es;
    }
 
    template <typename TMsg, typename TIter, typename TReader, typename... TExtraValues>
    ErrorStatus readInternal(
        Field& field,
        TMsg& msg,
        TIter& iter,
        std::size_t size,
        TReader&& nextLayerReader,
        VerifyBeforeReadTag<>,
        TExtraValues... extraValues)
    {
        return
            verifyRead(
                field,
                msg,
                iter,
                size,
                std::forward<TReader>(nextLayerReader),
                extraValues...);
    }
 
    template <typename TMsg, typename TIter, typename TReader, typename... TExtraValues>
    ErrorStatus readInternal(
        Field& field,
        TMsg& msg,
        TIter& iter,
        std::size_t size,
        TReader&& nextLayerReader,
        VerifyAfterReadTag<>,
        TExtraValues... extraValues)
    {
        return
            readVerify(
                field,
                msg,
                iter,
                size,
                std::forward<TReader>(nextLayerReader),
                extraValues...);
    }
 
    template <typename TMsg, typename TIter, typename TWriter>
    ErrorStatus writeInternalRandomAccess(
        Field& field,
        const TMsg& msg,
        TIter& iter,
        std::size_t size,
        TWriter&& nextLayerWriter) const
    {
        auto fromIter = iter;
        auto es = nextLayerWriter.write(msg, iter, size);
        if ((es != comms::ErrorStatus::Success) &&
            (es != comms::ErrorStatus::UpdateRequired)) {
            return es;
        }
 
        COMMS_ASSERT(fromIter <= iter);
        auto len = static_cast<std::size_t>(std::distance(fromIter, iter));
        auto remSize = size - len;
        auto& thisObj = BaseImpl::thisLayer();
 
        if (es == comms::ErrorStatus::UpdateRequired) {
            thisObj.prepareFieldForWrite(0, &msg, field);
            auto esTmp = thisObj.writeField(&msg, field, iter, remSize);
            if (esTmp != comms::ErrorStatus::Success) {
                return esTmp;
            }
 
            return es;
        }
 
        bool checksumValid = false;
        auto checksum = 
            thisObj.calculateChecksum(
                &msg,
                fromIter,
                len,
                checksumValid);
 
        if (!checksumValid) {
            return comms::ErrorStatus::ProtocolError;
        }
 
        thisObj.prepareFieldForWrite(checksum, &msg, field);
        return thisObj.writeField(&msg, field, iter, remSize);
    }
 
    template <typename TMsg, typename TIter, typename TWriter>
    ErrorStatus writeInternalOutput(
        Field& field,
        const TMsg& msg,
        TIter& iter,
        std::size_t size,
        TWriter&& nextLayerWriter) const
    {
        auto& thisObj = BaseImpl::thisLayer();
        auto fieldLen = thisObj.doFieldLength(msg);
        auto es = nextLayerWriter.write(msg, iter, size - fieldLen);
        if ((es != comms::ErrorStatus::Success) &&
            (es != comms::ErrorStatus::UpdateRequired)) {
            return es;
        }
 
        auto esTmp = thisObj.writeField(&msg, field, iter, fieldLen);
        static_cast<void>(esTmp);
        COMMS_ASSERT(esTmp == comms::ErrorStatus::Success);
        return comms::ErrorStatus::UpdateRequired;
    }
 
    template <typename TMsg, typename TIter, typename TWriter>
    ErrorStatus writeInternal(
        Field& field,
        const TMsg& msg,
        TIter& iter,
        std::size_t size,
        TWriter&& nextLayerWriter,
        std::random_access_iterator_tag) const
    {
        return writeInternalRandomAccess(field, msg, iter, size, std::forward<TWriter>(nextLayerWriter));
    }
 
    template <typename TMsg, typename TIter, typename TWriter>
    ErrorStatus writeInternal(
        Field& field,
        const TMsg& msg,
        TIter& iter,
        std::size_t size,
        TWriter&& nextLayerWriter,
        std::output_iterator_tag) const
    {
        return writeInternalOutput(field, msg, iter, size, std::forward<TWriter>(nextLayerWriter));
    }
 
    template <typename TMsg, typename TIter>
    ErrorStatus fieldUpdateInternal(const TMsg* msgPtr, TIter from, TIter to, std::size_t size, Field& field) const
    {
        COMMS_ASSERT(from <= to);
        auto len = static_cast<std::size_t>(std::distance(from, to));
        auto& thisObj = BaseImpl::thisLayer();
        if (msgPtr != nullptr) {
            COMMS_ASSERT(len == (size - thisObj.doFieldLength(*msgPtr)));    
        }
        else {
            COMMS_ASSERT(len == (size - Field::maxLength()));    
        }
        auto remSize = size - len;
 
        bool checksumValid = false;
        auto checksum = 
            thisObj.calculateChecksum(
                msgPtr,
                from,
                len,
                checksumValid);
 
        if (!checksumValid) {
            return comms::ErrorStatus::ProtocolError;
        }
 
        thisObj.prepareFieldForWrite(checksum, msgPtr, field);
        return thisObj.writeField(msgPtr, field, to, remSize);
    }
};
 
namespace details
{
template <typename T>
struct ChecksumLayerCheckHelper
{
    static const bool Value = false;
};
 
template <typename TField, typename TCalc, typename TNextLayer, typename... TOptions>
struct ChecksumLayerCheckHelper<ChecksumLayer<TField, TCalc, TNextLayer, TOptions...> >
{
    static const bool Value = true;
};
 
} // namespace details
 
template <typename T>
constexpr bool isChecksumLayer()
{
    return details::ChecksumLayerCheckHelper<T>::Value;
}
 
}  // namespace frame
 
}  // namespace comms
 
COMMS_MSVC_WARNING_POP