David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2017 Arm Ltd. All rights reserved. |
| 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | #pragma once |
| 6 | |
Matthew Bentham | 313e1c8 | 2019-03-25 17:37:47 +0000 | [diff] [blame] | 7 | #include <memory> |
David Beck | 3e9e115 | 2018-10-17 14:17:50 +0100 | [diff] [blame] | 8 | #include <ostream> |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 9 | #include <set> |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 10 | #include <string> |
Matthew Bentham | 313e1c8 | 2019-03-25 17:37:47 +0000 | [diff] [blame] | 11 | #include <unordered_set> |
David Beck | 3e9e115 | 2018-10-17 14:17:50 +0100 | [diff] [blame] | 12 | #include <vector> |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 13 | |
| 14 | namespace armnn |
| 15 | { |
| 16 | |
Ryan OShea | 2bbfaa7 | 2020-02-12 16:15:27 +0000 | [diff] [blame] | 17 | /// |
| 18 | /// The Compute enum is now deprecated and it is now |
| 19 | /// being replaced by BackendId |
| 20 | /// |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 21 | enum class Compute |
| 22 | { |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 23 | Undefined = 0, |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 24 | /// CPU Execution: Reference C++ kernels |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 25 | CpuRef = 1, |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 26 | /// CPU Execution: NEON: ArmCompute |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 27 | CpuAcc = 2, |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 28 | /// GPU Execution: OpenCL: ArmCompute |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 29 | GpuAcc = 3 |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 30 | }; |
| 31 | |
David Beck | e648871 | 2018-10-16 11:32:20 +0100 | [diff] [blame] | 32 | /// Deprecated function that will be removed together with |
| 33 | /// the Compute enum |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 34 | constexpr char const* GetComputeDeviceAsCString(Compute compute) |
| 35 | { |
| 36 | switch (compute) |
| 37 | { |
| 38 | case armnn::Compute::CpuRef: return "CpuRef"; |
| 39 | case armnn::Compute::CpuAcc: return "CpuAcc"; |
| 40 | case armnn::Compute::GpuAcc: return "GpuAcc"; |
| 41 | default: return "Unknown"; |
| 42 | } |
| 43 | } |
| 44 | |
David Beck | e648871 | 2018-10-16 11:32:20 +0100 | [diff] [blame] | 45 | /// Deprecated function that will be removed together with |
| 46 | /// the Compute enum |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 47 | inline std::ostream& operator<<(std::ostream& os, const std::vector<Compute>& compute) |
| 48 | { |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 49 | for (const Compute& comp : compute) |
| 50 | { |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 51 | os << GetComputeDeviceAsCString(comp) << " "; |
| 52 | } |
| 53 | return os; |
| 54 | } |
| 55 | |
David Beck | e648871 | 2018-10-16 11:32:20 +0100 | [diff] [blame] | 56 | /// Deprecated function that will be removed together with |
| 57 | /// the Compute enum |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 58 | inline std::ostream& operator<<(std::ostream& os, const std::set<Compute>& compute) |
| 59 | { |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 60 | for (const Compute& comp : compute) |
| 61 | { |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 62 | os << GetComputeDeviceAsCString(comp) << " "; |
| 63 | } |
| 64 | return os; |
| 65 | } |
| 66 | |
David Beck | e648871 | 2018-10-16 11:32:20 +0100 | [diff] [blame] | 67 | /// Deprecated function that will be removed together with |
| 68 | /// the Compute enum |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 69 | inline std::ostream& operator<<(std::ostream& os, const Compute& compute) |
| 70 | { |
| 71 | os << GetComputeDeviceAsCString(compute); |
| 72 | return os; |
| 73 | } |
| 74 | |
| 75 | class BackendId final |
| 76 | { |
| 77 | public: |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 78 | BackendId() : m_Id(GetComputeDeviceAsCString(Compute::Undefined)) {} |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 79 | BackendId(const std::string& id) : m_Id{id} {} |
| 80 | BackendId(const char* id) : m_Id{id} {} |
David Beck | e648871 | 2018-10-16 11:32:20 +0100 | [diff] [blame] | 81 | |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 82 | |
| 83 | BackendId(const BackendId& other) = default; |
| 84 | BackendId(BackendId&& other) = default; |
| 85 | BackendId& operator=(const BackendId& other) = default; |
| 86 | BackendId& operator=(BackendId&& other) = default; |
| 87 | ~BackendId(){} |
| 88 | |
David Beck | e648871 | 2018-10-16 11:32:20 +0100 | [diff] [blame] | 89 | /// Deprecated function that will be removed together with |
| 90 | /// the Compute enum |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 91 | BackendId(Compute compute) : m_Id{GetComputeDeviceAsCString(compute)} {} |
| 92 | |
| 93 | operator std::string() const { return m_Id; } |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 94 | BackendId& operator=(const std::string& other) |
| 95 | { |
| 96 | m_Id = other; |
| 97 | return *this; |
| 98 | } |
| 99 | |
David Beck | e648871 | 2018-10-16 11:32:20 +0100 | [diff] [blame] | 100 | /// Deprecated function that will be removed together with |
| 101 | /// the Compute enum |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 102 | BackendId& operator=(Compute compute) |
| 103 | { |
| 104 | BackendId temp{compute}; |
| 105 | std::swap(temp.m_Id, m_Id); |
| 106 | return *this; |
| 107 | } |
| 108 | |
| 109 | bool operator==(const BackendId& other) const |
| 110 | { |
| 111 | return m_Id == other.m_Id; |
| 112 | } |
| 113 | |
Ryan OShea | 2bbfaa7 | 2020-02-12 16:15:27 +0000 | [diff] [blame] | 114 | /// comparison against objects from which the |
| 115 | /// BackendId can be constructed |
David Beck | 33f0ae0 | 2018-10-18 15:13:56 +0100 | [diff] [blame] | 116 | template <typename O> |
| 117 | bool operator==(const O& other) const |
| 118 | { |
| 119 | BackendId temp{other}; |
| 120 | return *this == temp; |
| 121 | } |
| 122 | |
| 123 | template <typename O> |
| 124 | bool operator!=(const O& other) const |
| 125 | { |
| 126 | return !(*this == other); |
| 127 | } |
| 128 | |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 129 | bool operator<(const BackendId& other) const |
| 130 | { |
| 131 | return m_Id < other.m_Id; |
| 132 | } |
| 133 | |
Matteo Martincigh | adddddb | 2019-01-24 14:06:23 +0000 | [diff] [blame] | 134 | bool IsCpuRef() const { return m_Id == GetComputeDeviceAsCString(Compute::CpuRef); } |
Pablo Tello | 5f3dc25 | 2021-09-01 15:36:23 +0100 | [diff] [blame] | 135 | bool IsCpuAcc() const { return m_Id == GetComputeDeviceAsCString(Compute::CpuAcc); } |
| 136 | bool IsGpuAcc() const { return m_Id == GetComputeDeviceAsCString(Compute::GpuAcc); } |
Matteo Martincigh | adddddb | 2019-01-24 14:06:23 +0000 | [diff] [blame] | 137 | |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 138 | const std::string& Get() const { return m_Id; } |
| 139 | |
Matteo Martincigh | 0c2b289 | 2019-08-05 14:12:11 +0100 | [diff] [blame] | 140 | bool IsEmpty() const { return m_Id.empty(); } |
| 141 | bool IsUndefined() const { return m_Id == GetComputeDeviceAsCString(Compute::Undefined); } |
| 142 | |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 143 | private: |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 144 | std::string m_Id; |
| 145 | }; |
| 146 | |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 147 | } // namespace armnn |
David Beck | f0b4845 | 2018-10-19 15:20:56 +0100 | [diff] [blame] | 148 | |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 149 | namespace std |
| 150 | { |
| 151 | |
Ryan OShea | 2bbfaa7 | 2020-02-12 16:15:27 +0000 | [diff] [blame] | 152 | /// make BackendId compatible with std hashtables by reusing the hash |
| 153 | /// function for strings. |
| 154 | /// Note this must come *before* the first use of unordered_set<BackendId>. |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 155 | template <> |
| 156 | struct hash<armnn::BackendId> |
| 157 | { |
Matthew Bentham | fa9a5b7 | 2019-12-05 10:37:09 +0000 | [diff] [blame] | 158 | std::size_t operator()(const armnn::BackendId& id) const noexcept |
David Beck | 9df2d95 | 2018-10-10 15:11:44 +0100 | [diff] [blame] | 159 | { |
| 160 | std::hash<std::string> hasher; |
| 161 | return hasher(id.Get()); |
| 162 | } |
| 163 | }; |
| 164 | |
| 165 | } // namespace std |
Rob Hughes | 0214d7e | 2018-11-21 09:55:52 +0000 | [diff] [blame] | 166 | |
| 167 | namespace armnn |
| 168 | { |
| 169 | |
Keith Davis | e394bd9 | 2019-12-02 15:12:19 +0000 | [diff] [blame] | 170 | namespace profiling |
| 171 | { |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 172 | // Static constant describing ArmNN as a dummy backend |
| 173 | static const BackendId BACKEND_ID("ARMNN"); |
Keith Davis | e394bd9 | 2019-12-02 15:12:19 +0000 | [diff] [blame] | 174 | } // profiling |
| 175 | |
Rob Hughes | 0214d7e | 2018-11-21 09:55:52 +0000 | [diff] [blame] | 176 | inline std::ostream& operator<<(std::ostream& os, const BackendId& id) |
| 177 | { |
| 178 | os << id.Get(); |
| 179 | return os; |
| 180 | } |
| 181 | |
| 182 | template <template <typename...> class TContainer, typename... TContainerTemplateArgs> |
| 183 | std::ostream& operator<<(std::ostream& os, |
Matteo Martincigh | 992d6dc | 2019-01-10 17:34:20 +0000 | [diff] [blame] | 184 | const TContainer<BackendId, TContainerTemplateArgs...>& ids) |
Rob Hughes | 0214d7e | 2018-11-21 09:55:52 +0000 | [diff] [blame] | 185 | { |
| 186 | os << '['; |
| 187 | for (const auto& id : ids) { os << id << " "; } |
| 188 | os << ']'; |
| 189 | return os; |
| 190 | } |
| 191 | |
Matteo Martincigh | 4912402 | 2019-01-11 13:25:59 +0000 | [diff] [blame] | 192 | using BackendIdVector = std::vector<BackendId>; |
| 193 | using BackendIdSet = std::unordered_set<BackendId>; |
Rob Hughes | 0214d7e | 2018-11-21 09:55:52 +0000 | [diff] [blame] | 194 | |
| 195 | } // namespace armnn |