David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2017 Arm Ltd. All rights reserved. |
| 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 5 | |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 6 | #pragma once |
| 7 | |
David Beck | 9efb57d | 2018-11-05 13:40:33 +0000 | [diff] [blame] | 8 | #include <armnn/Types.hpp> |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 9 | #include <armnn/IRuntime.hpp> |
Matteo Martincigh | fc598e1 | 2019-05-14 10:36:13 +0100 | [diff] [blame] | 10 | #include <armnn/Deprecated.hpp> |
Matteo Martincigh | 4912402 | 2019-01-11 13:25:59 +0000 | [diff] [blame] | 11 | |
Derek Lamberti | ff05cc5 | 2019-04-26 13:05:17 +0100 | [diff] [blame] | 12 | #include <ISubgraphViewConverter.hpp> |
| 13 | #include <SubgraphView.hpp> |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 14 | #include <optimizations/Optimization.hpp> |
Matteo Martincigh | 4912402 | 2019-01-11 13:25:59 +0000 | [diff] [blame] | 15 | |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 16 | #include "IBackendContext.hpp" |
| 17 | #include "IMemoryManager.hpp" |
| 18 | #include "ITensorHandleFactory.hpp" |
Derek Lamberti | c2fe5fb | 2019-05-08 10:23:08 +0100 | [diff] [blame] | 19 | #include "OptimizationViews.hpp" |
| 20 | |
David Beck | 263e349 | 2018-11-09 14:46:40 +0000 | [diff] [blame] | 21 | #include <vector> |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 22 | #include <memory> |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 23 | |
| 24 | namespace armnn |
| 25 | { |
David Beck | 29c75de | 2018-10-23 13:35:58 +0100 | [diff] [blame] | 26 | class IWorkloadFactory; |
Aron Virginas-Tar | 5605519 | 2018-11-12 18:10:43 +0000 | [diff] [blame] | 27 | class IMemoryManager; |
David Beck | 111b5d9 | 2018-11-12 14:59:37 +0000 | [diff] [blame] | 28 | class ILayerSupport; |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 29 | |
Matteo Martincigh | ac60d28 | 2019-07-25 15:25:44 +0100 | [diff] [blame] | 30 | struct BackendVersion |
| 31 | { |
| 32 | uint32_t m_Major; |
| 33 | uint32_t m_Minor; |
| 34 | |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 35 | constexpr BackendVersion() |
Matteo Martincigh | ac60d28 | 2019-07-25 15:25:44 +0100 | [diff] [blame] | 36 | : m_Major(0) |
| 37 | , m_Minor(0) |
| 38 | {} |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 39 | constexpr BackendVersion(uint32_t major, uint32_t minor) |
Matteo Martincigh | ac60d28 | 2019-07-25 15:25:44 +0100 | [diff] [blame] | 40 | : m_Major(major) |
| 41 | , m_Minor(minor) |
| 42 | {} |
| 43 | |
| 44 | bool operator==(const BackendVersion& other) const |
| 45 | { |
| 46 | return this == &other || |
| 47 | (this->m_Major == other.m_Major && |
| 48 | this->m_Minor == other.m_Minor); |
| 49 | } |
| 50 | |
| 51 | bool operator<=(const BackendVersion& other) const |
| 52 | { |
| 53 | return this->m_Major < other.m_Major || |
| 54 | (this->m_Major == other.m_Major && |
| 55 | this->m_Minor <= other.m_Minor); |
| 56 | } |
| 57 | }; |
| 58 | |
| 59 | inline std::ostream& operator<<(std::ostream& os, const BackendVersion& backendVersion) |
| 60 | { |
| 61 | os << "[" << backendVersion.m_Major << "." << backendVersion.m_Minor << "]"; |
| 62 | |
| 63 | return os; |
| 64 | } |
| 65 | |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 66 | class IBackendInternal : public IBackend |
| 67 | { |
| 68 | protected: |
David Beck | 9efb57d | 2018-11-05 13:40:33 +0000 | [diff] [blame] | 69 | // Creation must be done through a specific |
| 70 | // backend interface. |
David Beck | 6b779f0 | 2018-10-09 17:20:21 +0100 | [diff] [blame] | 71 | IBackendInternal() = default; |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 72 | |
| 73 | public: |
David Beck | 29c75de | 2018-10-23 13:35:58 +0100 | [diff] [blame] | 74 | // Allow backends created by the factory function |
| 75 | // to be destroyed through IBackendInternal. |
| 76 | ~IBackendInternal() override = default; |
| 77 | |
| 78 | using IWorkloadFactoryPtr = std::unique_ptr<IWorkloadFactory>; |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 79 | using IBackendContextPtr = std::unique_ptr<IBackendContext>; |
David Beck | 263e349 | 2018-11-09 14:46:40 +0000 | [diff] [blame] | 80 | using OptimizationPtr = std::unique_ptr<Optimization>; |
| 81 | using Optimizations = std::vector<OptimizationPtr>; |
David Beck | 111b5d9 | 2018-11-12 14:59:37 +0000 | [diff] [blame] | 82 | using ILayerSupportSharedPtr = std::shared_ptr<ILayerSupport>; |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 83 | |
Aron Virginas-Tar | 5605519 | 2018-11-12 18:10:43 +0000 | [diff] [blame] | 84 | using IMemoryManagerUniquePtr = std::unique_ptr<IMemoryManager>; |
| 85 | using IMemoryManagerSharedPtr = std::shared_ptr<IMemoryManager>; |
| 86 | |
Matteo Martincigh | 602af09 | 2019-05-01 10:31:27 +0100 | [diff] [blame] | 87 | using GraphUniquePtr = std::unique_ptr<Graph>; |
Derek Lamberti | ff05cc5 | 2019-04-26 13:05:17 +0100 | [diff] [blame] | 88 | using SubgraphViewUniquePtr = std::unique_ptr<SubgraphView>; |
Matteo Martincigh | adddddb | 2019-01-24 14:06:23 +0000 | [diff] [blame] | 89 | |
Matteo Martincigh | c3ba50e | 2019-05-22 14:28:16 +0100 | [diff] [blame] | 90 | ARMNN_NO_DEPRECATE_WARN_BEGIN |
| 91 | using ISubGraphConverterPtr ARMNN_DEPRECATED_MSG("This type is no longer supported") |
| 92 | = std::unique_ptr<ISubGraphConverter>; |
| 93 | using SubGraphUniquePtr ARMNN_DEPRECATED_MSG("SubGraph is deprecated, use SubgraphView instead") |
| 94 | = std::unique_ptr<SubGraph>; |
| 95 | |
| 96 | ARMNN_DEPRECATED_MSG("This method is no longer supported") |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 97 | virtual ISubGraphConverterPtr CreateSubGraphConverter(const std::shared_ptr<SubGraph>& subGraph) const; |
Matteo Martincigh | c3ba50e | 2019-05-22 14:28:16 +0100 | [diff] [blame] | 98 | |
| 99 | ARMNN_DEPRECATED_MSG("Use \"OptimizationViews OptimizeSubgraphView(const SubgraphView&)\" instead") |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 100 | virtual Optimizations GetOptimizations() const; |
Matteo Martincigh | c3ba50e | 2019-05-22 14:28:16 +0100 | [diff] [blame] | 101 | |
| 102 | ARMNN_DEPRECATED_MSG("Use \"OptimizationViews OptimizeSubgraphView(const SubgraphView&)\" instead") |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 103 | virtual SubGraphUniquePtr OptimizeSubGraph(const SubGraph& subGraph, bool& optimizationAttempted) const; |
Matteo Martincigh | c3ba50e | 2019-05-22 14:28:16 +0100 | [diff] [blame] | 104 | ARMNN_NO_DEPRECATE_WARN_END |
| 105 | |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 106 | virtual IMemoryManagerUniquePtr CreateMemoryManager() const; |
Aron Virginas-Tar | 5605519 | 2018-11-12 18:10:43 +0000 | [diff] [blame] | 107 | |
| 108 | virtual IWorkloadFactoryPtr CreateWorkloadFactory( |
| 109 | const IMemoryManagerSharedPtr& memoryManager = nullptr) const = 0; |
| 110 | |
Narumol Prangnawarat | 11bd261 | 2019-08-13 10:26:53 +0100 | [diff] [blame] | 111 | virtual IWorkloadFactoryPtr CreateWorkloadFactory( |
| 112 | class TensorHandleFactoryRegistry& tensorHandleFactoryRegistry) const; |
| 113 | |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 114 | virtual IBackendContextPtr CreateBackendContext(const IRuntime::CreationOptions&) const; |
Aron Virginas-Tar | 5605519 | 2018-11-12 18:10:43 +0000 | [diff] [blame] | 115 | |
David Beck | 111b5d9 | 2018-11-12 14:59:37 +0000 | [diff] [blame] | 116 | virtual ILayerSupportSharedPtr GetLayerSupport() const = 0; |
Matteo Martincigh | adddddb | 2019-01-24 14:06:23 +0000 | [diff] [blame] | 117 | |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 118 | virtual OptimizationViews OptimizeSubgraphView(const SubgraphView& subgraph) const; |
Matteo Martincigh | fc598e1 | 2019-05-14 10:36:13 +0100 | [diff] [blame] | 119 | |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 120 | bool SupportsTensorAllocatorAPI() const; |
Derek Lamberti | c2fe5fb | 2019-05-08 10:23:08 +0100 | [diff] [blame] | 121 | |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 122 | ITensorHandleFactory::FactoryId GetBackwardCompatibleFavoriteHandleFactory(); |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 123 | |
| 124 | /// (Optional) Returns a vector of supported TensorHandleFactory ids in preference order. |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 125 | virtual std::vector<ITensorHandleFactory::FactoryId> GetHandleFactoryPreferences() const; |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 126 | |
| 127 | /// (Optional) Register TensorHandleFactories |
| 128 | /// Either this method or CreateMemoryManager() and |
| 129 | /// IWorkloadFactory::CreateTensor()/IWorkloadFactory::CreateSubtensor() methods must be implemented. |
| 130 | virtual void RegisterTensorHandleFactories(class TensorHandleFactoryRegistry& registry) {} |
Matteo Martincigh | ac60d28 | 2019-07-25 15:25:44 +0100 | [diff] [blame] | 131 | |
| 132 | /// Returns the version of the Backend API |
Matteo Martincigh | d0dc770 | 2019-08-01 17:09:03 +0100 | [diff] [blame] | 133 | static constexpr BackendVersion GetApiVersion() { return BackendVersion(1, 0); } |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 134 | }; |
| 135 | |
David Beck | 29c75de | 2018-10-23 13:35:58 +0100 | [diff] [blame] | 136 | using IBackendInternalUniquePtr = std::unique_ptr<IBackendInternal>; |
| 137 | |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 138 | } // namespace armnn |