Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2019 Arm Ltd. All rights reserved. |
| 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | |
| 6 | #include "BufferManager.hpp" |
| 7 | #include "PacketBuffer.hpp" |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 8 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 9 | namespace arm |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 10 | { |
| 11 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 12 | namespace pipe |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 13 | { |
| 14 | |
| 15 | BufferManager::BufferManager(unsigned int numberOfBuffers, unsigned int maxPacketSize) |
Finn Williams | 09ad6f9 | 2019-12-19 17:05:18 +0000 | [diff] [blame] | 16 | : m_MaxBufferSize(maxPacketSize), |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 17 | m_NumberOfBuffers(numberOfBuffers), |
| 18 | m_MaxNumberOfBuffers(numberOfBuffers * 3), |
| 19 | m_CurrentNumberOfBuffers(numberOfBuffers) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 20 | { |
Finn Williams | 09ad6f9 | 2019-12-19 17:05:18 +0000 | [diff] [blame] | 21 | Initialize(); |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 22 | } |
| 23 | |
Matteo Martincigh | 2ffcc41 | 2019-11-05 11:47:40 +0000 | [diff] [blame] | 24 | IPacketBufferPtr BufferManager::Reserve(unsigned int requestedSize, unsigned int& reservedSize) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 25 | { |
Narumol Prangnawarat | 0ec068f | 2019-09-30 16:20:20 +0100 | [diff] [blame] | 26 | reservedSize = 0; |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 27 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 28 | std::unique_lock<std::mutex> availableListLock(m_AvailableMutex, std::defer_lock); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 29 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 30 | if (requestedSize > m_MaxBufferSize) |
| 31 | { |
Narumol Prangnawarat | 0ec068f | 2019-09-30 16:20:20 +0100 | [diff] [blame] | 32 | return nullptr; |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 33 | } |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 34 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 35 | availableListLock.lock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 36 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 37 | if (m_AvailableList.empty()) |
| 38 | { |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 39 | if (m_CurrentNumberOfBuffers < m_MaxNumberOfBuffers) |
| 40 | { |
| 41 | // create a temporary overflow/surge buffer and hand it back |
| 42 | m_CurrentNumberOfBuffers++; |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 43 | #if !defined(ARMNN_DISABLE_THREADS) |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 44 | availableListLock.unlock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 45 | #endif |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 46 | IPacketBufferPtr buffer = std::make_unique<PacketBuffer>(m_MaxBufferSize); |
| 47 | reservedSize = requestedSize; |
| 48 | return buffer; |
| 49 | } |
| 50 | else |
| 51 | { |
| 52 | // we have totally busted the limit. call a halt to new memory allocations. |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 53 | #if !defined(ARMNN_DISABLE_THREADS) |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 54 | availableListLock.unlock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 55 | #endif |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 56 | return nullptr; |
| 57 | } |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 58 | } |
Matteo Martincigh | 2ffcc41 | 2019-11-05 11:47:40 +0000 | [diff] [blame] | 59 | IPacketBufferPtr buffer = std::move(m_AvailableList.back()); |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 60 | m_AvailableList.pop_back(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 61 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 62 | availableListLock.unlock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 63 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 64 | reservedSize = requestedSize; |
| 65 | return buffer; |
| 66 | } |
| 67 | |
Sadik Armagan | 3896b47 | 2020-02-10 12:24:15 +0000 | [diff] [blame] | 68 | void BufferManager::Commit(IPacketBufferPtr& packetBuffer, unsigned int size, bool notifyConsumer) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 69 | { |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 70 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 71 | std::unique_lock<std::mutex> readableListLock(m_ReadableMutex, std::defer_lock); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 72 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 73 | packetBuffer->Commit(size); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 74 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 75 | readableListLock.lock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 76 | #endif |
Finn Williams | b6a402f | 2020-03-24 13:46:22 +0000 | [diff] [blame] | 77 | m_ReadableList.push(std::move(packetBuffer)); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 78 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 79 | readableListLock.unlock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 80 | #endif |
Sadik Armagan | 3896b47 | 2020-02-10 12:24:15 +0000 | [diff] [blame] | 81 | if (notifyConsumer) |
| 82 | { |
| 83 | FlushReadList(); |
| 84 | } |
Finn Williams | 09ad6f9 | 2019-12-19 17:05:18 +0000 | [diff] [blame] | 85 | } |
| 86 | |
| 87 | void BufferManager::Initialize() |
| 88 | { |
| 89 | m_AvailableList.reserve(m_NumberOfBuffers); |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 90 | m_CurrentNumberOfBuffers = m_NumberOfBuffers; |
Finn Williams | 09ad6f9 | 2019-12-19 17:05:18 +0000 | [diff] [blame] | 91 | for (unsigned int i = 0; i < m_NumberOfBuffers; ++i) |
| 92 | { |
| 93 | IPacketBufferPtr buffer = std::make_unique<PacketBuffer>(m_MaxBufferSize); |
| 94 | m_AvailableList.emplace_back(std::move(buffer)); |
| 95 | } |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 96 | } |
| 97 | |
Matteo Martincigh | 2ffcc41 | 2019-11-05 11:47:40 +0000 | [diff] [blame] | 98 | void BufferManager::Release(IPacketBufferPtr& packetBuffer) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 99 | { |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 100 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 101 | std::unique_lock<std::mutex> availableListLock(m_AvailableMutex, std::defer_lock); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 102 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 103 | packetBuffer->Release(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 104 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 105 | availableListLock.lock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 106 | #endif |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 107 | if (m_AvailableList.size() <= m_NumberOfBuffers) |
| 108 | { |
| 109 | m_AvailableList.push_back(std::move(packetBuffer)); |
| 110 | } |
| 111 | else |
| 112 | { |
| 113 | // we have been handed a temporary overflow/surge buffer get rid of it |
| 114 | packetBuffer->Destroy(); |
| 115 | if (m_CurrentNumberOfBuffers > m_NumberOfBuffers) |
| 116 | { |
| 117 | --m_CurrentNumberOfBuffers; |
| 118 | } |
| 119 | } |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 120 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 121 | availableListLock.unlock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 122 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 123 | } |
| 124 | |
Finn Williams | 09ad6f9 | 2019-12-19 17:05:18 +0000 | [diff] [blame] | 125 | void BufferManager::Reset() |
| 126 | { |
| 127 | //This method should only be called once all threads have been joined |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 128 | #if !defined(ARMNN_DISABLE_THREADS) |
Finn Williams | 09ad6f9 | 2019-12-19 17:05:18 +0000 | [diff] [blame] | 129 | std::lock_guard<std::mutex> readableListLock(m_ReadableMutex); |
| 130 | std::lock_guard<std::mutex> availableListLock(m_AvailableMutex); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 131 | #endif |
Finn Williams | 09ad6f9 | 2019-12-19 17:05:18 +0000 | [diff] [blame] | 132 | |
| 133 | m_AvailableList.clear(); |
Finn Williams | b6a402f | 2020-03-24 13:46:22 +0000 | [diff] [blame] | 134 | std::queue<IPacketBufferPtr>().swap(m_ReadableList); |
Finn Williams | 09ad6f9 | 2019-12-19 17:05:18 +0000 | [diff] [blame] | 135 | |
| 136 | Initialize(); |
| 137 | } |
| 138 | |
Matteo Martincigh | 2ffcc41 | 2019-11-05 11:47:40 +0000 | [diff] [blame] | 139 | IPacketBufferPtr BufferManager::GetReadableBuffer() |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 140 | { |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 141 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 142 | std::unique_lock<std::mutex> readableListLock(m_ReadableMutex); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 143 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 144 | if (!m_ReadableList.empty()) |
| 145 | { |
Finn Williams | b6a402f | 2020-03-24 13:46:22 +0000 | [diff] [blame] | 146 | IPacketBufferPtr buffer = std::move(m_ReadableList.front()); |
| 147 | m_ReadableList.pop(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 148 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 149 | readableListLock.unlock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 150 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 151 | return buffer; |
| 152 | } |
| 153 | return nullptr; |
| 154 | } |
| 155 | |
Matteo Martincigh | 2ffcc41 | 2019-11-05 11:47:40 +0000 | [diff] [blame] | 156 | void BufferManager::MarkRead(IPacketBufferPtr& packetBuffer) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 157 | { |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 158 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 159 | std::unique_lock<std::mutex> availableListLock(m_AvailableMutex, std::defer_lock); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 160 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 161 | packetBuffer->MarkRead(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 162 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 163 | availableListLock.lock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 164 | #endif |
Jim Flynn | 0204f09 | 2020-06-22 20:41:43 +0100 | [diff] [blame] | 165 | if (m_AvailableList.size() <= m_NumberOfBuffers) |
| 166 | { |
| 167 | m_AvailableList.push_back(std::move(packetBuffer)); |
| 168 | } |
| 169 | else |
| 170 | { |
| 171 | // we have been handed a temporary overflow/surge buffer get rid of it |
| 172 | packetBuffer->Destroy(); |
| 173 | if (m_CurrentNumberOfBuffers > m_NumberOfBuffers) |
| 174 | { |
| 175 | --m_CurrentNumberOfBuffers; |
| 176 | } |
| 177 | } |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 178 | #if !defined(ARMNN_DISABLE_THREADS) |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 179 | availableListLock.unlock(); |
Jim Flynn | e195a04 | 2022-04-12 17:19:28 +0100 | [diff] [blame] | 180 | #endif |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 181 | } |
| 182 | |
Sadik Armagan | 3896b47 | 2020-02-10 12:24:15 +0000 | [diff] [blame] | 183 | void BufferManager::SetConsumer(IConsumer* consumer) |
| 184 | { |
| 185 | m_Consumer = consumer; |
| 186 | } |
| 187 | |
| 188 | void BufferManager::FlushReadList() |
| 189 | { |
| 190 | // notify consumer that packet is ready to read |
| 191 | if (m_Consumer != nullptr) |
| 192 | { |
| 193 | m_Consumer->SetReadyToRead(); |
| 194 | } |
| 195 | } |
| 196 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 197 | } // namespace pipe |
Narumol Prangnawarat | 7be47ef | 2019-09-27 18:00:11 +0100 | [diff] [blame] | 198 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 199 | } // namespace arm |