src/backends/backendsCommon/memoryOptimizerStrategyLibrary/strategies/StrategyValidator.cpp

//
// Copyright © 2021 Arm Ltd and Contributors. All rights reserved.
// SPDX-License-Identifier: MIT
//

#include <unordered_map>
#include <iostream>
#include "StrategyValidator.hpp"

namespace armnn
{

std::vector<MemBin> StrategyValidator::Optimize(std::vector<MemBlock>& memBlocks)
{
    // Condition #1: All Memblocks have been assigned to a MemBin

    // Condition #2: No Memblock is assigned to multiple MemBins

    // Condition #3: No two Memblocks in a MemBin overlap in both the X and Y axis
    //               Memblocks in a MemBin can overlap on the X axis for SingleAxisPacking
    //               Memblocks in a MemBin can overlap on the Y axis or the X for MultiAxisPacking but not both

    std::unordered_map<unsigned int, bool> validationMap;

    for (auto memBlock : memBlocks)
    {
        validationMap[memBlock.m_Index] = false;
    }

    auto memBinVect = m_Strategy->Optimize(memBlocks);

    // Compare each of the input memblocks against every assignedBlock in each bin
    // if we get through all bins without finding a block return
    // if at any stage the block is found twice return

    for (auto memBin : memBinVect)
    {
        for (auto block : memBin.m_MemBlocks)
        {
            try
            {
                if (!validationMap.at(block.m_Index))
                {
                    validationMap.at(block.m_Index) = true;
                }
                else
                {
                    throw MemoryValidationException("Condition #2: Memblock is assigned to multiple MemBins");
                }
            }
            catch (const std::out_of_range&)
            {
                throw MemoryValidationException("Unknown index ");
            }
        }
    }

    for (auto memBlock : memBlocks)
    {
        if (!validationMap.at(memBlock.m_Index))
        {
            throw MemoryValidationException("Condition #1: Block not found in any bin");
        }
    }

    // Check for overlaps once we know blocks are all assigned and no duplicates
    for (auto bin : memBinVect)
    {
        for (unsigned int i = 0; i < bin.m_MemBlocks.size(); ++i)
        {
            auto assignedBlock = bin.m_MemBlocks[i];
            auto xStart = assignedBlock.m_Offset;
            auto xEnd = assignedBlock.m_Offset + assignedBlock.m_MemSize;

            auto yStart = assignedBlock.m_StartOfLife;
            auto yEnd = assignedBlock.m_EndOfLife;
            auto assignedIndex = assignedBlock.m_Index;

            // Only compare with blocks after the current one as previous have already been checked
            for (unsigned int j = i + 1; j < bin.m_MemBlocks.size(); ++j)
            {
                auto otherAssignedBlock = bin.m_MemBlocks[j];
                auto xStartAssigned = otherAssignedBlock.m_Offset;
                auto xEndAssigned = otherAssignedBlock.m_Offset + otherAssignedBlock.m_MemSize;

                auto yStartAssigned = otherAssignedBlock.m_StartOfLife;
                auto yEndAssigned = otherAssignedBlock.m_EndOfLife;
                auto otherIndex = otherAssignedBlock.m_Index;

                // If overlapping on both X and Y then invalid
                // Inside left of rectangle & Inside right of rectangle
                if ((((xStart >= xStartAssigned) && (xEnd <= xEndAssigned)) &&
                     // Inside bottom of rectangle & Inside top of rectangle
                     ((yStart >= yStartAssigned) && (yEnd <= yEndAssigned))) &&
                     // Cant overlap with itself
                     (assignedIndex != otherIndex))
                {
                    // Condition #3: two Memblocks overlap on both the X and Y axis
                    throw MemoryValidationException("Condition #3: two Memblocks overlap on both the X and Y axis");
                }

                switch (m_Strategy->GetMemBlockStrategyType())
                {
                    case (MemBlockStrategyType::SingleAxisPacking):
                    {
                        // Inside bottom of rectangle  & Inside top of rectangle
                        if (((yStart >= yStartAssigned) && (yEnd <= yEndAssigned)) &&
                            // Cant overlap with itself
                            (assignedIndex != otherIndex))
                        {
                            throw MemoryValidationException("Condition #3: "
                                        "invalid as two Memblocks overlap on the Y axis for SingleAxisPacking");

                        }
                        break;
                    }
                    case (MemBlockStrategyType::MultiAxisPacking):
                    {
                        break;
                    }
                    default:
                        throw MemoryValidationException("Unknown MemBlockStrategyType");
                }
            }
        }
    }

    // None of the conditions broken so return true
    return memBinVect;
}

} // namespace armnn