IVGCVSW-6635 Expose a new MockWorkloadFactory and MockMemManager (Part 1)

* Create a MockBackend in armnnTestUtils.
* Create corresponding WorkloadFactory, TensorHandle, TensorHandleFactory
  MemoryManager and WorkloadFactoryHelper classes.

Signed-off-by: Colm Donelan <colm.donelan@arm.com>
Change-Id: I884731b109bc623a7272e5ad333ff754f8c13ae1

3 files changed, 255 insertions, 0 deletions

diff --git a/include/armnnTestUtils/MockBackend.hpp b/include/armnnTestUtils/MockBackend.hpp
new file mode 100644
index 0000000000..8bc41b3f3f
--- /dev/null
+++ b/include/armnnTestUtils/MockBackend.hpp
@@ -0,0 +1,115 @@
+//
+// Copyright © 2022 Arm Ltd and Contributors. All rights reserved.
+// SPDX-License-Identifier: MIT
+//
+#pragma once
+
+#include <armnn/backends/IBackendInternal.hpp>
+#include <armnn/backends/MemCopyWorkload.hpp>
+#include <armnnTestUtils/MockTensorHandle.hpp>
+
+namespace armnn
+{
+
+// A bare bones Mock backend to enable unit testing of simple tensor manipulation features.
+class MockBackend : public IBackendInternal
+{
+public:
+    MockBackend() = default;
+
+    ~MockBackend() = default;
+
+    static const BackendId& GetIdStatic();
+
+    const BackendId& GetId() const override
+    {
+        return GetIdStatic();
+    }
+    IBackendInternal::IWorkloadFactoryPtr
+        CreateWorkloadFactory(const IBackendInternal::IMemoryManagerSharedPtr& memoryManager = nullptr) const override
+    {
+        IgnoreUnused(memoryManager);
+        return nullptr;
+    }
+
+    IBackendInternal::ILayerSupportSharedPtr GetLayerSupport() const override
+    {
+        return nullptr;
+    };
+};
+
+class MockWorkloadFactory : public IWorkloadFactory
+{
+
+public:
+    explicit MockWorkloadFactory(const std::shared_ptr<MockMemoryManager>& memoryManager);
+    MockWorkloadFactory();
+
+    ~MockWorkloadFactory()
+    {}
+
+    const BackendId& GetBackendId() const override;
+
+    bool SupportsSubTensors() const override
+    {
+        return false;
+    }
+
+    ARMNN_DEPRECATED_MSG("Use ITensorHandleFactory::CreateSubTensorHandle instead")
+    std::unique_ptr<ITensorHandle> CreateSubTensorHandle(ITensorHandle&,
+                                                         TensorShape const&,
+                                                         unsigned int const*) const override
+    {
+        return nullptr;
+    }
+
+    ARMNN_DEPRECATED_MSG("Use ITensorHandleFactory::CreateTensorHandle instead")
+    std::unique_ptr<ITensorHandle> CreateTensorHandle(const TensorInfo& tensorInfo,
+                                                      const bool IsMemoryManaged = true) const override
+    {
+        IgnoreUnused(IsMemoryManaged);
+        return std::make_unique<MockTensorHandle>(tensorInfo, m_MemoryManager);
+    };
+
+    ARMNN_DEPRECATED_MSG("Use ITensorHandleFactory::CreateTensorHandle instead")
+    std::unique_ptr<ITensorHandle> CreateTensorHandle(const TensorInfo& tensorInfo,
+                                                      DataLayout dataLayout,
+                                                      const bool IsMemoryManaged = true) const override
+    {
+        IgnoreUnused(dataLayout, IsMemoryManaged);
+        return std::make_unique<MockTensorHandle>(tensorInfo, static_cast<unsigned int>(MemorySource::Malloc));
+    };
+
+    ARMNN_DEPRECATED_MSG_REMOVAL_DATE(
+        "Use ABI stable "
+        "CreateWorkload(LayerType, const QueueDescriptor&, const WorkloadInfo& info) instead.",
+        "22.11")
+    std::unique_ptr<IWorkload> CreateInput(const InputQueueDescriptor& descriptor,
+                                           const WorkloadInfo& info) const override
+    {
+        if (info.m_InputTensorInfos.empty())
+        {
+            throw InvalidArgumentException("MockWorkloadFactory::CreateInput: Input cannot be zero length");
+        }
+        if (info.m_OutputTensorInfos.empty())
+        {
+            throw InvalidArgumentException("MockWorkloadFactory::CreateInput: Output cannot be zero length");
+        }
+
+        if (info.m_InputTensorInfos[0].GetNumBytes() != info.m_OutputTensorInfos[0].GetNumBytes())
+        {
+            throw InvalidArgumentException(
+                "MockWorkloadFactory::CreateInput: data input and output differ in byte count.");
+        }
+
+        return std::make_unique<CopyMemGenericWorkload>(descriptor, info);
+    };
+
+    std::unique_ptr<IWorkload>
+        CreateWorkload(LayerType type, const QueueDescriptor& descriptor, const WorkloadInfo& info) const override;
+
+private:
+    mutable std::shared_ptr<MockMemoryManager> m_MemoryManager;
+};
+
+}    // namespace armnn
diff --git a/include/armnnTestUtils/MockMemoryManager.hpp b/include/armnnTestUtils/MockMemoryManager.hpp
new file mode 100644
index 0000000000..38cd56747a
--- /dev/null
+++ b/include/armnnTestUtils/MockMemoryManager.hpp
@@ -0,0 +1,59 @@
+//
+// Copyright © 2022 Arm Ltd and Contributors. All rights reserved.
+// SPDX-License-Identifier: MIT
+//
+#pragma once
+
+#include <armnn/backends/IMemoryManager.hpp>
+
+#include <forward_list>
+#include <vector>
+
+namespace armnn
+{
+
+// An implementation of IMemoryManager to be used with MockTensorHandle
+class MockMemoryManager : public IMemoryManager
+{
+public:
+    MockMemoryManager();
+    virtual ~MockMemoryManager();
+
+    class Pool;
+
+    Pool* Manage(unsigned int numBytes);
+
+    void Allocate(Pool* pool);
+
+    void* GetPointer(Pool* pool);
+
+    void Acquire() override;
+    void Release() override;
+
+    class Pool
+    {
+    public:
+        Pool(unsigned int numBytes);
+        ~Pool();
+
+        void Acquire();
+        void Release();
+
+        void* GetPointer();
+
+        void Reserve(unsigned int numBytes);
+
+    private:
+        unsigned int m_Size;
+        void* m_Pointer;
+    };
+
+private:
+    MockMemoryManager(const MockMemoryManager&) = delete;               // Noncopyable
+    MockMemoryManager& operator=(const MockMemoryManager&) = delete;    // Noncopyable
+
+    std::forward_list<Pool> m_Pools;
+    std::vector<Pool*> m_FreePools;
+};
+
+}    // namespace armnn
diff --git a/include/armnnTestUtils/MockTensorHandle.hpp b/include/armnnTestUtils/MockTensorHandle.hpp
new file mode 100644
index 0000000000..9a7518b21a
--- /dev/null
+++ b/include/armnnTestUtils/MockTensorHandle.hpp
@@ -0,0 +1,81 @@
+//
+// Copyright © 2022 Arm Ltd and Contributors. All rights reserved.
+// SPDX-License-Identifier: MIT
+//
+#pragma once
+
+#include "MockMemoryManager.hpp"
+#include <armnn/backends/TensorHandle.hpp>
+
+namespace armnn
+{
+
+// An implementation of ITensorHandle with simple "bump the pointer" memory-management behaviour
+class MockTensorHandle : public ITensorHandle
+{
+public:
+    MockTensorHandle(const TensorInfo& tensorInfo, std::shared_ptr<MockMemoryManager>& memoryManager);
+
+    MockTensorHandle(const TensorInfo& tensorInfo, MemorySourceFlags importFlags);
+
+    ~MockTensorHandle() override;
+
+    void Manage() override;
+
+    void Allocate() override;
+
+    ITensorHandle* GetParent() const override
+    {
+        return nullptr;
+    }
+
+    const void* Map(bool /* blocking = true */) const override;
+    using ITensorHandle::Map;
+
+    void Unmap() const override
+    {}
+
+    TensorShape GetStrides() const override
+    {
+        return GetUnpaddedTensorStrides(m_TensorInfo);
+    }
+
+    TensorShape GetShape() const override
+    {
+        return m_TensorInfo.GetShape();
+    }
+
+    const TensorInfo& GetTensorInfo() const
+    {
+        return m_TensorInfo;
+    }
+
+    MemorySourceFlags GetImportFlags() const override
+    {
+        return m_ImportFlags;
+    }
+
+    bool Import(void* memory, MemorySource source) override;
+    bool CanBeImported(void* memory, MemorySource source) override;
+
+private:
+    // Only used for testing
+    void CopyOutTo(void*) const override;
+    void CopyInFrom(const void*) override;
+
+    void* GetPointer() const;
+
+    MockTensorHandle(const MockTensorHandle& other) = delete;               // noncopyable
+    MockTensorHandle& operator=(const MockTensorHandle& other) = delete;    //noncopyable
+
+    TensorInfo m_TensorInfo;
+
+    std::shared_ptr<MockMemoryManager> m_MemoryManager;
+    MockMemoryManager::Pool* m_Pool;
+    mutable void* m_UnmanagedMemory;
+    MemorySourceFlags m_ImportFlags;
+    bool m_Imported;
+    bool m_IsImportEnabled;
+};
+
+}    // namespace armnn