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 | // |
| 5 | #pragma once |
| 6 | |
David Beck | 9efb57d | 2018-11-05 13:40:33 +0000 | [diff] [blame] | 7 | #include <armnn/Types.hpp> |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 8 | #include <armnn/IRuntime.hpp> |
Matteo Martincigh | fc598e1 | 2019-05-14 10:36:13 +0100 | [diff] [blame] | 9 | #include <armnn/Deprecated.hpp> |
Matteo Martincigh | 4912402 | 2019-01-11 13:25:59 +0000 | [diff] [blame] | 10 | |
Derek Lamberti | ff05cc5 | 2019-04-26 13:05:17 +0100 | [diff] [blame] | 11 | #include <ISubgraphViewConverter.hpp> |
| 12 | #include <SubgraphView.hpp> |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 13 | #include <optimizations/Optimization.hpp> |
Matteo Martincigh | 4912402 | 2019-01-11 13:25:59 +0000 | [diff] [blame] | 14 | |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 15 | #include "IBackendContext.hpp" |
| 16 | #include "IMemoryManager.hpp" |
| 17 | #include "ITensorHandleFactory.hpp" |
Derek Lamberti | c2fe5fb | 2019-05-08 10:23:08 +0100 | [diff] [blame] | 18 | #include "OptimizationViews.hpp" |
| 19 | |
David Beck | 263e349 | 2018-11-09 14:46:40 +0000 | [diff] [blame] | 20 | #include <vector> |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 21 | |
| 22 | namespace armnn |
| 23 | { |
David Beck | 29c75de | 2018-10-23 13:35:58 +0100 | [diff] [blame] | 24 | class IWorkloadFactory; |
Aron Virginas-Tar | 5605519 | 2018-11-12 18:10:43 +0000 | [diff] [blame] | 25 | class IMemoryManager; |
David Beck | 111b5d9 | 2018-11-12 14:59:37 +0000 | [diff] [blame] | 26 | class ILayerSupport; |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 27 | |
Matteo Martincigh | ac60d28 | 2019-07-25 15:25:44 +0100 | [diff] [blame^] | 28 | struct BackendVersion |
| 29 | { |
| 30 | uint32_t m_Major; |
| 31 | uint32_t m_Minor; |
| 32 | |
| 33 | BackendVersion() |
| 34 | : m_Major(0) |
| 35 | , m_Minor(0) |
| 36 | {} |
| 37 | BackendVersion(uint32_t major, uint32_t minor) |
| 38 | : m_Major(major) |
| 39 | , m_Minor(minor) |
| 40 | {} |
| 41 | |
| 42 | bool operator==(const BackendVersion& other) const |
| 43 | { |
| 44 | return this == &other || |
| 45 | (this->m_Major == other.m_Major && |
| 46 | this->m_Minor == other.m_Minor); |
| 47 | } |
| 48 | |
| 49 | bool operator<=(const BackendVersion& other) const |
| 50 | { |
| 51 | return this->m_Major < other.m_Major || |
| 52 | (this->m_Major == other.m_Major && |
| 53 | this->m_Minor <= other.m_Minor); |
| 54 | } |
| 55 | }; |
| 56 | |
| 57 | inline std::ostream& operator<<(std::ostream& os, const BackendVersion& backendVersion) |
| 58 | { |
| 59 | os << "[" << backendVersion.m_Major << "." << backendVersion.m_Minor << "]"; |
| 60 | |
| 61 | return os; |
| 62 | } |
| 63 | |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 64 | class IBackendInternal : public IBackend |
| 65 | { |
| 66 | protected: |
David Beck | 9efb57d | 2018-11-05 13:40:33 +0000 | [diff] [blame] | 67 | // Creation must be done through a specific |
| 68 | // backend interface. |
David Beck | 6b779f0 | 2018-10-09 17:20:21 +0100 | [diff] [blame] | 69 | IBackendInternal() = default; |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 70 | |
| 71 | public: |
David Beck | 29c75de | 2018-10-23 13:35:58 +0100 | [diff] [blame] | 72 | // Allow backends created by the factory function |
| 73 | // to be destroyed through IBackendInternal. |
| 74 | ~IBackendInternal() override = default; |
| 75 | |
| 76 | using IWorkloadFactoryPtr = std::unique_ptr<IWorkloadFactory>; |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 77 | using IBackendContextPtr = std::unique_ptr<IBackendContext>; |
David Beck | 263e349 | 2018-11-09 14:46:40 +0000 | [diff] [blame] | 78 | using OptimizationPtr = std::unique_ptr<Optimization>; |
| 79 | using Optimizations = std::vector<OptimizationPtr>; |
David Beck | 111b5d9 | 2018-11-12 14:59:37 +0000 | [diff] [blame] | 80 | using ILayerSupportSharedPtr = std::shared_ptr<ILayerSupport>; |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 81 | |
Aron Virginas-Tar | 5605519 | 2018-11-12 18:10:43 +0000 | [diff] [blame] | 82 | using IMemoryManagerUniquePtr = std::unique_ptr<IMemoryManager>; |
| 83 | using IMemoryManagerSharedPtr = std::shared_ptr<IMemoryManager>; |
| 84 | |
Matteo Martincigh | 602af09 | 2019-05-01 10:31:27 +0100 | [diff] [blame] | 85 | using GraphUniquePtr = std::unique_ptr<Graph>; |
Derek Lamberti | ff05cc5 | 2019-04-26 13:05:17 +0100 | [diff] [blame] | 86 | using SubgraphViewUniquePtr = std::unique_ptr<SubgraphView>; |
Matteo Martincigh | adddddb | 2019-01-24 14:06:23 +0000 | [diff] [blame] | 87 | |
Matteo Martincigh | c3ba50e | 2019-05-22 14:28:16 +0100 | [diff] [blame] | 88 | ARMNN_NO_DEPRECATE_WARN_BEGIN |
| 89 | using ISubGraphConverterPtr ARMNN_DEPRECATED_MSG("This type is no longer supported") |
| 90 | = std::unique_ptr<ISubGraphConverter>; |
| 91 | using SubGraphUniquePtr ARMNN_DEPRECATED_MSG("SubGraph is deprecated, use SubgraphView instead") |
| 92 | = std::unique_ptr<SubGraph>; |
| 93 | |
| 94 | ARMNN_DEPRECATED_MSG("This method is no longer supported") |
| 95 | virtual ISubGraphConverterPtr CreateSubGraphConverter(const std::shared_ptr<SubGraph>& subGraph) const |
| 96 | { |
| 97 | return ISubGraphConverterPtr{}; |
| 98 | } |
| 99 | |
| 100 | ARMNN_DEPRECATED_MSG("Use \"OptimizationViews OptimizeSubgraphView(const SubgraphView&)\" instead") |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 101 | virtual Optimizations GetOptimizations() const |
| 102 | { |
| 103 | return Optimizations{}; |
| 104 | } |
Matteo Martincigh | c3ba50e | 2019-05-22 14:28:16 +0100 | [diff] [blame] | 105 | |
| 106 | ARMNN_DEPRECATED_MSG("Use \"OptimizationViews OptimizeSubgraphView(const SubgraphView&)\" instead") |
| 107 | virtual SubGraphUniquePtr OptimizeSubGraph(const SubGraph& subGraph, bool& optimizationAttempted) const |
| 108 | { |
| 109 | optimizationAttempted = false; |
| 110 | return nullptr; |
| 111 | } |
| 112 | ARMNN_NO_DEPRECATE_WARN_END |
| 113 | |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 114 | |
| 115 | virtual IMemoryManagerUniquePtr CreateMemoryManager() const |
| 116 | { |
| 117 | return IMemoryManagerUniquePtr(); |
Matteo Martincigh | ac60d28 | 2019-07-25 15:25:44 +0100 | [diff] [blame^] | 118 | } |
Aron Virginas-Tar | 5605519 | 2018-11-12 18:10:43 +0000 | [diff] [blame] | 119 | |
| 120 | virtual IWorkloadFactoryPtr CreateWorkloadFactory( |
| 121 | const IMemoryManagerSharedPtr& memoryManager = nullptr) const = 0; |
| 122 | |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 123 | virtual IBackendContextPtr CreateBackendContext(const IRuntime::CreationOptions&) const |
| 124 | { |
| 125 | return IBackendContextPtr{}; |
| 126 | } |
Aron Virginas-Tar | 5605519 | 2018-11-12 18:10:43 +0000 | [diff] [blame] | 127 | |
David Beck | 111b5d9 | 2018-11-12 14:59:37 +0000 | [diff] [blame] | 128 | virtual ILayerSupportSharedPtr GetLayerSupport() const = 0; |
Matteo Martincigh | adddddb | 2019-01-24 14:06:23 +0000 | [diff] [blame] | 129 | |
Matteo Martincigh | c3ba50e | 2019-05-22 14:28:16 +0100 | [diff] [blame] | 130 | // Default implementation of OptimizeSubgraphView for backward compatibility with the old API. |
Derek Lamberti | c2fe5fb | 2019-05-08 10:23:08 +0100 | [diff] [blame] | 131 | // Override this method with a custom optimization implementation. |
Derek Lamberti | 8106b7c | 2019-05-07 21:33:30 +0100 | [diff] [blame] | 132 | virtual OptimizationViews OptimizeSubgraphView(const SubgraphView& subgraph) const |
Derek Lamberti | c2fe5fb | 2019-05-08 10:23:08 +0100 | [diff] [blame] | 133 | { |
Matteo Martincigh | 8492433 | 2019-05-09 12:46:16 +0100 | [diff] [blame] | 134 | bool optimizationAttempted = false; |
Matteo Martincigh | fc598e1 | 2019-05-14 10:36:13 +0100 | [diff] [blame] | 135 | |
| 136 | ARMNN_NO_DEPRECATE_WARN_BEGIN |
Matteo Martincigh | c3ba50e | 2019-05-22 14:28:16 +0100 | [diff] [blame] | 137 | SubGraphUniquePtr optSubgraph = OptimizeSubGraph(subgraph, optimizationAttempted); |
Matteo Martincigh | fc598e1 | 2019-05-14 10:36:13 +0100 | [diff] [blame] | 138 | ARMNN_NO_DEPRECATE_WARN_END |
Derek Lamberti | c2fe5fb | 2019-05-08 10:23:08 +0100 | [diff] [blame] | 139 | |
| 140 | OptimizationViews result; |
Matteo Martincigh | 8492433 | 2019-05-09 12:46:16 +0100 | [diff] [blame] | 141 | if (!optimizationAttempted) |
Derek Lamberti | c2fe5fb | 2019-05-08 10:23:08 +0100 | [diff] [blame] | 142 | { |
| 143 | result.AddUntouchedSubgraph(SubgraphView(subgraph)); |
| 144 | } |
| 145 | else |
| 146 | { |
| 147 | if (optSubgraph) |
| 148 | { |
Matteo Martincigh | 88054f8 | 2019-05-17 12:15:30 +0100 | [diff] [blame] | 149 | result.AddSubstitution({subgraph, SubgraphView(*optSubgraph.get())}); |
Derek Lamberti | c2fe5fb | 2019-05-08 10:23:08 +0100 | [diff] [blame] | 150 | } |
| 151 | else |
| 152 | { |
| 153 | result.AddFailedSubgraph(SubgraphView(subgraph)); |
| 154 | } |
| 155 | } |
| 156 | return result; |
| 157 | } |
Derek Lamberti | 84da38b | 2019-06-13 11:40:08 +0100 | [diff] [blame] | 158 | |
| 159 | bool SupportsTensorAllocatorAPI() const { return GetHandleFactoryPreferences().empty() == false; } |
| 160 | |
| 161 | ITensorHandleFactory::FactoryId GetBackwardCompatibleFavoriteHandleFactory() |
| 162 | { |
| 163 | auto favorites = GetHandleFactoryPreferences(); |
| 164 | if (favorites.empty()) |
| 165 | { |
| 166 | return ITensorHandleFactory::LegacyFactoryId; |
| 167 | } |
| 168 | return favorites[0]; |
| 169 | } |
| 170 | |
| 171 | /// (Optional) Returns a vector of supported TensorHandleFactory ids in preference order. |
| 172 | virtual std::vector<ITensorHandleFactory::FactoryId> GetHandleFactoryPreferences() const |
| 173 | { |
| 174 | return std::vector<ITensorHandleFactory::FactoryId>(); |
| 175 | } |
| 176 | |
| 177 | /// (Optional) Register TensorHandleFactories |
| 178 | /// Either this method or CreateMemoryManager() and |
| 179 | /// IWorkloadFactory::CreateTensor()/IWorkloadFactory::CreateSubtensor() methods must be implemented. |
| 180 | virtual void RegisterTensorHandleFactories(class TensorHandleFactoryRegistry& registry) {} |
Matteo Martincigh | ac60d28 | 2019-07-25 15:25:44 +0100 | [diff] [blame^] | 181 | |
| 182 | /// Returns the version of the Backend API |
| 183 | static BackendVersion GetApiVersion() { return { 1, 0 }; } |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 184 | }; |
| 185 | |
David Beck | 29c75de | 2018-10-23 13:35:58 +0100 | [diff] [blame] | 186 | using IBackendInternalUniquePtr = std::unique_ptr<IBackendInternal>; |
| 187 | |
David Beck | e97c6e0 | 2018-10-03 13:09:28 +0100 | [diff] [blame] | 188 | } // namespace armnn |