From 8a5e59bc9bdc862add31aff31734aa50c3122ca4 Mon Sep 17 00:00:00 2001
From: David Monahan <david.monahan@arm.com>
Date: Thu, 12 Aug 2021 10:20:21 +0100
Subject: IVGCVSW-6078 Add support for Dma_buf CustomMemoryAllocator

 * Updated supported sources in ICustomAllocator
 * Added MemorySource to the overridden MemoryRegion in ClBackend
 * Added switch statements to handle mapping/unmapping of differing memory sources
 * Added Import handler to map allocated DmaBuf memory

Signed-off-by: David Monahan <david.monahan@arm.com>
Change-Id: I2125f6f6fe72363d87ead62e211fc45e4fa28b3f
---
 include/armnn/backends/ICustomAllocator.hpp |  2 +-
 src/backends/cl/ClBackend.hpp               | 73 +++++++++++++++++++++++++++--
 2 files changed, 69 insertions(+), 6 deletions(-)

diff --git a/include/armnn/backends/ICustomAllocator.hpp b/include/armnn/backends/ICustomAllocator.hpp
index 92cbcc2641..2cb5f41f78 100644
--- a/include/armnn/backends/ICustomAllocator.hpp
+++ b/include/armnn/backends/ICustomAllocator.hpp
@@ -34,8 +34,8 @@ public:
     //  Used to specify what type of memory is being allocated by this allocator.
     //  Supported types are:
     //      MemorySource::Malloc
-    //  Unsupported types are:
     //      MemorySource::DmaBuf
+    //  Unsupported types are:
     //      MemorySource::DmaBufProtected
     virtual armnn::MemorySource GetMemorySourceType() = 0;
 
diff --git a/src/backends/cl/ClBackend.hpp b/src/backends/cl/ClBackend.hpp
index c63bd25c56..e3ff91c268 100644
--- a/src/backends/cl/ClBackend.hpp
+++ b/src/backends/cl/ClBackend.hpp
@@ -15,6 +15,9 @@
 #include <arm_compute/core/CL/CLKernelLibrary.h>
 #include <CL/cl_ext.h>
 
+// System includes for mapping and unmapping memory
+#include <sys/mman.h>
+
 namespace armnn
 {
 
@@ -121,7 +124,9 @@ public:
             auto hostMemPtr = m_CustomAllocator->allocate(size, alignment);
             cl_mem buffer = MapAllocatedMemory(hostMemPtr, size, m_CustomAllocator->GetMemorySourceType());
 
-            return std::make_unique<ClBackendCustomAllocatorMemoryRegion>(cl::Buffer(buffer), hostMemPtr);
+            return std::make_unique<ClBackendCustomAllocatorMemoryRegion>(cl::Buffer(buffer),
+                                                                          hostMemPtr,
+                                                                          m_CustomAllocator->GetMemorySourceType());
         }
     private:
         cl_mem MapAllocatedMemory(void* memory, size_t size, MemorySource source)
@@ -154,6 +159,32 @@ public:
                 throw armnn::Exception(
                     "Mapping allocated memory from CustomMemoryAllocator failed, errcode: " + std::to_string(error));
             }
+            else if (source == MemorySource::DmaBuf)
+            {
+                const cl_import_properties_arm importProperties[] =
+                        {
+                        CL_IMPORT_TYPE_ARM,
+                        CL_IMPORT_TYPE_DMA_BUF_ARM,
+                        CL_IMPORT_DMA_BUF_DATA_CONSISTENCY_WITH_HOST_ARM,
+                        CL_TRUE,
+                        0
+                        };
+                cl_int error = CL_SUCCESS;
+                cl_mem buffer = clImportMemoryARM(arm_compute::CLKernelLibrary::get().context().get(),
+                                                  CL_MEM_READ_WRITE,
+                                                  importProperties,
+                                                  memory,
+                                                  roundedSize,
+                                                  &error);
+                if (error == CL_SUCCESS)
+                {
+                    m_AllocatedBufferMappings.insert(std::make_pair(static_cast<void *>(buffer), memory));
+                    return buffer;
+                }
+                throw armnn::Exception(
+                        "Mapping allocated memory from CustomMemoryAllocator failed, errcode: "
+                         + std::to_string(error));
+            }
             throw armnn::Exception(
                     "Attempting to allocate memory with unsupported MemorySource type in CustomAllocator");
         }
@@ -165,11 +196,12 @@ public:
     {
     public:
         // We need to have a new version of ICLMemoryRegion which holds a hostMemPtr to allow for cpu copy access
-        ClBackendCustomAllocatorMemoryRegion(const cl::Buffer &buffer, void* hostMemPtr)
+        ClBackendCustomAllocatorMemoryRegion(const cl::Buffer &buffer, void* hostMemPtr, armnn::MemorySource source)
             : ICLMemoryRegion(buffer.getInfo<CL_MEM_SIZE>())
         {
             _mem = buffer;
             m_HostMemPtr = hostMemPtr;
+            m_MemorySource = source;
         }
 
         // Inherited methods overridden :
@@ -185,16 +217,47 @@ public:
             {
                 throw armnn::Exception("ClBackend: Attempting to map memory with an invalid host ptr");
             }
-            _mapping = m_HostMemPtr;
-            return _mapping;
+            if (_mapping != nullptr)
+            {
+                throw armnn::Exception("ClBackend: Attempting to map memory which has not yet been unmapped");
+            }
+            switch (m_MemorySource)
+            {
+                case armnn::MemorySource::Malloc:
+                    _mapping = m_HostMemPtr;
+                    return _mapping;
+                    break;
+                case armnn::MemorySource::DmaBuf:
+                    // If the source is a Dmabuf then the memory ptr should be pointing to an integer value for the fd
+                    _mapping = mmap(NULL, _size, PROT_WRITE, MAP_SHARED, *(reinterpret_cast<int*>(m_HostMemPtr)), 0);
+                    return _mapping;
+                    break;
+                default:
+                    throw armnn::Exception("ClBackend: Attempting to map imported memory without a valid source");
+                    break;
+            }
         }
 
         void unmap(cl::CommandQueue &q) override
         {
             armnn::IgnoreUnused(q);
-            _mapping = nullptr;
+            switch (m_MemorySource)
+            {
+                case armnn::MemorySource::Malloc:
+                    _mapping = nullptr;
+                    break;
+                case armnn::MemorySource::DmaBuf:
+                    munmap(_mapping, _size);
+                    _mapping = nullptr;
+                    break;
+                default:
+                    throw armnn::Exception("ClBackend: Attempting to unmap imported memory without a valid source");
+                    break;
+            }
         }
+    private:
         void* m_HostMemPtr = nullptr;
+        armnn::MemorySource m_MemorySource;
     };
 
     std::shared_ptr<ClBackendCustomAllocatorWrapper> m_CustomAllocator;
-- 
cgit v1.2.1