aboutsummaryrefslogtreecommitdiff
path: root/include/armnn/IWorkingMemHandle.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'include/armnn/IWorkingMemHandle.hpp')
-rw-r--r--include/armnn/IWorkingMemHandle.hpp46
1 files changed, 46 insertions, 0 deletions
diff --git a/include/armnn/IWorkingMemHandle.hpp b/include/armnn/IWorkingMemHandle.hpp
new file mode 100644
index 0000000000..921b7e1f40
--- /dev/null
+++ b/include/armnn/IWorkingMemHandle.hpp
@@ -0,0 +1,46 @@
+//
+// Copyright © 2021 Arm Ltd and Contributors. All rights reserved.
+// SPDX-License-Identifier: MIT
+//
+
+#pragma once
+
+#include <mutex>
+
+namespace armnn
+{
+
+namespace experimental
+{
+
+struct WorkingMemDescriptor;
+
+class IWorkingMemHandle
+{
+public:
+ virtual ~IWorkingMemHandle() {};
+
+ /// Allocate the backing memory required for execution. If this is not called, then allocation will be
+ /// deferred to execution time. The mutex must be locked.
+ virtual void Allocate() = 0;
+
+ /// Free the backing memory required for execution. The mutex must be locked.
+ virtual void Free() = 0;
+
+ /// IsAllocated returns true if the backing memory is currently allocated. The mutex must be locked.
+ virtual bool IsAllocated() = 0;
+
+ /// Get a mutex which can be used for synchronizing access to the WorkingMemHandle object.
+ virtual std::mutex& GetMutex() = 0;
+
+ /// Get the WorkingMemDescriptor for a Layer. The mutex must be locked.
+ virtual WorkingMemDescriptor& GetWorkingMemDescriptor(LayerGuid id) = 0;
+
+ /// Get the WorkingMemDescriptor at an index. The WorkingMemDescriptors are stored in the same order as
+ /// the Workloads in a topologically sorted graph. The mutex must be locked.
+ virtual WorkingMemDescriptor& GetWorkingMemDescriptorAt(unsigned int id) = 0;
+};
+
+} // end experimental namespace
+
+} // end armnn namespace